123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175 |
- <?php
- /**
- * Cookie holder object
- *
- * @package Requests
- * @subpackage Cookies
- */
- /**
- * Cookie holder object
- *
- * @package Requests
- * @subpackage Cookies
- */
- class Requests_Cookie_Jar implements ArrayAccess, IteratorAggregate {
- /**
- * Actual item data
- *
- * @var array
- */
- protected $cookies = array();
- /**
- * Create a new jar
- *
- * @param array $cookies Existing cookie values
- */
- public function __construct($cookies = array()) {
- $this->cookies = $cookies;
- }
- /**
- * Normalise cookie data into a Requests_Cookie
- *
- * @param string|Requests_Cookie $cookie
- * @return Requests_Cookie
- */
- public function normalize_cookie($cookie, $key = null) {
- if ($cookie instanceof Requests_Cookie) {
- return $cookie;
- }
- return Requests_Cookie::parse($cookie, $key);
- }
- /**
- * Normalise cookie data into a Requests_Cookie
- *
- * @codeCoverageIgnore
- * @deprecated Use {@see Requests_Cookie_Jar::normalize_cookie}
- * @return Requests_Cookie
- */
- public function normalizeCookie($cookie, $key = null) {
- return $this->normalize_cookie($cookie, $key);
- }
- /**
- * Check if the given item exists
- *
- * @param string $key Item key
- * @return boolean Does the item exist?
- */
- public function offsetExists($key) {
- return isset($this->cookies[$key]);
- }
- /**
- * Get the value for the item
- *
- * @param string $key Item key
- * @return string Item value
- */
- public function offsetGet($key) {
- if (!isset($this->cookies[$key])) {
- return null;
- }
- return $this->cookies[$key];
- }
- /**
- * Set the given item
- *
- * @throws Requests_Exception On attempting to use dictionary as list (`invalidset`)
- *
- * @param string $key Item name
- * @param string $value Item value
- */
- public function offsetSet($key, $value) {
- if ($key === null) {
- throw new Requests_Exception('Object is a dictionary, not a list', 'invalidset');
- }
- $this->cookies[$key] = $value;
- }
- /**
- * Unset the given header
- *
- * @param string $key
- */
- public function offsetUnset($key) {
- unset($this->cookies[$key]);
- }
- /**
- * Get an iterator for the data
- *
- * @return ArrayIterator
- */
- public function getIterator() {
- return new ArrayIterator($this->cookies);
- }
- /**
- * Register the cookie handler with the request's hooking system
- *
- * @param Requests_Hooker $hooks Hooking system
- */
- public function register(Requests_Hooker $hooks) {
- $hooks->register('requests.before_request', array($this, 'before_request'));
- $hooks->register('requests.before_redirect_check', array($this, 'before_redirect_check'));
- }
- /**
- * Add Cookie header to a request if we have any
- *
- * As per RFC 6265, cookies are separated by '; '
- *
- * @param string $url
- * @param array $headers
- * @param array $data
- * @param string $type
- * @param array $options
- */
- public function before_request($url, &$headers, &$data, &$type, &$options) {
- if (!$url instanceof Requests_IRI) {
- $url = new Requests_IRI($url);
- }
- if (!empty($this->cookies)) {
- $cookies = array();
- foreach ($this->cookies as $key => $cookie) {
- $cookie = $this->normalize_cookie($cookie, $key);
- // Skip expired cookies
- if ($cookie->is_expired()) {
- continue;
- }
- if ($cookie->domain_matches($url->host)) {
- $cookies[] = $cookie->format_for_header();
- }
- }
- $headers['Cookie'] = implode('; ', $cookies);
- }
- }
- /**
- * Parse all cookies from a response and attach them to the response
- *
- * @var Requests_Response $response
- */
- public function before_redirect_check(Requests_Response &$return) {
- $url = $return->url;
- if (!$url instanceof Requests_IRI) {
- $url = new Requests_IRI($url);
- }
- $cookies = Requests_Cookie::parse_from_headers($return->headers, $url);
- $this->cookies = array_merge($this->cookies, $cookies);
- $return->cookies = $this;
- }
- }
|