-
Notifications
You must be signed in to change notification settings - Fork 3.4k
/
SessionStorage.php
142 lines (124 loc) · 3.58 KB
/
SessionStorage.php
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
<?php
declare(strict_types=1);
/**
* CakePHP(tm) : Rapid Development Framework (https://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (https://cakefoundation.org)
* @link https://cakephp.org CakePHP(tm) Project
* @since 3.1.0
* @license https://opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Auth\Storage;
use Cake\Core\InstanceConfigTrait;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
/**
* Session based persistent storage for authenticated user record.
*/
class SessionStorage implements StorageInterface
{
use InstanceConfigTrait;
/**
* User record.
*
* Stores user record array if fetched from session or false if session
* does not have user record.
*
* @var \ArrayAccess|array|false|null
*/
protected $_user;
/**
* Session object.
*
* @var \Cake\Http\Session
*/
protected $_session;
/**
* Default configuration for this class.
*
* Keys:
*
* - `key` - Session key used to store user record.
* - `redirect` - Session key used to store redirect URL.
*
* @var array
*/
protected $_defaultConfig = [
'key' => 'Auth.User',
'redirect' => 'Auth.redirect',
];
/**
* Constructor.
*
* @param \Cake\Http\ServerRequest $request Request instance.
* @param \Cake\Http\Response $response Response instance.
* @param array $config Configuration list.
*/
public function __construct(ServerRequest $request, Response $response, array $config = [])
{
$this->_session = $request->getSession();
$this->setConfig($config);
}
/**
* Read user record from session.
*
* @return \ArrayAccess|array|null User record if available else null.
* @psalm-suppress InvalidReturnType
*/
public function read()
{
if ($this->_user !== null) {
return $this->_user ?: null;
}
/** @psalm-suppress PossiblyInvalidPropertyAssignmentValue */
$this->_user = $this->_session->read($this->_config['key']) ?: false;
/** @psalm-suppress InvalidReturnStatement */
return $this->_user ?: null;
}
/**
* Write user record to session.
*
* The session id is also renewed to help mitigate issues with session replays.
*
* @param array|\ArrayAccess $user User record.
* @return void
*/
public function write($user): void
{
$this->_user = $user;
$this->_session->renew();
$this->_session->write($this->_config['key'], $user);
}
/**
* Delete user record from session.
*
* The session id is also renewed to help mitigate issues with session replays.
*
* @return void
*/
public function delete(): void
{
$this->_user = false;
$this->_session->delete($this->_config['key']);
$this->_session->renew();
}
/**
* @inheritDoc
*/
public function redirectUrl($url = null)
{
if ($url === null) {
return $this->_session->read($this->_config['redirect']);
}
if ($url === false) {
$this->_session->delete($this->_config['redirect']);
return null;
}
$this->_session->write($this->_config['redirect'], $url);
}
}