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

NAME

6       HTTP::Date - HTTP::Date - date conversion routines
7

VERSION

9       version 6.06
10

SYNOPSIS

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

DESCRIPTION

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

SEE ALSO

115       "time" in perlfunc, Time::Zone
116

AUTHOR

118       Gisle Aas <gisle@activestate.com>
119

121       This software is copyright (c) 1995 by Gisle Aas.
122
123       This is free software; you can redistribute it and/or modify it under
124       the same terms as the Perl 5 programming language system itself.
125
126
127
128perl v5.36.1                      2023-07-07                     HTTP::Date(3)
Impressum