posixtm: don't reject a time with "60" as the number of seconds
[gnulib.git] / lib / posixtm.c
1 /* Parse dates for touch and date.
2
3    Copyright (C) 1989, 1990, 1991, 1998, 2000, 2001, 2002, 2003, 2004,
4    2005, 2006, 2007, 2009 Free Software Foundation Inc.
5
6    This program is free software: you can redistribute it and/or modify
7    it under the terms of the GNU General Public License as published by
8    the Free Software Foundation; either version 3 of the License, or
9    (at your option) any later version.
10
11    This program is distributed in the hope that it will be useful,
12    but WITHOUT ANY WARRANTY; without even the implied warranty of
13    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14    GNU General Public License for more details.
15
16    You should have received a copy of the GNU General Public License
17    along with this program.  If not, see <http://www.gnu.org/licenses/>.  */
18
19 /* Yacc-based version written by Jim Kingdon and David MacKenzie.
20    Rewritten by Jim Meyering.  */
21
22 #include <config.h>
23
24 #include "posixtm.h"
25
26 #include <stdio.h>
27 #include <stdlib.h>
28 #include <sys/types.h>
29 #include <string.h>
30
31 #if USE_UNLOCKED_IO
32 # include "unlocked-io.h"
33 #endif
34
35 /* ISDIGIT differs from isdigit, as follows:
36    - Its arg may be any int or unsigned int; it need not be an unsigned char
37      or EOF.
38    - It's typically faster.
39    POSIX says that only '0' through '9' are digits.  Prefer ISDIGIT to
40    isdigit unless it's important to use the locale's definition
41    of `digit' even when the host does not conform to POSIX.  */
42 #define ISDIGIT(c) ((unsigned int) (c) - '0' <= 9)
43
44 /*
45   POSIX requires:
46
47   touch -t [[CC]YY]mmddhhmm[.ss] FILE...
48     8, 10, or 12 digits, followed by optional .ss
49     (PDS_LEADING_YEAR | PDS_CENTURY | PDS_SECONDS)
50
51   touch mmddhhmm[YY] FILE... (obsoleted by POSIX 1003.1-2001)
52     8 or 10 digits, YY (if present) must be in the range 69-99
53     (PDS_TRAILING_YEAR | PDS_PRE_2000)
54
55   date mmddhhmm[[CC]YY]
56     8, 10, or 12 digits
57     (PDS_TRAILING_YEAR | PDS_CENTURY)
58
59 */
60
61 static int
62 year (struct tm *tm, const int *digit_pair, size_t n, unsigned int syntax_bits)
63 {
64   switch (n)
65     {
66     case 1:
67       tm->tm_year = *digit_pair;
68       /* Deduce the century based on the year.
69          POSIX requires that 00-68 be interpreted as 2000-2068,
70          and that 69-99 be interpreted as 1969-1999.  */
71       if (digit_pair[0] <= 68)
72         {
73           if (syntax_bits & PDS_PRE_2000)
74             return 1;
75           tm->tm_year += 100;
76         }
77       break;
78
79     case 2:
80       if (! (syntax_bits & PDS_CENTURY))
81         return 1;
82       tm->tm_year = digit_pair[0] * 100 + digit_pair[1] - 1900;
83       break;
84
85     case 0:
86       {
87         time_t now;
88         struct tm *tmp;
89
90         /* Use current year.  */
91         time (&now);
92         tmp = localtime (&now);
93         if (! tmp)
94           return 1;
95         tm->tm_year = tmp->tm_year;
96       }
97       break;
98
99     default:
100       abort ();
101     }
102
103   return 0;
104 }
105
106 static int
107 posix_time_parse (struct tm *tm, const char *s, unsigned int syntax_bits)
108 {
109   const char *dot = NULL;
110   int pair[6];
111   int *p;
112   size_t i;
113
114   size_t s_len = strlen (s);
115   size_t len = (((syntax_bits & PDS_SECONDS) && (dot = strchr (s, '.')))
116                 ? (size_t) (dot - s)
117                 : s_len);
118
119   if (len != 8 && len != 10 && len != 12)
120     return 1;
121
122   if (dot)
123     {
124       if (!(syntax_bits & PDS_SECONDS))
125         return 1;
126
127       if (s_len - len != 3)
128         return 1;
129     }
130
131   for (i = 0; i < len; i++)
132     if (!ISDIGIT (s[i]))
133       return 1;
134
135   len /= 2;
136   for (i = 0; i < len; i++)
137     pair[i] = 10 * (s[2*i] - '0') + s[2*i + 1] - '0';
138
139   p = pair;
140   if (syntax_bits & PDS_LEADING_YEAR)
141     {
142       if (year (tm, p, len - 4, syntax_bits))
143         return 1;
144       p += len - 4;
145       len = 4;
146     }
147
148   /* Handle 8 digits worth of `MMDDhhmm'.  */
149   tm->tm_mon = *p++ - 1;
150   tm->tm_mday = *p++;
151   tm->tm_hour = *p++;
152   tm->tm_min = *p++;
153   len -= 4;
154
155   /* Handle any trailing year.  */
156   if (syntax_bits & PDS_TRAILING_YEAR)
157     {
158       if (year (tm, p, len, syntax_bits))
159         return 1;
160     }
161
162   /* Handle seconds.  */
163   if (!dot)
164     {
165       tm->tm_sec = 0;
166     }
167   else
168     {
169       int seconds;
170
171       ++dot;
172       if (!ISDIGIT (dot[0]) || !ISDIGIT (dot[1]))
173         return 1;
174       seconds = 10 * (dot[0] - '0') + dot[1] - '0';
175
176       tm->tm_sec = seconds;
177     }
178
179   return 0;
180 }
181
182 /* Parse a POSIX-style date, returning true if successful.  */
183
184 bool
185 posixtime (time_t *p, const char *s, unsigned int syntax_bits)
186 {
187   struct tm tm0;
188   struct tm tm1;
189   struct tm const *tm;
190   time_t t;
191
192   if (posix_time_parse (&tm0, s, syntax_bits))
193     return false;
194
195   tm1 = tm0;
196   tm1.tm_isdst = -1;
197   t = mktime (&tm1);
198
199   if (t != (time_t) -1)
200     tm = &tm1;
201   else
202     {
203       /* mktime returns -1 for errors, but -1 is also a valid time_t
204          value.  Check whether an error really occurred.  */
205       tm = localtime (&t);
206       if (! tm)
207         return false;
208     }
209
210   /* Reject dates like "September 31" and times like "25:61".
211      Do not reject times that specify "60" as the number of seconds.  */
212   if ((tm0.tm_year ^ tm->tm_year)
213       | (tm0.tm_mon ^ tm->tm_mon)
214       | (tm0.tm_mday ^ tm->tm_mday)
215       | (tm0.tm_hour ^ tm->tm_hour)
216       | (tm0.tm_min ^ tm->tm_min)
217       | (tm0.tm_sec ^ tm->tm_sec))
218     {
219       /* Any mismatch without 60 in the tm_sec field is invalid.  */
220       if (tm0.tm_sec != 60)
221         return false;
222
223       {
224         /* Allow times like 01:35:60 or 23:59:60.  */
225         time_t dummy;
226         char buf[16];
227         char *b = stpcpy (buf, s);
228         strcpy (b - 2, "59");
229         if (!posixtime (&dummy, buf, syntax_bits))
230           return false;
231       }
232     }
233
234   *p = t;
235   return true;
236 }
237
238 #ifdef TEST_POSIXTIME
239 /*
240     Test mainly with syntax_bits == 13
241     (aka: (PDS_LEADING_YEAR | PDS_CENTURY | PDS_SECONDS))
242
243     This test data assumes Universal Time, e.g., TZ="UTC0".
244
245     This test data also assumes that time_t is signed and is at least
246     39 bits wide, so that it can represent all years from 0000 through
247     9999.  A host with 32-bit signed time_t can represent only time
248     stamps in the range 1901-12-13 20:45:52 through 2038-01-18
249     03:14:07 UTC, assuming POSIX time_t with no leap seconds, so test
250     cases outside this range will not work on such a host.
251
252     Also, the first two lines of test data assume that the current
253     year is 2002.
254
255 BEGIN-DATA
256 12131415.16     13   1039788916 Fri Dec 13 14:15:16 2002
257 12131415.16     13   1039788916 Fri Dec 13 14:15:16 2002
258 000001010000.00 13 -62167132800 Sun Jan  1 00:00:00 0000
259 190112132045.52 13  -2147483648 Fri Dec 13 20:45:52 1901
260 190112132045.53 13  -2147483647 Fri Dec 13 20:45:53 1901
261 190112132046.52 13  -2147483588 Fri Dec 13 20:46:52 1901
262 190112132145.52 13  -2147480048 Fri Dec 13 21:45:52 1901
263 190112142045.52 13  -2147397248 Sat Dec 14 20:45:52 1901
264 190201132045.52 13  -2144805248 Mon Jan 13 20:45:52 1902
265 196912312359.59 13           -1 Wed Dec 31 23:59:59 1969
266 197001010000.00 13            0 Thu Jan  1 00:00:00 1970
267 197001010000.01 13            1 Thu Jan  1 00:00:01 1970
268 197001010001.00 13           60 Thu Jan  1 00:01:00 1970
269 197001010000.60 13           60 Thu Jan  1 00:01:00 1970
270 197001010100.00 13         3600 Thu Jan  1 01:00:00 1970
271 197001020000.00 13        86400 Fri Jan  2 00:00:00 1970
272 197002010000.00 13      2678400 Sun Feb  1 00:00:00 1970
273 197101010000.00 13     31536000 Fri Jan  1 00:00:00 1971
274 197001000000.00 13            * *
275 197000010000.00 13            * *
276 197001010060.00 13            * *
277 197001012400.00 13            * *
278 197001320000.00 13            * *
279 197013010000.00 13            * *
280 203801190314.06 13   2147483646 Tue Jan 19 03:14:06 2038
281 203801190314.07 13   2147483647 Tue Jan 19 03:14:07 2038
282 203801190314.08 13   2147483648 Tue Jan 19 03:14:08 2038
283 999912312359.59 13 253402300799 Fri Dec 31 23:59:59 9999
284 1112131415      13   1323785700 Tue Dec 13 14:15:00 2011
285 1112131415.16   13   1323785716 Tue Dec 13 14:15:16 2011
286 201112131415.16 13   1323785716 Tue Dec 13 14:15:16 2011
287 191112131415.16 13  -1831974284 Wed Dec 13 14:15:16 1911
288 203712131415.16 13   2144326516 Sun Dec 13 14:15:16 2037
289 3712131415.16   13   2144326516 Sun Dec 13 14:15:16 2037
290 6812131415.16   13   3122633716 Thu Dec 13 14:15:16 2068
291 6912131415.16   13     -1590284 Sat Dec 13 14:15:16 1969
292 7012131415.16   13     29945716 Sun Dec 13 14:15:16 1970
293 1213141599       2    945094500 Mon Dec 13 14:15:00 1999
294 1213141500       2    976716900 Wed Dec 13 14:15:00 2000
295 END-DATA
296
297 */
298
299 # define MAX_BUFF_LEN 1024
300
301 int
302 main (void)
303 {
304   char buff[MAX_BUFF_LEN + 1];
305
306   buff[MAX_BUFF_LEN] = 0;
307   while (fgets (buff, MAX_BUFF_LEN, stdin) && buff[0])
308     {
309       char time_str[MAX_BUFF_LEN];
310       unsigned int syntax_bits;
311       time_t t;
312       if (sscanf (buff, "%s %u", time_str, &syntax_bits) != 2)
313         printf ("*\n");
314       else
315         {
316           printf ("%-15s %2u ", time_str, syntax_bits);
317           if (posixtime (&t, time_str, syntax_bits))
318             printf ("%12ld %s", (long int) t, ctime (&t));
319           else
320             printf ("%12s %s", "*", "*\n");
321         }
322     }
323   exit (0);
324
325 }
326 #endif
327 \f
328 /*
329 Local Variables:
330 compile-command: "gcc -DTEST_POSIXTIME -g -O -Wall -W posixtm.c"
331 End:
332 */