* Valid keys are (currently) path, domain, expires, max-age, secure and
* @var Requests_Utility_CaseInsensitiveDictionary|array Array-like object
public $attributes = array();
* Valid keys are (currently) creation, last-access, persistent and
* Reference time for relative calculations
* This is used in place of `time()` when calculating Max-Age expiration and
* checking time validity.
public $reference_time = 0;
* Create a new cookie object
* @param array|Requests_Utility_CaseInsensitiveDictionary $attributes Associative array of attribute data
public function __construct($name, $value, $attributes = array(), $flags = array(), $reference_time = null) {
$this->attributes = $attributes;
$this->flags = array_merge($default_flags, $flags);
$this->reference_time = time();
if ($reference_time !== null) {
$this->reference_time = $reference_time;
* Check if a cookie is expired.
* Checks the age against $this->reference_time to determine if the cookie
* @return boolean True if expired, false if time is valid.
public function is_expired() {
// 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
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;
* 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)) {
if (!$this->path_matches($uri->path)) {
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
$domain_string = $this->attributes['domain'];
if ($domain_string === $string) {
// The domain string and the string are identical.
// 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) {
if (strlen($string) <= strlen($domain_string)) {
// For obvious reasons, the string cannot be a suffix if the domain
// is shorter than the domain string
if (substr($string, -1 * strlen($domain_string)) !== $domain_string) {
// The domain string should be a suffix of the string.
$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.
// 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
if (!isset($this->attributes['path'])) {
// Cookies created manually; cookies created by Requests will set
// the path to the requested path
$cookie_path = $this->attributes['path'];
if ($cookie_path === $request_path) {
// The cookie-path and the request-path are identical.
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 ("/").
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.
* Normalize cookie and attributes
* @return boolean Whether the cookie was successfully normalized
public function normalize() {
foreach ($this->attributes as $key => $value) {
$value = $this->normalize_attribute($key, $value);
unset($this->attributes[$key]);
if ($value !== $orig_value) {
$this->attributes[$key] = $value;
* 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)) {
// Expiration parsing, as per RFC 6265 section 5.2.1
$expiry_time = strtotime($value);
if ($expiry_time === false) {
// Expiration parsing, as per RFC 6265 section 5.2.2
// Check that we have a valid age
if (!preg_match('/^-?\d+$/', $value)) {
$delta_seconds = (int) $value;
if ($delta_seconds <= 0) {
$expiry_time = $this->reference_time + $delta_seconds;
// Domains are not required as per RFC 6265 section 5.2.3
// Domain normalization, as per RFC 6265 section 5.2.3
$value = substr($value, 1);
* 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
* @deprecated Use {@see Requests_Cookie::format_for_header}
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)) {
foreach ($this->attributes as $key => $value) {
// Ignore non-associative attributes
$parts[] = sprintf('%s=%s', $key, $value);
$header_value .= '; ' . implode('; ', $parts);
* Format a cookie for a Set-Cookie header
* @deprecated Use {@see Requests_Cookie::format_for_set_cookie}
public function formatForSetCookie() {
return $this->format_for_set_cookie();
* Attributes and other data can be accessed via methods.
public function __toString() {
* 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);
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
// https://bugzilla.mozilla.org/show_bug.cgi?id=169091
list($name, $value) = explode('=', $kvparts, 2);
// Attribute key are handled case-insensitively
$attributes = new Requests_Utility_CaseInsensitiveDictionary();
foreach ($parts as $part) {
if (strpos($part, '=') === false) {
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
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)) {
foreach ($cookie_headers as $header) {
$parsed = self::parse($header, '', $time);
// Default domain/path attributes
if (empty($parsed->attributes['domain']) && !empty($origin)) {
$parsed->attributes['domain'] = $origin->host;
$parsed->flags['host-only'] = true;
$parsed->flags['host-only'] = false;
$path_is_valid = (!empty($parsed->attributes['path']) && $parsed->attributes['path'][0] === '/');
if (!$path_is_valid && !empty($origin)) {
// Default path normalization as per RFC 6265 section 5.1.4
if (substr($path, 0, 1) !== '/') {
// If the uri-path is empty or if the first character of
// the uri-path is not a %x2F ("/") character, output
// %x2F ("/") and skip the remaining steps.
elseif (substr_count($path, '/') === 1) {
// If the uri-path contains no more than one %x2F ("/")
// character, output %x2F ("/") and skip the remaining
// Output the characters of the uri-path from the first
// character up to, but not including, the right-most
$path = substr($path, 0, strrpos($path, '/'));
$parsed->attributes['path'] = $path;
// Reject invalid cookie domains
if (!empty($origin) && !$parsed->domain_matches($origin->host)) {
$cookies[$parsed->name] = $parsed;
* Parse all Set-Cookie headers from request headers
* @deprecated Use {@see Requests_Cookie::parse_from_headers}
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
