SessionTrait::limitSession() - Code Metrics - Inspection of "Improve code quality." - terrylinooo/shieldon - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — 2.x ( d6434d...dbf03f )

by Terry

created 2020-07-21 17:39 UTC

SessionTrait::limitSession() A

↳ Parent: SessionTrait

Complexity

Conditions	1
Paths	1

Size

Total Lines	5
Code Lines	3

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
cc	1
eloc	3
c	1
b	0
f	0
nc	1
nop	2
dl	0
loc	5
rs	10

<?php
/*
 * This file is part of the Shieldon package.
 *
 * (c) Terry L. <[email protected]>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Shieldon\Firewall\Kernel;

use function Shieldon\Firewall\get_session;
use function microtime;
use function str_replace;
use function time;

/*
 * The main functionality for this trait is to limit the online session amount.
 */
trait SessionTrait
{
   /**
     * Are you willing to limit the online session amount?
     *
     * @var array
     */
    protected $sessionLimit = [

        // How many sessions will be available?
        // 0 = no limit.
        'count' => 0,

        // How many minutes will a session be availe to visit?
        // 0 = no limit.
        'period' => 0, 
    ];

    /**
     * Record the online session status.
     * This will be enabled when $sessionLimit[count] > 0
     *
     * This array is recording a live data, not a setting value.
     *
     * @var array
     */
    protected $sessionStatus = [

        // Online session count.
        'count' => 0,

        // Current session order.
        'order' => 0,

        // Current waiting queue.
        'queue' => 0,
    ];

    /**
     * Limt online sessions.
     *
     * @param int $count
     * @param int $period
     *
     * @return void
     */
    public function limitSession(int $count = 1000, int $period = 300): void
    {
        $this->sessionLimit = [
            'count' => $count,
            'period' => $period
        ];
    }

    /**
     * Get online people count. If enable limitSession.
     *
     * @return int
     */
    public function getSessionCount(): int
    {
        return $this->sessionStatus['count'];
    }

    /**
     * Deal with online sessions.
     *
     * @param int $statusCode The response code.
     *
     * @return int The response code.
     */
    protected function sessionHandler($statusCode): int
    {
        if (self::RESPONSE_ALLOW !== $statusCode) {

            return $statusCode;
        }

        // If you don't enable `limit traffic`, ignore the following steps.
        if (empty($this->sessionLimit['count'])) {
            return self::RESPONSE_ALLOW;

        } else {

            // Get the proerties.
            $limit = (int) ($this->sessionLimit['count'] ?? 0);
            $period = (int) ($this->sessionLimit['period'] ?? 300);
            $now = time();

            $sessionData = $this->driver->getAll('session');
            $sessionPools = [];

            $i = 1;
            $sessionOrder = 0;

            if (!empty($sessionData)) {
                foreach ($sessionData as $v) {
                    $sessionPools[] = $v['id'];
                    $lasttime = (int) $v['time'];
    
                    if (get_session()->get('id') === $v['id']) {
                        $sessionOrder = $i;
                    }
    
                    // Remove session if it expires.
                    if ($now - $lasttime > $period) {
                        $this->driver->delete($v['id'], 'session');
                    }
                    $i++;
                }

                if (0 === $sessionOrder) {
                    $sessionOrder = $i;
                }
            } else {
                $sessionOrder = 0;
            }

            // Count the online sessions.
            $this->sessionStatus['count'] = count($sessionPools);
            $this->sessionStatus['order'] = $sessionOrder;
            $this->sessionStatus['queue'] = $sessionOrder - $limit;

            if (!in_array(get_session()->get('id'), $sessionPools)) {
                $this->sessionStatus['count']++;

                // New session, record this data.
                $data['id'] = get_session()->get('id');

                $data['ip'] = $this->ip;
                $data['time'] = $now;

                $microtimesamp = explode(' ', microtime());
                $microtimesamp = $microtimesamp[1] . str_replace('0.', '', $microtimesamp[0]);
                $data['microtimesamp'] = $microtimesamp;

                $this->driver->save(get_session()->get('id'), $data, 'session');
            }

            // Online session count reached the limit. So return RESPONSE_LIMIT_SESSION response code.
            if ($sessionOrder >= $limit) {
                return self::RESPONSE_LIMIT_SESSION;

            }
        }

        return self::RESPONSE_ALLOW;
    }



    // @codeCoverageIgnoreStart

    /**
     * For testing propose.
     *
     * @param string $sessionId
     *
     * @return void
     */
    protected function setSessionId(string $sessionId = ''): void
    {
        if ('' !== $sessionId) {
            get_session()->set('id', $sessionId);
        }
    }
}


1			<?php
2			/*
3			* This file is part of the Shieldon package.
4			*
5			* (c) Terry L. <[email protected]>
6			*
7			* For the full copyright and license information, please view the LICENSE
8			* file that was distributed with this source code.
9			*/
10
11			declare(strict_types=1);
12
13			namespace Shieldon\Firewall\Kernel;
14
15			use function Shieldon\Firewall\get_session;
16			use function microtime;
17			use function str_replace;
18			use function time;
19
20			/*
21			* The main functionality for this trait is to limit the online session amount.
22			*/
23			trait SessionTrait
24			{
25			/**
26			* Are you willing to limit the online session amount?
27			*
28			* @var array
29			*/
30			protected $sessionLimit = [
31
32			// How many sessions will be available?
33			// 0 = no limit.
34			'count' => 0,
35
36			// How many minutes will a session be availe to visit?
37			// 0 = no limit.
38			'period' => 0,
39			];
40
41			/**
42			* Record the online session status.
43			* This will be enabled when $sessionLimit[count] > 0
44			*
45			* This array is recording a live data, not a setting value.
46			*
47			* @var array
48			*/
49			protected $sessionStatus = [
50
51			// Online session count.
52			'count' => 0,
53
54			// Current session order.
55			'order' => 0,
56
57			// Current waiting queue.
58			'queue' => 0,
59			];
60
61			/**
62			* Limt online sessions.
63			*
64			* @param int $count
65			* @param int $period
66			*
67			* @return void
68			*/
69			public function limitSession(int $count = 1000, int $period = 300): void
70			{
71			$this->sessionLimit = [
72			'count' => $count,
73			'period' => $period
74			];
75			}
76
77			/**
78			* Get online people count. If enable limitSession.
79			*
80			* @return int
81			*/
82			public function getSessionCount(): int
83			{
84			return $this->sessionStatus['count'];
85			}
86
87			/**
88			* Deal with online sessions.
89			*
90			* @param int $statusCode The response code.
91			*
92			* @return int The response code.
93			*/
94			protected function sessionHandler($statusCode): int
95			{
96			if (self::RESPONSE_ALLOW !== $statusCode) {
			0 ignored issues – show Bug introduced 2020-07-21 12:50 UTC by Report Bug Copy Issue Report The constant `Shieldon\Firewall\Kernel...onTrait::RESPONSE_ALLOW` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
97			return $statusCode;
98			}
99
100			// If you don't enable `limit traffic`, ignore the following steps.
101			if (empty($this->sessionLimit['count'])) {
102			return self::RESPONSE_ALLOW;
103
104			} else {
105
106			// Get the proerties.
107			$limit = (int) ($this->sessionLimit['count'] ?? 0);
108			$period = (int) ($this->sessionLimit['period'] ?? 300);
109			$now = time();
110
111			$sessionData = $this->driver->getAll('session');
112			$sessionPools = [];
113
114			$i = 1;
115			$sessionOrder = 0;
116
117			if (!empty($sessionData)) {
118			foreach ($sessionData as $v) {
119			$sessionPools[] = $v['id'];
120			$lasttime = (int) $v['time'];
121
122			if (get_session()->get('id') === $v['id']) {
123			$sessionOrder = $i;
124			}
125
126			// Remove session if it expires.
127			if ($now - $lasttime > $period) {
128			$this->driver->delete($v['id'], 'session');
129			}
130			$i++;
131			}
132
133			if (0 === $sessionOrder) {
134			$sessionOrder = $i;
135			}
136			} else {
137			$sessionOrder = 0;
138			}
139
140			// Count the online sessions.
141			$this->sessionStatus['count'] = count($sessionPools);
142			$this->sessionStatus['order'] = $sessionOrder;
143			$this->sessionStatus['queue'] = $sessionOrder - $limit;
144
145			if (!in_array(get_session()->get('id'), $sessionPools)) {
146			$this->sessionStatus['count']++;
147
148			// New session, record this data.
149			$data['id'] = get_session()->get('id');
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-07-15 19:08 UTC by Report Bug Copy Issue Report `$data` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$data = array();` before regardless. Loading history...
150			$data['ip'] = $this->ip;
151			$data['time'] = $now;
152
153			$microtimesamp = explode(' ', microtime());
154			$microtimesamp = $microtimesamp[1] . str_replace('0.', '', $microtimesamp[0]);
155			$data['microtimesamp'] = $microtimesamp;
156
157			$this->driver->save(get_session()->get('id'), $data, 'session');
158			}
159
160			// Online session count reached the limit. So return RESPONSE_LIMIT_SESSION response code.
161			if ($sessionOrder >= $limit) {
162			return self::RESPONSE_LIMIT_SESSION;
			0 ignored issues – show Bug introduced 2020-07-21 12:50 UTC by Report Bug Copy Issue Report The constant `Shieldon\Firewall\Kernel...:RESPONSE_LIMIT_SESSION` was not found. Maybe you did not declare it correctly or list all dependencies? Loading history...
163			}
164			}
165
166			return self::RESPONSE_ALLOW;
167			}
168
169
170
171			// @codeCoverageIgnoreStart
172
173			/**
174			* For testing propose.
175			*
176			* @param string $sessionId
177			*
178			* @return void
179			*/
180			protected function setSessionId(string $sessionId = ''): void
181			{
182			if ('' !== $sessionId) {
183			get_session()->set('id', $sessionId);
184			}
185			}
186			}
187

terrylinooo / shieldon

Push — 2.x ( d6434d...dbf03f )

SessionTrait::limitSession() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like