3 # See the bottom of this file for the POD documentation. Search for the
6 # You can run this file through either pod2man or pod2html to produce pretty
7 # documentation in manual or html file format (these utilities are part of the
8 # Perl 5 distribution).
10 # Copyright 1995-1999, Lincoln D. Stein. All rights reserved.
11 # It may be used and modified freely, but I do request that this copyright
12 # notice remain attached to the file. You may modify this module as you
13 # wish, but if you redistribute a modified version, please attach a note
14 # listing the modifications you have made.
16 $CGI::Cookie::VERSION='1.24';
18 use CGI::Util qw(rearrange unescape escape);
19 use overload '""' => \&as_string,
23 # Turn on special checking for Doug MacEachern's modperl
25 if (exists $ENV{MOD_PERL}) {
26 eval "require mod_perl";
27 if (defined $mod_perl::VERSION) {
28 my $float = $mod_perl::VERSION;
29 $float = ~ s/^.+?([\d.]+).+$/$1/;
32 require Apache::RequestUtil;
33 eval "require APR::Table"; # Changing APIs? I hope not.
41 # fetch a list of cookies from the environment and
42 # return as a hash. the cookies are parsed as normal
46 my $raw_cookie = get_raw_cookie(@_) or return;
47 return $class->parse($raw_cookie);
50 # Fetch a list of cookies from the environment or the incoming headers and
51 # return as a hash. The cookie values are not unescaped or altered in any way.
54 my $raw_cookie = get_raw_cookie(@_) or return;
58 my(@pairs) = split("; ?",$raw_cookie);
61 if (/^([^=]+)=(.*)/) {
69 $results{$key} = $value;
71 return \%results unless wantarray;
77 $r ||= eval { Apache->request() } if $MOD_PERL;
79 $raw_cookie = $r->headers_in->{'Cookie'};
81 if ($MOD_PERL && !exists $ENV{REQUEST_METHOD}) {
82 die "Run $r->subprocess_env; before calling fetch()";
84 $raw_cookie = $ENV{HTTP_COOKIE} || $ENV{COOKIE};
90 my ($self,$raw_cookie) = @_;
93 my(@pairs) = split("; ?",$raw_cookie);
96 my($key,$value) = split("=",$_,2);
98 # Some foreign cookies are not in name=value format, so ignore
100 next if !defined($value);
103 @values = map unescape($_),split(/[&;]/,$value.'&dmy');
106 $key = unescape($key);
107 # A bug in Netscape can cause several cookies with same name to
108 # appear. The FIRST one in HTTP_COOKIE is the most recent version.
109 $results{$key} ||= $self->new(-name=>$key,-value=>\@values);
111 return \%results unless wantarray;
117 $class = ref($class) if ref($class);
118 my($name,$value,$path,$domain,$secure,$expires) =
119 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@_);
121 # Pull out our parameters.
124 if (ref($value) eq 'ARRAY') {
126 } elsif (ref($value) eq 'HASH') {
138 # IE requires the path and domain to be present for some reason.
140 # however, this breaks networks which use host tables without fully qualified
141 # names, so we comment it out.
142 # $domain = CGI::virtual_host() unless defined $domain;
144 $self->path($path) if defined $path;
145 $self->domain($domain) if defined $domain;
146 $self->secure($secure) if defined $secure;
147 $self->expires($expires) if defined $expires;
148 # $self->max_age($expires) if defined $expires;
154 return "" unless $self->name;
156 my(@constant_values,$domain,$path,$expires,$max_age,$secure);
158 push(@constant_values,"domain=$domain") if $domain = $self->domain;
159 push(@constant_values,"path=$path") if $path = $self->path;
160 push(@constant_values,"expires=$expires") if $expires = $self->expires;
161 push(@constant_values,"max-age=$max_age") if $max_age = $self->max_age;
162 push(@constant_values,"secure") if $secure = $self->secure;
164 my($key) = escape($self->name);
165 my($cookie) = join("=",$key,join("&",map escape($_),$self->value));
166 return join("; ",$cookie,@constant_values);
172 return "$self" cmp $value;
179 $self->{'name'} = $name if defined $name;
180 return $self->{'name'};
186 if (defined $value) {
189 if (ref($value) eq 'ARRAY') {
191 } elsif (ref($value) eq 'HASH') {
197 $self->{'value'} = [@values];
199 return wantarray ? @{$self->{'value'}} : $self->{'value'}->[0]
205 $self->{'domain'} = lc $domain if defined $domain;
206 return $self->{'domain'};
212 $self->{'secure'} = $secure if defined $secure;
213 return $self->{'secure'};
219 $self->{'expires'} = CGI::Util::expires($expires,'cookie') if defined $expires;
220 return $self->{'expires'};
226 $self->{'max-age'} = CGI::Util::expire_calc($expires)-time() if defined $expires;
227 return $self->{'max-age'};
233 $self->{'path'} = $path if defined $path;
234 return $self->{'path'};
241 CGI::Cookie - Interface to Netscape Cookies
245 use CGI qw/:standard/;
248 # Create new cookies and send them
249 $cookie1 = new CGI::Cookie(-name=>'ID',-value=>123456);
250 $cookie2 = new CGI::Cookie(-name=>'preferences',
251 -value=>{ font => Helvetica,
254 print header(-cookie=>[$cookie1,$cookie2]);
256 # fetch existing cookies
257 %cookies = fetch CGI::Cookie;
258 $id = $cookies{'ID'}->value;
260 # create cookies returned from an external source
261 %cookies = parse CGI::Cookie($ENV{COOKIE});
265 CGI::Cookie is an interface to Netscape (HTTP/1.1) cookies, an
266 innovation that allows Web servers to store persistent information on
267 the browser's side of the connection. Although CGI::Cookie is
268 intended to be used in conjunction with CGI.pm (and is in fact used by
269 it internally), you can use this module independently.
271 For full information on cookies see
273 http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt
275 =head1 USING CGI::Cookie
277 CGI::Cookie is object oriented. Each cookie object has a name and a
278 value. The name is any scalar value. The value is any scalar or
279 array value (associative arrays are also allowed). Cookies also have
280 several optional attributes, including:
284 =item B<1. expiration date>
286 The expiration date tells the browser how long to hang on to the
287 cookie. If the cookie specifies an expiration date in the future, the
288 browser will store the cookie information in a disk file and return it
289 to the server every time the user reconnects (until the expiration
290 date is reached). If the cookie species an expiration date in the
291 past, the browser will remove the cookie from the disk file. If the
292 expiration date is not specified, the cookie will persist only until
293 the user quits the browser.
297 This is a partial or complete domain name for which the cookie is
298 valid. The browser will return the cookie to any host that matches
299 the partial domain name. For example, if you specify a domain name
300 of ".capricorn.com", then Netscape will return the cookie to
301 Web servers running on any of the machines "www.capricorn.com",
302 "ftp.capricorn.com", "feckless.capricorn.com", etc. Domain names
303 must contain at least two periods to prevent attempts to match
304 on top level domains like ".edu". If no domain is specified, then
305 the browser will only return the cookie to servers on the host the
306 cookie originated from.
310 If you provide a cookie path attribute, the browser will check it
311 against your script's URL before returning the cookie. For example,
312 if you specify the path "/cgi-bin", then the cookie will be returned
313 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl", and
314 "/cgi-bin/customer_service/complain.pl", but not to the script
315 "/cgi-private/site_admin.pl". By default, the path is set to "/", so
316 that all scripts at your site will receive the cookie.
318 =item B<4. secure flag>
320 If the "secure" attribute is set, the cookie will only be sent to your
321 script if the CGI request is occurring on a secure channel, such as SSL.
325 =head2 Creating New Cookies
327 $c = new CGI::Cookie(-name => 'foo',
330 -domain => '.capricorn.com',
331 -path => '/cgi-bin/database',
335 Create cookies from scratch with the B<new> method. The B<-name> and
336 B<-value> parameters are required. The name must be a scalar value.
337 The value can be a scalar, an array reference, or a hash reference.
338 (At some point in the future cookies will support one of the Perl
339 object serialization protocols for full generality).
341 B<-expires> accepts any of the relative or absolute date formats
342 recognized by CGI.pm, for example "+3M" for three months in the
343 future. See CGI.pm's documentation for details.
345 B<-domain> points to a domain name or to a fully qualified host name.
346 If not specified, the cookie will be returned only to the Web server
349 B<-path> points to a partial URL on the current server. The cookie
350 will be returned to all URLs beginning with the specified path. If
351 not specified, it defaults to '/', which returns the cookie to all
354 B<-secure> if set to a true value instructs the browser to return the
355 cookie only when a cryptographic protocol is in use.
357 =head2 Sending the Cookie to the Browser
359 Within a CGI script you can send a cookie to the browser by creating
360 one or more Set-Cookie: fields in the HTTP header. Here is a typical
363 my $c = new CGI::Cookie(-name => 'foo',
364 -value => ['bar','baz'],
367 print "Set-Cookie: $c\n";
368 print "Content-Type: text/html\n\n";
370 To send more than one cookie, create several Set-Cookie: fields.
372 If you are using CGI.pm, you send cookies by providing a -cookie
373 argument to the header() method:
375 print header(-cookie=>$c);
377 Mod_perl users can set cookies using the request object's header_out()
380 $r->headers_out->set('Set-Cookie' => $c);
382 Internally, Cookie overloads the "" operator to call its as_string()
383 method when incorporated into the HTTP header. as_string() turns the
384 Cookie's internal representation into an RFC-compliant text
385 representation. You may call as_string() yourself if you prefer:
387 print "Set-Cookie: ",$c->as_string,"\n";
389 =head2 Recovering Previous Cookies
391 %cookies = fetch CGI::Cookie;
393 B<fetch> returns an associative array consisting of all cookies
394 returned by the browser. The keys of the array are the cookie names. You
395 can iterate through the cookies this way:
397 %cookies = fetch CGI::Cookie;
398 foreach (keys %cookies) {
399 do_something($cookies{$_});
402 In a scalar context, fetch() returns a hash reference, which may be more
403 efficient if you are manipulating multiple cookies.
405 CGI.pm uses the URL escaping methods to save and restore reserved characters
406 in its cookies. If you are trying to retrieve a cookie set by a foreign server,
407 this escaping method may trip you up. Use raw_fetch() instead, which has the
408 same semantics as fetch(), but performs no unescaping.
410 You may also retrieve cookies that were stored in some external
411 form using the parse() class method:
413 $COOKIES = `cat /usr/tmp/Cookie_stash`;
414 %cookies = parse CGI::Cookie($COOKIES);
416 If you are in a mod_perl environment, you can save some overhead by
417 passing the request object to fetch() like this:
419 CGI::Cookie->fetch($r);
421 =head2 Manipulating Cookies
423 Cookie objects have a series of accessor methods to get and set cookie
424 attributes. Each accessor has a similar syntax. Called without
425 arguments, the accessor returns the current value of the attribute.
426 Called with an argument, the accessor changes the attribute and
427 returns its new value.
433 Get or set the cookie's name. Example:
436 $new_name = $c->name('fred');
440 Get or set the cookie's value. Example:
443 @new_value = $c->value(['a','b','c','d']);
445 B<value()> is context sensitive. In a list context it will return
446 the current value of the cookie as an array. In a scalar context it
447 will return the B<first> value of a multivalued cookie.
451 Get or set the cookie's domain.
455 Get or set the cookie's path.
459 Get or set the cookie's expiration time.
464 =head1 AUTHOR INFORMATION
466 Copyright 1997-1998, Lincoln D. Stein. All rights reserved.
468 This library is free software; you can redistribute it and/or modify
469 it under the same terms as Perl itself.
471 Address bug reports and comments to: lstein@cshl.org
475 This section intentionally left blank.