CookieJar.php
7 months ago
CookieJarInterface.php
7 months ago
FileCookieJar.php
7 months ago
SessionCookieJar.php
7 months ago
SetCookie.php
7 months ago
SetCookie.php
493 lines
| 1 | <?php |
| 2 | |
| 3 | namespace AmeliaVendor\GuzzleHttp\Cookie; |
| 4 | |
| 5 | /** |
| 6 | * Set-Cookie object |
| 7 | */ |
| 8 | class SetCookie |
| 9 | { |
| 10 | /** |
| 11 | * @var array |
| 12 | */ |
| 13 | private static $defaults = [ |
| 14 | 'Name' => null, |
| 15 | 'Value' => null, |
| 16 | 'Domain' => null, |
| 17 | 'Path' => '/', |
| 18 | 'Max-Age' => null, |
| 19 | 'Expires' => null, |
| 20 | 'Secure' => false, |
| 21 | 'Discard' => false, |
| 22 | 'HttpOnly' => false, |
| 23 | ]; |
| 24 | |
| 25 | /** |
| 26 | * @var array Cookie data |
| 27 | */ |
| 28 | private $data; |
| 29 | |
| 30 | /** |
| 31 | * Create a new SetCookie object from a string. |
| 32 | * |
| 33 | * @param string $cookie Set-Cookie header string |
| 34 | */ |
| 35 | public static function fromString(string $cookie): self |
| 36 | { |
| 37 | // Create the default return array |
| 38 | $data = self::$defaults; |
| 39 | // Explode the cookie string using a series of semicolons |
| 40 | $pieces = \array_filter(\array_map('trim', \explode(';', $cookie))); |
| 41 | // The name of the cookie (first kvp) must exist and include an equal sign. |
| 42 | if (!isset($pieces[0]) || \strpos($pieces[0], '=') === false) { |
| 43 | return new self($data); |
| 44 | } |
| 45 | |
| 46 | // Add the cookie pieces into the parsed data array |
| 47 | foreach ($pieces as $part) { |
| 48 | $cookieParts = \explode('=', $part, 2); |
| 49 | $key = \trim($cookieParts[0]); |
| 50 | $value = isset($cookieParts[1]) |
| 51 | ? \trim($cookieParts[1], " \n\r\t\0\x0B") |
| 52 | : true; |
| 53 | |
| 54 | // Only check for non-cookies when cookies have been found |
| 55 | if (!isset($data['Name'])) { |
| 56 | $data['Name'] = $key; |
| 57 | $data['Value'] = $value; |
| 58 | } else { |
| 59 | foreach (\array_keys(self::$defaults) as $search) { |
| 60 | if (!\strcasecmp($search, $key)) { |
| 61 | if ($search === 'Max-Age') { |
| 62 | if (is_numeric($value)) { |
| 63 | $data[$search] = (int) $value; |
| 64 | } |
| 65 | } elseif ($search === 'Secure' || $search === 'Discard' || $search === 'HttpOnly') { |
| 66 | if ($value) { |
| 67 | $data[$search] = true; |
| 68 | } |
| 69 | } else { |
| 70 | $data[$search] = $value; |
| 71 | } |
| 72 | continue 2; |
| 73 | } |
| 74 | } |
| 75 | $data[$key] = $value; |
| 76 | } |
| 77 | } |
| 78 | |
| 79 | return new self($data); |
| 80 | } |
| 81 | |
| 82 | /** |
| 83 | * @param array $data Array of cookie data provided by a Cookie parser |
| 84 | */ |
| 85 | public function __construct(array $data = []) |
| 86 | { |
| 87 | $this->data = self::$defaults; |
| 88 | |
| 89 | if (isset($data['Name'])) { |
| 90 | $this->setName($data['Name']); |
| 91 | } |
| 92 | |
| 93 | if (isset($data['Value'])) { |
| 94 | $this->setValue($data['Value']); |
| 95 | } |
| 96 | |
| 97 | if (isset($data['Domain'])) { |
| 98 | $this->setDomain($data['Domain']); |
| 99 | } |
| 100 | |
| 101 | if (isset($data['Path'])) { |
| 102 | $this->setPath($data['Path']); |
| 103 | } |
| 104 | |
| 105 | if (isset($data['Max-Age'])) { |
| 106 | $this->setMaxAge($data['Max-Age']); |
| 107 | } |
| 108 | |
| 109 | if (isset($data['Expires'])) { |
| 110 | $this->setExpires($data['Expires']); |
| 111 | } |
| 112 | |
| 113 | if (isset($data['Secure'])) { |
| 114 | $this->setSecure($data['Secure']); |
| 115 | } |
| 116 | |
| 117 | if (isset($data['Discard'])) { |
| 118 | $this->setDiscard($data['Discard']); |
| 119 | } |
| 120 | |
| 121 | if (isset($data['HttpOnly'])) { |
| 122 | $this->setHttpOnly($data['HttpOnly']); |
| 123 | } |
| 124 | |
| 125 | // Set the remaining values that don't have extra validation logic |
| 126 | foreach (array_diff(array_keys($data), array_keys(self::$defaults)) as $key) { |
| 127 | $this->data[$key] = $data[$key]; |
| 128 | } |
| 129 | |
| 130 | // Extract the Expires value and turn it into a UNIX timestamp if needed |
| 131 | if (!$this->getExpires() && $this->getMaxAge()) { |
| 132 | // Calculate the Expires date |
| 133 | $this->setExpires(\time() + $this->getMaxAge()); |
| 134 | } elseif (null !== ($expires = $this->getExpires()) && !\is_numeric($expires)) { |
| 135 | $this->setExpires($expires); |
| 136 | } |
| 137 | } |
| 138 | |
| 139 | public function __toString() |
| 140 | { |
| 141 | $str = $this->data['Name'].'='.($this->data['Value'] ?? '').'; '; |
| 142 | foreach ($this->data as $k => $v) { |
| 143 | if ($k !== 'Name' && $k !== 'Value' && $v !== null && $v !== false) { |
| 144 | if ($k === 'Expires') { |
| 145 | $str .= 'Expires='.\gmdate('D, d M Y H:i:s \G\M\T', $v).'; '; |
| 146 | } else { |
| 147 | $str .= ($v === true ? $k : "{$k}={$v}").'; '; |
| 148 | } |
| 149 | } |
| 150 | } |
| 151 | |
| 152 | return \rtrim($str, '; '); |
| 153 | } |
| 154 | |
| 155 | public function toArray(): array |
| 156 | { |
| 157 | return $this->data; |
| 158 | } |
| 159 | |
| 160 | /** |
| 161 | * Get the cookie name. |
| 162 | * |
| 163 | * @return string |
| 164 | */ |
| 165 | public function getName() |
| 166 | { |
| 167 | return $this->data['Name']; |
| 168 | } |
| 169 | |
| 170 | /** |
| 171 | * Set the cookie name. |
| 172 | * |
| 173 | * @param string $name Cookie name |
| 174 | */ |
| 175 | public function setName($name): void |
| 176 | { |
| 177 | if (!is_string($name)) { |
| 178 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 179 | } |
| 180 | |
| 181 | $this->data['Name'] = (string) $name; |
| 182 | } |
| 183 | |
| 184 | /** |
| 185 | * Get the cookie value. |
| 186 | * |
| 187 | * @return string|null |
| 188 | */ |
| 189 | public function getValue() |
| 190 | { |
| 191 | return $this->data['Value']; |
| 192 | } |
| 193 | |
| 194 | /** |
| 195 | * Set the cookie value. |
| 196 | * |
| 197 | * @param string $value Cookie value |
| 198 | */ |
| 199 | public function setValue($value): void |
| 200 | { |
| 201 | if (!is_string($value)) { |
| 202 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 203 | } |
| 204 | |
| 205 | $this->data['Value'] = (string) $value; |
| 206 | } |
| 207 | |
| 208 | /** |
| 209 | * Get the domain. |
| 210 | * |
| 211 | * @return string|null |
| 212 | */ |
| 213 | public function getDomain() |
| 214 | { |
| 215 | return $this->data['Domain']; |
| 216 | } |
| 217 | |
| 218 | /** |
| 219 | * Set the domain of the cookie. |
| 220 | * |
| 221 | * @param string|null $domain |
| 222 | */ |
| 223 | public function setDomain($domain): void |
| 224 | { |
| 225 | if (!is_string($domain) && null !== $domain) { |
| 226 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 227 | } |
| 228 | |
| 229 | $this->data['Domain'] = null === $domain ? null : (string) $domain; |
| 230 | } |
| 231 | |
| 232 | /** |
| 233 | * Get the path. |
| 234 | * |
| 235 | * @return string |
| 236 | */ |
| 237 | public function getPath() |
| 238 | { |
| 239 | return $this->data['Path']; |
| 240 | } |
| 241 | |
| 242 | /** |
| 243 | * Set the path of the cookie. |
| 244 | * |
| 245 | * @param string $path Path of the cookie |
| 246 | */ |
| 247 | public function setPath($path): void |
| 248 | { |
| 249 | if (!is_string($path)) { |
| 250 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a string to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 251 | } |
| 252 | |
| 253 | $this->data['Path'] = (string) $path; |
| 254 | } |
| 255 | |
| 256 | /** |
| 257 | * Maximum lifetime of the cookie in seconds. |
| 258 | * |
| 259 | * @return int|null |
| 260 | */ |
| 261 | public function getMaxAge() |
| 262 | { |
| 263 | return null === $this->data['Max-Age'] ? null : (int) $this->data['Max-Age']; |
| 264 | } |
| 265 | |
| 266 | /** |
| 267 | * Set the max-age of the cookie. |
| 268 | * |
| 269 | * @param int|null $maxAge Max age of the cookie in seconds |
| 270 | */ |
| 271 | public function setMaxAge($maxAge): void |
| 272 | { |
| 273 | if (!is_int($maxAge) && null !== $maxAge) { |
| 274 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an int or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 275 | } |
| 276 | |
| 277 | $this->data['Max-Age'] = $maxAge === null ? null : (int) $maxAge; |
| 278 | } |
| 279 | |
| 280 | /** |
| 281 | * The UNIX timestamp when the cookie Expires. |
| 282 | * |
| 283 | * @return string|int|null |
| 284 | */ |
| 285 | public function getExpires() |
| 286 | { |
| 287 | return $this->data['Expires']; |
| 288 | } |
| 289 | |
| 290 | /** |
| 291 | * Set the unix timestamp for which the cookie will expire. |
| 292 | * |
| 293 | * @param int|string|null $timestamp Unix timestamp or any English textual datetime description. |
| 294 | */ |
| 295 | public function setExpires($timestamp): void |
| 296 | { |
| 297 | if (!is_int($timestamp) && !is_string($timestamp) && null !== $timestamp) { |
| 298 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing an int, string or null to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 299 | } |
| 300 | |
| 301 | $this->data['Expires'] = null === $timestamp ? null : (\is_numeric($timestamp) ? (int) $timestamp : \strtotime((string) $timestamp)); |
| 302 | } |
| 303 | |
| 304 | /** |
| 305 | * Get whether or not this is a secure cookie. |
| 306 | * |
| 307 | * @return bool |
| 308 | */ |
| 309 | public function getSecure() |
| 310 | { |
| 311 | return $this->data['Secure']; |
| 312 | } |
| 313 | |
| 314 | /** |
| 315 | * Set whether or not the cookie is secure. |
| 316 | * |
| 317 | * @param bool $secure Set to true or false if secure |
| 318 | */ |
| 319 | public function setSecure($secure): void |
| 320 | { |
| 321 | if (!is_bool($secure)) { |
| 322 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 323 | } |
| 324 | |
| 325 | $this->data['Secure'] = (bool) $secure; |
| 326 | } |
| 327 | |
| 328 | /** |
| 329 | * Get whether or not this is a session cookie. |
| 330 | * |
| 331 | * @return bool|null |
| 332 | */ |
| 333 | public function getDiscard() |
| 334 | { |
| 335 | return $this->data['Discard']; |
| 336 | } |
| 337 | |
| 338 | /** |
| 339 | * Set whether or not this is a session cookie. |
| 340 | * |
| 341 | * @param bool $discard Set to true or false if this is a session cookie |
| 342 | */ |
| 343 | public function setDiscard($discard): void |
| 344 | { |
| 345 | if (!is_bool($discard)) { |
| 346 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 347 | } |
| 348 | |
| 349 | $this->data['Discard'] = (bool) $discard; |
| 350 | } |
| 351 | |
| 352 | /** |
| 353 | * Get whether or not this is an HTTP only cookie. |
| 354 | * |
| 355 | * @return bool |
| 356 | */ |
| 357 | public function getHttpOnly() |
| 358 | { |
| 359 | return $this->data['HttpOnly']; |
| 360 | } |
| 361 | |
| 362 | /** |
| 363 | * Set whether or not this is an HTTP only cookie. |
| 364 | * |
| 365 | * @param bool $httpOnly Set to true or false if this is HTTP only |
| 366 | */ |
| 367 | public function setHttpOnly($httpOnly): void |
| 368 | { |
| 369 | if (!is_bool($httpOnly)) { |
| 370 | ameliavendor_trigger_deprecation('guzzlehttp/guzzle', '7.4', 'Not passing a bool to %s::%s() is deprecated and will cause an error in 8.0.', __CLASS__, __FUNCTION__); |
| 371 | } |
| 372 | |
| 373 | $this->data['HttpOnly'] = (bool) $httpOnly; |
| 374 | } |
| 375 | |
| 376 | /** |
| 377 | * Check if the cookie matches a path value. |
| 378 | * |
| 379 | * A request-path path-matches a given cookie-path if at least one of |
| 380 | * the following conditions holds: |
| 381 | * |
| 382 | * - The cookie-path and the request-path are identical. |
| 383 | * - The cookie-path is a prefix of the request-path, and the last |
| 384 | * character of the cookie-path is %x2F ("/"). |
| 385 | * - The cookie-path is a prefix of the request-path, and the first |
| 386 | * character of the request-path that is not included in the cookie- |
| 387 | * path is a %x2F ("/") character. |
| 388 | * |
| 389 | * @param string $requestPath Path to check against |
| 390 | */ |
| 391 | public function matchesPath(string $requestPath): bool |
| 392 | { |
| 393 | $cookiePath = $this->getPath(); |
| 394 | |
| 395 | // Match on exact matches or when path is the default empty "/" |
| 396 | if ($cookiePath === '/' || $cookiePath == $requestPath) { |
| 397 | return true; |
| 398 | } |
| 399 | |
| 400 | // Ensure that the cookie-path is a prefix of the request path. |
| 401 | if (0 !== \strpos($requestPath, $cookiePath)) { |
| 402 | return false; |
| 403 | } |
| 404 | |
| 405 | // Match if the last character of the cookie-path is "/" |
| 406 | if (\substr($cookiePath, -1, 1) === '/') { |
| 407 | return true; |
| 408 | } |
| 409 | |
| 410 | // Match if the first character not included in cookie path is "/" |
| 411 | return \substr($requestPath, \strlen($cookiePath), 1) === '/'; |
| 412 | } |
| 413 | |
| 414 | /** |
| 415 | * Check if the cookie matches a domain value. |
| 416 | * |
| 417 | * @param string $domain Domain to check against |
| 418 | */ |
| 419 | public function matchesDomain(string $domain): bool |
| 420 | { |
| 421 | $cookieDomain = $this->getDomain(); |
| 422 | if (null === $cookieDomain) { |
| 423 | return true; |
| 424 | } |
| 425 | |
| 426 | // Remove the leading '.' as per spec in RFC 6265. |
| 427 | // https://datatracker.ietf.org/doc/html/rfc6265#section-5.2.3 |
| 428 | $cookieDomain = \ltrim(\strtolower($cookieDomain), '.'); |
| 429 | |
| 430 | $domain = \strtolower($domain); |
| 431 | |
| 432 | // Domain not set or exact match. |
| 433 | if ('' === $cookieDomain || $domain === $cookieDomain) { |
| 434 | return true; |
| 435 | } |
| 436 | |
| 437 | // Matching the subdomain according to RFC 6265. |
| 438 | // https://datatracker.ietf.org/doc/html/rfc6265#section-5.1.3 |
| 439 | if (\filter_var($domain, \FILTER_VALIDATE_IP)) { |
| 440 | return false; |
| 441 | } |
| 442 | |
| 443 | return (bool) \preg_match('/\.'.\preg_quote($cookieDomain, '/').'$/', $domain); |
| 444 | } |
| 445 | |
| 446 | /** |
| 447 | * Check if the cookie is expired. |
| 448 | */ |
| 449 | public function isExpired(): bool |
| 450 | { |
| 451 | return $this->getExpires() !== null && \time() > $this->getExpires(); |
| 452 | } |
| 453 | |
| 454 | /** |
| 455 | * Check if the cookie is valid according to RFC 6265. |
| 456 | * |
| 457 | * @return bool|string Returns true if valid or an error message if invalid |
| 458 | */ |
| 459 | public function validate() |
| 460 | { |
| 461 | $name = $this->getName(); |
| 462 | if ($name === '') { |
| 463 | return 'The cookie name must not be empty'; |
| 464 | } |
| 465 | |
| 466 | // Check if any of the invalid characters are present in the cookie name |
| 467 | if (\preg_match( |
| 468 | '/[\x00-\x20\x22\x28-\x29\x2c\x2f\x3a-\x40\x5c\x7b\x7d\x7f]/', |
| 469 | $name |
| 470 | )) { |
| 471 | return 'Cookie name must not contain invalid characters: ASCII ' |
| 472 | .'Control characters (0-31;127), space, tab and the ' |
| 473 | .'following characters: ()<>@,;:\"/?={}'; |
| 474 | } |
| 475 | |
| 476 | // Value must not be null. 0 and empty string are valid. Empty strings |
| 477 | // are technically against RFC 6265, but known to happen in the wild. |
| 478 | $value = $this->getValue(); |
| 479 | if ($value === null) { |
| 480 | return 'The cookie value must not be empty'; |
| 481 | } |
| 482 | |
| 483 | // Domains must not be empty, but can be 0. "0" is not a valid internet |
| 484 | // domain, but may be used as server name in a private network. |
| 485 | $domain = $this->getDomain(); |
| 486 | if ($domain === null || $domain === '') { |
| 487 | return 'The cookie domain must not be empty'; |
| 488 | } |
| 489 | |
| 490 | return true; |
| 491 | } |
| 492 | } |
| 493 |