1: 2: 3: 4: 5: 6: 7: 8: 9: 10: 11: 12: 13: 14: 15: 16: 17: 18: 19: 20: 21: 22: 23: 24: 25: 26: 27: 28: 29: 30: 31: 32: 33: 34: 35: 36: 37: 38: 39: 40: 41: 42: 43: 44: 45: 46: 47: 48: 49: 50: 51: 52: 53: 54: 55: 56: 57: 58: 59: 60: 61: 62: 63: 64: 65: 66: 67: 68: 69: 70: 71: 72: 73: 74: 75: 76: 77: 78: 79: 80: 81: 82: 83: 84: 85: 86: 87: 88: 89: 90: 91: 92: 93: 94: 95: 96: 97: 98: 99: 100: 101: 102: 103: 104: 105: 106: 107: 108: 109: 110: 111: 112: 113: 114: 115: 116: 117: 118: 119: 120: 121: 122: 123: 124: 125: 126: 127: 128: 129: 130: 131: 132: 133: 134: 135: 136: 137: 138: 139: 140: 141: 142: 143: 144: 145: 146: 147: 148: 149: 150: 151: 152: 153: 154: 155: 156: 157: 158: 159: 160: 161: 162: 163: 164: 165: 166: 167: 168: 169: 170: 171: 172: 173: 174: 175: 176: 177: 178: 179: 180: 181: 182: 183: 184: 185: 186: 187: 188: 189: 190: 191: 192: 193: 194: 195: 196: 197: 198: 199: 200: 201: 202: 203: 204: 205: 206: 207: 208: 209: 210: 211: 212: 213: 214: 215: 216: 217: 218: 219: 220: 221: 222: 223: 224: 225: 226: 227: 228: 229: 230: 231: 232: 233: 234: 235: 236: 237: 238: 239: 240: 241: 242: 243: 244: 245: 246: 247: 248: 249: 250: 251: 252: 253: 254: 255: 256: 257: 258: 259: 260: 261: 262: 263: 264: 265: 266: 267: 268: 269: 270: 271: 272: 273: 274: 275: 276: 277: 278: 279: 280: 281: 282: 283: 284: 285: 286: 287: 288: 289: 290: 291: 292: 293: 294: 295: 296: 297: 298: 299: 300: 301: 302: 303: 304: 305: 306: 307: 308: 309: 310: 311: 312: 313: 314: 315: 316: 317: 318: 319: 320: 321: 322: 323: 324: 325: 326: 327: 328: 329: 330: 331: 332: 333: 334: 335: 336: 337: 338: 339: 340: 341: 342: 343: 344: 345: 346: 347: 348: 349: 350: 351: 352: 353: 354: 355: 356: 357: 358: 359: 360: 361: 362: 363: 364: 365: 366: 367: 368: 369: 370: 371: 372: 373: 374: 375: 376: 377: 378: 379: 380: 381: 382: 383: 384: 385: 386: 387: 388: 389: 390: 391: 392: 393: 394: 395: 396: 397: 398: 399: 400: 401: 402: 403: 404: 405: 406: 407: 408: 409: 410: 411: 412: 413: 414: 415: 416: 417: 418: 419: 420: 421: 422: 423: 424: 425: 426: 427: 428: 429: 430: 431: 432: 433: 434: 435: 436: 437: 438: 439: 440: 441: 442: 443: 444: 445: 446: 447: 448: 449: 450: 451: 452: 453: 454: 455: 456: 457: 458: 459: 460: 461: 462: 463: 464: 465: 466: 467: 468: 469: 470: 471: 472: 473: 474: 475: 476: 477: 478: 479: 480: 481: 482: 483: 484: 485: 486: 487: 488: 489: 490: 491: 492: 493: 494: 495: 496: 497: 498: 499: 500: 501: 502: 503: 504: 505: 506: 507: 508: 509: 510: 511: 512: 513: 514: 515: 516: 517: 518: 519: 520: 521: 522: 523: 524: 525: 526: 527: 528: 529: 530: 531: 532: 533: 534: 535: 536: 537: 538: 539: <?php
namespace Guzzle\Plugin\Cookie;
use Guzzle\Common\ToArrayInterface;
/**
* Set-Cookie object
*/
class Cookie implements ToArrayInterface
{
/** @var array Cookie data */
protected $data;
/**
* @var string ASCII codes not valid for for use in a cookie name
*
* Cookie names are defined as 'token', according to RFC 2616, Section 2.2
* A valid token may contain any CHAR except CTLs (ASCII 0 - 31 or 127)
* or any of the following separators
*/
protected static $invalidCharString;
/**
* Gets an array of invalid cookie characters
*
* @return array
*/
protected static function getInvalidCharacters()
{
if (!self::$invalidCharString) {
self::$invalidCharString = implode('', array_map('chr', array_merge(
range(0, 32),
array(34, 40, 41, 44, 47),
array(58, 59, 60, 61, 62, 63, 64, 91, 92, 93, 123, 125, 127)
)));
}
return self::$invalidCharString;
}
/**
* @param array $data Array of cookie data provided by a Cookie parser
*/
public function __construct(array $data = array())
{
static $defaults = array(
'name' => '',
'value' => '',
'domain' => '',
'path' => '/',
'expires' => null,
'max_age' => 0,
'comment' => null,
'comment_url' => null,
'port' => array(),
'version' => null,
'secure' => false,
'discard' => false,
'http_only' => false
);
$this->data = array_merge($defaults, $data);
// 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() + (int) $this->getMaxAge());
} elseif ($this->getExpires() && !is_numeric($this->getExpires())) {
$this->setExpires(strtotime($this->getExpires()));
}
}
/**
* Get the cookie as an array
*
* @return array
*/
public function toArray()
{
return $this->data;
}
/**
* Get the cookie name
*
* @return string
*/
public function getName()
{
return $this->data['name'];
}
/**
* Set the cookie name
*
* @param string $name Cookie name
*
* @return Cookie
*/
public function setName($name)
{
return $this->setData('name', $name);
}
/**
* Get the cookie value
*
* @return string
*/
public function getValue()
{
return $this->data['value'];
}
/**
* Set the cookie value
*
* @param string $value Cookie value
*
* @return Cookie
*/
public function setValue($value)
{
return $this->setData('value', $value);
}
/**
* Get the domain
*
* @return string|null
*/
public function getDomain()
{
return $this->data['domain'];
}
/**
* Set the domain of the cookie
*
* @param string $domain
*
* @return Cookie
*/
public function setDomain($domain)
{
return $this->setData('domain', $domain);
}
/**
* Get the path
*
* @return string
*/
public function getPath()
{
return $this->data['path'];
}
/**
* Set the path of the cookie
*
* @param string $path Path of the cookie
*
* @return Cookie
*/
public function setPath($path)
{
return $this->setData('path', $path);
}
/**
* Maximum lifetime of the cookie in seconds
*
* @return int|null
*/
public function getMaxAge()
{
return $this->data['max_age'];
}
/**
* Set the max-age of the cookie
*
* @param int $maxAge Max age of the cookie in seconds
*
* @return Cookie
*/
public function setMaxAge($maxAge)
{
return $this->setData('max_age', $maxAge);
}
/**
* The UNIX timestamp when the cookie expires
*
* @return mixed
*/
public function getExpires()
{
return $this->data['expires'];
}
/**
* Set the unix timestamp for which the cookie will expire
*
* @param int $timestamp Unix timestamp
*
* @return Cookie
*/
public function setExpires($timestamp)
{
return $this->setData('expires', $timestamp);
}
/**
* Version of the cookie specification. RFC 2965 is 1
*
* @return mixed
*/
public function getVersion()
{
return $this->data['version'];
}
/**
* Set the cookie version
*
* @param string|int $version Version to set
*
* @return Cookie
*/
public function setVersion($version)
{
return $this->setData('version', $version);
}
/**
* Get whether or not this is a secure cookie
*
* @return null|bool
*/
public function getSecure()
{
return $this->data['secure'];
}
/**
* Set whether or not the cookie is secure
*
* @param bool $secure Set to true or false if secure
*
* @return Cookie
*/
public function setSecure($secure)
{
return $this->setData('secure', (bool) $secure);
}
/**
* Get whether or not this is a session cookie
*
* @return null|bool
*/
public function getDiscard()
{
return $this->data['discard'];
}
/**
* Set whether or not this is a session cookie
*
* @param bool $discard Set to true or false if this is a session cookie
*
* @return Cookie
*/
public function setDiscard($discard)
{
return $this->setData('discard', $discard);
}
/**
* Get the comment
*
* @return string|null
*/
public function getComment()
{
return $this->data['comment'];
}
/**
* Set the comment of the cookie
*
* @param string $comment Cookie comment
*
* @return Cookie
*/
public function setComment($comment)
{
return $this->setData('comment', $comment);
}
/**
* Get the comment URL of the cookie
*
* @return string|null
*/
public function getCommentUrl()
{
return $this->data['comment_url'];
}
/**
* Set the comment URL of the cookie
*
* @param string $commentUrl Cookie comment URL for more information
*
* @return Cookie
*/
public function setCommentUrl($commentUrl)
{
return $this->setData('comment_url', $commentUrl);
}
/**
* Get an array of acceptable ports this cookie can be used with
*
* @return array
*/
public function getPorts()
{
return $this->data['port'];
}
/**
* Set a list of acceptable ports this cookie can be used with
*
* @param array $ports Array of acceptable ports
*
* @return Cookie
*/
public function setPorts(array $ports)
{
return $this->setData('port', $ports);
}
/**
* Get whether or not this is an HTTP only cookie
*
* @return bool
*/
public function getHttpOnly()
{
return $this->data['http_only'];
}
/**
* Set whether or not this is an HTTP only cookie
*
* @param bool $httpOnly Set to true or false if this is HTTP only
*
* @return Cookie
*/
public function setHttpOnly($httpOnly)
{
return $this->setData('http_only', $httpOnly);
}
/**
* Get an array of extra cookie data
*
* @return array
*/
public function getAttributes()
{
return $this->data['data'];
}
/**
* Get a specific data point from the extra cookie data
*
* @param string $name Name of the data point to retrieve
*
* @return null|string
*/
public function getAttribute($name)
{
return array_key_exists($name, $this->data['data']) ? $this->data['data'][$name] : null;
}
/**
* Set a cookie data attribute
*
* @param string $name Name of the attribute to set
* @param string $value Value to set
*
* @return Cookie
*/
public function setAttribute($name, $value)
{
$this->data['data'][$name] = $value;
return $this;
}
/**
* Check if the cookie matches a path value
*
* @param string $path Path to check against
*
* @return bool
*/
public function matchesPath($path)
{
// RFC6265 http://tools.ietf.org/search/rfc6265#section-5.1.4
// A request-path path-matches a given cookie-path if at least one of
// the following conditions holds:
// o The cookie-path and the request-path are identical.
if ($path == $this->getPath()) {
return true;
}
$pos = stripos($path, $this->getPath());
if ($pos === 0) {
// o The cookie-path is a prefix of the request-path, and the last
// character of the cookie-path is %x2F ("/").
if (substr($this->getPath(), -1, 1) === "/") {
return true;
}
// o 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.
if (substr($path, strlen($this->getPath()), 1) === "/") {
return true;
}
}
return false;
}
/**
* Check if the cookie matches a domain value
*
* @param string $domain Domain to check against
*
* @return bool
*/
public function matchesDomain($domain)
{
// Remove the leading '.' as per spec in RFC 6265: http://tools.ietf.org/html/rfc6265#section-5.2.3
$cookieDomain = ltrim($this->getDomain(), '.');
// Domain not set or exact match.
if (!$cookieDomain || !strcasecmp($domain, $cookieDomain)) {
return true;
}
// Matching the subdomain according to RFC 6265: http://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, '/') . '$/i', $domain);
}
/**
* Check if the cookie is compatible with a specific port
*
* @param int $port Port to check
*
* @return bool
*/
public function matchesPort($port)
{
return count($this->getPorts()) == 0 || in_array($port, $this->getPorts());
}
/**
* Check if the cookie is expired
*
* @return bool
*/
public function isExpired()
{
return $this->getExpires() && time() > $this->getExpires();
}
/**
* 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)) {
return 'The cookie name must not be empty';
}
// Check if any of the invalid characters are present in the cookie name
if (strpbrk($name, self::getInvalidCharacters()) !== false) {
return 'The cookie name must not contain invalid characters: ' . $name;
}
// Value must not be empty, but can be 0
$value = $this->getValue();
if (empty($value) && !is_numeric($value)) {
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
$domain = $this->getDomain();
if (empty($domain) && !is_numeric($domain)) {
return 'The cookie domain must not be empty';
}
return true;
}
/**
* Set a value and return the cookie object
*
* @param string $key Key to set
* @param string $value Value to set
*
* @return Cookie
*/
private function setData($key, $value)
{
$this->data[$key] = $value;
return $this;
}
}