composer/iTop
6
0
Fork 0
mirror of https://github.com/Combodo/iTop.git synced 2026-05-22 00:32:16 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update guzzle library

Browse Source
This commit is contained in:
Stephen Abello
2022-07-26 14:00:11 +02:00
committed by bdalsass
parent 742ef2b23b
commit 70d1504cd4
90 changed files with 2984 additions and 13756 deletions
Download Patch File Download Diff File Expand all files Collapse all files

232
lib/guzzlehttp/guzzle/src/Cookie/SetCookie.php
View File

@@ -1,4 +1,5 @@
<?php
namespace GuzzleHttp\Cookie;
/**
@@ -6,7 +7,9 @@ namespace GuzzleHttp\Cookie;
*/
class SetCookie
{
/** @var array */
/**
* @var array
*/
private static $defaults = [
'Name' => null,
'Value' => null,
@@ -19,42 +22,42 @@ class SetCookie
'HttpOnly' => false
];
/** @var array Cookie data */
/**
* @var array Cookie data
*/
private $data;
/**
* Create a new SetCookie object from a string
* Create a new SetCookie object from a string.
*
* @param string $cookie Set-Cookie header string
*
* @return self
*/
public static function fromString($cookie)
public static function fromString(string $cookie): self
{
// Create the default return array
$data = self::$defaults;
// Explode the cookie string using a series of semicolons
$pieces = array_filter(array_map('trim', explode(';', $cookie)));
$pieces = \array_filter(\array_map('trim', \explode(';', $cookie)));
// The name of the cookie (first kvp) must exist and include an equal sign.
if (empty($pieces[0]) || !strpos($pieces[0], '=')) {
if (!isset($pieces[0]) || \strpos($pieces[0], '=') === false) {
return new self($data);
}
// Add the cookie pieces into the parsed data array
foreach ($pieces as $part) {
$cookieParts = explode('=', $part, 2);
$key = trim($cookieParts[0]);
$cookieParts = \explode('=', $part, 2);
$key = \trim($cookieParts[0]);
$value = isset($cookieParts[1])
? trim($cookieParts[1], " \n\r\t\0\x0B")
? \trim($cookieParts[1], " \n\r\t\0\x0B")
: true;
// Only check for non-cookies when cookies have been found
if (empty($data['Name'])) {
if (!isset($data['Name'])) {
$data['Name'] = $key;
$data['Value'] = $value;
} else {
foreach (array_keys(self::$defaults) as $search) {
if (!strcasecmp($search, $key)) {
foreach (\array_keys(self::$defaults) as $search) {
if (!\strcasecmp($search, $key)) {
$data[$search] = $value;
continue 2;
}
@@ -71,39 +74,45 @@ class SetCookie
*/
public function __construct(array $data = [])
{
$this->data = array_replace(self::$defaults, $data);
/** @var array|null $replaced will be null in case of replace error */
$replaced = \array_replace(self::$defaults, $data);
if ($replaced === null) {
throw new \InvalidArgumentException('Unable to replace the default values for the Cookie.');
}
$this->data = $replaced;
// Extract the Expires value and turn it into a UNIX timestamp if needed
if (!$this->getExpires() && $this->getMaxAge()) {
// Calculate the Expires date
$this->setExpires(time() + $this->getMaxAge());
} elseif ($this->getExpires() && !is_numeric($this->getExpires())) {
$this->setExpires($this->getExpires());
$this->setExpires(\time() + $this->getMaxAge());
} elseif (null !== ($expires = $this->getExpires()) && !\is_numeric($expires)) {
$this->setExpires($expires);
}
}
public function __toString()
{
$str = $this->data['Name'] . '=' . $this->data['Value'] . '; ';
$str = $this->data['Name'] . '=' . ($this->data['Value'] ?? '') . '; ';
foreach ($this->data as $k => $v) {
if ($k !== 'Name' && $k !== 'Value' && $v !== null && $v !== false) {
if ($k === 'Expires') {
$str .= 'Expires=' . gmdate('D, d M Y H:i:s \G\M\T', $v) . '; ';
$str .= 'Expires=' . \gmdate('D, d M Y H:i:s \G\M\T', $v) . '; ';
} else {
$str .= ($v === true ? $k : "{$k}={$v}") . '; ';
}
}
}
return rtrim($str, '; ');
return \rtrim($str, '; ');
}
public function toArray()
public function toArray(): array
{
return $this->data;
}
/**
* Get the cookie name
* Get the cookie name.
*
* @return string
*/
@@ -113,19 +122,23 @@ class SetCookie
}
/**
* Set the cookie name
* Set the cookie name.
*
* @param string $name Cookie name
*/
public function setName($name)
public function setName($name): void
{
$this->data['Name'] = $name;
if (!is_string($name)) {
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__);
}
$this->data['Name'] = (string) $name;
}
/**
* Get the cookie value
* Get the cookie value.
*
* @return string
* @return string|null
*/
public function getValue()
{
@@ -133,17 +146,21 @@ class SetCookie
}
/**
* Set the cookie value
* Set the cookie value.
*
* @param string $value Cookie value
*/
public function setValue($value)
public function setValue($value): void
{
$this->data['Value'] = $value;
if (!is_string($value)) {
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__);
}
$this->data['Value'] = (string) $value;
}
/**
* Get the domain
* Get the domain.
*
* @return string|null
*/
@@ -153,17 +170,21 @@ class SetCookie
}
/**
* Set the domain of the cookie
* Set the domain of the cookie.
*
* @param string $domain
* @param string|null $domain
*/
public function setDomain($domain)
public function setDomain($domain): void
{
$this->data['Domain'] = $domain;
if (!is_string($domain) && null !== $domain) {
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__);
}
$this->data['Domain'] = null === $domain ? null : (string) $domain;
}
/**
* Get the path
* Get the path.
*
* @return string
*/
@@ -173,39 +194,47 @@ class SetCookie
}
/**
* Set the path of the cookie
* Set the path of the cookie.
*
* @param string $path Path of the cookie
*/
public function setPath($path)
public function setPath($path): void
{
$this->data['Path'] = $path;
if (!is_string($path)) {
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__);
}
$this->data['Path'] = (string) $path;
}
/**
* Maximum lifetime of the cookie in seconds
* Maximum lifetime of the cookie in seconds.
*
* @return int|null
*/
public function getMaxAge()
{
return $this->data['Max-Age'];
return null === $this->data['Max-Age'] ? null : (int) $this->data['Max-Age'];
}
/**
* Set the max-age of the cookie
* Set the max-age of the cookie.
*
* @param int $maxAge Max age of the cookie in seconds
* @param int|null $maxAge Max age of the cookie in seconds
*/
public function setMaxAge($maxAge)
public function setMaxAge($maxAge): void
{
$this->data['Max-Age'] = $maxAge;
if (!is_int($maxAge) && null !== $maxAge) {
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__);
}
$this->data['Max-Age'] = $maxAge === null ? null : (int) $maxAge;
}
/**
* The UNIX timestamp when the cookie Expires
* The UNIX timestamp when the cookie Expires.
*
* @return mixed
* @return string|int|null
*/
public function getExpires()
{
@@ -213,21 +242,23 @@ class SetCookie
}
/**
* Set the unix timestamp for which the cookie will expire
* Set the unix timestamp for which the cookie will expire.
*
* @param int $timestamp Unix timestamp
* @param int|string|null $timestamp Unix timestamp or any English textual datetime description.
*/
public function setExpires($timestamp)
public function setExpires($timestamp): void
{
$this->data['Expires'] = is_numeric($timestamp)
? (int) $timestamp
: strtotime($timestamp);
if (!is_int($timestamp) && !is_string($timestamp) && null !== $timestamp) {
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__);
}
$this->data['Expires'] = null === $timestamp ? null : (\is_numeric($timestamp) ? (int) $timestamp : \strtotime((string) $timestamp));
}
/**
* Get whether or not this is a secure cookie
* Get whether or not this is a secure cookie.
*
* @return bool|null
* @return bool
*/
public function getSecure()
{
@@ -235,17 +266,21 @@ class SetCookie
}
/**
* Set whether or not the cookie is secure
* Set whether or not the cookie is secure.
*
* @param bool $secure Set to true or false if secure
*/
public function setSecure($secure)
public function setSecure($secure): void
{
$this->data['Secure'] = $secure;
if (!is_bool($secure)) {
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__);
}
$this->data['Secure'] = (bool) $secure;
}
/**
* Get whether or not this is a session cookie
* Get whether or not this is a session cookie.
*
* @return bool|null
*/
@@ -255,17 +290,21 @@ class SetCookie
}
/**
* Set whether or not this is a session cookie
* Set whether or not this is a session cookie.
*
* @param bool $discard Set to true or false if this is a session cookie
*/
public function setDiscard($discard)
public function setDiscard($discard): void
{
$this->data['Discard'] = $discard;
if (!is_bool($discard)) {
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__);
}
$this->data['Discard'] = (bool) $discard;
}
/**
* Get whether or not this is an HTTP only cookie
* Get whether or not this is an HTTP only cookie.
*
* @return bool
*/
@@ -275,13 +314,17 @@ class SetCookie
}
/**
* Set whether or not this is an HTTP only cookie
* Set whether or not this is an HTTP only cookie.
*
* @param bool $httpOnly Set to true or false if this is HTTP only
*/
public function setHttpOnly($httpOnly)
public function setHttpOnly($httpOnly): void
{
$this->data['HttpOnly'] = $httpOnly;
if (!is_bool($httpOnly)) {
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__);
}
$this->data['HttpOnly'] = (bool) $httpOnly;
}
/**
@@ -298,10 +341,8 @@ class SetCookie
* path is a %x2F ("/") character.
*
* @param string $requestPath Path to check against
*
* @return bool
*/
public function matchesPath($requestPath)
public function matchesPath(string $requestPath): bool
{
$cookiePath = $this->getPath();
@@ -311,27 +352,25 @@ class SetCookie
}
// Ensure that the cookie-path is a prefix of the request path.
if (0 !== strpos($requestPath, $cookiePath)) {
if (0 !== \strpos($requestPath, $cookiePath)) {
return false;
}
// Match if the last character of the cookie-path is "/"
if (substr($cookiePath, -1, 1) === '/') {
if (\substr($cookiePath, -1, 1) === '/') {
return true;
}
// Match if the first character not included in cookie path is "/"
return substr($requestPath, strlen($cookiePath), 1) === '/';
return \substr($requestPath, \strlen($cookiePath), 1) === '/';
}
/**
* Check if the cookie matches a domain value
* Check if the cookie matches a domain value.
*
* @param string $domain Domain to check against
*
* @return bool
*/
public function matchesDomain($domain)
public function matchesDomain(string $domain): bool
{
$cookieDomain = $this->getDomain();
if (null === $cookieDomain) {
@@ -339,10 +378,10 @@ class SetCookie
}
// Remove the leading '.' as per spec in RFC 6265.
// http://tools.ietf.org/html/rfc6265#section-5.2.3
$cookieDomain = ltrim(strtolower($cookieDomain), '.');
// https://tools.ietf.org/html/rfc6265#section-5.2.3
$cookieDomain = \ltrim(\strtolower($cookieDomain), '.');
$domain = strtolower($domain);
$domain = \strtolower($domain);
// Domain not set or exact match.
if ('' === $cookieDomain || $domain === $cookieDomain) {
@@ -350,39 +389,36 @@ class SetCookie
}
// Matching the subdomain according to RFC 6265.
// http://tools.ietf.org/html/rfc6265#section-5.1.3
if (filter_var($domain, FILTER_VALIDATE_IP)) {
// https://tools.ietf.org/html/rfc6265#section-5.1.3
if (\filter_var($domain, \FILTER_VALIDATE_IP)) {
return false;
}
return (bool) preg_match('/\.' . preg_quote($cookieDomain, '/') . '$/', $domain);
return (bool) \preg_match('/\.' . \preg_quote($cookieDomain, '/') . '$/', $domain);
}
/**
* Check if the cookie is expired
*
* @return bool
* Check if the cookie is expired.
*/
public function isExpired()
public function isExpired(): bool
{
return $this->getExpires() !== null && time() > $this->getExpires();
return $this->getExpires() !== null && \time() > $this->getExpires();
}
/**
* Check if the cookie is valid according to RFC 6265
* Check if the cookie is valid according to RFC 6265.
*
* @return bool|string Returns true if valid or an error message if invalid
*/
public function validate()
{
// Names must not be empty, but can be 0
$name = $this->getName();
if (empty($name) && !is_numeric($name)) {
if ($name === '') {
return 'The cookie name must not be empty';
}
// Check if any of the invalid characters are present in the cookie name
if (preg_match(
if (\preg_match(
'/[\x00-\x20\x22\x28-\x29\x2c\x2f\x3a-\x40\x5c\x7b\x7d\x7f]/',
$name
)) {
@@ -391,17 +427,17 @@ class SetCookie
. 'following characters: ()<>@,;:\"/?={}';
}
// Value must not be empty, but can be 0
// Value must not be null. 0 and empty string are valid. Empty strings
// are technically against RFC 6265, but known to happen in the wild.
$value = $this->getValue();
if (empty($value) && !is_numeric($value)) {
if ($value === null) {
return 'The cookie value must not be empty';
}
// Domains must not be empty, but can be 0
// A "0" is not a valid internet domain, but may be used as server name
// in a private network.
// Domains must not be empty, but can be 0. "0" is not a valid internet
// domain, but may be used as server name in a private network.
$domain = $this->getDomain();
if (empty($domain) && !is_numeric($domain)) {
if ($domain === null || $domain === '') {
return 'The cookie domain must not be empty';
}