Exception
2 years ago
File
2 years ago
Session
2 years ago
Tests
2 years ago
AcceptHeader.php
2 years ago
AcceptHeaderItem.php
2 years ago
ApacheRequest.php
2 years ago
BinaryFileResponse.php
2 years ago
Cookie.php
2 years ago
ExpressionRequestMatcher.php
2 years ago
FileBag.php
2 years ago
HeaderBag.php
2 years ago
IpUtils.php
2 years ago
JsonResponse.php
2 years ago
LICENSE
2 years ago
ParameterBag.php
2 years ago
RedirectResponse.php
2 years ago
Request.php
2 years ago
RequestMatcher.php
2 years ago
RequestMatcherInterface.php
2 years ago
RequestStack.php
2 years ago
Response.php
2 years ago
ResponseHeaderBag.php
2 years ago
ServerBag.php
2 years ago
StreamedResponse.php
2 years ago
Cookie.php
307 lines
| 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | * |
| 11 | * Modified by impress-org on 23-January-2024 using Strauss. |
| 12 | * @see https://github.com/BrianHenryIE/strauss |
| 13 | */ |
| 14 | |
| 15 | namespace Give\Vendors\Symfony\Component\HttpFoundation; |
| 16 | |
| 17 | /** |
| 18 | * Represents a cookie. |
| 19 | * |
| 20 | * @author Johannes M. Schmitt <schmittjoh@gmail.com> |
| 21 | */ |
| 22 | class Cookie |
| 23 | { |
| 24 | const SAMESITE_NONE = 'none'; |
| 25 | const SAMESITE_LAX = 'lax'; |
| 26 | const SAMESITE_STRICT = 'strict'; |
| 27 | |
| 28 | protected $name; |
| 29 | protected $value; |
| 30 | protected $domain; |
| 31 | protected $expire; |
| 32 | protected $path; |
| 33 | protected $secure; |
| 34 | protected $httpOnly; |
| 35 | |
| 36 | private $raw; |
| 37 | private $sameSite; |
| 38 | |
| 39 | private static $reservedCharsList = "=,; \t\r\n\v\f"; |
| 40 | private static $reservedCharsFrom = ['=', ',', ';', ' ', "\t", "\r", "\n", "\v", "\f"]; |
| 41 | private static $reservedCharsTo = ['%3D', '%2C', '%3B', '%20', '%09', '%0D', '%0A', '%0B', '%0C']; |
| 42 | |
| 43 | /** |
| 44 | * Creates cookie from raw header string. |
| 45 | * |
| 46 | * @param string $cookie |
| 47 | * @param bool $decode |
| 48 | * |
| 49 | * @return static |
| 50 | */ |
| 51 | public static function fromString($cookie, $decode = false) |
| 52 | { |
| 53 | $data = [ |
| 54 | 'expires' => 0, |
| 55 | 'path' => '/', |
| 56 | 'domain' => null, |
| 57 | 'secure' => false, |
| 58 | 'httponly' => false, |
| 59 | 'raw' => !$decode, |
| 60 | 'samesite' => null, |
| 61 | ]; |
| 62 | foreach (explode(';', $cookie) as $part) { |
| 63 | if (false === strpos($part, '=')) { |
| 64 | $key = trim($part); |
| 65 | $value = true; |
| 66 | } else { |
| 67 | list($key, $value) = explode('=', trim($part), 2); |
| 68 | $key = trim($key); |
| 69 | $value = trim($value); |
| 70 | } |
| 71 | if (!isset($data['name'])) { |
| 72 | $data['name'] = $decode ? urldecode($key) : $key; |
| 73 | $data['value'] = true === $value ? null : ($decode ? urldecode($value) : $value); |
| 74 | continue; |
| 75 | } |
| 76 | switch ($key = strtolower($key)) { |
| 77 | case 'name': |
| 78 | case 'value': |
| 79 | break; |
| 80 | case 'max-age': |
| 81 | $data['expires'] = time() + (int) $value; |
| 82 | break; |
| 83 | default: |
| 84 | $data[$key] = $value; |
| 85 | break; |
| 86 | } |
| 87 | } |
| 88 | |
| 89 | return new static($data['name'], $data['value'], $data['expires'], $data['path'], $data['domain'], $data['secure'], $data['httponly'], $data['raw'], $data['samesite']); |
| 90 | } |
| 91 | |
| 92 | /** |
| 93 | * @param string $name The name of the cookie |
| 94 | * @param string|null $value The value of the cookie |
| 95 | * @param int|string|\DateTimeInterface $expire The time the cookie expires |
| 96 | * @param string $path The path on the server in which the cookie will be available on |
| 97 | * @param string|null $domain The domain that the cookie is available to |
| 98 | * @param bool $secure Whether the cookie should only be transmitted over a secure HTTPS connection from the client |
| 99 | * @param bool $httpOnly Whether the cookie will be made accessible only through the HTTP protocol |
| 100 | * @param bool $raw Whether the cookie value should be sent with no url encoding |
| 101 | * @param string|null $sameSite Whether the cookie will be available for cross-site requests |
| 102 | * |
| 103 | * @throws \InvalidArgumentException |
| 104 | */ |
| 105 | public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true, $raw = false, $sameSite = null) |
| 106 | { |
| 107 | // from PHP source code |
| 108 | if ($raw && false !== strpbrk($name, self::$reservedCharsList)) { |
| 109 | throw new \InvalidArgumentException(sprintf('The cookie name "%s" contains invalid characters.', $name)); |
| 110 | } |
| 111 | |
| 112 | if (empty($name)) { |
| 113 | throw new \InvalidArgumentException('The cookie name cannot be empty.'); |
| 114 | } |
| 115 | |
| 116 | // convert expiration time to a Unix timestamp |
| 117 | if ($expire instanceof \DateTimeInterface) { |
| 118 | $expire = $expire->format('U'); |
| 119 | } elseif (!is_numeric($expire)) { |
| 120 | $expire = strtotime($expire); |
| 121 | |
| 122 | if (false === $expire) { |
| 123 | throw new \InvalidArgumentException('The cookie expiration time is not valid.'); |
| 124 | } |
| 125 | } |
| 126 | |
| 127 | $this->name = $name; |
| 128 | $this->value = $value; |
| 129 | $this->domain = $domain; |
| 130 | $this->expire = 0 < $expire ? (int) $expire : 0; |
| 131 | $this->path = empty($path) ? '/' : $path; |
| 132 | $this->secure = (bool) $secure; |
| 133 | $this->httpOnly = (bool) $httpOnly; |
| 134 | $this->raw = (bool) $raw; |
| 135 | |
| 136 | if (null !== $sameSite) { |
| 137 | $sameSite = strtolower($sameSite); |
| 138 | } |
| 139 | |
| 140 | if (!\in_array($sameSite, [self::SAMESITE_LAX, self::SAMESITE_STRICT, self::SAMESITE_NONE, null], true)) { |
| 141 | throw new \InvalidArgumentException('The "sameSite" parameter value is not valid.'); |
| 142 | } |
| 143 | |
| 144 | $this->sameSite = $sameSite; |
| 145 | } |
| 146 | |
| 147 | /** |
| 148 | * Returns the cookie as a string. |
| 149 | * |
| 150 | * @return string The cookie |
| 151 | */ |
| 152 | public function __toString() |
| 153 | { |
| 154 | if ($this->isRaw()) { |
| 155 | $str = $this->getName(); |
| 156 | } else { |
| 157 | $str = str_replace(self::$reservedCharsFrom, self::$reservedCharsTo, $this->getName()); |
| 158 | } |
| 159 | |
| 160 | $str .= '='; |
| 161 | |
| 162 | if ('' === (string) $this->getValue()) { |
| 163 | $str .= 'deleted; expires='.gmdate('D, d-M-Y H:i:s T', time() - 31536001).'; Max-Age=0'; |
| 164 | } else { |
| 165 | $str .= $this->isRaw() ? $this->getValue() : rawurlencode($this->getValue()); |
| 166 | |
| 167 | if (0 !== $this->getExpiresTime()) { |
| 168 | $str .= '; expires='.gmdate('D, d-M-Y H:i:s T', $this->getExpiresTime()).'; Max-Age='.$this->getMaxAge(); |
| 169 | } |
| 170 | } |
| 171 | |
| 172 | if ($this->getPath()) { |
| 173 | $str .= '; path='.$this->getPath(); |
| 174 | } |
| 175 | |
| 176 | if ($this->getDomain()) { |
| 177 | $str .= '; domain='.$this->getDomain(); |
| 178 | } |
| 179 | |
| 180 | if (true === $this->isSecure()) { |
| 181 | $str .= '; secure'; |
| 182 | } |
| 183 | |
| 184 | if (true === $this->isHttpOnly()) { |
| 185 | $str .= '; httponly'; |
| 186 | } |
| 187 | |
| 188 | if (null !== $this->getSameSite()) { |
| 189 | $str .= '; samesite='.$this->getSameSite(); |
| 190 | } |
| 191 | |
| 192 | return $str; |
| 193 | } |
| 194 | |
| 195 | /** |
| 196 | * Gets the name of the cookie. |
| 197 | * |
| 198 | * @return string |
| 199 | */ |
| 200 | public function getName() |
| 201 | { |
| 202 | return $this->name; |
| 203 | } |
| 204 | |
| 205 | /** |
| 206 | * Gets the value of the cookie. |
| 207 | * |
| 208 | * @return string|null |
| 209 | */ |
| 210 | public function getValue() |
| 211 | { |
| 212 | return $this->value; |
| 213 | } |
| 214 | |
| 215 | /** |
| 216 | * Gets the domain that the cookie is available to. |
| 217 | * |
| 218 | * @return string|null |
| 219 | */ |
| 220 | public function getDomain() |
| 221 | { |
| 222 | return $this->domain; |
| 223 | } |
| 224 | |
| 225 | /** |
| 226 | * Gets the time the cookie expires. |
| 227 | * |
| 228 | * @return int |
| 229 | */ |
| 230 | public function getExpiresTime() |
| 231 | { |
| 232 | return $this->expire; |
| 233 | } |
| 234 | |
| 235 | /** |
| 236 | * Gets the max-age attribute. |
| 237 | * |
| 238 | * @return int |
| 239 | */ |
| 240 | public function getMaxAge() |
| 241 | { |
| 242 | $maxAge = $this->expire - time(); |
| 243 | |
| 244 | return 0 >= $maxAge ? 0 : $maxAge; |
| 245 | } |
| 246 | |
| 247 | /** |
| 248 | * Gets the path on the server in which the cookie will be available on. |
| 249 | * |
| 250 | * @return string |
| 251 | */ |
| 252 | public function getPath() |
| 253 | { |
| 254 | return $this->path; |
| 255 | } |
| 256 | |
| 257 | /** |
| 258 | * Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client. |
| 259 | * |
| 260 | * @return bool |
| 261 | */ |
| 262 | public function isSecure() |
| 263 | { |
| 264 | return $this->secure; |
| 265 | } |
| 266 | |
| 267 | /** |
| 268 | * Checks whether the cookie will be made accessible only through the HTTP protocol. |
| 269 | * |
| 270 | * @return bool |
| 271 | */ |
| 272 | public function isHttpOnly() |
| 273 | { |
| 274 | return $this->httpOnly; |
| 275 | } |
| 276 | |
| 277 | /** |
| 278 | * Whether this cookie is about to be cleared. |
| 279 | * |
| 280 | * @return bool |
| 281 | */ |
| 282 | public function isCleared() |
| 283 | { |
| 284 | return 0 !== $this->expire && $this->expire < time(); |
| 285 | } |
| 286 | |
| 287 | /** |
| 288 | * Checks if the cookie value should be sent with no url encoding. |
| 289 | * |
| 290 | * @return bool |
| 291 | */ |
| 292 | public function isRaw() |
| 293 | { |
| 294 | return $this->raw; |
| 295 | } |
| 296 | |
| 297 | /** |
| 298 | * Gets the SameSite attribute. |
| 299 | * |
| 300 | * @return string|null |
| 301 | */ |
| 302 | public function getSameSite() |
| 303 | { |
| 304 | return $this->sameSite; |
| 305 | } |
| 306 | } |
| 307 |