home *** CD-ROM | disk | FTP | other *** search
/ Chip 2000 May / Chip_2000-05_cd1.bin / zkuste / Perl / ActivePerl-5.6.0.613.msi / 䆊䌷䈹䈙䏵-䞅䞆䞀㡆䞃䄦䠥 / _37130bbdc1af84e2a71e66be42e9e929 < prev    next >
Text File  |  2000-03-23  |  7KB  |  158 lines
  1.  
  2. <HTML>
  3. <HEAD>
  4. <TITLE>HTTP::Date - date conversion routines</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> HTTP::Date - date conversion routines</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="#see also">SEE ALSO</A></LI>
  26.     <LI><A HREF="#copyright">COPYRIGHT</A></LI>
  27. </UL>
  28. <!-- INDEX END -->
  29.  
  30. <HR>
  31. <P>
  32. <H1><A NAME="name">NAME</A></H1>
  33. <P>HTTP::Date - date conversion routines</P>
  34. <P>
  35. <HR>
  36. <H1><A NAME="supportedplatforms">SUPPORTED PLATFORMS</A></H1>
  37. <UL>
  38. <LI>Linux</LI>
  39. <LI>Solaris</LI>
  40. <LI>Windows</LI>
  41. </UL>
  42. <HR>
  43. <H1><A NAME="synopsis">SYNOPSIS</A></H1>
  44. <PRE>
  45.  use HTTP::Date;</PRE>
  46. <PRE>
  47.  $string = time2str($time);    # Format as GMT ASCII time
  48.  $time = str2time($string);    # convert ASCII date to machine time</PRE>
  49. <P>
  50. <HR>
  51. <H1><A NAME="description">DESCRIPTION</A></H1>
  52. <P>This module provides functions that deal the date formats used by the
  53. HTTP protocol (and then some more).  Only the first two functions,
  54. <A HREF="#item_time2str"><CODE>time2str()</CODE></A> and str2time(), are exported by default.</P>
  55. <DL>
  56. <DT><STRONG><A NAME="item_time2str">time2str( [$time] )</A></STRONG><BR>
  57. <DD>
  58. The <A HREF="#item_time2str"><CODE>time2str()</CODE></A> function converts a machine time (seconds since epoch)
  59. to a string.  If the function is called without an argument, it will
  60. use the current time.
  61. <P>The string returned is in the format preferred for the HTTP protocol.
  62. This is a fixed length subset of the format defined by RFC 1123,
  63. represented in Universal Time (GMT).  An example of a time stamp
  64. in this format is:</P>
  65. <PRE>
  66.    Sun, 06 Nov 1994 08:49:37 GMT</PRE>
  67. <P></P>
  68. <DT><STRONG><A NAME="item_str2time">str2time( $str [, $zone] )</A></STRONG><BR>
  69. <DD>
  70. The <A HREF="#item_str2time"><CODE>str2time()</CODE></A> function converts a string to machine time.  It returns
  71. <A HREF="../../../lib/Pod/perlfunc.html#item_undef"><CODE>undef</CODE></A> if the format of $str is unrecognized, or the time is outside
  72. the representable range.  The time formats recognized are the same as
  73. for parse_date().
  74. <P>The function also takes an optional second argument that specifies the
  75. default time zone to use when converting the date.  This parameter is
  76. ignored if the zone is found in the date string itself.  If this
  77. parameter is missing, and the date string format does not contain any
  78. zone specification, then the local time zone is assumed.</P>
  79. <P>If the zone is not ``<CODE>GMT</CODE>'' or numerical (like ``<CODE>-0800</CODE>'' or
  80. ``<CODE>+0100</CODE>''), then the <CODE>Time::Zone</CODE> module must be installed in order
  81. to get the date recognized.</P>
  82. <P></P>
  83. <DT><STRONG><A NAME="item_parse_date">parse_date( $str )</A></STRONG><BR>
  84. <DD>
  85. This function will try to parse a date string, and then return it as a
  86. list of numerical values followed by a (possible undefined) time zone
  87. specifier; ($year, $month, $day, $hour, $min, $sec, $tz).  The $year
  88. returned will <STRONG>not</STRONG> have the number 1900 subtracted from it and the
  89. $month numbers start with 1.
  90. <P>In scalar context the numbers are interpolated in a string of the
  91. ``YYYY-MM-DD hh:mm:ss TZ''-format and returned.</P>
  92. <P>If the date is unrecognized, then the empty list is returned.</P>
  93. <P>The function is able to parse the following formats:</P>
  94. <PRE>
  95.  "Wed, 09 Feb 1994 22:23:32 GMT"       -- HTTP format
  96.  "Thu Feb  3 17:03:55 GMT 1994"        -- ctime(3) format
  97.  "Thu Feb  3 00:00:00 1994",           -- ANSI C asctime() format
  98.  "Tuesday, 08-Feb-94 14:15:29 GMT"     -- old rfc850 HTTP format
  99.  "Tuesday, 08-Feb-1994 14:15:29 GMT"   -- broken rfc850 HTTP format</PRE>
  100. <PRE>
  101.  "03/Feb/1994:17:03:55 -0700"   -- common logfile format
  102.  "09 Feb 1994 22:23:32 GMT"     -- HTTP format (no weekday)
  103.  "08-Feb-94 14:15:29 GMT"       -- rfc850 format (no weekday)
  104.  "08-Feb-1994 14:15:29 GMT"     -- broken rfc850 format (no weekday)</PRE>
  105. <PRE>
  106.  "1994-02-03 14:15:29 -0100"    -- ISO 8601 format
  107.  "1994-02-03 14:15:29"          -- zone is optional
  108.  "1994-02-03"                   -- only date
  109.  "1994-02-03T14:15:29"          -- Use T as separator
  110.  "19940203T141529Z"             -- ISO 8601 compact format
  111.  "19940203"                     -- only date</PRE>
  112. <PRE>
  113.  "08-Feb-94"         -- old rfc850 HTTP format    (no weekday, no time)
  114.  "08-Feb-1994"       -- broken rfc850 HTTP format (no weekday, no time)
  115.  "09 Feb 1994"       -- proposed new HTTP format  (no weekday, no time)
  116.  "03/Feb/1994"       -- common logfile format     (no time, no offset)</PRE>
  117. <PRE>
  118.  "Feb  3  1994"      -- Unix 'ls -l' format
  119.  "Feb  3 17:03"      -- Unix 'ls -l' format</PRE>
  120. <PRE>
  121.  "11-15-96  03:52PM" -- Windows 'dir' format</PRE>
  122. <P>The parser ignores leading and trailing whitespace.  It also allow the
  123. seconds to be missing and the month to be numerical in most formats.</P>
  124. <P>If the year is missing, then we assume that the date is the first
  125. matching date <EM>before</EM> current month.  If the year is given with only
  126. 2 digits, then <A HREF="#item_parse_date"><CODE>parse_date()</CODE></A> will select the century that makes the
  127. year closest to the current date.</P>
  128. <P></P>
  129. <DT><STRONG><A NAME="item_time2iso">time2iso( [$time] )</A></STRONG><BR>
  130. <DD>
  131. Same as time2str(), but returns a ``YYYY-MM-DD hh:mm:ss''-formatted
  132. string representing time in the local time zone.
  133. <P></P>
  134. <DT><STRONG><A NAME="item_time2isoz">time2isoz( [$time] )</A></STRONG><BR>
  135. <DD>
  136. Same as time2str(), but returns a ``YYYY-MM-DD hh:mm:ssZ''-formatted
  137. string representing Universal Time.
  138. <P></P></DL>
  139. <P>
  140. <HR>
  141. <H1><A NAME="see also">SEE ALSO</A></H1>
  142. <P><A HREF="../../../lib/Pod/perlfunc.html#time">time in the perlfunc manpage</A>, <A HREF="../../../site/lib/Time/Zone.html">the Time::Zone manpage</A></P>
  143. <P>
  144. <HR>
  145. <H1><A NAME="copyright">COPYRIGHT</A></H1>
  146. <P>Copyright 1995-1999, Gisle Aas</P>
  147. <P>This library is free software; you can redistribute it and/or
  148. modify it under the same terms as Perl itself.</P>
  149. <TABLE BORDER=0 CELLPADDING=0 CELLSPACING=0 WIDTH=100%>
  150. <TR><TD CLASS=block VALIGN=MIDDLE WIDTH=100% BGCOLOR="#cccccc">
  151. <STRONG><P CLASS=block> HTTP::Date - date conversion routines</P></STRONG>
  152. </TD></TR>
  153. </TABLE>
  154.  
  155. </BODY>
  156.  
  157. </HTML>
  158.