w32: Add icons and version information.
[gnupg.git] / common / gettime.c
1 /* gettime.c - Wrapper for time functions
2  * Copyright (C) 1998, 2002, 2007, 2011 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * This file is free software; you can redistribute it and/or modify
7  * it under the terms of either
8  *
9  *   - the GNU Lesser General Public License as published by the Free
10  *     Software Foundation; either version 3 of the License, or (at
11  *     your option) any later version.
12  *
13  * or
14  *
15  *   - the GNU General Public License as published by the Free
16  *     Software Foundation; either version 2 of the License, or (at
17  *     your option) any later version.
18  *
19  * or both in parallel, as here.
20  *
21  * This file is distributed in the hope that it will be useful,
22  * but WITHOUT ANY WARRANTY; without even the implied warranty of
23  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
24  * GNU General Public License for more details.
25  *
26  * You should have received a copy of the GNU General Public License
27  * along with this program; if not, see <http://www.gnu.org/licenses/>.
28  */
29
30 #include <config.h>
31 #include <stdlib.h>
32 #include <time.h>
33 #include <ctype.h>
34 #ifdef HAVE_LANGINFO_H
35 #include <langinfo.h>
36 #endif
37
38 #include "util.h"
39 #include "i18n.h"
40 #include "gettime.h"
41
42 #ifdef HAVE_UNSIGNED_TIME_T
43 # define IS_INVALID_TIME_T(a) ((a) == (time_t)(-1))
44 #else
45   /* Error or 32 bit time_t and value after 2038-01-19.  */
46 # define IS_INVALID_TIME_T(a) ((a) < 0)
47 #endif
48
49
50 static unsigned long timewarp;
51 static enum { NORMAL = 0, FROZEN, FUTURE, PAST } timemode;
52
53 /* Correction used to map to real Julian days. */
54 #define JD_DIFF 1721060L
55
56
57 /* Wrapper for the time(3).  We use this here so we can fake the time
58    for tests */
59 time_t
60 gnupg_get_time ()
61 {
62   time_t current = time (NULL);
63   if (timemode == NORMAL)
64     return current;
65   else if (timemode == FROZEN)
66     return timewarp;
67   else if (timemode == FUTURE)
68     return current + timewarp;
69   else
70     return current - timewarp;
71 }
72
73
74 /* Return the current time (possibly faked) in ISO format. */
75 void
76 gnupg_get_isotime (gnupg_isotime_t timebuf)
77 {
78   time_t atime = gnupg_get_time ();
79
80   if (atime == (time_t)(-1))
81     *timebuf = 0;
82   else
83     {
84       struct tm *tp;
85 #ifdef HAVE_GMTIME_R
86       struct tm tmbuf;
87
88       tp = gmtime_r (&atime, &tmbuf);
89 #else
90       tp = gmtime (&atime);
91 #endif
92       snprintf (timebuf, 16, "%04d%02d%02dT%02d%02d%02d",
93                 1900 + tp->tm_year, tp->tm_mon+1, tp->tm_mday,
94                 tp->tm_hour, tp->tm_min, tp->tm_sec);
95     }
96 }
97
98
99 /* Set the time to NEWTIME so that gnupg_get_time returns a time
100    starting with this one.  With FREEZE set to 1 the returned time
101    will never change.  Just for completeness, a value of (time_t)-1
102    for NEWTIME gets you back to reality.  Note that this is obviously
103    not thread-safe but this is not required. */
104 void
105 gnupg_set_time (time_t newtime, int freeze)
106 {
107   time_t current = time (NULL);
108
109   if ( newtime == (time_t)-1 || current == newtime)
110     {
111       timemode = NORMAL;
112       timewarp = 0;
113     }
114   else if (freeze)
115     {
116       timemode = FROZEN;
117       timewarp = current;
118     }
119   else if (newtime > current)
120     {
121       timemode = FUTURE;
122       timewarp = newtime - current;
123     }
124   else
125     {
126       timemode = PAST;
127       timewarp = current - newtime;
128     }
129 }
130
131 /* Returns true when we are in timewarp mode */
132 int
133 gnupg_faked_time_p (void)
134 {
135   return timemode;
136 }
137
138
139 /* This function is used by gpg because OpenPGP defines the timestamp
140    as an unsigned 32 bit value. */
141 u32
142 make_timestamp (void)
143 {
144   time_t t = gnupg_get_time ();
145
146   if (t == (time_t)-1)
147     log_fatal ("gnupg_get_time() failed\n");
148   return (u32)t;
149 }
150
151
152
153 /****************
154  * Scan a date string and return a timestamp.
155  * The only supported format is "yyyy-mm-dd"
156  * Returns 0 for an invalid date.
157  */
158 u32
159 scan_isodatestr( const char *string )
160 {
161     int year, month, day;
162     struct tm tmbuf;
163     time_t stamp;
164     int i;
165
166     if( strlen(string) != 10 || string[4] != '-' || string[7] != '-' )
167         return 0;
168     for( i=0; i < 4; i++ )
169         if( !digitp (string+i) )
170             return 0;
171     if( !digitp (string+5) || !digitp(string+6) )
172         return 0;
173     if( !digitp(string+8) || !digitp(string+9) )
174         return 0;
175     year = atoi(string);
176     month = atoi(string+5);
177     day = atoi(string+8);
178     /* some basic checks */
179     if( year < 1970 || month < 1 || month > 12 || day < 1 || day > 31 )
180         return 0;
181     memset( &tmbuf, 0, sizeof tmbuf );
182     tmbuf.tm_mday = day;
183     tmbuf.tm_mon = month-1;
184     tmbuf.tm_year = year - 1900;
185     tmbuf.tm_isdst = -1;
186     stamp = mktime( &tmbuf );
187     if( stamp == (time_t)-1 )
188         return 0;
189     return stamp;
190 }
191
192
193 int
194 isotime_p (const char *string)
195 {
196   const char *s;
197   int i;
198
199   if (!*string)
200     return 0;
201   for (s=string, i=0; i < 8; i++, s++)
202     if (!digitp (s))
203       return 0;
204   if (*s != 'T')
205       return 0;
206   for (s++, i=9; i < 15; i++, s++)
207     if (!digitp (s))
208       return 0;
209   if ( !(!*s || (isascii (*s) && isspace(*s)) || *s == ':' || *s == ','))
210     return 0;  /* Wrong delimiter.  */
211
212   return 1;
213 }
214
215
216 /* Scan a string and return true if the string represents the human
217    readable format of an ISO time.  This format is:
218       yyyy-mm-dd[ hh[:mm[:ss]]]
219    Scanning stops at the second space or at a comma.  */
220 int
221 isotime_human_p (const char *string)
222 {
223   const char *s;
224   int i;
225
226   if (!*string)
227     return 0;
228   for (s=string, i=0; i < 4; i++, s++)
229     if (!digitp (s))
230       return 0;
231   if (*s != '-')
232     return 0;
233   s++;
234   if (!digitp (s) || !digitp (s+1) || s[2] != '-')
235     return 0;
236   i = atoi_2 (s);
237   if (i < 1 || i > 12)
238     return 0;
239   s += 3;
240   if (!digitp (s) || !digitp (s+1))
241     return 0;
242   i = atoi_2 (s);
243   if (i < 1 || i > 31)
244     return 0;
245   s += 2;
246   if (!*s || *s == ',')
247     return 1; /* Okay; only date given.  */
248   if (!spacep (s))
249     return 0;
250   s++;
251   if (spacep (s))
252     return 1; /* Okay, second space stops scanning.  */
253   if (!digitp (s) || !digitp (s+1))
254     return 0;
255   i = atoi_2 (s);
256   if (i < 0 || i > 23)
257     return 0;
258   s += 2;
259   if (!*s || *s == ',')
260     return 1; /* Okay; only date and hour given.  */
261   if (*s != ':')
262     return 0;
263   s++;
264   if (!digitp (s) || !digitp (s+1))
265     return 0;
266   i = atoi_2 (s);
267   if (i < 0 || i > 59)
268     return 0;
269   s += 2;
270   if (!*s || *s == ',')
271     return 1; /* Okay; only date, hour and minute given.  */
272   if (*s != ':')
273     return 0;
274   s++;
275   if (!digitp (s) || !digitp (s+1))
276     return 0;
277   i = atoi_2 (s);
278   if (i < 0 || i > 60)
279     return 0;
280   s += 2;
281   if (!*s || *s == ',' || spacep (s))
282     return 1; /* Okay; date, hour and minute and second given.  */
283
284   return 0; /* Unexpected delimiter.  */
285 }
286
287 /* Convert a standard isotime or a human readable variant into an
288    isotime structure.  The allowed formats are those described by
289    isotime_p and isotime_human_p.  The function returns 0 on failure
290    or the length of the scanned string on success.  */
291 size_t
292 string2isotime (gnupg_isotime_t atime, const char *string)
293 {
294   gnupg_isotime_t dummyatime;
295
296   if (!atime)
297     atime = dummyatime;
298
299   atime[0] = 0;
300   if (isotime_p (string))
301     {
302       memcpy (atime, string, 15);
303       atime[15] = 0;
304       return 15;
305     }
306   if (!isotime_human_p (string))
307     return 0;
308   atime[0] = string[0];
309   atime[1] = string[1];
310   atime[2] = string[2];
311   atime[3] = string[3];
312   atime[4] = string[5];
313   atime[5] = string[6];
314   atime[6] = string[8];
315   atime[7] = string[9];
316   atime[8] = 'T';
317   memset (atime+9, '0', 6);
318   atime[15] = 0;
319   if (!spacep (string+10))
320     return 10;
321   if (spacep (string+11))
322     return 11; /* As per def, second space stops scanning.  */
323   atime[9] = string[11];
324   atime[10] = string[12];
325   if (string[13] != ':')
326     return 13;
327   atime[11] = string[14];
328   atime[12] = string[15];
329   if (string[16] != ':')
330     return 16;
331   atime[13] = string[17];
332   atime[14] = string[18];
333   return 19;
334 }
335
336
337 /* Scan an ISO timestamp and return an Epoch based timestamp.  The only
338    supported format is "yyyymmddThhmmss" delimited by white space, nul, a
339    colon or a comma.  Returns (time_t)(-1) for an invalid string.  */
340 time_t
341 isotime2epoch (const char *string)
342 {
343   int year, month, day, hour, minu, sec;
344   struct tm tmbuf;
345
346   if (!isotime_p (string))
347     return (time_t)(-1);
348
349   year  = atoi_4 (string);
350   month = atoi_2 (string + 4);
351   day   = atoi_2 (string + 6);
352   hour  = atoi_2 (string + 9);
353   minu  = atoi_2 (string + 11);
354   sec   = atoi_2 (string + 13);
355
356   /* Basic checks.  */
357   if (year < 1970 || month < 1 || month > 12 || day < 1 || day > 31
358       || hour > 23 || minu > 59 || sec > 61 )
359     return (time_t)(-1);
360
361   memset (&tmbuf, 0, sizeof tmbuf);
362   tmbuf.tm_sec  = sec;
363   tmbuf.tm_min  = minu;
364   tmbuf.tm_hour = hour;
365   tmbuf.tm_mday = day;
366   tmbuf.tm_mon  = month-1;
367   tmbuf.tm_year = year - 1900;
368   tmbuf.tm_isdst = -1;
369   return timegm (&tmbuf);
370 }
371
372
373 /* Convert an Epoch time to an iso time stamp. */
374 void
375 epoch2isotime (gnupg_isotime_t timebuf, time_t atime)
376 {
377   if (atime == (time_t)(-1))
378     *timebuf = 0;
379   else
380     {
381       struct tm *tp;
382 #ifdef HAVE_GMTIME_R
383       struct tm tmbuf;
384
385       tp = gmtime_r (&atime, &tmbuf);
386 #else
387       tp = gmtime (&atime);
388 #endif
389       snprintf (timebuf, 16, "%04d%02d%02dT%02d%02d%02d",
390                 1900 + tp->tm_year, tp->tm_mon+1, tp->tm_mday,
391                 tp->tm_hour, tp->tm_min, tp->tm_sec);
392     }
393 }
394
395
396
397
398 u32
399 add_days_to_timestamp( u32 stamp, u16 days )
400 {
401     return stamp + days*86400L;
402 }
403
404
405 /****************
406  * Return a string with a time value in the form: x Y, n D, n H
407  */
408
409 const char *
410 strtimevalue( u32 value )
411 {
412     static char buffer[30];
413     unsigned int years, days, hours, minutes;
414
415     value /= 60;
416     minutes = value % 60;
417     value /= 60;
418     hours = value % 24;
419     value /= 24;
420     days = value % 365;
421     value /= 365;
422     years = value;
423
424     sprintf(buffer,"%uy%ud%uh%um", years, days, hours, minutes );
425     if( years )
426         return buffer;
427     if( days )
428         return strchr( buffer, 'y' ) + 1;
429     return strchr( buffer, 'd' ) + 1;
430 }
431
432
433 /*
434  * Note: this function returns GMT
435  */
436 const char *
437 strtimestamp (u32 stamp)
438 {
439   static char buffer[11+5];
440   struct tm *tp;
441   time_t atime = stamp;
442
443   if (IS_INVALID_TIME_T (atime))
444     {
445       strcpy (buffer, "????" "-??" "-??");
446     }
447   else
448     {
449       tp = gmtime( &atime );
450       snprintf (buffer, sizeof buffer, "%04d-%02d-%02d",
451                 1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
452     }
453   return buffer;
454 }
455
456
457 /*
458  * Note: this function returns GMT
459  */
460 const char *
461 isotimestamp (u32 stamp)
462 {
463   static char buffer[25+5];
464   struct tm *tp;
465   time_t atime = stamp;
466
467   if (IS_INVALID_TIME_T (atime))
468     {
469       strcpy (buffer, "????" "-??" "-??" " " "??" ":" "??" ":" "??");
470     }
471   else
472     {
473       tp = gmtime ( &atime );
474       snprintf (buffer, sizeof buffer, "%04d-%02d-%02d %02d:%02d:%02d",
475                 1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday,
476                 tp->tm_hour, tp->tm_min, tp->tm_sec);
477     }
478   return buffer;
479 }
480
481
482 /****************
483  * Note: this function returns local time
484  */
485 const char *
486 asctimestamp (u32 stamp)
487 {
488   static char buffer[50];
489 #if defined (HAVE_STRFTIME) && defined (HAVE_NL_LANGINFO)
490   static char fmt[50];
491 #endif
492   struct tm *tp;
493   time_t atime = stamp;
494
495   if (IS_INVALID_TIME_T (atime))
496     {
497       strcpy (buffer, "????" "-??" "-??");
498       return buffer;
499     }
500
501   tp = localtime( &atime );
502 #ifdef HAVE_STRFTIME
503 # if defined(HAVE_NL_LANGINFO)
504   mem2str( fmt, nl_langinfo(D_T_FMT), DIM(fmt)-3 );
505   if (!strstr( fmt, "%Z" ))
506     strcat( fmt, " %Z");
507   /* NOTE: gcc -Wformat-noliteral will complain here.  I have found no
508      way to suppress this warning.  */
509   strftime (buffer, DIM(buffer)-1, fmt, tp);
510 # elif defined(HAVE_W32CE_SYSTEM)
511   /* tzset is not available but %Z nevertheless prints a default
512      nonsense timezone ("WILDABBR").  Thus we don't print the time
513      zone at all.  */
514   strftime (buffer, DIM(buffer)-1, "%c", tp);
515 # else
516    /* FIXME: we should check whether the locale appends a " %Z" These
517     * locales from glibc don't put the " %Z": fi_FI hr_HR ja_JP lt_LT
518     * lv_LV POSIX ru_RU ru_SU sv_FI sv_SE zh_CN.  */
519   strftime (buffer, DIM(buffer)-1, "%c %Z", tp);
520 # endif
521   buffer[DIM(buffer)-1] = 0;
522 #else
523   mem2str( buffer, asctime(tp), DIM(buffer) );
524 #endif
525   return buffer;
526 }
527
528
529
530 static int
531 days_per_year (int y)
532 {
533   int s ;
534
535   s = !(y % 4);
536   if ( !(y % 100))
537     if ((y%400))
538       s = 0;
539   return s ? 366 : 365;
540 }
541
542 static int
543 days_per_month (int y, int m)
544 {
545   int s;
546
547   switch(m)
548     {
549     case 1: case 3: case 5: case 7: case 8: case 10: case 12:
550       return 31 ;
551     case 2:
552       s = !(y % 4);
553       if (!(y % 100))
554         if ((y % 400))
555           s = 0;
556       return s? 29 : 28 ;
557     case 4: case 6: case 9: case 11:
558       return 30;
559     }
560   BUG();
561 }
562
563
564 /* Convert YEAR, MONTH and DAY into the Julian date.  We assume that
565    it is already noon.  We do not support dates before 1582-10-15. */
566 static unsigned long
567 date2jd (int year, int month, int day)
568 {
569   unsigned long jd;
570
571   jd = 365L * year + 31 * (month-1) + day + JD_DIFF;
572   if (month < 3)
573     year-- ;
574   else
575     jd -= (4 * month + 23) / 10;
576
577   jd += year / 4 - ((year / 100 + 1) *3) / 4;
578
579   return jd ;
580 }
581
582 /* Convert a Julian date back to YEAR, MONTH and DAY.  Return day of
583    the year or 0 on error.  This function uses some more or less
584    arbitrary limits, most important is that days before 1582 are not
585    supported. */
586 static int
587 jd2date (unsigned long jd, int *year, int *month, int *day)
588 {
589   int y, m, d;
590   long delta;
591
592   if (!jd)
593     return 0 ;
594   if (jd < 1721425 || jd > 2843085)
595     return 0;
596
597   y = (jd - JD_DIFF) / 366;
598   d = m = 1;
599
600   while ((delta = jd - date2jd (y, m, d)) > days_per_year (y))
601     y++;
602
603   m = (delta / 31) + 1;
604   while( (delta = jd - date2jd (y, m, d)) > days_per_month (y,m))
605     if (++m > 12)
606       {
607         m = 1;
608         y++;
609       }
610
611   d = delta + 1 ;
612   if (d > days_per_month (y, m))
613     {
614       d = 1;
615       m++;
616     }
617   if (m > 12)
618     {
619       m = 1;
620       y++;
621     }
622
623   if (year)
624     *year = y;
625   if (month)
626     *month = m;
627   if (day)
628     *day = d ;
629
630   return (jd - date2jd (y, 1, 1)) + 1;
631 }
632
633
634 /* Check that the 15 bytes in ATIME represent a valid ISO time.  Note
635    that this function does not expect a string but a plain 15 byte
636    isotime buffer. */
637 gpg_error_t
638 check_isotime (const gnupg_isotime_t atime)
639 {
640   int i;
641   const char *s;
642
643   if (!*atime)
644     return gpg_error (GPG_ERR_NO_VALUE);
645
646   for (s=atime, i=0; i < 8; i++, s++)
647     if (!digitp (s))
648       return gpg_error (GPG_ERR_INV_TIME);
649   if (*s != 'T')
650       return gpg_error (GPG_ERR_INV_TIME);
651   for (s++, i=9; i < 15; i++, s++)
652     if (!digitp (s))
653       return gpg_error (GPG_ERR_INV_TIME);
654   return 0;
655 }
656
657
658 /* Dump the ISO time T to the log stream without a LF.  */
659 void
660 dump_isotime (const gnupg_isotime_t t)
661 {
662   if (!t || !*t)
663     log_printf ("%s", _("[none]"));
664   else
665     log_printf ("%.4s-%.2s-%.2s %.2s:%.2s:%s",
666                 t, t+4, t+6, t+9, t+11, t+13);
667 }
668
669
670 /* Copy one ISO date to another, this is inline so that we can do a
671    minimal sanity check.  A null date (empty string) is allowed.  */
672 void
673 gnupg_copy_time (gnupg_isotime_t d, const gnupg_isotime_t s)
674 {
675   if (*s)
676     {
677       if ((strlen (s) != 15 || s[8] != 'T'))
678         BUG();
679       memcpy (d, s, 15);
680       d[15] = 0;
681     }
682   else
683     *d = 0;
684 }
685
686
687 /* Add SECONDS to ATIME.  SECONDS may not be negative and is limited
688    to about the equivalent of 62 years which should be more then
689    enough for our purposes. */
690 gpg_error_t
691 add_seconds_to_isotime (gnupg_isotime_t atime, int nseconds)
692 {
693   gpg_error_t err;
694   int year, month, day, hour, minute, sec, ndays;
695   unsigned long jd;
696
697   err = check_isotime (atime);
698   if (err)
699     return err;
700
701   if (nseconds < 0 || nseconds >= (0x7fffffff - 61) )
702     return gpg_error (GPG_ERR_INV_VALUE);
703
704   year  = atoi_4 (atime+0);
705   month = atoi_2 (atime+4);
706   day   = atoi_2 (atime+6);
707   hour  = atoi_2 (atime+9);
708   minute= atoi_2 (atime+11);
709   sec   = atoi_2 (atime+13);
710
711   if (year <= 1582) /* The julian date functions don't support this. */
712     return gpg_error (GPG_ERR_INV_VALUE);
713
714   sec    += nseconds;
715   minute += sec/60;
716   sec    %= 60;
717   hour   += minute/60;
718   minute %= 60;
719   ndays  = hour/24;
720   hour   %= 24;
721
722   jd = date2jd (year, month, day) + ndays;
723   jd2date (jd, &year, &month, &day);
724
725   if (year > 9999 || month > 12 || day > 31
726       || year < 0 || month < 1 || day < 1)
727     return gpg_error (GPG_ERR_INV_VALUE);
728
729   snprintf (atime, 16, "%04d%02d%02dT%02d%02d%02d",
730             year, month, day, hour, minute, sec);
731   return 0;
732 }
733
734
735 gpg_error_t
736 add_days_to_isotime (gnupg_isotime_t atime, int ndays)
737 {
738   gpg_error_t err;
739   int year, month, day, hour, minute, sec;
740   unsigned long jd;
741
742   err = check_isotime (atime);
743   if (err)
744     return err;
745
746   if (ndays < 0 || ndays >= 9999*366 )
747     return gpg_error (GPG_ERR_INV_VALUE);
748
749   year  = atoi_4 (atime+0);
750   month = atoi_2 (atime+4);
751   day   = atoi_2 (atime+6);
752   hour  = atoi_2 (atime+9);
753   minute= atoi_2 (atime+11);
754   sec   = atoi_2 (atime+13);
755
756   if (year <= 1582) /* The julian date functions don't support this. */
757     return gpg_error (GPG_ERR_INV_VALUE);
758
759   jd = date2jd (year, month, day) + ndays;
760   jd2date (jd, &year, &month, &day);
761
762   if (year > 9999 || month > 12 || day > 31
763       || year < 0 || month < 1 || day < 1)
764     return gpg_error (GPG_ERR_INV_VALUE);
765
766   snprintf (atime, 16, "%04d%02d%02dT%02d%02d%02d",
767             year, month, day, hour, minute, sec);
768   return 0;
769 }