/
Cookie.php
621 lines (545 loc) · 14 KB
/
Cookie.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
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
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since 3.5.0
* @license http://www.opensource.org/licenses/mit-license.php MIT License
*/
namespace Cake\Http\Cookie;
use Cake\Chronos\Chronos;
use Cake\Utility\Hash;
use DateTimeInterface;
use InvalidArgumentException;
use RuntimeException;
/**
* Cookie object to build a cookie and turn it into a header value
*
* An HTTP cookie (also called web cookie, Internet cookie, browser cookie or
* simply cookie) is a small piece of data sent from a website and stored on
* the user's computer by the user's web browser while the user is browsing.
*
* Cookies were designed to be a reliable mechanism for websites to remember
* stateful information (such as items added in the shopping cart in an online
* store) or to record the user's browsing activity (including clicking
* particular buttons, logging in, or recording which pages were visited in
* the past). They can also be used to remember arbitrary pieces of information
* that the user previously entered into form fields such as names, and preferences.
*
* Cookie objects are immutable, and you must re-assign variables when modifying
* cookie objects:
*
* ```
* $cookie = $cookie->withValue('0');
* ```
*
* @link https://tools.ietf.org/html/rfc6265
* @link https://en.wikipedia.org/wiki/HTTP_cookie
*/
class Cookie implements CookieInterface
{
use CookieCryptTrait;
/**
* Cookie name
*
* @var string
*/
protected $name = '';
/**
* Raw Cookie value.
*
* @var string|array
*/
protected $value = '';
/**
* Whether or not a JSON value has been expanded into an array.
*
* @var bool
*/
protected $isExpanded = false;
/**
* Expiration time
*
* @var int
*/
protected $expiresAt = 0;
/**
* Path
*
* @var string
*/
protected $path = '';
/**
* Domain
*
* @var string
*/
protected $domain = '';
/**
* Secure
*
* @var bool
*/
protected $secure = false;
/**
* HTTP only
*
* @var bool
*/
protected $httpOnly = false;
/**
* Constructor
*
* The constructors args are similar to the native PHP `setcookie()` method.
* The only difference is the 3rd argument which excepts null or an object
* implementing \DateTimeInterface instead an integer.
*
* @link http://php.net/manual/en/function.setcookie.php
* @param string $name Cookie name
* @param string|array $value Value of the cookie
* @param \DateTimeInterface|null $expiresAt Expiration time and date
* @param string $path Path
* @param string $domain Domain
* @param bool $secure Is secure
* @param bool $httpOnly HTTP Only
*/
public function __construct(
$name,
$value = '',
DateTimeInterface $expiresAt = null,
$path = '',
$domain = '',
$secure = false,
$httpOnly = false
) {
$this->validateName($name);
$this->name = $name;
$this->_setValue($value);
$this->validateString($domain);
$this->domain = $domain;
$this->validateBool($httpOnly);
$this->httpOnly = $httpOnly;
$this->validateString($path);
$this->path = $path;
$this->validateBool($secure);
$this->secure = $secure;
if ($expiresAt !== null) {
$this->expiresAt = (int)$expiresAt->format('U');
}
}
/**
* Builds the expiration value part of the header string
*
* @return string
*/
protected function _buildExpirationValue()
{
return sprintf(
'expires=%s',
gmdate('D, d-M-Y H:i:s T', $this->expiresAt)
);
}
/**
* Returns a header value as string
*
* @return string
*/
public function toHeaderValue()
{
$headerValue[] = sprintf('%s=%s', $this->name, urlencode($this->value));
if ($this->expiresAt !== 0) {
$headerValue[] = $this->_buildExpirationValue();
}
if ($this->path !== '') {
$headerValue[] = sprintf('path=%s', $this->path);
}
if ($this->domain !== '') {
$headerValue[] = sprintf('domain=%s', $this->domain);
}
if ($this->secure) {
$headerValue[] = 'secure';
}
if ($this->httpOnly) {
$headerValue[] = 'httponly';
}
return implode('; ', $headerValue);
}
/**
* Create a cookie with an updated name
*
* @param string $name Name of the cookie
* @return static
*/
public function withName($name)
{
$this->validateName($name);
$new = clone $this;
$new->name = $name;
return $new;
}
/**
* Gets the cookie name
*
* @return string
*/
public function getName()
{
return $this->name;
}
/**
* Validates the cookie name
*
* @param string $name Name of the cookie
* @return void
* @throws \InvalidArgumentException
*/
protected function validateName($name)
{
if (preg_match("/[=,; \t\r\n\013\014]/", $name)) {
throw new InvalidArgumentException(
sprintf('The cookie name `%s` contains invalid characters.', $name)
);
}
if (empty($name)) {
throw new InvalidArgumentException('The cookie name cannot be empty.');
}
}
/**
* Gets the cookie value
*
* @return string|array
*/
public function getValue()
{
return $this->value;
}
/**
* Create a cookie with an updated value.
*
* @param string|array $value Value of the cookie to set
* @return static
*/
public function withValue($value)
{
$new = clone $this;
$new->_setValue($value);
return $new;
}
/**
* Setter for the value attribute.
*
* @param mixed $value The value to store.
* @return void
*/
protected function _setValue($value)
{
if (is_array($value)) {
$this->isExpanded = true;
}
$this->value = $value;
}
/**
* Create a new cookie with an updated path
*
* @param string $path Sets the path
* @return static
*/
public function withPath($path)
{
$this->validateString($path);
$new = clone $this;
$new->path = $path;
return $new;
}
/**
* Create a cookie with an updated domain
*
* @param string $domain Domain to set
* @return static
*/
public function withDomain($domain)
{
$this->validateString($domain);
$new = clone $this;
$new->domain = $domain;
return $new;
}
/**
* Validate that an argument is a string
*
* @param string $value The value to validate.
* @return void
* @throws \InvalidArgumentException
*/
protected function validateString($value)
{
if (!is_string($value)) {
throw new InvalidArgumentException(sprintf(
'The provided arg must be of type `string` but `%s` given',
gettype($value)
));
}
}
/**
* Check if the cookie is secure
*
* @return bool
*/
public function isSecure()
{
return $this->secure;
}
/**
* Create a cookie with Secure updated
*
* @param bool $secure Secure attribute value
* @return static
*/
public function withSecure($secure)
{
$this->validateBool($secure);
$new = clone $this;
$new->secure = $secure;
return $new;
}
/**
* Create a cookie with HTTP Only updated
*
* @param bool $httpOnly HTTP Only
* @return static
*/
public function withHttpOnly($httpOnly)
{
$this->validateBool($httpOnly);
$new = clone $this;
$new->httpOnly = $httpOnly;
return $new;
}
/**
* Validate that an argument is a boolean
*
* @param bool $value The value to validate.
* @return void
* @throws \InvalidArgumentException
*/
protected function validateBool($value)
{
if (!is_bool($value)) {
throw new InvalidArgumentException(sprintf(
'The provided arg must be of type `bool` but `%s` given',
gettype($value)
));
}
}
/**
* Check if the cookie is HTTP only
*
* @return bool
*/
public function isHttpOnly()
{
return $this->httpOnly;
}
/**
* Create a cookie with an updated expiration date
*
* @param \DateTimeInterface $dateTime Date time object
* @return static
*/
public function withExpiry(DateTimeInterface $dateTime)
{
$new = clone $this;
$new->expiresAt = (int)$dateTime->format('U');
return $new;
}
/**
* Create a new cookie that will virtually never expire.
*
* @return static
*/
public function withNeverExpire()
{
$new = clone $this;
$new->expiresAt = Chronos::createFromDate(2038, 1, 1)->format('U');
return $new;
}
/**
* Create a new cookie that will expire/delete the cookie from the browser.
*
* This is done by setting the expiration time to 1 year ago
*
* @return static
*/
public function withExpired()
{
$new = clone $this;
$new->expiresAt = Chronos::parse('-1 year')->format('U');
return $new;
}
/**
* Checks if a value exists in the cookie data.
*
* @param string $path Path to check
* @return bool
*/
public function check($path)
{
$this->_isExpanded();
return Hash::check($this->value, $path);
}
/**
* Create a new cookie with updated data.
*
* @param string $path Path to write to
* @param mixed $value Value to write
* @return static
*/
public function withAddedValue($path, $value)
{
$this->_isExpanded();
$new = clone $this;
$new->value = Hash::insert($new->value, $path, $value);
return $new;
}
/**
* Create a new cookie without a specific path
*
* @param string $path Path to remove
* @return static
*/
public function withoutAddedValue($path)
{
$this->_isExpanded();
$new = clone $this;
$new->value = Hash::remove($new->value, $path);
return $new;
}
/**
* Read data from the cookie
*
* @param string $path Path to read the data from
* @return mixed
*/
public function read($path = null)
{
$this->_isExpanded();
if ($path === null) {
return $this->value;
}
return Hash::get($this->value, $path);
}
/**
* Throws a \RuntimeException if the cookie value was not expanded
*
* @throws \RuntimeException
* @return void
*/
protected function _isExpanded()
{
if (!$this->isExpanded) {
throw new RuntimeException('The Cookie data has not been expanded');
}
}
/**
* Encrypts the cookie value
*
* @param string|null $key Encryption key
* @return $this
*/
public function encrypt($key = null)
{
if ($key !== null) {
$this->setEncryptionKey($key);
}
$this->value = $this->_encrypt($this->value);
return $this;
}
/**
* Decrypts the cookie value
*
* @param string|null $key Encryption key
* @return $this
*/
public function decrypt($key = null)
{
if ($key !== null) {
$this->setEncryptionKey($key);
}
$this->value = $this->_decrypt($this->value);
return $this;
}
/**
* Expands a serialized cookie value
*
* @return $this
*/
public function expand()
{
if (!$this->isExpanded) {
$this->value = $this->_expand($this->value);
$this->isExpanded = true;
}
return $this;
}
/**
* Serializes the cookie value to a string
*
* @return $this
*/
public function flatten()
{
if ($this->isExpanded) {
$this->value = $this->_flatten($this->value);
$this->isExpanded = false;
}
return $this;
}
/**
* Checks if the cookie value was expanded
*
* @return bool
*/
public function isExpanded()
{
return $this->isExpanded;
}
/**
* Implode method to keep keys are multidimensional arrays
*
* @param array $array Map of key and values
* @return string A json encoded string.
*/
protected function _flatten(array $array)
{
return json_encode($array);
}
/**
* Explode method to return array from string set in CookieComponent::_flatten()
* Maintains reading backwards compatibility with 1.x CookieComponent::_flatten().
*
* @param string $string A string containing JSON encoded data, or a bare string.
* @return string|array Map of key and values
*/
protected function _expand($string)
{
$first = substr($string, 0, 1);
if ($first === '{' || $first === '[') {
$ret = json_decode($string, true);
return ($ret !== null) ? $ret : $string;
}
$array = [];
foreach (explode(',', $string) as $pair) {
$key = explode('|', $pair);
if (!isset($key[1])) {
return $key[0];
}
$array[$key[0]] = $key[1];
}
return $array;
}
}