home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _78e9673bdd7dd4922a950c9ff1a34985 < prev    next >
Encoding:
Text File  |  2000-03-23  |  11.5 KB  |  270 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>CGI::Cookie - Interface to Netscape Cookies</TITLE>
  5. <LINK REL="stylesheet" HREF="../../Active.css" TYPE="text/css">
  6. <LINK REV="made" HREF="mailto:">
  7. </HEAD>
  8.  
  9. <BODY>
  10. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  11. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  12. <STRONG><P CLASS=block> CGI::Cookie - Interface to Netscape Cookies</P></STRONG>
  13. </TD></TR>
  14. </TABLE>
  15.  
  16. <A NAME="__index__"></A>
  17. <!-- INDEX BEGIN -->
  18.  
  19. <UL>
  20.  
  21.     <LI><A HREF="#name">NAME</A></LI><LI><A HREF="#supportedplatforms">SUPPORTED PLATFORMS</A></LI>
  22.  
  23.     <LI><A HREF="#synopsis">SYNOPSIS</A></LI>
  24.     <LI><A HREF="#description">DESCRIPTION</A></LI>
  25.     <LI><A HREF="#using cgi::cookie">USING CGI::Cookie</A></LI>
  26.     <UL>
  27.  
  28.         <LI><A HREF="#creating new cookies">Creating New Cookies</A></LI>
  29.         <LI><A HREF="#sending the cookie to the browser">Sending the Cookie to the Browser</A></LI>
  30.         <LI><A HREF="#recovering previous cookies">Recovering Previous Cookies</A></LI>
  31.         <LI><A HREF="#manipulating cookies">Manipulating Cookies</A></LI>
  32.     </UL>
  33.  
  34.     <LI><A HREF="#author information">AUTHOR INFORMATION</A></LI>
  35.     <LI><A HREF="#bugs">BUGS</A></LI>
  36.     <LI><A HREF="#see also">SEE ALSO</A></LI>
  37. </UL>
  38. <!-- INDEX END -->
  39.  
  40. <HR>
  41. <P>
  42. <H1><A NAME="name">NAME</A></H1>
  43. <P>CGI::Cookie - Interface to Netscape Cookies</P>
  44. <P>
  45. <HR>
  46. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  47. <UL>
  48. <LI>Linux</LI>
  49. <LI>Solaris</LI>
  50. <LI>Windows</LI>
  51. </UL>
  52. <HR>
  53. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  54. <PRE>
  55.     use CGI qw/:standard/;
  56.     use CGI::Cookie;</PRE>
  57. <PRE>
  58.     # Create new cookies and send them
  59.     $cookie1 = new CGI::Cookie(-name=>'ID',-value=>123456);
  60.     $cookie2 = new CGI::Cookie(-name=>'preferences',
  61.                                -value=>{ font => Helvetica,
  62.                                          size => 12 } 
  63.                                );
  64.     print header(-cookie=>[$cookie1,$cookie2]);</PRE>
  65. <PRE>
  66.     # fetch existing cookies
  67.     %cookies = fetch CGI::Cookie;
  68.     $id = $cookies{'ID'}->value;</PRE>
  69. <PRE>
  70.     # create cookies returned from an external source
  71.     %cookies = parse CGI::Cookie($ENV{COOKIE});</PRE>
  72. <P>
  73. <HR>
  74. <H1><A NAME="description">DESCRIPTION</A></H1>
  75. <P>CGI::Cookie is an interface to Netscape (HTTP/1.1) cookies, an
  76. innovation that allows Web servers to store persistent information on
  77. the browser's side of the connection.  Although CGI::Cookie is
  78. intended to be used in conjunction with CGI.pm (and is in fact used by
  79. it internally), you can use this module independently.</P>
  80. <P>For full information on cookies see</P>
  81. <PRE>
  82.         <A HREF="http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt">http://www.ics.uci.edu/pub/ietf/http/rfc2109.txt</A></PRE>
  83. <P>
  84. <HR>
  85. <H1><A NAME="using cgi::cookie">USING CGI::Cookie</A></H1>
  86. <P>CGI::Cookie is object oriented.  Each cookie object has a name and a
  87. value.  The name is any scalar value.  The value is any scalar or
  88. array value (associative arrays are also allowed).  Cookies also have
  89. several optional attributes, including:</P>
  90. <OL>
  91. <LI><STRONG><A NAME="item_expiration_date"><STRONG>1. expiration date</STRONG></A></STRONG><BR>
  92.  
  93. The expiration date tells the browser how long to hang on to the
  94. cookie.  If the cookie specifies an expiration date in the future, the
  95. browser will store the cookie information in a disk file and return it
  96. to the server every time the user reconnects (until the expiration
  97. date is reached).  If the cookie species an expiration date in the
  98. past, the browser will remove the cookie from the disk file.  If the
  99. expiration date is not specified, the cookie will persist only until
  100. the user quits the browser.
  101. <P></P>
  102. <LI><STRONG><A NAME="item_domain"><STRONG>2. domain</STRONG></A></STRONG><BR>
  103.  
  104. This is a partial or complete domain name for which the cookie is 
  105. valid.  The browser will return the cookie to any host that matches
  106. the partial domain name.  For example, if you specify a domain name
  107. of ``.capricorn.com'', then Netscape will return the cookie to
  108. Web servers running on any of the machines ``www.capricorn.com'', 
  109. ``ftp.capricorn.com'', ``feckless.capricorn.com'', etc.  Domain names
  110. must contain at least two periods to prevent attempts to match
  111. on top level domains like ``.edu''.  If no domain is specified, then
  112. the browser will only return the cookie to servers on the host the
  113. cookie originated from.
  114. <P></P>
  115. <LI><STRONG><A NAME="item_path"><STRONG>3. path</STRONG></A></STRONG><BR>
  116.  
  117. If you provide a cookie path attribute, the browser will check it
  118. against your script's URL before returning the cookie.  For example,
  119. if you specify the path ``/cgi-bin'', then the cookie will be returned
  120. to each of the scripts ``/cgi-bin/tally.pl'', ``/cgi-bin/order.pl'', and
  121. ``/cgi-bin/customer_service/complain.pl'', but not to the script
  122. ``/cgi-private/site_admin.pl''.  By default, the path is set to your
  123. script, so that only it will receive the cookie.
  124. <P></P>
  125. <LI><STRONG><A NAME="item_secure_flag"><STRONG>4. secure flag</STRONG></A></STRONG><BR>
  126.  
  127. If the ``secure'' attribute is set, the cookie will only be sent to your
  128. script if the CGI request is occurring on a secure channel, such as SSL.
  129. <P></P></OL>
  130. <P>
  131. <H2><A NAME="creating new cookies">Creating New Cookies</A></H2>
  132. <PRE>
  133.         $c = new CGI::Cookie(-name    =>  'foo',
  134.                              -value   =>  'bar',
  135.                              -expires =>  '+3M',
  136.                              -domain  =>  '.capricorn.com',
  137.                              -path    =>  '/cgi-bin/database'
  138.                              -secure  =>  1
  139.                             );</PRE>
  140. <P>Create cookies from scratch with the <STRONG>new</STRONG> method.  The <STRONG>-name</STRONG> and
  141. <STRONG>-value</STRONG> parameters are required.  The name must be a scalar value.
  142. The value can be a scalar, an array reference, or a hash reference.
  143. (At some point in the future cookies will support one of the Perl
  144. object serialization protocols for full generality).</P>
  145. <P><STRONG>-expires</STRONG> accepts any of the relative or absolute date formats
  146. recognized by CGI.pm, for example ``+3M'' for three months in the
  147. future.  See CGI.pm's documentation for details.</P>
  148. <P><STRONG>-domain</STRONG> points to a domain name or to a fully qualified host name.
  149. If not specified, the cookie will be returned only to the Web server
  150. that created it.</P>
  151. <P><STRONG>-path</STRONG> points to a partial URL on the current server.  The cookie
  152. will be returned to all URLs beginning with the specified path.  If
  153. not specified, it defaults to '/', which returns the cookie to all
  154. pages at your site.</P>
  155. <P><STRONG>-secure</STRONG> if set to a true value instructs the browser to return the
  156. cookie only when a cryptographic protocol is in use.</P>
  157. <P>
  158. <H2><A NAME="sending the cookie to the browser">Sending the Cookie to the Browser</A></H2>
  159. <P>Within a CGI script you can send a cookie to the browser by creating
  160. one or more Set-Cookie: fields in the HTTP header.  Here is a typical
  161. sequence:</P>
  162. <PRE>
  163.   my $c = new CGI::Cookie(-name    =>  'foo',
  164.                           -value   =>  ['bar','baz'],
  165.                           -expires =>  '+3M');</PRE>
  166. <PRE>
  167.   print "Set-Cookie: $c\n";
  168.   print "Content-Type: text/html\n\n";</PRE>
  169. <P>To send more than one cookie, create several Set-Cookie: fields.
  170. Alternatively, you may concatenate the cookies together with ``; '' and
  171. send them in one field.</P>
  172. <P>If you are using CGI.pm, you send cookies by providing a -cookie
  173. argument to the <CODE>header()</CODE> method:</P>
  174. <PRE>
  175.   print header(-cookie=>$c);</PRE>
  176. <P>Mod_perl users can set cookies using the request object's <CODE>header_out()</CODE>
  177. method:</P>
  178. <PRE>
  179.   $r->header_out('Set-Cookie',$c);</PRE>
  180. <P>Internally, Cookie overloads the ``'' operator to call its <CODE>as_string()</CODE>
  181. method when incorporated into the HTTP header.  <CODE>as_string()</CODE> turns the
  182. Cookie's internal representation into an RFC-compliant text
  183. representation.  You may call <CODE>as_string()</CODE> yourself if you prefer:</P>
  184. <PRE>
  185.   print "Set-Cookie: ",$c->as_string,"\n";</PRE>
  186. <P>
  187. <H2><A NAME="recovering previous cookies">Recovering Previous Cookies</A></H2>
  188. <PRE>
  189.         %cookies = fetch CGI::Cookie;</PRE>
  190. <P><STRONG>fetch</STRONG> returns an associative array consisting of all cookies
  191. returned by the browser.  The keys of the array are the cookie names.  You
  192. can iterate through the cookies this way:</P>
  193. <PRE>
  194.         %cookies = fetch CGI::Cookie;
  195.         foreach (keys %cookies) {
  196.            do_something($cookies{$_});
  197.         }</PRE>
  198. <P>In a scalar context, <CODE>fetch()</CODE> returns a hash reference, which may be more
  199. efficient if you are manipulating multiple cookies.</P>
  200. <P>CGI.pm uses the URL escaping methods to save and restore reserved characters
  201. in its cookies.  If you are trying to retrieve a cookie set by a foreign server,
  202. this escaping method may trip you up.  Use <CODE>raw_fetch()</CODE> instead, which has the
  203. same semantics as fetch(), but performs no unescaping.</P>
  204. <P>You may also retrieve cookies that were stored in some external
  205. form using the <CODE>parse()</CODE> class method:</P>
  206. <PRE>
  207.        $COOKIES = `cat /usr/tmp/Cookie_stash`;
  208.        %cookies = parse CGI::Cookie($COOKIES);</PRE>
  209. <P>
  210. <H2><A NAME="manipulating cookies">Manipulating Cookies</A></H2>
  211. <P>Cookie objects have a series of accessor methods to get and set cookie
  212. attributes.  Each accessor has a similar syntax.  Called without
  213. arguments, the accessor returns the current value of the attribute.
  214. Called with an argument, the accessor changes the attribute and
  215. returns its new value.</P>
  216. <DL>
  217. <DT><STRONG><A NAME="item_name"><STRONG>name()</STRONG></A></STRONG><BR>
  218. <DD>
  219. Get or set the cookie's name.  Example:
  220. <PRE>
  221.         $name = $c->name;
  222.         $new_name = $c->name('fred');</PRE>
  223. <P></P>
  224. <DT><STRONG><A NAME="item_value"><STRONG>value()</STRONG></A></STRONG><BR>
  225. <DD>
  226. Get or set the cookie's value.  Example:
  227. <PRE>
  228.         $value = $c->value;
  229.         @new_value = $c->value(['a','b','c','d']);</PRE>
  230. <P><STRONG>value()</STRONG> is context sensitive.  In an array context it will return
  231. the current value of the cookie as an array.  In a scalar context it
  232. will return the <STRONG>first</STRONG> value of a multivalued cookie.</P>
  233. <P></P>
  234. <DT><STRONG><STRONG>domain()</STRONG></STRONG><BR>
  235. <DD>
  236. Get or set the cookie's domain.
  237. <P></P>
  238. <DT><STRONG><STRONG>path()</STRONG></STRONG><BR>
  239. <DD>
  240. Get or set the cookie's path.
  241. <P></P>
  242. <DT><STRONG><A NAME="item_expires"><STRONG>expires()</STRONG></A></STRONG><BR>
  243. <DD>
  244. Get or set the cookie's expiration time.
  245. <P></P></DL>
  246. <P>
  247. <HR>
  248. <H1><A NAME="author information">AUTHOR INFORMATION</A></H1>
  249. <P>Copyright 1997-1998, Lincoln D. Stein.  All rights reserved.</P>
  250. <P>This library is free software; you can redistribute it and/or modify
  251. it under the same terms as Perl itself.</P>
  252. <P>Address bug reports and comments to: <A HREF="mailto:lstein@cshl.org">lstein@cshl.org</A></P>
  253. <P>
  254. <HR>
  255. <H1><A NAME="bugs">BUGS</A></H1>
  256. <P>This section intentionally left blank.</P>
  257. <P>
  258. <HR>
  259. <H1><A NAME="see also">SEE ALSO</A></H1>
  260. <P><A HREF="../../lib/CGI/Carp.html">the CGI::Carp manpage</A>, <A HREF="../../lib/CGI.html">the CGI manpage</A></P>
  261. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  262. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  263. <STRONG><P CLASS=block> CGI::Cookie - Interface to Netscape Cookies</P></STRONG>
  264. </TD></TR>
  265. </TABLE>
  266.  
  267. </BODY>
  268.  
  269. </HTML>
  270.