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
51 * @throws InvalidArgumentException
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 $this->path
= $attr['path'] ??
'/';
63 if ( isset( $attr['domain'] ) ) {
64 if ( self
::validateCookieDomain( $attr['domain'] ) ) {
65 $this->domain
= $attr['domain'];
68 throw new InvalidArgumentException( '$attr must contain a domain' );
73 * Return the true if the cookie is valid is valid. Otherwise,
74 * false. The uses a method similar to IE cookie security
76 * http://kuza55.blogspot.com/2008/02/understanding-cookie-security.html
77 * A better method might be to use a blacklist like
78 * http://publicsuffix.org/
80 * @todo fixme fails to detect 3-letter top-level domains
81 * @todo fixme fails to detect 2-letter top-level domains for single-domain use (probably
82 * not a big problem in practice, but there are test cases)
84 * @param string $domain The domain to validate
85 * @param string|null $originDomain (optional) the domain the cookie originates from
88 public static function validateCookieDomain( $domain, $originDomain = null ) {
89 $dc = explode( ".", $domain );
91 // Don't allow a trailing dot or addresses without a or just a leading dot
92 if ( substr( $domain, -1 ) == '.' ||
94 count( $dc ) == 2 && $dc[0] === ''
99 // Only allow full, valid IP addresses
100 if ( preg_match( '/^[0-9.]+$/', $domain ) ) {
101 if ( count( $dc ) != 4 ) {
105 if ( ip2long( $domain ) === false ) {
109 if ( $originDomain == null ||
$originDomain == $domain ) {
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 ) ) {
121 if ( ( count( $dc ) == 2 ||
( count( $dc ) == 3 && $dc[0] == '' ) )
122 && preg_match( '/(com|net|org|gov|edu)\...$/', $domain ) ) {
127 if ( $originDomain != null ) {
128 if ( substr( $domain, 0, 1 ) != '.' && $domain != $originDomain ) {
132 if ( substr( $domain, 0, 1 ) == '.'
149 * Serialize the cookie jar into a format useful for HTTP Request headers.
151 * @param string $path The path that will be used. Required.
152 * @param string $domain The domain that will be used. Required.
155 public function serializeToHttpRequest( $path, $domain ) {
158 if ( $this->canServeDomain( $domain )
159 && $this->canServePath( $path )
160 && $this->isUnExpired() ) {
161 $ret = $this->name
. '=' . $this->value
;
168 * @param string $domain
171 protected function canServeDomain( $domain ) {
172 if ( $domain == $this->domain
173 ||
( strlen( $domain ) > strlen( $this->domain
)
174 && substr( $this->domain
, 0, 1 ) == '.'
178 -strlen( $this->domain
),
179 strlen( $this->domain
),
191 * @param string $path
194 protected function canServePath( $path ) {
195 return ( $this->path
&& substr_compare( $this->path
, $path, 0, strlen( $this->path
) ) == 0 );
201 protected function isUnExpired() {
202 return $this->isSessionKey ||
$this->expires
> time();