diff options
Diffstat (limited to 'vendor/zendframework/zend-http/src/Cookies.php')
| -rw-r--r-- | vendor/zendframework/zend-http/src/Cookies.php | 367 |
1 files changed, 0 insertions, 367 deletions
diff --git a/vendor/zendframework/zend-http/src/Cookies.php b/vendor/zendframework/zend-http/src/Cookies.php deleted file mode 100644 index 725c062..0000000 --- a/vendor/zendframework/zend-http/src/Cookies.php +++ /dev/null @@ -1,367 +0,0 @@ -<?php -/** - * Zend Framework (http://framework.zend.com/) - * - * @link http://github.com/zendframework/zf2 for the canonical source repository - * @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) - * @license http://framework.zend.com/license/new-bsd New BSD License - */ - -namespace Zend\Http; - -use ArrayIterator; -use Zend\Http\Header\SetCookie; -use Zend\Uri; - -/** - * A Zend\Http\Cookies object is designed to contain and maintain HTTP cookies, and should - * be used along with Zend\Http\Client in order to manage cookies across HTTP requests and - * responses. - * - * The class contains an array of Zend\Http\Header\Cookie objects. Cookies can be added - * automatically from a request or manually. Then, the Cookies class can find and return the - * cookies needed for a specific HTTP request. - * - * A special parameter can be passed to all methods of this class that return cookies: Cookies - * can be returned either in their native form (as Zend\Http\Header\Cookie objects) or as strings - - * the later is suitable for sending as the value of the "Cookie" header in an HTTP request. - * You can also choose, when returning more than one cookie, whether to get an array of strings - * (by passing Zend\Http\Client\Cookies::COOKIE_STRING_ARRAY) or one unified string for all cookies - * (by passing Zend\Http\Client\Cookies::COOKIE_STRING_CONCAT). - * - * @link http://wp.netscape.com/newsref/std/cookie_spec.html for some specs. - */ -class Cookies extends Headers -{ - /** - * Return cookie(s) as a Zend\Http\Cookie object - * - */ - const COOKIE_OBJECT = 0; - - /** - * Return cookie(s) as a string (suitable for sending in an HTTP request) - * - */ - const COOKIE_STRING_ARRAY = 1; - - /** - * Return all cookies as one long string (suitable for sending in an HTTP request) - * - */ - const COOKIE_STRING_CONCAT = 2; - - /** - * Return all cookies as one long string (strict mode) - * - Single space after the semi-colon separating each cookie - * - Remove trailing semi-colon, if any - */ - const COOKIE_STRING_CONCAT_STRICT = 3; - - /** - * @var array - */ - protected $cookies = array(); - - /** - * @var \Zend\Http\Headers - */ - protected $headers = null; - - /** - * @var array - */ - protected $rawCookies; - - /** - * @static - * @throws Exception\RuntimeException - * @param $string - * @return void - */ - public static function fromString($string) - { - throw new Exception\RuntimeException( - __CLASS__ . '::' . __FUNCTION__ . ' should not be used as a factory, use ' - . __NAMESPACE__ . '\Headers::fromtString() instead.' - ); - } - - /** - * Add a cookie to the class. Cookie should be passed either as a Zend\Http\Header\Cookie object - * or as a string - in which case an object is created from the string. - * - * @param SetCookie|string $cookie - * @param Uri\Uri|string $refUri Optional reference URI (for domain, path, secure) - * @throws Exception\InvalidArgumentException - */ - public function addCookie($cookie, $refUri = null) - { - if (is_string($cookie)) { - $cookie = SetCookie::fromString($cookie, $refUri); - } - - if ($cookie instanceof SetCookie) { - $domain = $cookie->getDomain(); - $path = $cookie->getPath(); - if (!isset($this->cookies[$domain])) { - $this->cookies[$domain] = array(); - } - if (!isset($this->cookies[$domain][$path])) { - $this->cookies[$domain][$path] = array(); - } - $this->cookies[$domain][$path][$cookie->getName()] = $cookie; - $this->rawCookies[] = $cookie; - } else { - throw new Exception\InvalidArgumentException('Supplient argument is not a valid cookie string or object'); - } - } - - /** - * Parse an HTTP response, adding all the cookies set in that response - * - * @param Response $response - * @param Uri\Uri|string $refUri Requested URI - */ - public function addCookiesFromResponse(Response $response, $refUri) - { - $cookieHdrs = $response->getHeaders()->get('Set-Cookie'); - - if (is_array($cookieHdrs) || $cookieHdrs instanceof ArrayIterator) { - foreach ($cookieHdrs as $cookie) { - $this->addCookie($cookie, $refUri); - } - } elseif (is_string($cookieHdrs)) { - $this->addCookie($cookieHdrs, $refUri); - } - } - - /** - * Get all cookies in the cookie jar as an array - * - * @param int $retAs Whether to return cookies as objects of \Zend\Http\Header\SetCookie or as strings - * @return array|string - */ - public function getAllCookies($retAs = self::COOKIE_OBJECT) - { - $cookies = $this->_flattenCookiesArray($this->cookies, $retAs); - return $cookies; - } - - /** - * Return an array of all cookies matching a specific request according to the request URI, - * whether session cookies should be sent or not, and the time to consider as "now" when - * checking cookie expiry time. - * - * @param string|Uri\Uri $uri URI to check against (secure, domain, path) - * @param bool $matchSessionCookies Whether to send session cookies - * @param int $retAs Whether to return cookies as objects of \Zend\Http\Header\Cookie or as strings - * @param int $now Override the current time when checking for expiry time - * @throws Exception\InvalidArgumentException if invalid URI specified - * @return array|string - */ - public function getMatchingCookies( - $uri, - $matchSessionCookies = true, - $retAs = self::COOKIE_OBJECT, - $now = null - ) { - if (is_string($uri)) { - $uri = Uri\UriFactory::factory($uri, 'http'); - } elseif (!$uri instanceof Uri\Uri) { - throw new Exception\InvalidArgumentException("Invalid URI string or object passed"); - } - - $host = $uri->getHost(); - if (empty($host)) { - throw new Exception\InvalidArgumentException('Invalid URI specified; does not contain a host'); - } - - // First, reduce the array of cookies to only those matching domain and path - $cookies = $this->_matchDomain($host); - $cookies = $this->_matchPath($cookies, $uri->getPath()); - $cookies = $this->_flattenCookiesArray($cookies, self::COOKIE_OBJECT); - - // Next, run Cookie->match on all cookies to check secure, time and session matching - $ret = array(); - foreach ($cookies as $cookie) { - if ($cookie->match($uri, $matchSessionCookies, $now)) { - $ret[] = $cookie; - } - } - // Now, use self::_flattenCookiesArray again - only to convert to the return format ;) - $ret = $this->_flattenCookiesArray($ret, $retAs); - - return $ret; - } - - /** - * Get a specific cookie according to a URI and name - * - * @param Uri\Uri|string $uri The uri (domain and path) to match - * @param string $cookieName The cookie's name - * @param int $retAs Whether to return cookies as objects of \Zend\Http\Header\SetCookie or as strings - * @throws Exception\InvalidArgumentException if invalid URI specified or invalid $retAs value - * @return SetCookie|string - */ - public function getCookie($uri, $cookieName, $retAs = self::COOKIE_OBJECT) - { - if (is_string($uri)) { - $uri = Uri\UriFactory::factory($uri, 'http'); - } elseif (!$uri instanceof Uri\Uri) { - throw new Exception\InvalidArgumentException('Invalid URI specified'); - } - - $host = $uri->getHost(); - if (empty($host)) { - throw new Exception\InvalidArgumentException('Invalid URI specified; host missing'); - } - - // Get correct cookie path - $path = $uri->getPath(); - $lastSlashPos = strrpos($path, '/') ?: 0; - $path = substr($path, 0, $lastSlashPos); - if (! $path) { - $path = '/'; - } - - if (isset($this->cookies[$uri->getHost()][$path][$cookieName])) { - $cookie = $this->cookies[$uri->getHost()][$path][$cookieName]; - - switch ($retAs) { - case self::COOKIE_OBJECT: - return $cookie; - - case self::COOKIE_STRING_ARRAY: - case self::COOKIE_STRING_CONCAT: - return $cookie->__toString(); - - default: - throw new Exception\InvalidArgumentException("Invalid value passed for \$retAs: {$retAs}"); - } - } - - return false; - } - - /** - * Helper function to recursively flatten an array. Should be used when exporting the - * cookies array (or parts of it) - * - * @param \Zend\Http\Header\SetCookie|array $ptr - * @param int $retAs What value to return - * @return array|string - */ - protected function _flattenCookiesArray($ptr, $retAs = self::COOKIE_OBJECT) - { - if (is_array($ptr)) { - $ret = ($retAs == self::COOKIE_STRING_CONCAT ? '' : array()); - foreach ($ptr as $item) { - if ($retAs == self::COOKIE_STRING_CONCAT) { - $ret .= $this->_flattenCookiesArray($item, $retAs); - } else { - $ret = array_merge($ret, $this->_flattenCookiesArray($item, $retAs)); - } - } - return $ret; - } elseif ($ptr instanceof SetCookie) { - switch ($retAs) { - case self::COOKIE_STRING_ARRAY: - return array($ptr->__toString()); - - case self::COOKIE_STRING_CONCAT: - return $ptr->__toString(); - - case self::COOKIE_OBJECT: - default: - return array($ptr); - } - } - - return; - } - - /** - * Return a subset of the cookies array matching a specific domain - * - * @param string $domain - * @return array - */ - protected function _matchDomain($domain) - { - $ret = array(); - - foreach (array_keys($this->cookies) as $cdom) { - if (SetCookie::matchCookieDomain($cdom, $domain)) { - $ret[$cdom] = $this->cookies[$cdom]; - } - } - - return $ret; - } - - /** - * Return a subset of a domain-matching cookies that also match a specified path - * - * @param array $domains - * @param string $path - * @return array - */ - protected function _matchPath($domains, $path) - { - $ret = array(); - - foreach ($domains as $dom => $pathsArray) { - foreach (array_keys($pathsArray) as $cpath) { - if (SetCookie::matchCookiePath($cpath, $path)) { - if (! isset($ret[$dom])) { - $ret[$dom] = array(); - } - - $ret[$dom][$cpath] = $pathsArray[$cpath]; - } - } - } - - return $ret; - } - - /** - * Create a new Cookies object and automatically load into it all the - * cookies set in a Response object. If $uri is set, it will be - * considered as the requested URI for setting default domain and path - * of the cookie. - * - * @param Response $response HTTP Response object - * @param Uri\Uri|string $refUri The requested URI - * @return Cookies - * @todo Add the $uri functionality. - */ - public static function fromResponse(Response $response, $refUri) - { - $jar = new static(); - $jar->addCookiesFromResponse($response, $refUri); - return $jar; - } - - /** - * Tells if the array of cookies is empty - * - * @return bool - */ - public function isEmpty() - { - return count($this) == 0; - } - - /** - * Empties the cookieJar of any cookie - * - * @return Cookies - */ - public function reset() - { - $this->cookies = $this->rawCookies = array(); - return $this; - } -} |