Localisation updates from http://translatewiki.net.
[mediawiki.git] / includes / Cookie.php
blob1b22c0e5c734f9f56c40a223bdacbcbc0a1c4ca5
1 <?php
2 /**
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
20 * @file
21 * @ingroup HTTP
24 class Cookie {
25 protected $name;
26 protected $value;
27 protected $expires;
28 protected $path;
29 protected $domain;
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 ) {
37 $this->name = $name;
38 $this->set( $value, $attr );
41 /**
42 * Sets a cookie. Used before a request to set up any individual
43 * cookies. Used internally after a request to parse the
44 * Set-Cookie headers.
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
51 * @throws MWException
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'];
63 } else {
64 $this->path = '/';
67 if ( isset( $attr['domain'] ) ) {
68 if ( self::validateCookieDomain( $attr['domain'] ) ) {
69 $this->domain = $attr['domain'];
71 } else {
72 throw new MWException( 'You must specify a domain.' );
76 /**
77 * Return the true if the cookie is valid is valid. Otherwise,
78 * false. The uses a method similar to IE cookie security
79 * described here:
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 not a big problem in practice, but there are test cases)
87 * @param string $domain the domain to validate
88 * @param string $originDomain (optional) the domain the cookie originates from
89 * @return Boolean
91 public static function validateCookieDomain( $domain, $originDomain = null ) {
92 // Don't allow a trailing dot
93 if ( substr( $domain, -1 ) == '.' ) {
94 return false;
97 $dc = explode( ".", $domain );
99 // Only allow full, valid IP addresses
100 if ( preg_match( '/^[0-9.]+$/', $domain ) ) {
101 if ( count( $dc ) != 4 ) {
102 return false;
105 if ( ip2long( $domain ) === false ) {
106 return false;
109 if ( $originDomain == null || $originDomain == $domain ) {
110 return true;
115 // Don't allow cookies for "co.uk" or "gov.uk", etc, but allow "supermarket.uk"
116 if ( strrpos( $domain, "." ) - strlen( $domain ) == -3 ) {
117 if ( ( count( $dc ) == 2 && strlen( $dc[0] ) <= 2 )
118 || ( count( $dc ) == 3 && strlen( $dc[0] ) == "" && strlen( $dc[1] ) <= 2 ) ) {
119 return false;
121 if ( ( count( $dc ) == 2 || ( count( $dc ) == 3 && $dc[0] == '' ) )
122 && preg_match( '/(com|net|org|gov|edu)\...$/', $domain ) ) {
123 return false;
127 if ( $originDomain != null ) {
128 if ( substr( $domain, 0, 1 ) != '.' && $domain != $originDomain ) {
129 return false;
132 if ( substr( $domain, 0, 1 ) == '.'
133 && substr_compare( $originDomain, $domain, -strlen( $domain ),
134 strlen( $domain ), true ) != 0 ) {
135 return false;
139 return true;
143 * Serialize the cookie jar into a format useful for HTTP Request headers.
145 * @param string $path the path that will be used. Required.
146 * @param string $domain the domain that will be used. Required.
147 * @return String
149 public function serializeToHttpRequest( $path, $domain ) {
150 $ret = '';
152 if ( $this->canServeDomain( $domain )
153 && $this->canServePath( $path )
154 && $this->isUnExpired() ) {
155 $ret = $this->name . '=' . $this->value;
158 return $ret;
162 * @param $domain
163 * @return bool
165 protected function canServeDomain( $domain ) {
166 if ( $domain == $this->domain
167 || ( strlen( $domain ) > strlen( $this->domain )
168 && substr( $this->domain, 0, 1 ) == '.'
169 && substr_compare( $domain, $this->domain, -strlen( $this->domain ),
170 strlen( $this->domain ), true ) == 0 ) ) {
171 return true;
174 return false;
178 * @param $path
179 * @return bool
181 protected function canServePath( $path ) {
182 return ( $this->path && substr_compare( $this->path, $path, 0, strlen( $this->path ) ) == 0 );
186 * @return bool
188 protected function isUnExpired() {
189 return $this->isSessionKey || $this->expires > time();
193 class CookieJar {
194 private $cookie = array();
197 * Set a cookie in the cookie jar. Make sure only one cookie per-name exists.
198 * @see Cookie::set()
200 public function setCookie( $name, $value, $attr ) {
201 /* cookies: case insensitive, so this should work.
202 * We'll still send the cookies back in the same case we got them, though.
204 $index = strtoupper( $name );
206 if ( isset( $this->cookie[$index] ) ) {
207 $this->cookie[$index]->set( $value, $attr );
208 } else {
209 $this->cookie[$index] = new Cookie( $name, $value, $attr );
214 * @see Cookie::serializeToHttpRequest
215 * @return string
217 public function serializeToHttpRequest( $path, $domain ) {
218 $cookies = array();
220 foreach ( $this->cookie as $c ) {
221 $serialized = $c->serializeToHttpRequest( $path, $domain );
223 if ( $serialized ) {
224 $cookies[] = $serialized;
228 return implode( '; ', $cookies );
232 * Parse the content of an Set-Cookie HTTP Response header.
234 * @param $cookie String
235 * @param string $domain cookie's domain
236 * @return null
238 public function parseCookieResponseHeader( $cookie, $domain ) {
239 $len = strlen( 'Set-Cookie:' );
241 if ( substr_compare( 'Set-Cookie:', $cookie, 0, $len, true ) === 0 ) {
242 $cookie = substr( $cookie, $len );
245 $bit = array_map( 'trim', explode( ';', $cookie ) );
247 if ( count( $bit ) >= 1 ) {
248 list( $name, $value ) = explode( '=', array_shift( $bit ), 2 );
249 $attr = array();
251 foreach ( $bit as $piece ) {
252 $parts = explode( '=', $piece );
253 if ( count( $parts ) > 1 ) {
254 $attr[strtolower( $parts[0] )] = $parts[1];
255 } else {
256 $attr[strtolower( $parts[0] )] = true;
260 if ( !isset( $attr['domain'] ) ) {
261 $attr['domain'] = $domain;
262 } elseif ( !Cookie::validateCookieDomain( $attr['domain'], $domain ) ) {
263 return null;
266 $this->setCookie( $name, $value, $attr );