3 * Cookie for HTTP requests.
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
30 protected $isSessionKey = true;
31 // TO IMPLEMENT protected $secure
32 // TO IMPLEMENT? protected $maxAge (add onto expires)
33 // TO IMPLEMENT? protected $version
34 // TO IMPLEMENT? protected $comment
36 function __construct( $name, $value, $attr ) {
38 $this->set( $value, $attr );
42 * Sets a cookie. Used before a request to set up any individual
43 * cookies. Used internally after a request to parse the
46 * @param string $value The value of the cookie
47 * @param array $attr Possible key/values:
48 * expires A date string
49 * path The path this cookie is used on
50 * domain Domain this cookie is used on
53 public function set( $value, $attr ) {
54 $this->value
= $value;
56 if ( isset( $attr['expires'] ) ) {
57 $this->isSessionKey
= false;
58 $this->expires
= strtotime( $attr['expires'] );
61 if ( isset( $attr['path'] ) ) {
62 $this->path
= $attr['path'];
67 if ( isset( $attr['domain'] ) ) {
68 if ( self
::validateCookieDomain( $attr['domain'] ) ) {
69 $this->domain
= $attr['domain'];
72 throw new MWException( 'You must specify a domain.' );
77 * Return the true if the cookie is valid is valid. Otherwise,
78 * false. The uses a method similar to IE cookie security
80 * http://kuza55.blogspot.com/2008/02/understanding-cookie-security.html
81 * A better method might be to use a blacklist like
82 * http://publicsuffix.org/
84 * @todo fixme fails to detect 3-letter top-level domains
85 * @todo fixme fails to detect 2-letter top-level domains for single-domain use (probably
86 * not a big problem in practice, but there are test cases)
88 * @param string $domain The domain to validate
89 * @param string $originDomain (optional) the domain the cookie originates from
92 public static function validateCookieDomain( $domain, $originDomain = null ) {
93 $dc = explode( ".", $domain );
95 // Don't allow a trailing dot or addresses without a or just a leading dot
96 if ( substr( $domain, -1 ) == '.' ||
98 count( $dc ) == 2 && $dc[0] === '' ) {
102 // Only allow full, valid IP addresses
103 if ( preg_match( '/^[0-9.]+$/', $domain ) ) {
104 if ( count( $dc ) != 4 ) {
108 if ( ip2long( $domain ) === false ) {
112 if ( $originDomain == null ||
$originDomain == $domain ) {
118 // Don't allow cookies for "co.uk" or "gov.uk", etc, but allow "supermarket.uk"
119 if ( strrpos( $domain, "." ) - strlen( $domain ) == -3 ) {
120 if ( ( count( $dc ) == 2 && strlen( $dc[0] ) <= 2 )
121 ||
( count( $dc ) == 3 && strlen( $dc[0] ) == "" && strlen( $dc[1] ) <= 2 ) ) {
124 if ( ( count( $dc ) == 2 ||
( count( $dc ) == 3 && $dc[0] == '' ) )
125 && preg_match( '/(com|net|org|gov|edu)\...$/', $domain ) ) {
130 if ( $originDomain != null ) {
131 if ( substr( $domain, 0, 1 ) != '.' && $domain != $originDomain ) {
135 if ( substr( $domain, 0, 1 ) == '.'
152 * Serialize the cookie jar into a format useful for HTTP Request headers.
154 * @param string $path The path that will be used. Required.
155 * @param string $domain The domain that will be used. Required.
158 public function serializeToHttpRequest( $path, $domain ) {
161 if ( $this->canServeDomain( $domain )
162 && $this->canServePath( $path )
163 && $this->isUnExpired() ) {
164 $ret = $this->name
. '=' . $this->value
;
171 * @param string $domain
174 protected function canServeDomain( $domain ) {
175 if ( $domain == $this->domain
176 ||
( strlen( $domain ) > strlen( $this->domain
)
177 && substr( $this->domain
, 0, 1 ) == '.'
181 -strlen( $this->domain
),
182 strlen( $this->domain
),
194 * @param string $path
197 protected function canServePath( $path ) {
198 return ( $this->path
&& substr_compare( $this->path
, $path, 0, strlen( $this->path
) ) == 0 );
204 protected function isUnExpired() {
205 return $this->isSessionKey ||
$this->expires
> time();
210 private $cookie = array();
213 * Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
215 * @param string $name
216 * @param string $value
219 public function setCookie( $name, $value, $attr ) {
220 /* cookies: case insensitive, so this should work.
221 * We'll still send the cookies back in the same case we got them, though.
223 $index = strtoupper( $name );
225 if ( isset( $this->cookie
[$index] ) ) {
226 $this->cookie
[$index]->set( $value, $attr );
228 $this->cookie
[$index] = new Cookie( $name, $value, $attr );
233 * @see Cookie::serializeToHttpRequest
234 * @param string $path
235 * @param string $domain
238 public function serializeToHttpRequest( $path, $domain ) {
241 foreach ( $this->cookie
as $c ) {
242 $serialized = $c->serializeToHttpRequest( $path, $domain );
245 $cookies[] = $serialized;
249 return implode( '; ', $cookies );
253 * Parse the content of an Set-Cookie HTTP Response header.
255 * @param string $cookie
256 * @param string $domain Cookie's domain
259 public function parseCookieResponseHeader( $cookie, $domain ) {
260 $len = strlen( 'Set-Cookie:' );
262 if ( substr_compare( 'Set-Cookie:', $cookie, 0, $len, true ) === 0 ) {
263 $cookie = substr( $cookie, $len );
266 $bit = array_map( 'trim', explode( ';', $cookie ) );
268 if ( count( $bit ) >= 1 ) {
269 list( $name, $value ) = explode( '=', array_shift( $bit ), 2 );
272 foreach ( $bit as $piece ) {
273 $parts = explode( '=', $piece );
274 if ( count( $parts ) > 1 ) {
275 $attr[strtolower( $parts[0] )] = $parts[1];
277 $attr[strtolower( $parts[0] )] = true;
281 if ( !isset( $attr['domain'] ) ) {
282 $attr['domain'] = $domain;
283 } elseif ( !Cookie
::validateCookieDomain( $attr['domain'], $domain ) ) {
287 $this->setCookie( $name, $value, $attr );