/
CookieJar.php
161 lines (141 loc) · 3.62 KB
/
CookieJar.php
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
<?php
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\BrowserKit;
/**
* CookieJar.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @api
*/
class CookieJar
{
protected $cookieJar = array();
/**
* Sets a cookie.
*
* @param Cookie $cookie A Cookie instance
*
* @api
*/
public function set(Cookie $cookie)
{
$this->cookieJar[$cookie->getName()] = $cookie;
}
/**
* Gets a cookie by name.
*
* @param string $name The cookie name
*
* @return Cookie|null A Cookie instance or null if the cookie does not exist
*
* @api
*/
public function get($name)
{
$this->flushExpiredCookies();
return isset($this->cookieJar[$name]) ? $this->cookieJar[$name] : null;
}
/**
* Removes a cookie by name.
*
* @param string $name The cookie name
*
* @api
*/
public function expire($name)
{
unset($this->cookieJar[$name]);
}
/**
* Removes all the cookies from the jar.
*
* @api
*/
public function clear()
{
$this->cookieJar = array();
}
/**
* Updates the cookie jar from a Response object.
*
* @param Response $response A Response object
* @param string $uri The base URL
*/
public function updateFromResponse(Response $response, $uri = null)
{
foreach ($response->getHeader('Set-Cookie', false) as $cookie) {
$this->set(Cookie::fromString($cookie, $uri));
}
}
/**
* Returns not yet expired cookies.
*
* @return array An array of cookies
*/
public function all()
{
$this->flushExpiredCookies();
return $this->cookieJar;
}
/**
* Returns not yet expired cookie values for the given URI.
*
* @param string $uri A URI
* @param Boolean $returnsRawValue Returns raw value or urldecoded value
*
* @return array An array of cookie values
*/
public function allValues($uri, $returnsRawValue = false)
{
$this->flushExpiredCookies();
$parts = array_replace(array('path' => '/'), parse_url($uri));
$cookies = array();
foreach ($this->cookieJar as $cookie) {
if ($cookie->getDomain()) {
$domain = ltrim($cookie->getDomain(), '.');
if ($domain != substr($parts['host'], -strlen($domain))) {
continue;
}
}
if ($cookie->getPath() != substr($parts['path'], 0, strlen($cookie->getPath()))) {
continue;
}
if ($cookie->isSecure() && 'https' != $parts['scheme']) {
continue;
}
$cookies[$cookie->getName()] = $returnsRawValue ? $cookie->getRawValue() : $cookie->getValue();
}
return $cookies;
}
/**
* Returns not yet expired raw cookie values for the given URI.
*
* @param string $uri A URI
*
* @return array An array of cookie values
*/
public function allRawValues($uri)
{
return $this->allValues($uri, true);
}
/**
* Removes all expired cookies.
*/
public function flushExpiredCookies()
{
$cookies = $this->cookieJar;
foreach ($cookies as $name => $cookie) {
if ($cookie->isExpired()) {
unset($this->cookieJar[$name]);
}
}
}
}