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.21';
18 use CGI::Util qw(rearrange unescape escape);
19 use overload '""' => \&as_string,
23 # fetch a list of cookies from the environment and
24 # return as a hash. the cookies are parsed as normal
28 my $raw_cookie = $ENV{HTTP_COOKIE} || $ENV{COOKIE};
29 return () unless $raw_cookie;
30 return $class->parse($raw_cookie);
33 # fetch a list of cookies from the environment and
34 # return as a hash. the cookie values are not unescaped
35 # or altered in any way.
38 my $raw_cookie = $ENV{HTTP_COOKIE} || $ENV{COOKIE};
39 return () unless $raw_cookie;
43 my(@pairs) = split("; ?",$raw_cookie);
46 if (/^([^=]+)=(.*)/) {
54 $results{$key} = $value;
56 return \%results unless wantarray;
62 my ($self,$raw_cookie) = @_;
65 my(@pairs) = split("; ?",$raw_cookie);
68 my($key,$value) = split("=",$_,2);
70 # Some foreign cookies are not in name=value format, so ignore
72 next if !defined($value);
75 @values = map unescape($_),split(/[&;]/,$value.'&dmy');
78 $key = unescape($key);
79 # A bug in Netscape can cause several cookies with same name to
80 # appear. The FIRST one in HTTP_COOKIE is the most recent version.
81 $results{$key} ||= $self->new(-name=>$key,-value=>\@values);
83 return \%results unless wantarray;
89 $class = ref($class) if ref($class);
90 my($name,$value,$path,$domain,$secure,$expires) =
91 rearrange([NAME,[VALUE,VALUES],PATH,DOMAIN,SECURE,EXPIRES],@_);
93 # Pull out our parameters.
96 if (ref($value) eq 'ARRAY') {
98 } elsif (ref($value) eq 'HASH') {
110 # IE requires the path and domain to be present for some reason.
112 # however, this breaks networks which use host tables without fully qualified
113 # names, so we comment it out.
114 # $domain = CGI::virtual_host() unless defined $domain;
116 $self->path($path) if defined $path;
117 $self->domain($domain) if defined $domain;
118 $self->secure($secure) if defined $secure;
119 $self->expires($expires) if defined $expires;
120 # $self->max_age($expires) if defined $expires;
126 return "" unless $self->name;
128 my(@constant_values,$domain,$path,$expires,$max_age,$secure);
130 push(@constant_values,"domain=$domain") if $domain = $self->domain;
131 push(@constant_values,"path=$path") if $path = $self->path;
132 push(@constant_values,"expires=$expires") if $expires = $self->expires;
133 push(@constant_values,"max-age=$max_age") if $max_age = $self->max_age;
134 push(@constant_values,"secure") if $secure = $self->secure;
136 my($key) = escape($self->name);
137 my($cookie) = join("=",$key,join("&",map escape($_),$self->value));
138 return join("; ",$cookie,@constant_values);
144 return "$self" cmp $value;
151 $self->{'name'} = $name if defined $name;
152 return $self->{'name'};
158 if (defined $value) {
161 if (ref($value) eq 'ARRAY') {
163 } elsif (ref($value) eq 'HASH') {
169 $self->{'value'} = [@values];
171 return wantarray ? @{$self->{'value'}} : $self->{'value'}->[0]
177 $self->{'domain'} = $domain if defined $domain;
178 return $self->{'domain'};
184 $self->{'secure'} = $secure if defined $secure;
185 return $self->{'secure'};
191 $self->{'expires'} = CGI::Util::expires($expires,'cookie') if defined $expires;
192 return $self->{'expires'};
198 $self->{'max-age'} = CGI::Util::expire_calc($expires)-time if defined $expires;
199 return $self->{'max-age'};
205 $self->{'path'} = $path if defined $path;
206 return $self->{'path'};
213 CGI::Cookie - Interface to Netscape Cookies
217 use CGI qw/:standard/;
220 # Create new cookies and send them
221 $cookie1 = new CGI::Cookie(-name=>'ID',-value=>123456);
222 $cookie2 = new CGI::Cookie(-name=>'preferences',
223 -value=>{ font => Helvetica,
226 print header(-cookie=>[$cookie1,$cookie2]);
228 # fetch existing cookies
229 %cookies = fetch CGI::Cookie;
230 $id = $cookies{'ID'}->value;
232 # create cookies returned from an external source
233 %cookies = parse CGI::Cookie($ENV{COOKIE});
237 CGI::Cookie is an interface to Netscape (HTTP/1.1) cookies, an
238 innovation that allows Web servers to store persistent information on
239 the browser's side of the connection. Although CGI::Cookie is
240 intended to be used in conjunction with CGI.pm (and is in fact used by
241 it internally), you can use this module independently.
243 For full information on cookies see
245 http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt
247 =head1 USING CGI::Cookie
249 CGI::Cookie is object oriented. Each cookie object has a name and a
250 value. The name is any scalar value. The value is any scalar or
251 array value (associative arrays are also allowed). Cookies also have
252 several optional attributes, including:
256 =item B<1. expiration date>
258 The expiration date tells the browser how long to hang on to the
259 cookie. If the cookie specifies an expiration date in the future, the
260 browser will store the cookie information in a disk file and return it
261 to the server every time the user reconnects (until the expiration
262 date is reached). If the cookie species an expiration date in the
263 past, the browser will remove the cookie from the disk file. If the
264 expiration date is not specified, the cookie will persist only until
265 the user quits the browser.
269 This is a partial or complete domain name for which the cookie is
270 valid. The browser will return the cookie to any host that matches
271 the partial domain name. For example, if you specify a domain name
272 of ".capricorn.com", then Netscape will return the cookie to
273 Web servers running on any of the machines "www.capricorn.com",
274 "ftp.capricorn.com", "feckless.capricorn.com", etc. Domain names
275 must contain at least two periods to prevent attempts to match
276 on top level domains like ".edu". If no domain is specified, then
277 the browser will only return the cookie to servers on the host the
278 cookie originated from.
282 If you provide a cookie path attribute, the browser will check it
283 against your script's URL before returning the cookie. For example,
284 if you specify the path "/cgi-bin", then the cookie will be returned
285 to each of the scripts "/cgi-bin/tally.pl", "/cgi-bin/order.pl", and
286 "/cgi-bin/customer_service/complain.pl", but not to the script
287 "/cgi-private/site_admin.pl". By default, the path is set to "/", so
288 that all scripts at your site will receive the cookie.
290 =item B<4. secure flag>
292 If the "secure" attribute is set, the cookie will only be sent to your
293 script if the CGI request is occurring on a secure channel, such as SSL.
297 =head2 Creating New Cookies
299 $c = new CGI::Cookie(-name => 'foo',
302 -domain => '.capricorn.com',
303 -path => '/cgi-bin/database',
307 Create cookies from scratch with the B<new> method. The B<-name> and
308 B<-value> parameters are required. The name must be a scalar value.
309 The value can be a scalar, an array reference, or a hash reference.
310 (At some point in the future cookies will support one of the Perl
311 object serialization protocols for full generality).
313 B<-expires> accepts any of the relative or absolute date formats
314 recognized by CGI.pm, for example "+3M" for three months in the
315 future. See CGI.pm's documentation for details.
317 B<-domain> points to a domain name or to a fully qualified host name.
318 If not specified, the cookie will be returned only to the Web server
321 B<-path> points to a partial URL on the current server. The cookie
322 will be returned to all URLs beginning with the specified path. If
323 not specified, it defaults to '/', which returns the cookie to all
326 B<-secure> if set to a true value instructs the browser to return the
327 cookie only when a cryptographic protocol is in use.
329 =head2 Sending the Cookie to the Browser
331 Within a CGI script you can send a cookie to the browser by creating
332 one or more Set-Cookie: fields in the HTTP header. Here is a typical
335 my $c = new CGI::Cookie(-name => 'foo',
336 -value => ['bar','baz'],
339 print "Set-Cookie: $c\n";
340 print "Content-Type: text/html\n\n";
342 To send more than one cookie, create several Set-Cookie: fields.
343 Alternatively, you may concatenate the cookies together with "; " and
344 send them in one field.
346 If you are using CGI.pm, you send cookies by providing a -cookie
347 argument to the header() method:
349 print header(-cookie=>$c);
351 Mod_perl users can set cookies using the request object's header_out()
354 $r->header_out('Set-Cookie',$c);
356 Internally, Cookie overloads the "" operator to call its as_string()
357 method when incorporated into the HTTP header. as_string() turns the
358 Cookie's internal representation into an RFC-compliant text
359 representation. You may call as_string() yourself if you prefer:
361 print "Set-Cookie: ",$c->as_string,"\n";
363 =head2 Recovering Previous Cookies
365 %cookies = fetch CGI::Cookie;
367 B<fetch> returns an associative array consisting of all cookies
368 returned by the browser. The keys of the array are the cookie names. You
369 can iterate through the cookies this way:
371 %cookies = fetch CGI::Cookie;
372 foreach (keys %cookies) {
373 do_something($cookies{$_});
376 In a scalar context, fetch() returns a hash reference, which may be more
377 efficient if you are manipulating multiple cookies.
379 CGI.pm uses the URL escaping methods to save and restore reserved characters
380 in its cookies. If you are trying to retrieve a cookie set by a foreign server,
381 this escaping method may trip you up. Use raw_fetch() instead, which has the
382 same semantics as fetch(), but performs no unescaping.
384 You may also retrieve cookies that were stored in some external
385 form using the parse() class method:
387 $COOKIES = `cat /usr/tmp/Cookie_stash`;
388 %cookies = parse CGI::Cookie($COOKIES);
390 =head2 Manipulating Cookies
392 Cookie objects have a series of accessor methods to get and set cookie
393 attributes. Each accessor has a similar syntax. Called without
394 arguments, the accessor returns the current value of the attribute.
395 Called with an argument, the accessor changes the attribute and
396 returns its new value.
402 Get or set the cookie's name. Example:
405 $new_name = $c->name('fred');
409 Get or set the cookie's value. Example:
412 @new_value = $c->value(['a','b','c','d']);
414 B<value()> is context sensitive. In a list context it will return
415 the current value of the cookie as an array. In a scalar context it
416 will return the B<first> value of a multivalued cookie.
420 Get or set the cookie's domain.
424 Get or set the cookie's path.
428 Get or set the cookie's expiration time.
433 =head1 AUTHOR INFORMATION
435 Copyright 1997-1998, Lincoln D. Stein. All rights reserved.
437 This library is free software; you can redistribute it and/or modify
438 it under the same terms as Perl itself.
440 Address bug reports and comments to: lstein@cshl.org
444 This section intentionally left blank.