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 if ($mod_perl::VERSION >= 1.99) {
30 require Apache::RequestUtil;
38 # fetch a list of cookies from the environment and
39 # return as a hash. the cookies are parsed as normal
43 my $raw_cookie = get_raw_cookie(@_) or return;
44 return $class->parse($raw_cookie);
47 # Fetch a list of cookies from the environment or the incoming headers and
48 # return as a hash. The cookie values are not unescaped or altered in any way.
51 my $raw_cookie = get_raw_cookie(@_) or return;
55 my(@pairs) = split("; ?",$raw_cookie);
58 if (/^([^=]+)=(.*)/) {
66 $results{$key} = $value;
68 return \%results unless wantarray;
74 $r ||= eval { Apache->request() } if $MOD_PERL;
76 $raw_cookie = $r->headers_in->{'Cookie'};
78 if ($MOD_PERL && !exists $ENV{REQUEST_METHOD}) {
79 die "Run $r->subprocess_env; before calling fetch()";
81 $raw_cookie = $ENV{HTTP_COOKIE} || $ENV{COOKIE};
87 my ($self,$raw_cookie) = @_;
90 my(@pairs) = split("; ?",$raw_cookie);
93 my($key,$value) = split("=",$_,2);
95 # Some foreign cookies are not in name=value format, so ignore
97 next if !defined($value);
100 @values = map unescape($_),split(/[&;]/,$value.'&dmy');
103 $key = unescape($key);
104 # A bug in Netscape can cause several cookies with same name to
105 # appear. The FIRST one in HTTP_COOKIE is the most recent version.
106 $results{$key} ||= $self->new(-name=>$key,-value=>\@values);
108 return \%results unless wantarray;
114 $class = ref($class) if ref($class);
115 my($name,$value,$path,$domain,$secure,$expires) =
116 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@_);
118 # Pull out our parameters.
121 if (ref($value) eq 'ARRAY') {
123 } elsif (ref($value) eq 'HASH') {
135 # IE requires the path and domain to be present for some reason.
137 # however, this breaks networks which use host tables without fully qualified
138 # names, so we comment it out.
139 # $domain = CGI::virtual_host() unless defined $domain;
141 $self->path($path) if defined $path;
142 $self->domain($domain) if defined $domain;
143 $self->secure($secure) if defined $secure;
144 $self->expires($expires) if defined $expires;
145 # $self->max_age($expires) if defined $expires;
151 return "" unless $self->name;
153 my(@constant_values,$domain,$path,$expires,$max_age,$secure);
155 push(@constant_values,"domain=$domain") if $domain = $self->domain;
156 push(@constant_values,"path=$path") if $path = $self->path;
157 push(@constant_values,"expires=$expires") if $expires = $self->expires;
158 push(@constant_values,"max-age=$max_age") if $max_age = $self->max_age;
159 push(@constant_values,"secure") if $secure = $self->secure;
161 my($key) = escape($self->name);
162 my($cookie) = join("=",$key,join("&",map escape($_),$self->value));
163 return join("; ",$cookie,@constant_values);
169 return "$self" cmp $value;
176 $self->{'name'} = $name if defined $name;
177 return $self->{'name'};
183 if (defined $value) {
186 if (ref($value) eq 'ARRAY') {
188 } elsif (ref($value) eq 'HASH') {
194 $self->{'value'} = [@values];
196 return wantarray ? @{$self->{'value'}} : $self->{'value'}->[0]
202 $self->{'domain'} = $domain if defined $domain;
203 return $self->{'domain'};
209 $self->{'secure'} = $secure if defined $secure;
210 return $self->{'secure'};
216 $self->{'expires'} = CGI::Util::expires($expires,'cookie') if defined $expires;
217 return $self->{'expires'};
223 $self->{'max-age'} = CGI::Util::expire_calc($expires)-time() if defined $expires;
224 return $self->{'max-age'};
230 $self->{'path'} = $path if defined $path;
231 return $self->{'path'};
238 CGI::Cookie - Interface to Netscape Cookies
242 use CGI qw/:standard/;
245 # Create new cookies and send them
246 $cookie1 = new CGI::Cookie(-name=>'ID',-value=>123456);
247 $cookie2 = new CGI::Cookie(-name=>'preferences',
248 -value=>{ font => Helvetica,
251 print header(-cookie=>[$cookie1,$cookie2]);
253 # fetch existing cookies
254 %cookies = fetch CGI::Cookie;
255 $id = $cookies{'ID'}->value;
257 # create cookies returned from an external source
258 %cookies = parse CGI::Cookie($ENV{COOKIE});
262 CGI::Cookie is an interface to Netscape (HTTP/1.1) cookies, an
263 innovation that allows Web servers to store persistent information on
264 the browser's side of the connection. Although CGI::Cookie is
265 intended to be used in conjunction with CGI.pm (and is in fact used by
266 it internally), you can use this module independently.
268 For full information on cookies see
270 http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt
272 =head1 USING CGI::Cookie
274 CGI::Cookie is object oriented. Each cookie object has a name and a
275 value. The name is any scalar value. The value is any scalar or
276 array value (associative arrays are also allowed). Cookies also have
277 several optional attributes, including:
281 =item B<1. expiration date>
283 The expiration date tells the browser how long to hang on to the
284 cookie. If the cookie specifies an expiration date in the future, the
285 browser will store the cookie information in a disk file and return it
286 to the server every time the user reconnects (until the expiration
287 date is reached). If the cookie species an expiration date in the
288 past, the browser will remove the cookie from the disk file. If the
289 expiration date is not specified, the cookie will persist only until
290 the user quits the browser.
294 This is a partial or complete domain name for which the cookie is
295 valid. The browser will return the cookie to any host that matches
296 the partial domain name. For example, if you specify a domain name
297 of ".capricorn.com", then Netscape will return the cookie to
298 Web servers running on any of the machines "www.capricorn.com",
299 "ftp.capricorn.com", "feckless.capricorn.com", etc. Domain names
300 must contain at least two periods to prevent attempts to match
301 on top level domains like ".edu". If no domain is specified, then
302 the browser will only return the cookie to servers on the host the
303 cookie originated from.
307 If you provide a cookie path attribute, the browser will check it
308 against your script's URL before returning the cookie. For example,
309 if you specify the path "/cgi-bin", then the cookie will be returned
310 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl", and
311 "/cgi-bin/customer_service/complain.pl", but not to the script
312 "/cgi-private/site_admin.pl". By default, the path is set to "/", so
313 that all scripts at your site will receive the cookie.
315 =item B<4. secure flag>
317 If the "secure" attribute is set, the cookie will only be sent to your
318 script if the CGI request is occurring on a secure channel, such as SSL.
322 =head2 Creating New Cookies
324 $c = new CGI::Cookie(-name => 'foo',
327 -domain => '.capricorn.com',
328 -path => '/cgi-bin/database',
332 Create cookies from scratch with the B<new> method. The B<-name> and
333 B<-value> parameters are required. The name must be a scalar value.
334 The value can be a scalar, an array reference, or a hash reference.
335 (At some point in the future cookies will support one of the Perl
336 object serialization protocols for full generality).
338 B<-expires> accepts any of the relative or absolute date formats
339 recognized by CGI.pm, for example "+3M" for three months in the
340 future. See CGI.pm's documentation for details.
342 B<-domain> points to a domain name or to a fully qualified host name.
343 If not specified, the cookie will be returned only to the Web server
346 B<-path> points to a partial URL on the current server. The cookie
347 will be returned to all URLs beginning with the specified path. If
348 not specified, it defaults to '/', which returns the cookie to all
351 B<-secure> if set to a true value instructs the browser to return the
352 cookie only when a cryptographic protocol is in use.
354 =head2 Sending the Cookie to the Browser
356 Within a CGI script you can send a cookie to the browser by creating
357 one or more Set-Cookie: fields in the HTTP header. Here is a typical
360 my $c = new CGI::Cookie(-name => 'foo',
361 -value => ['bar','baz'],
364 print "Set-Cookie: $c\n";
365 print "Content-Type: text/html\n\n";
367 To send more than one cookie, create several Set-Cookie: fields.
369 If you are using CGI.pm, you send cookies by providing a -cookie
370 argument to the header() method:
372 print header(-cookie=>$c);
374 Mod_perl users can set cookies using the request object's header_out()
377 $r->headers_out->set('Set-Cookie' => $c);
379 Internally, Cookie overloads the "" operator to call its as_string()
380 method when incorporated into the HTTP header. as_string() turns the
381 Cookie's internal representation into an RFC-compliant text
382 representation. You may call as_string() yourself if you prefer:
384 print "Set-Cookie: ",$c->as_string,"\n";
386 =head2 Recovering Previous Cookies
388 %cookies = fetch CGI::Cookie;
390 B<fetch> returns an associative array consisting of all cookies
391 returned by the browser. The keys of the array are the cookie names. You
392 can iterate through the cookies this way:
394 %cookies = fetch CGI::Cookie;
395 foreach (keys %cookies) {
396 do_something($cookies{$_});
399 In a scalar context, fetch() returns a hash reference, which may be more
400 efficient if you are manipulating multiple cookies.
402 CGI.pm uses the URL escaping methods to save and restore reserved characters
403 in its cookies. If you are trying to retrieve a cookie set by a foreign server,
404 this escaping method may trip you up. Use raw_fetch() instead, which has the
405 same semantics as fetch(), but performs no unescaping.
407 You may also retrieve cookies that were stored in some external
408 form using the parse() class method:
410 $COOKIES = `cat /usr/tmp/Cookie_stash`;
411 %cookies = parse CGI::Cookie($COOKIES);
413 If you are in a mod_perl environment, you can save some overhead by
414 passing the request object to fetch() like this:
416 CGI::Cookie->fetch($r);
418 =head2 Manipulating Cookies
420 Cookie objects have a series of accessor methods to get and set cookie
421 attributes. Each accessor has a similar syntax. Called without
422 arguments, the accessor returns the current value of the attribute.
423 Called with an argument, the accessor changes the attribute and
424 returns its new value.
430 Get or set the cookie's name. Example:
433 $new_name = $c->name('fred');
437 Get or set the cookie's value. Example:
440 @new_value = $c->value(['a','b','c','d']);
442 B<value()> is context sensitive. In a list context it will return
443 the current value of the cookie as an array. In a scalar context it
444 will return the B<first> value of a multivalued cookie.
448 Get or set the cookie's domain.
452 Get or set the cookie's path.
456 Get or set the cookie's expiration time.
461 =head1 AUTHOR INFORMATION
463 Copyright 1997-1998, Lincoln D. Stein. All rights reserved.
465 This library is free software; you can redistribute it and/or modify
466 it under the same terms as Perl itself.
468 Address bug reports and comments to: lstein@cshl.org
472 This section intentionally left blank.