Shieldon\Firewall\Session

Complexity

Total Complexity

30

Size/Duplication

Total Lines	393
Duplicated Lines	0 %

Importance

Changes	5
Bugs	0	Features	0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	17	1
A	remove()	0	6	2
A	log()	0	4	2
A	init()	0	37	4
A	getChannel()	0	3	1
A	has()	0	5	1
A	isInitialized()	0	3	1
A	create()	0	16	1
A	assertInit()	0	5	2
A	set()	0	5	1
A	parsedData()	0	6	2
A	resetCookie()	0	20	2
A	setId()	0	8	1
A	get()	0	5	1
A	clear()	0	5	1
A	save()	0	12	1
A	getId()	0	3	1
A	gc()	0	21	5

<?php
/**
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <contact@terryl.in>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 * 
 * php version 7.1.0
 * 
 * @category  Web-security
 * @package   Shieldon
 * @author    Terry Lin <contact@terryl.in>
 * @copyright 2019 terrylinooo
 * @license   https://github.com/terrylinooo/shieldon/blob/2.x/LICENSE MIT
 * @link      https://github.com/terrylinooo/shieldon
 * @see       https://shieldon.io
 */

declare(strict_types=1);

namespace Shieldon\Firewall;

use Shieldon\Firewall\Container;
use Shieldon\Firewall\Driver\DirverProvider;

The type Shieldon\Firewall\Driver\DirverProvider was not found. Maybe you did not declare it correctly or list all dependencies?

use Shieldon\Firewall\Log\SessionLogger;
use Shieldon\Event\Event;
use RuntimeException;
use function Shieldon\Firewall\create_session_id;
use function Shieldon\Firewall\get_ip;
use function Shieldon\Firewall\get_microtimesamp;
use function Shieldon\Firewall\get_request;
use function Shieldon\Firewall\get_response;
use function Shieldon\Firewall\set_response;
use function intval;
use function rand;
use function setcookie;
use function time;
use function php_sapi_name;

/*
 * Session for the use of Shieldon.
 */
class Session
{
    /**
     *   Public methods       | Desctiotion
     *  ----------------------|---------------------------------------------
     *   init                 | Initialize the session.
     *   getId                | Get session ID.
     *   setId                | Set session ID
     *   isInitialized        | Check if a session has been initialized or not.
     *   get                  | Get specific value from session by key.
     *   set                  | To store data in the session.
     *   remove               | To delete data from the session.
     *   has                  | To determine if an item is present in the session.
     *   clear                | Clear all data in the session array.
     *   save                 | Save session data into database.
     *   ::resetCookie        | Create a new session cookie for current user.
     *  ----------------------|---------------------------------------------
     */

    /**
     * The session data.
     *
     * @var array
     */
    protected $data = [];

    /**
     * The session data will be removed after expiring.
     * Time unit: second.
     *
     * @var int
     */
    protected $expire = 600;

    /**
     * The Shieldon kernel.
     *
     * @var Kernel|null
     */
    protected $kernel;

    /**
     * The data driver.
     *
     * @var DirverProvider|null
     */
    protected $driver;

    /**
     * Make sure the init() run first.
     *
     * @var bool
     */
    protected static $status = false;

    /**
     * A session Id.
     *
     * @var string
     */
    protected static $id = '_php_cli_';

    /**
     * Constructor.
     * 
     * @param string $id Session ID
     */
    public function __construct(string $sessionId = '')
    {
        $this->setId($sessionId);

        /**
         * Store the session data back into the database table when the 
         * Shieldon Kernel workflow is reaching the end of the process.
         */
        Event::AddListener('kernel_end', [$this, 'save'], 10);

        /**
         * Store the session data back into the database table when the 
         * user is logged successfully.
         */
        Event::AddListener('user_login', [$this, 'save'], 10);

        self::log();
    }

    /**
     * Initialize.
     *
     * @param object $driver        The data driver.
     * @param int    $gcExpires     The time of expiring.
     * @param int    $gcProbability GC setting,
     * @param int    $gcDivisor     GC setting,
     * @param bool   $psr7          Reset the cookie the PSR-7 way?
     *
     * @return void
     */
    public function init(
             $driver, 
        int  $gcExpires     = 300, 
        int  $gcProbability = 1, 
        int  $gcDivisor     = 100, 
        bool $psr7          = true
    ): void {
        $this->driver = $driver;

        $cookie = get_request()->getCookieParams();

        $this->gc($gcExpires, $gcProbability, $gcDivisor);
 
        // New visitor? Create a new session.
        if (
            php_sapi_name() !== 'cli' && 
            empty($cookie['_shieldon'])
        ) {
            self::resetCookie($psr7);
            $this->create();
            self::$status = true;

            return;
        }

        $this->data = $this->driver->get(self::$id, 'session');

        if (empty($this->data)) {
            self::resetCookie($psr7);
            $this->create();
        }

        $this->parsedData();

        self::$status = true;

        self::log(self::$id);
    }

    /**
     * Get the channel name from data driver.
     *
     * @return string
     */
    public function getChannel(): string
    {
        return $this->driver->getChannel();

The method getChannel() does not exist on null.

    }

    /**
     * Check the initialization status.
     *
     * @return bool
     */
    public function isInitialized(): bool
    {
        return self::$status;
    }

    /**
     * Get session ID.
     *
     * @return string
     */
    public function getId(): string
    {
        return self::$id;
    }

    /**
     * Set session ID.
     *
     * @param string $id Session Id.
     *
     * @return void
     */
    public function setId(string $id): void
    {
        self::$id = $id;

        // We store this session ID into the container for the use of other functions.
        Container::set('session_id', $id, true);

        self::log($id);
    }

    /**
     * Get specific value from session by key.
     *
     * @param string $key The key of a data field.
     *
     * @return mixed
     */
    public function get(string $key)
    {
        $this->assertInit();

        return $this->data['parsed_data'][$key] ?? '';
    }

    /**
     * To store data in the session.
     *
     * @param string $key   The key of a data field.
     * @param mixed  $value The value of a data field.
     *
     * @return void
     */
    public function set(string $key, $value): void
    {
        $this->assertInit();

        $this->data['parsed_data'][$key] = $value;
    }

    /**
     * To delete data from the session.
     *
     * @param string $key The key of a data field.
     *
     * @return void
     */
    public function remove(string $key): void
    {
        $this->assertInit();

        if (isset($this->data['parsed_data'][$key])) {
            unset($this->data['parsed_data'][$key]);
        }
    }

    /**
     * To determine if an item is present in the session.
     *
     * @param string $key The key of a data field.
     *
     * @return bool
     */
    public function has($key): bool
    {
        $this->assertInit();

        return isset($this->data['parsed_data'][$key]);
    }

    /**
     * Clear all data in the session array.
     *
     * @return void
     */
    public function clear(): void
    {
        $this->assertInit();

        $this->data = [];
    }

    /**
     * Save session data into database.
     *
     * @return void
     */
    public function save(): void
    {
        $data['id'] = self::$id;

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

        $data['ip'] = get_ip();
        $data['time'] = time();
        $data['microtimesamp'] = (string) get_microtimesamp();

        $data['data'] = json_encode($this->data['parsed_data']);

        $this->driver->save(self::$id, $data, 'session');

        self::log(self::$id . "\n" . $this->data['data']);
    }

    /**
     * Reset cookie.
     * 
     * @param bool $psr7 Reset the cookie the PSR-7 way, otherwise native.
     *
     * @return void
     */
    public static function resetCookie(bool $psr7 = true): void
    {
        $sessionHashId = create_session_id();
        $cookieName = '_shieldon';
        $expiredTime = time() + 3600;

        if ($psr7) {
            $expires = date('D, d M Y H:i:s', $expiredTime) . ' GMT';
            $response = get_response()->withHeader(
                'Set-Cookie',
                $cookieName . '=' . $sessionHashId . '; Path=/; Expires=' . $expires
            );
            set_response($response);
        } else {
            setcookie($cookieName, $sessionHashId, $expiredTime, '/');
        }

        self::$id = $sessionHashId;

        self::log($sessionHashId);
    }

    /**
     * Perform session data garbage collection.
     *
     * @param int $expires     The time of expiring.
     * @param int $probability Numerator.
     * @param int $divisor     Denominator.
     *
     * @return bool
     */
    protected function gc(int $expires, int $probability, int $divisor): bool
    {
        $chance = intval($divisor / $probability);
        $hit = rand(1, $chance);

        if ($hit === 1) {
            
            $sessionData = $this->driver->getAll('session');

            if (!empty($sessionData)) {
                foreach ($sessionData as $v) {
                    $lasttime = (int) $v['time'];
    
                    if (time() - $lasttime > $expires) {
                        $this->driver->delete($v['id'], 'session');
                    }
                }
            }
            return true;
        }
        return false;
    }

    /**
     * Create session data structure.
     *
     * @return void
     */
    protected function create(): void
    {
        // Initialize new session data.
        $data['id'] = self::$id;

$data was never initialized. Although not strictly required by PHP, it is generally a good practice to add $data = array(); before regardless.

        $data['ip'] = get_ip();
        $data['time'] = time();
        $data['microtimesamp'] = get_microtimesamp();

        // This field is a JSON string.
        $data['data'] = '{}';
        $data['parsed_data'] = [];

        $this->data = $data;
        $this->save();

        self::log(json_encode($this->data));
    }

    /**
     * Parse JSON data and store it into parsed_data field.
     *
     * @return void
     */
    protected function parsedData()
    {
        if (empty($this->data['data'])) {
            $this->data['data'] = '{}';
        }
        $this->data['parsed_data'] = json_decode($this->data['data'], true);
    }

    /**
     * Make sure init run first.
     *
     * @return void
     */
    protected function assertInit(): void
    {
        if (!$this->isInitialized()) {
            throw new RuntimeException(
                'The init method is supposed to run first.'
            );
        }
    }

    /**
     * Log.
     *
     * @return void
     */
    protected static function log($text = '')
    {
        if (php_sapi_name() === 'cli') {
            SessionLogger::log($text);
        }
    }
}