<?php

/**

 * Cookie storage object

 *

 * @package Requests

 * @subpackage Cookies

 */

/**

 * Cookie storage object

 *

 * @package Requests

 * @subpackage Cookies

 */

class Requests_Cookie {

	/**

	 * Cookie name.

	 *

	 * @var string

	 */

	public $name;

	/**

	 * Cookie value.

	 *

	 * @var string

	 */

	public $value;

	/**

	 * Cookie attributes

	 *

	 * Valid keys are (currently) path, domain, expires, max-age, secure and

	 * httponly.

	 *

	 * @var Requests_Utility_CaseInsensitiveDictionary|array Array-like object

	 */

	public $attributes = array();

	/**

	 * Cookie flags

	 *

	 * Valid keys are (currently) creation, last-access, persistent and

	 * host-only.

	 *

	 * @var array

	 */

	public $flags = array();

	/**

	 * Reference time for relative calculations

	 *

	 * This is used in place of `time()` when calculating Max-Age expiration and

	 * checking time validity.

	 *

	 * @var int

	 */

	public $reference_time = 0;

	/**

	 * Create a new cookie object

	 *

	 * @param string $name

	 * @param string $value

	 * @param array|Requests_Utility_CaseInsensitiveDictionary $attributes Associative array of attribute data

	 */

	public function __construct($name, $value, $attributes = array(), $flags = array(), $reference_time = null) {

		$this->name       = $name;

		$this->value      = $value;

		$this->attributes = $attributes;

		$default_flags    = array(

			'creation'    => time(),

			'last-access' => time(),

			'persistent'  => false,

			'host-only'   => true,

		);

		$this->flags      = array_merge($default_flags, $flags);

		$this->reference_time = time();

		if ($reference_time !== null) {

			$this->reference_time = $reference_time;

		}

		$this->normalize();

	}

	/**

	 * Check if a cookie is expired.

	 *

	 * Checks the age against $this->reference_time to determine if the cookie

	 * is expired.

	 *

	 * @return boolean True if expired, false if time is valid.

	 */

	public function is_expired() {

		// RFC6265, s. 4.1.2.2:

		// If a cookie has both the Max-Age and the Expires attribute, the Max-

		// Age attribute has precedence and controls the expiration date of the

		// cookie.

		if (isset($this->attributes['max-age'])) {

			$max_age = $this->attributes['max-age'];

			return $max_age < $this->reference_time;

		}

		if (isset($this->attributes['expires'])) {

			$expires = $this->attributes['expires'];

			return $expires < $this->reference_time;

		}

		return false;

	}

	/**

	 * Check if a cookie is valid for a given URI

	 *

	 * @param Requests_IRI $uri URI to check

	 * @return boolean Whether the cookie is valid for the given URI

	 */

	public function uri_matches(Requests_IRI $uri) {

		if (!$this->domain_matches($uri->host)) {

			return false;

		}

		if (!$this->path_matches($uri->path)) {

			return false;

		}

		return empty($this->attributes['secure']) || $uri->scheme === 'https';

	}

	/**

	 * Check if a cookie is valid for a given domain

	 *

	 * @param string $string Domain to check

	 * @return boolean Whether the cookie is valid for the given domain

	 */

	public function domain_matches($string) {

		if (!isset($this->attributes['domain'])) {

			// Cookies created manually; cookies created by Requests will set

			// the domain to the requested domain

			return true;

		}

		$domain_string = $this->attributes['domain'];

		if ($domain_string === $string) {

			// The domain string and the string are identical.

			return true;

		}

		// If the cookie is marked as host-only and we don't have an exact

		// match, reject the cookie

		if ($this->flags['host-only'] === true) {

			return false;

		}

		if (strlen($string) <= strlen($domain_string)) {

			// For obvious reasons, the string cannot be a suffix if the domain

			// is shorter than the domain string

			return false;

		}

		if (substr($string, -1 * strlen($domain_string)) !== $domain_string) {

			// The domain string should be a suffix of the string.

			return false;

		}

		$prefix = substr($string, 0, strlen($string) - strlen($domain_string));

		if (substr($prefix, -1) !== '.') {

			// The last character of the string that is not included in the

			// domain string should be a %x2E (".") character.

			return false;

		}

		// The string should be a host name (i.e., not an IP address).

		return !preg_match('#^(.+\.)\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}$#', $string);

	}

	/**

	 * Check if a cookie is valid for a given path

	 *

	 * From the path-match check in RFC 6265 section 5.1.4

	 *

	 * @param string $request_path Path to check

	 * @return boolean Whether the cookie is valid for the given path

	 */

	public function path_matches($request_path) {

		if (empty($request_path)) {

			// Normalize empty path to root

			$request_path = '/';

		}

		if (!isset($this->attributes['path'])) {

			// Cookies created manually; cookies created by Requests will set

			// the path to the requested path

			return true;

		}

		$cookie_path = $this->attributes['path'];

		if ($cookie_path === $request_path) {

			// The cookie-path and the request-path are identical.

			return true;

		}

		if (strlen($request_path) > strlen($cookie_path) && substr($request_path, 0, strlen($cookie_path)) === $cookie_path) {

			if (substr($cookie_path, -1) === '/') {

				// The cookie-path is a prefix of the request-path, and the last

				// character of the cookie-path is %x2F ("/").

				return true;

			}

			if (substr($request_path, strlen($cookie_path), 1) === '/') {

				// The cookie-path is a prefix of the request-path, and the

				// first character of the request-path that is not included in

				// the cookie-path is a %x2F ("/") character.

				return true;

			}

		}

		return false;

	}

	/**

	 * Normalize cookie and attributes

	 *

	 * @return boolean Whether the cookie was successfully normalized

	 */

	public function normalize() {

		foreach ($this->attributes as $key => $value) {

			$orig_value = $value;

			$value      = $this->normalize_attribute($key, $value);

			if ($value === null) {

				unset($this->attributes[$key]);

				continue;

			}

			if ($value !== $orig_value) {

				$this->attributes[$key] = $value;

			}

		}

		return true;

	}

	/**

	 * Parse an individual cookie attribute

	 *

	 * Handles parsing individual attributes from the cookie values.

	 *

	 * @param string $name Attribute name

	 * @param string|boolean $value Attribute value (string value, or true if empty/flag)

	 * @return mixed Value if available, or null if the attribute value is invalid (and should be skipped)

	 */

	protected function normalize_attribute($name, $value) {

		switch (strtolower($name)) {

			case 'expires':

				// Expiration parsing, as per RFC 6265 section 5.2.1

				if (is_int($value)) {

					return $value;

				}

				$expiry_time = strtotime($value);

				if ($expiry_time === false) {

					return null;

				}

				return $expiry_time;

			case 'max-age':

				// Expiration parsing, as per RFC 6265 section 5.2.2

				if (is_int($value)) {

					return $value;

				}

				// Check that we have a valid age

				if (!preg_match('/^-?\d+$/', $value)) {

					return null;

				}

				$delta_seconds = (int) $value;

				if ($delta_seconds <= 0) {

					$expiry_time = 0;

				}

				else {

					$expiry_time = $this->reference_time + $delta_seconds;

				}

				return $expiry_time;

			case 'domain':

				// Domains are not required as per RFC 6265 section 5.2.3

				if (empty($value)) {

					return null;

				}

				// Domain normalization, as per RFC 6265 section 5.2.3

				if ($value[0] === '.') {

					$value = substr($value, 1);

				}

				return $value;

			default:

				return $value;

		}

	}

	/**

	 * Format a cookie for a Cookie header

	 *

	 * This is used when sending cookies to a server.

	 *

	 * @return string Cookie formatted for Cookie header

	 */

	public function format_for_header() {

		return sprintf('%s=%s', $this->name, $this->value);

	}

	/**

	 * Format a cookie for a Cookie header

	 *

	 * @codeCoverageIgnore

	 * @deprecated Use {@see Requests_Cookie::format_for_header}

	 * @return string

	 */

	public function formatForHeader() {

		return $this->format_for_header();

	}

	/**

	 * Format a cookie for a Set-Cookie header

	 *

	 * This is used when sending cookies to clients. This isn't really

	 * applicable to client-side usage, but might be handy for debugging.

	 *

	 * @return string Cookie formatted for Set-Cookie header

	 */

	public function format_for_set_cookie() {

		$header_value = $this->format_for_header();

		if (!empty($this->attributes)) {

			$parts = array();

			foreach ($this->attributes as $key => $value) {

				// Ignore non-associative attributes

				if (is_numeric($key)) {

					$parts[] = $value;

				}

				else {

					$parts[] = sprintf('%s=%s', $key, $value);

				}

			}

			$header_value .= '; ' . implode('; ', $parts);

		}

		return $header_value;

	}

	/**

	 * Format a cookie for a Set-Cookie header

	 *

	 * @codeCoverageIgnore

	 * @deprecated Use {@see Requests_Cookie::format_for_set_cookie}

	 * @return string

	 */

	public function formatForSetCookie() {

		return $this->format_for_set_cookie();

	}

	/**

	 * Get the cookie value

	 *

	 * Attributes and other data can be accessed via methods.

	 */

	public function __toString() {

		return $this->value;

	}

	/**

	 * Parse a cookie string into a cookie object

	 *

	 * Based on Mozilla's parsing code in Firefox and related projects, which

	 * is an intentional deviation from RFC 2109 and RFC 2616. RFC 6265

	 * specifies some of this handling, but not in a thorough manner.

	 *

	 * @param string Cookie header value (from a Set-Cookie header)

	 * @return Requests_Cookie Parsed cookie object

	 */

	public static function parse($string, $name = '', $reference_time = null) {

		$parts   = explode(';', $string);

		$kvparts = array_shift($parts);

		if (!empty($name)) {

			$value = $string;

		}

		elseif (strpos($kvparts, '=') === false) {

			// Some sites might only have a value without the equals separator.

			// Deviate from RFC 6265 and pretend it was actually a blank name

			// (`=foo`)

			//

			// https://bugzilla.mozilla.org/show_bug.cgi?id=169091

			$name  = '';

			$value = $kvparts;

		}

		else {

			list($name, $value) = explode('=', $kvparts, 2);

		}

		$name  = trim($name);

		$value = trim($value);

		// Attribute key are handled case-insensitively

		$attributes = new Requests_Utility_CaseInsensitiveDictionary();

		if (!empty($parts)) {

			foreach ($parts as $part) {

				if (strpos($part, '=') === false) {

					$part_key   = $part;

					$part_value = true;

				}

				else {

					list($part_key, $part_value) = explode('=', $part, 2);

					$part_value                  = trim($part_value);

				}

				$part_key              = trim($part_key);

				$attributes[$part_key] = $part_value;

			}

		}

		return new Requests_Cookie($name, $value, $attributes, array(), $reference_time);

	}

	/**

	 * Parse all Set-Cookie headers from request headers

	 *

	 * @param Requests_Response_Headers $headers Headers to parse from

	 * @param Requests_IRI|null $origin URI for comparing cookie origins

	 * @param int|null $time Reference time for expiration calculation

	 * @return array

	 */

	public static function parse_from_headers(Requests_Response_Headers $headers, Requests_IRI $origin = null, $time = null) {

		$cookie_headers = $headers->getValues('Set-Cookie');

		if (empty($cookie_headers)) {

			return array();