UserSession::get() - Code Metrics - Inspection of "[!!!][FEATURE] Refactored Session Handling" - TYPO3/TYPO3.CMS - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( f16b47...733353 )

unknown

created 2020-12-10 12:09 UTC

UserSession::get() A

↳ Parent: UserSession

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

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

<?php

declare(strict_types=1);

/*
 * This file is part of the TYPO3 CMS project.
 *
 * It is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, either version 2
 * of the License, or any later version.
 *
 * For the full copyright and license information, please read the
 * LICENSE.txt file that was distributed with this source code.
 *
 * The TYPO3 project - inspiring people to share!
 */

namespace TYPO3\CMS\Core\Session;

/**
 * Represents all information about a user's session.
 * A user session can be bound to a frontend / backend user, or an anonymous session based on session data stored
 * in the session backend.
 *
 * If a session is anonymous, it can be fixated by storing the session in the backend, but only if there
 * is data in the session.
 *
 * if a session is user-bound, it is automatically fixated.
 *
 * The $isNew flag is meant to show that this user session object was not fetched from the session backend,
 * but initialized in the first place by the current request.
 *
 * The $data argument is to store any arbitrary data valid for the users' session.
 *
 * A permanent session means: XYZ?
 */
class UserSession
{
    protected const SESSION_UPDATE_GRACE_PERIOD = 61;
    protected string $identifier;
    protected ?int $userId;
    protected int $lastUpdated;
    protected array $data;
    protected bool $wasUpdated = false;
    protected string $ipLock = '';
    protected bool $isNew = true;
    protected bool $isPermanent = false;

    protected function __construct(string $identifier, int $userId, int $lastUpdated, array $data = [])
    {
        $this->identifier = $identifier;
        $this->userId = $userId > 0 ? $userId : null;
        $this->lastUpdated = $lastUpdated;
        $this->data = $data;
    }

    /**
     * Get the user session identifier (the ses_id)
     *
     * @return string
     */
    public function getIdentifier(): string
    {
        return $this->identifier;
    }

    /**
     * Get the user id (ID of the user record to whom the session belongs)
     *
     * @return int
     */
    public function getUserId(): ?int
    {
        return $this->userId;
    }

    /**
     * Get the timestamp of the last session data update
     *
     * @return int
     */
    public function getLastUpdated(): int
    {
        return $this->lastUpdated;
    }

    /**
     * Set / update a data value for a given key.
     * Throws an exception if the given key is empty.
     *
     * @param string $key The key whose value should be updated
     * @param mixed $value The value or NULL to unset the key
     */
    public function set(string $key, $value): void
    {
        if ($key === '') {
            throw new \InvalidArgumentException('Argument key must not be empty', 1484312516);
        }
        if ($value === null) {
            unset($this->data[$key]);
        } else {
            $this->data[$key] = $value;
        }
        $this->wasUpdated = true;
    }

    /**
     * Check whether the session has data
     *
     * @return bool
     */
    public function hasData(): bool
    {
        return $this->data !== [];
    }

    /**
     * Return the data for the given key or an NULL if the key does not exist
     *
     * @param string $key
     * @return mixed
     */
    public function get(string $key)
    {
        return $this->data[$key] ?? null;
    }

    /**
     * Return the whole session data array.
     *
     * @return array
     */
    public function getData(): array
    {
        return $this->data;
    }

    /**
     * Override the whole $data. Can be used to e.g. preserve session data
     * on login or to remove session data by providing an empty array.
     *
     * @param array $data
     */
    public function overrideData(array $data): void
    {
        if ($this->data !== $data) {
            // Only set update flag if there is change in the $data array
            $this->wasUpdated = true;
        }

        $this->data = $data;
    }

    /**
     * Check if session data was already updated
     *
     * @return bool
     */
    public function dataWasUpdated(): bool
    {
        return $this->wasUpdated;
    }

    /**
     * Check if the user session is an anonymous one.
     * This means, the session does not belong to a logged-in user.
     *
     * @return bool
     */
    public function isAnonymous(): bool
    {
        return $this->userId === 0 || $this->userId === null;
    }

    /**
     * Return the sessions ipLock state
     *
     * @return string
     */
    public function getIpLock(): string
    {
        return $this->ipLock;
    }

    /**
     * Check whether the session was marked as new on creation
     *
     * @return bool
     */
    public function isNew(): bool
    {
        return $this->isNew;
    }

    /**
     * Check whether the session was marked as permanent on creation
     *
     * @return bool
     */
    public function isPermanent(): bool
    {
        return $this->isPermanent;
    }

    /**
     * Use a gracetime-value to avoid updating a session-record too often
     *
     * @return bool
     */
    public function needsUpdate(): bool
    {
        return $GLOBALS['EXEC_TIME'] > ($this->lastUpdated + self::SESSION_UPDATE_GRACE_PERIOD);
    }

    /**
     * Create a new user session based on the provided session record
     *
     * @param string $id the session identifier
     * @param array $record
     * @param bool $markAsNew
     * @return UserSession
     */
    public static function createFromRecord(string $id, array $record, bool $markAsNew = false): self
    {
        $userSession = new self(
            $id,
            (int)($record['ses_userid'] ?? 0),
            (int)($record['ses_tstamp'] ?? 0),
            unserialize($record['ses_data'] ?? '', ['allowed_classes' => false]) ?: []
        );
        $userSession->ipLock = $record['ses_iplock'] ?? '';
        $userSession->isNew = $markAsNew;
        if (isset($record['ses_permanent'])) {
            $userSession->isPermanent = (bool)$record['ses_permanent'];
        }
        return $userSession;
    }

    /**
     * Create a non fixated user session. This means the
     * session does not belong to a logged-in user.
     *
     * @param string $identifier
     * @return UserSession
     */
    public static function createNonFixated(string $identifier): self
    {
        $userSession = new self($identifier, 0, $GLOBALS['EXEC_TIME'], []);
        $userSession->isPermanent = false;
        $userSession->isNew = true;
        return $userSession;
    }

    /**
     * Used internally to store data in the backend
     *
     * @return array The session record as array
     */
    public function toArray(): array
    {
        $data = [
            'ses_id' => $this->identifier,
            'ses_data' => serialize($this->data),
            'ses_userid' => (int)$this->userId,
            'ses_iplock' => $this->ipLock,
            'ses_tstamp' => $this->lastUpdated
        ];
        if ($this->isPermanent) {
            $data['ses_permanent'] = 1;
        }
        return $data;
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			/*
6			* This file is part of the TYPO3 CMS project.
7			*
8			* It is free software; you can redistribute it and/or modify it under
9			* the terms of the GNU General Public License, either version 2
10			* of the License, or any later version.
11			*
12			* For the full copyright and license information, please read the
13			* LICENSE.txt file that was distributed with this source code.
14			*
15			* The TYPO3 project - inspiring people to share!
16			*/
17
18			namespace TYPO3\CMS\Core\Session;
19
20			/**
21			* Represents all information about a user's session.
22			* A user session can be bound to a frontend / backend user, or an anonymous session based on session data stored
23			* in the session backend.
24			*
25			* If a session is anonymous, it can be fixated by storing the session in the backend, but only if there
26			* is data in the session.
27			*
28			* if a session is user-bound, it is automatically fixated.
29			*
30			* The $isNew flag is meant to show that this user session object was not fetched from the session backend,
31			* but initialized in the first place by the current request.
32			*
33			* The $data argument is to store any arbitrary data valid for the users' session.
34			*
35			* A permanent session means: XYZ?
36			*/
37			class UserSession
38			{
39			protected const SESSION_UPDATE_GRACE_PERIOD = 61;
40			protected string $identifier;
41			protected ?int $userId;
42			protected int $lastUpdated;
43			protected array $data;
44			protected bool $wasUpdated = false;
45			protected string $ipLock = '';
46			protected bool $isNew = true;
47			protected bool $isPermanent = false;
48
49			protected function __construct(string $identifier, int $userId, int $lastUpdated, array $data = [])
50			{
51			$this->identifier = $identifier;
52			$this->userId = $userId > 0 ? $userId : null;
53			$this->lastUpdated = $lastUpdated;
54			$this->data = $data;
55			}
56
57			/**
58			* Get the user session identifier (the ses_id)
59			*
60			* @return string
61			*/
62			public function getIdentifier(): string
63			{
64			return $this->identifier;
65			}
66
67			/**
68			* Get the user id (ID of the user record to whom the session belongs)
69			*
70			* @return int
71			*/
72			public function getUserId(): ?int
73			{
74			return $this->userId;
75			}
76
77			/**
78			* Get the timestamp of the last session data update
79			*
80			* @return int
81			*/
82			public function getLastUpdated(): int
83			{
84			return $this->lastUpdated;
85			}
86
87			/**
88			* Set / update a data value for a given key.
89			* Throws an exception if the given key is empty.
90			*
91			* @param string $key The key whose value should be updated
92			* @param mixed $value The value or NULL to unset the key
93			*/
94			public function set(string $key, $value): void
95			{
96			if ($key === '') {
97			throw new \InvalidArgumentException('Argument key must not be empty', 1484312516);
98			}
99			if ($value === null) {
100			unset($this->data[$key]);
101			} else {
102			$this->data[$key] = $value;
103			}
104			$this->wasUpdated = true;
105			}
106
107			/**
108			* Check whether the session has data
109			*
110			* @return bool
111			*/
112			public function hasData(): bool
113			{
114			return $this->data !== [];
115			}
116
117			/**
118			* Return the data for the given key or an NULL if the key does not exist
119			*
120			* @param string $key
121			* @return mixed
122			*/
123			public function get(string $key)
124			{
125			return $this->data[$key] ?? null;
126			}
127
128			/**
129			* Return the whole session data array.
130			*
131			* @return array
132			*/
133			public function getData(): array
134			{
135			return $this->data;
136			}
137
138			/**
139			* Override the whole $data. Can be used to e.g. preserve session data
140			* on login or to remove session data by providing an empty array.
141			*
142			* @param array $data
143			*/
144			public function overrideData(array $data): void
145			{
146			if ($this->data !== $data) {
147			// Only set update flag if there is change in the $data array
148			$this->wasUpdated = true;
149			}
150
151			$this->data = $data;
152			}
153
154			/**
155			* Check if session data was already updated
156			*
157			* @return bool
158			*/
159			public function dataWasUpdated(): bool
160			{
161			return $this->wasUpdated;
162			}
163
164			/**
165			* Check if the user session is an anonymous one.
166			* This means, the session does not belong to a logged-in user.
167			*
168			* @return bool
169			*/
170			public function isAnonymous(): bool
171			{
172			return $this->userId === 0 \|\| $this->userId === null;
173			}
174
175			/**
176			* Return the sessions ipLock state
177			*
178			* @return string
179			*/
180			public function getIpLock(): string
181			{
182			return $this->ipLock;
183			}
184
185			/**
186			* Check whether the session was marked as new on creation
187			*
188			* @return bool
189			*/
190			public function isNew(): bool
191			{
192			return $this->isNew;
193			}
194
195			/**
196			* Check whether the session was marked as permanent on creation
197			*
198			* @return bool
199			*/
200			public function isPermanent(): bool
201			{
202			return $this->isPermanent;
203			}
204
205			/**
206			* Use a gracetime-value to avoid updating a session-record too often
207			*
208			* @return bool
209			*/
210			public function needsUpdate(): bool
211			{
212			return $GLOBALS['EXEC_TIME'] > ($this->lastUpdated + self::SESSION_UPDATE_GRACE_PERIOD);
213			}
214
215			/**
216			* Create a new user session based on the provided session record
217			*
218			* @param string $id the session identifier
219			* @param array $record
220			* @param bool $markAsNew
221			* @return UserSession
222			*/
223			public static function createFromRecord(string $id, array $record, bool $markAsNew = false): self
224			{
225			$userSession = new self(
226			$id,
227			(int)($record['ses_userid'] ?? 0),
228			(int)($record['ses_tstamp'] ?? 0),
229			unserialize($record['ses_data'] ?? '', ['allowed_classes' => false]) ?: []
230			);
231			$userSession->ipLock = $record['ses_iplock'] ?? '';
232			$userSession->isNew = $markAsNew;
233			if (isset($record['ses_permanent'])) {
234			$userSession->isPermanent = (bool)$record['ses_permanent'];
235			}
236			return $userSession;
237			}
238
239			/**
240			* Create a non fixated user session. This means the
241			* session does not belong to a logged-in user.
242			*
243			* @param string $identifier
244			* @return UserSession
245			*/
246			public static function createNonFixated(string $identifier): self
247			{
248			$userSession = new self($identifier, 0, $GLOBALS['EXEC_TIME'], []);
249			$userSession->isPermanent = false;
250			$userSession->isNew = true;
251			return $userSession;
252			}
253
254			/**
255			* Used internally to store data in the backend
256			*
257			* @return array The session record as array
258			*/
259			public function toArray(): array
260			{
261			$data = [
262			'ses_id' => $this->identifier,
263			'ses_data' => serialize($this->data),
264			'ses_userid' => (int)$this->userId,
265			'ses_iplock' => $this->ipLock,
266			'ses_tstamp' => $this->lastUpdated
267			];
268			if ($this->isPermanent) {
269			$data['ses_permanent'] = 1;
270			}
271			return $data;
272			}
273			}
274

TYPO3 / TYPO3.CMS

Push — master ( f16b47...733353 )

UserSession::get() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like