Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* Cookie holder object

[2] Fix | Delete

[3] Fix | Delete

* @package Requests\Cookies

[4] Fix | Delete

[5] Fix | Delete

[6] Fix | Delete

namespace WpOrg\Requests\Cookie;

[7] Fix | Delete

[8] Fix | Delete

use ArrayAccess;

[9] Fix | Delete

use ArrayIterator;

[10] Fix | Delete

use IteratorAggregate;

[11] Fix | Delete

use ReturnTypeWillChange;

[12] Fix | Delete

use WpOrg\Requests\Cookie;

[13] Fix | Delete

use WpOrg\Requests\Exception;

[14] Fix | Delete

use WpOrg\Requests\Exception\InvalidArgument;

[15] Fix | Delete

use WpOrg\Requests\HookManager;

[16] Fix | Delete

use WpOrg\Requests\Iri;

[17] Fix | Delete

use WpOrg\Requests\Response;

[18] Fix | Delete

[19] Fix | Delete

/**

[20] Fix | Delete

* Cookie holder object

[21] Fix | Delete

[22] Fix | Delete

* @package Requests\Cookies

[23] Fix | Delete

[24] Fix | Delete

class Jar implements ArrayAccess, IteratorAggregate {

[25] Fix | Delete

/**

[26] Fix | Delete

* Actual item data

[27] Fix | Delete

[28] Fix | Delete

* @var array

[29] Fix | Delete

[30] Fix | Delete

protected $cookies = [];

[31] Fix | Delete

[32] Fix | Delete

/**

[33] Fix | Delete

* Create a new jar

[34] Fix | Delete

[35] Fix | Delete

* @param array $cookies Existing cookie values

[36] Fix | Delete

[37] Fix | Delete

* @throws \WpOrg\Requests\Exception\InvalidArgument When the passed argument is not an array.

[38] Fix | Delete

[39] Fix | Delete

public function __construct($cookies = []) {

[40] Fix | Delete

if (is_array($cookies) === false) {

[41] Fix | Delete

throw InvalidArgument::create(1, '$cookies', 'array', gettype($cookies));

[42] Fix | Delete

}

[43] Fix | Delete

[44] Fix | Delete

$this->cookies = $cookies;

[45] Fix | Delete

}

[46] Fix | Delete

[47] Fix | Delete

/**

[48] Fix | Delete

* Normalise cookie data into a \WpOrg\Requests\Cookie

[49] Fix | Delete

[50] Fix | Delete

* @param string|\WpOrg\Requests\Cookie $cookie Cookie header value, possibly pre-parsed (object).

[51] Fix | Delete

* @param string $key Optional. The name for this cookie.

[52] Fix | Delete

* @return \WpOrg\Requests\Cookie

[53] Fix | Delete

[54] Fix | Delete

public function normalize_cookie($cookie, $key = '') {

[55] Fix | Delete

if ($cookie instanceof Cookie) {

[56] Fix | Delete

return $cookie;

[57] Fix | Delete

}

[58] Fix | Delete

[59] Fix | Delete

return Cookie::parse($cookie, $key);

[60] Fix | Delete

}

[61] Fix | Delete

[62] Fix | Delete

/**

[63] Fix | Delete

* Check if the given item exists

[64] Fix | Delete

[65] Fix | Delete

* @param string $offset Item key

[66] Fix | Delete

* @return boolean Does the item exist?

[67] Fix | Delete

[68] Fix | Delete

#[ReturnTypeWillChange]

[69] Fix | Delete

public function offsetExists($offset) {

[70] Fix | Delete

return isset($this->cookies[$offset]);

[71] Fix | Delete

}

[72] Fix | Delete

[73] Fix | Delete

/**

[74] Fix | Delete

* Get the value for the item

[75] Fix | Delete

[76] Fix | Delete

* @param string $offset Item key

[77] Fix | Delete

* @return string|null Item value (null if offsetExists is false)

[78] Fix | Delete

[79] Fix | Delete

#[ReturnTypeWillChange]

[80] Fix | Delete

public function offsetGet($offset) {

[81] Fix | Delete

if (!isset($this->cookies[$offset])) {

[82] Fix | Delete

return null;

[83] Fix | Delete

}

[84] Fix | Delete

[85] Fix | Delete

return $this->cookies[$offset];

[86] Fix | Delete

}

[87] Fix | Delete

[88] Fix | Delete

/**

[89] Fix | Delete

* Set the given item

[90] Fix | Delete

[91] Fix | Delete

* @param string $offset Item name

[92] Fix | Delete

* @param string $value Item value

[93] Fix | Delete

[94] Fix | Delete

* @throws \WpOrg\Requests\Exception On attempting to use dictionary as list (`invalidset`)

[95] Fix | Delete

[96] Fix | Delete

#[ReturnTypeWillChange]

[97] Fix | Delete

public function offsetSet($offset, $value) {

[98] Fix | Delete

if ($offset === null) {

[99] Fix | Delete

throw new Exception('Object is a dictionary, not a list', 'invalidset');

[100] Fix | Delete

}

[101] Fix | Delete

[102] Fix | Delete

$this->cookies[$offset] = $value;

[103] Fix | Delete

}

[104] Fix | Delete

[105] Fix | Delete

/**

[106] Fix | Delete

* Unset the given header

[107] Fix | Delete

[108] Fix | Delete

* @param string $offset The key for the item to unset.

[109] Fix | Delete

[110] Fix | Delete

#[ReturnTypeWillChange]

[111] Fix | Delete

public function offsetUnset($offset) {

[112] Fix | Delete

unset($this->cookies[$offset]);

[113] Fix | Delete

}

[114] Fix | Delete

[115] Fix | Delete

/**

[116] Fix | Delete

* Get an iterator for the data

[117] Fix | Delete

[118] Fix | Delete

* @return \ArrayIterator

[119] Fix | Delete

[120] Fix | Delete

#[ReturnTypeWillChange]

[121] Fix | Delete

public function getIterator() {

[122] Fix | Delete

return new ArrayIterator($this->cookies);

[123] Fix | Delete

}

[124] Fix | Delete

[125] Fix | Delete

/**

[126] Fix | Delete

* Register the cookie handler with the request's hooking system

[127] Fix | Delete

[128] Fix | Delete

* @param \WpOrg\Requests\HookManager $hooks Hooking system

[129] Fix | Delete

[130] Fix | Delete

public function register(HookManager $hooks) {

[131] Fix | Delete

$hooks->register('requests.before_request', [$this, 'before_request']);

[132] Fix | Delete

$hooks->register('requests.before_redirect_check', [$this, 'before_redirect_check']);

[133] Fix | Delete

}

[134] Fix | Delete

[135] Fix | Delete

/**

[136] Fix | Delete

* Add Cookie header to a request if we have any

[137] Fix | Delete

[138] Fix | Delete

* As per RFC 6265, cookies are separated by '; '

[139] Fix | Delete

[140] Fix | Delete

* @param string $url

[141] Fix | Delete

* @param array $headers

[142] Fix | Delete

* @param array $data

[143] Fix | Delete

* @param string $type

[144] Fix | Delete

* @param array $options

[145] Fix | Delete

[146] Fix | Delete

public function before_request($url, &$headers, &$data, &$type, &$options) {

[147] Fix | Delete

if (!$url instanceof Iri) {

[148] Fix | Delete

$url = new Iri($url);

[149] Fix | Delete

}

[150] Fix | Delete

[151] Fix | Delete

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

[152] Fix | Delete

$cookies = [];

[153] Fix | Delete

foreach ($this->cookies as $key => $cookie) {

[154] Fix | Delete

$cookie = $this->normalize_cookie($cookie, $key);

[155] Fix | Delete

[156] Fix | Delete

// Skip expired cookies

[157] Fix | Delete

if ($cookie->is_expired()) {

[158] Fix | Delete

continue;

[159] Fix | Delete

}

[160] Fix | Delete

[161] Fix | Delete

if ($cookie->domain_matches($url->host)) {

[162] Fix | Delete

$cookies[] = $cookie->format_for_header();

[163] Fix | Delete

}

[164] Fix | Delete

}

[165] Fix | Delete

[166] Fix | Delete

$headers['Cookie'] = implode('; ', $cookies);

[167] Fix | Delete

}

[168] Fix | Delete

}

[169] Fix | Delete

[170] Fix | Delete

/**

[171] Fix | Delete

* Parse all cookies from a response and attach them to the response

[172] Fix | Delete

[173] Fix | Delete

* @param \WpOrg\Requests\Response $response Response as received.

[174] Fix | Delete

[175] Fix | Delete

public function before_redirect_check(Response $response) {

[176] Fix | Delete

$url = $response->url;

[177] Fix | Delete

if (!$url instanceof Iri) {

[178] Fix | Delete

$url = new Iri($url);

[179] Fix | Delete

}

[180] Fix | Delete

[181] Fix | Delete

$cookies = Cookie::parse_from_headers($response->headers, $url);

[182] Fix | Delete

$this->cookies = array_merge($this->cookies, $cookies);

[183] Fix | Delete

$response->cookies = $this;

[184] Fix | Delete

}

[185] Fix | Delete

}

[186] Fix | Delete

[187] Fix | Delete