Repository navigation
Expand file tree
/
Copy pathSession.php
More file actions
356 lines (307 loc) · 8.2 KB
/
Copy pathSession.php
File metadata and controls
356 lines (307 loc) · 8.2 KB
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
<?php
declare(strict_types=1);
/**
* This file is part of Hyperf.
*
* @link https://www.hyperf.io
* @document https://hyperf.wiki
* @contact [email protected]
* @license https://github.com/hyperf/hyperf/blob/master/LICENSE
*/
namespace Hyperf\Session;
use Hyperf\Collection\Arr;
use Hyperf\Contract\SessionInterface;
use Hyperf\Stringable\Str;
use SessionHandlerInterface;
use function Hyperf\Collection\data_get;
use function Hyperf\Collection\data_set;
/**
* This is a data class, please create a new instance for each request.
*/
class Session implements SessionInterface
{
use FlashTrait;
protected string $id;
protected array $attributes = [];
/**
* Session store started status.
*/
protected bool $started = false;
public function __construct(protected string $name, protected SessionHandlerInterface $handler, $id = null)
{
if (! is_string($id) || ! $this->isValidId($id)) {
$id = $this->generateSessionId();
}
$this->setId($id);
$this->setName($name);
}
/**
* Determine if this is a valid session ID.
*/
public function isValidId(string $id): bool
{
return ctype_alnum($id) && strlen($id) === 40;
}
/**
* Starts the session storage.
*/
public function start(): bool
{
$this->loadSession();
return $this->started = true;
}
/**
* Returns the session ID.
*
* @return string The session ID
*/
public function getId(): string
{
return $this->id;
}
/**
* Sets the session ID.
*/
public function setId(string $id): void
{
$this->id = $id;
}
/**
* Returns the session name.
*/
public function getName(): string
{
return $this->name;
}
/**
* Sets the session name.
*/
public function setName(string $name): void
{
$this->name = $name;
}
/**
* Invalidates the current session.
* Clears all session attributes and flashes and regenerates the
* session and deletes the old session from persistence.
*
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
* @return bool True if session invalidated, false if error
*/
public function invalidate(?int $lifetime = null): bool
{
$this->clear();
return $this->migrate(true, $lifetime);
}
/**
* Migrates the current session to a new session id while maintaining all
* session attributes.
*
* @param bool $destroy Whether to delete the old session or leave it to garbage collection
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
* @return bool True if session migrated, false if error
*/
public function migrate(bool $destroy = false, ?int $lifetime = null): bool
{
if ($destroy) {
$this->handler->destroy($this->getId());
}
$this->setId($this->generateSessionId());
return true;
}
/**
* Force the session to be saved and closed.
* This method is generally not required for real sessions as
* the session will be automatically saved at the end of
* code execution.
*/
public function save(): void
{
$this->ageFlashData();
$this->handler->write($this->getId(), $this->prepareForStorage(serialize($this->attributes)));
$this->started = false;
}
/**
* Checks if an attribute is defined.
*
* @param string $name The attribute name
* @return bool true if the attribute is defined, false otherwise
*/
public function has(string $name): bool
{
return Arr::exists($this->attributes, $name);
}
/**
* Returns an attribute.
*
* @param string $name The attribute name
* @param mixed $default The default value if not found
*/
public function get(string $name, $default = null)
{
return data_get($this->attributes, $name, $default);
}
/**
* Sets an attribute.
*
* @param mixed $value
*/
public function set(string $name, $value): void
{
data_set($this->attributes, $name, $value);
}
/**
* Put a key / value pair or array of key / value pairs in the session.
*
* @param array|string $key
* @param null|mixed $value
*/
public function put($key, $value = null): void
{
if (! is_array($key)) {
$key = [$key => $value];
}
foreach ($key as $arrayKey => $arrayValue) {
Arr::set($this->attributes, $arrayKey, $arrayValue);
}
}
/**
* Returns attributes.
*/
public function all(): array
{
return $this->attributes;
}
/**
* Sets attributes.
*/
public function replace(array $attributes): void
{
foreach ($attributes as $name => $value) {
data_set($this->attributes, $name, $value);
}
}
/**
* Removes an attribute, returning its value.
*
* @return mixed The removed value or null when it does not exist
*/
public function remove(string $name)
{
return Arr::pull($this->attributes, $name);
}
/**
* Remove one or many items from the session.
*
* @param array|string $keys
*/
public function forget($keys): void
{
Arr::forget($this->attributes, $keys);
}
/**
* Clears all attributes.
*/
public function clear(): void
{
$this->attributes = [];
}
/**
* Checks if the session was started.
*/
public function isStarted(): bool
{
return $this->started;
}
/**
* Get the CSRF token value.
*/
public function token(): string
{
return (string) $this->get('_token');
}
/**
* Regenerate the CSRF token value.
*/
public function regenerateToken(): string
{
$this->put('_token', $token = Str::random(40));
return $token;
}
/**
* Get the previous URL from the session.
*/
public function previousUrl(): ?string
{
$previousUrl = $this->get('_previous.url');
if (! is_string($previousUrl)) {
$previousUrl = null;
}
return $previousUrl;
}
/**
* Set the "previous" URL in the session.
*/
public function setPreviousUrl(string $url): void
{
$this->set('_previous.url', $url);
}
/**
* Push a value onto a session array.
*
* @param mixed $value
*/
public function push(string $key, $value): void
{
$array = $this->get($key, []);
$array[] = $value;
$this->put($key, $array);
}
/**
* Generate a new random session ID.
*/
protected function generateSessionId(): string
{
return Str::random(40);
}
/**
* Load the session data from the handler.
*/
protected function loadSession(): void
{
$this->attributes = array_merge($this->attributes, $this->readFromHandler());
}
/**
* Read the session data from the handler.
*/
protected function readFromHandler(): array
{
if ($data = $this->handler->read($this->getId())) {
$data = @unserialize($this->prepareForUnserialize($data));
if ($data !== false && is_array($data)) {
return $data;
}
}
return [];
}
/**
* Prepare the raw string data from the session for serialization.
*/
protected function prepareForUnserialize(string $data): string
{
return $data;
}
/**
* Prepare the serialized session data for storage.
*/
protected function prepareForStorage(string $data): string
{
return $data;
}
}