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