1HTTP::Date(3)         User Contributed Perl Documentation        HTTP::Date(3)
2
3
4

NAME

6       HTTP::Date - date conversion routines
7

SYNOPSIS

9        use HTTP::Date;
10
11        $string = time2str($time);    # Format as GMT ASCII time
12        $time = str2time($string);    # convert ASCII date to machine time
13

DESCRIPTION

15       This module provides functions that deal the date formats used by the
16       HTTP protocol (and then some more).  Only the first two functions,
17       time2str() and str2time(), are exported by default.
18
19       time2str( [$time] )
20           The time2str() function converts a machine time (seconds since
21           epoch) to a string.  If the function is called without an argument
22           or with an undefined argument, it will use the current time.
23
24           The string returned is in the format preferred for the HTTP
25           protocol.  This is a fixed length subset of the format defined by
26           RFC 1123, represented in Universal Time (GMT).  An example of a
27           time stamp in this format is:
28
29              Sun, 06 Nov 1994 08:49:37 GMT
30
31       str2time( $str [, $zone] )
32           The str2time() function converts a string to machine time.  It
33           returns "undef" if the format of $str is unrecognized, otherwise
34           whatever the "Time::Local" functions can make out of the parsed
35           time.  Dates before the system's epoch may not work on all
36           operating systems.  The time formats recognized are the same as for
37           parse_date().
38
39           The function also takes an optional second argument that specifies
40           the default time zone to use when converting the date.  This
41           parameter is ignored if the zone is found in the date string
42           itself.  If this parameter is missing, and the date string format
43           does not contain any zone specification, then the local time zone
44           is assumed.
45
46           If the zone is not ""GMT"" or numerical (like ""-0800"" or
47           "+0100"), then the "Time::Zone" module must be installed in order
48           to get the date recognized.
49
50       parse_date( $str )
51           This function will try to parse a date string, and then return it
52           as a list of numerical values followed by a (possible undefined)
53           time zone specifier; ($year, $month, $day, $hour, $min, $sec, $tz).
54           The $year returned will not have the number 1900 subtracted from it
55           and the $month numbers start with 1.
56
57           In scalar context the numbers are interpolated in a string of the
58           "YYYY-MM-DD hh:mm:ss TZ"-format and returned.
59
60           If the date is unrecognized, then the empty list is returned.
61
62           The function is able to parse the following formats:
63
64            "Wed, 09 Feb 1994 22:23:32 GMT"       -- HTTP format
65            "Thu Feb  3 17:03:55 GMT 1994"        -- ctime(3) format
66            "Thu Feb  3 00:00:00 1994",           -- ANSI C asctime() format
67            "Tuesday, 08-Feb-94 14:15:29 GMT"     -- old rfc850 HTTP format
68            "Tuesday, 08-Feb-1994 14:15:29 GMT"   -- broken rfc850 HTTP format
69
70            "03/Feb/1994:17:03:55 -0700"   -- common logfile format
71            "09 Feb 1994 22:23:32 GMT"     -- HTTP format (no weekday)
72            "08-Feb-94 14:15:29 GMT"       -- rfc850 format (no weekday)
73            "08-Feb-1994 14:15:29 GMT"     -- broken rfc850 format (no weekday)
74
75            "1994-02-03 14:15:29 -0100"    -- ISO 8601 format
76            "1994-02-03 14:15:29"          -- zone is optional
77            "1994-02-03"                   -- only date
78            "1994-02-03T14:15:29"          -- Use T as separator
79            "19940203T141529Z"             -- ISO 8601 compact format
80            "19940203"                     -- only date
81
82            "08-Feb-94"         -- old rfc850 HTTP format    (no weekday, no time)
83            "08-Feb-1994"       -- broken rfc850 HTTP format (no weekday, no time)
84            "09 Feb 1994"       -- proposed new HTTP format  (no weekday, no time)
85            "03/Feb/1994"       -- common logfile format     (no time, no offset)
86
87            "Feb  3  1994"      -- Unix 'ls -l' format
88            "Feb  3 17:03"      -- Unix 'ls -l' format
89
90            "11-15-96  03:52PM" -- Windows 'dir' format
91
92           The parser ignores leading and trailing whitespace.  It also allow
93           the seconds to be missing and the month to be numerical in most
94           formats.
95
96           If the year is missing, then we assume that the date is the first
97           matching date before current month.  If the year is given with only
98           2 digits, then parse_date() will select the century that makes the
99           year closest to the current date.
100
101       time2iso( [$time] )
102           Same as time2str(), but returns a "YYYY-MM-DD hh:mm:ss"-formatted
103           string representing time in the local time zone.
104
105       time2isoz( [$time] )
106           Same as time2str(), but returns a "YYYY-MM-DD hh:mm:ssZ"-formatted
107           string representing Universal Time.
108

SEE ALSO

110       "time" in perlfunc, Time::Zone
111

113       Copyright 1995-1999, Gisle Aas
114
115       This library is free software; you can redistribute it and/or modify it
116       under the same terms as Perl itself.
117
118
119
120perl v5.12.4                      2009-10-03                     HTTP::Date(3)
Impressum