update from main archive 970212
[kopensolaris-gnu/glibc.git] / time / tzfile.c
1 /* Copyright (C) 1991, 92, 93, 95, 96, 97 Free Software Foundation, Inc.
2    This file is part of the GNU C Library.
3
4    The GNU C Library is free software; you can redistribute it and/or
5    modify it under the terms of the GNU Library General Public License as
6    published by the Free Software Foundation; either version 2 of the
7    License, or (at your option) any later version.
8
9    The GNU C Library is distributed in the hope that it will be useful,
10    but WITHOUT ANY WARRANTY; without even the implied warranty of
11    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
12    Library General Public License for more details.
13
14    You should have received a copy of the GNU Library General Public
15    License along with the GNU C Library; see the file COPYING.LIB.  If not,
16    write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17    Boston, MA 02111-1307, USA.  */
18
19 #include <stdlib.h>
20 #include <stdio.h>
21 #include <time.h>
22 #include <string.h>
23 #include <limits.h>
24 #include <unistd.h>
25
26 #define NOID
27 #include <tzfile.h>
28
29 int __use_tzfile = 0;
30
31 struct ttinfo
32   {
33     long int offset;            /* Seconds east of GMT.  */
34     unsigned char isdst;        /* Used to set tm_isdst.  */
35     unsigned char idx;          /* Index into `zone_names'.  */
36     unsigned char isstd;        /* Transition times are in standard time.  */
37     unsigned char isgmt;        /* Transition times are in GMT.  */
38   };
39
40 struct leap
41   {
42     time_t transition;          /* Time the transition takes effect.  */
43     long int change;            /* Seconds of correction to apply.  */
44   };
45
46 static struct ttinfo *find_transition (time_t timer);
47 static void compute_tzname_max (size_t);
48
49 static size_t num_transitions;
50 static time_t *transitions = NULL;
51 static unsigned char *type_idxs = NULL;
52 static size_t num_types;
53 static struct ttinfo *types = NULL;
54 static char *zone_names = NULL;
55 static size_t num_leaps;
56 static struct leap *leaps = NULL;
57
58 #include <endian.h>
59
60 /* Decode the four bytes at PTR as a signed integer in network byte order.  */
61 static inline int
62 decode (const void *ptr)
63 {
64   if ((BYTE_ORDER == BIG_ENDIAN) && sizeof (int) == 4)
65     return *(const int *) ptr;
66   else
67     {
68       const unsigned char *p = ptr;
69       int result = *p & (1 << (CHAR_BIT - 1)) ? ~0 : 0;
70
71       result = (result << 8) | *p++;
72       result = (result << 8) | *p++;
73       result = (result << 8) | *p++;
74       result = (result << 8) | *p++;
75
76       return result;
77     }
78 }
79
80 void
81 __tzfile_read (const char *file)
82 {
83   static const char default_tzdir[] = TZDIR;
84   size_t num_isstd, num_isgmt;
85   register FILE *f;
86   struct tzhead tzhead;
87   size_t chars;
88   register size_t i;
89   struct ttinfo *info;
90
91   __use_tzfile = 0;
92
93   if (transitions != NULL)
94     free ((void *) transitions);
95   transitions = NULL;
96   if (type_idxs != NULL)
97     free ((void *) type_idxs);
98   type_idxs = NULL;
99   if (types != NULL)
100     free ((void *) types);
101   types = NULL;
102   if (zone_names != NULL)
103     free ((void *) zone_names);
104   zone_names = NULL;
105   if (leaps != NULL)
106     free ((void *) leaps);
107   leaps = NULL;
108
109   if (file == NULL)
110     /* No user specification; use the site-wide default.  */
111     file = TZDEFAULT;
112   else if (*file == '\0')
113     /* User specified the empty string; use UTC explicitly.  */
114     file = "Universal";
115   else
116     {
117       /* We must not allow to read an arbitrary file in a setuid
118          program.  So we fail for any file which is not in the
119          directory hierachy starting at TZDIR.  */
120       if (__libc_enable_secure
121           && ((*file == '/'
122                && (memcmp(file, TZDEFAULT, sizeof(TZDEFAULT) -1))
123                && memcmp (file, default_tzdir, sizeof (default_tzdir) - 1))
124               || strstr (file, "../") != NULL))
125         /* This test a certainly a bit too restrictive but it should
126            catch all critical case.  */
127         return;
128     }
129
130   if (*file != '/')
131     {
132       const char *tzdir;
133       unsigned int len, tzdir_len;
134       char *new;
135
136       tzdir = __secure_getenv ("TZDIR");
137       if (tzdir == NULL || *tzdir == '\0')
138         {
139           tzdir = default_tzdir;
140           tzdir_len = sizeof (default_tzdir) - 1;
141         }
142       else
143         tzdir_len = strlen (tzdir);
144       len = strlen (file) + 1;
145       new = (char *) __alloca (tzdir_len + 1 + len);
146       memcpy (new, tzdir, tzdir_len);
147       new[tzdir_len] = '/';
148       memcpy (&new[tzdir_len + 1], file, len);
149       file = new;
150     }
151
152   f = fopen (file, "r");
153   if (f == NULL)
154     return;
155
156   if (fread ((void *) &tzhead, sizeof (tzhead), 1, f) != 1)
157     goto lose;
158
159   num_transitions = (size_t) decode (tzhead.tzh_timecnt);
160   num_types = (size_t) decode (tzhead.tzh_typecnt);
161   chars = (size_t) decode (tzhead.tzh_charcnt);
162   num_leaps = (size_t) decode (tzhead.tzh_leapcnt);
163   num_isstd = (size_t) decode (tzhead.tzh_ttisstdcnt);
164   num_isgmt = (size_t) decode (tzhead.tzh_ttisgmtcnt);
165
166   if (num_transitions > 0)
167     {
168       transitions = (time_t *) malloc (num_transitions * sizeof(time_t));
169       if (transitions == NULL)
170         goto lose;
171       type_idxs = (unsigned char *) malloc (num_transitions);
172       if (type_idxs == NULL)
173         goto lose;
174     }
175   if (num_types > 0)
176     {
177       types = (struct ttinfo *) malloc (num_types * sizeof (struct ttinfo));
178       if (types == NULL)
179         goto lose;
180     }
181   if (chars > 0)
182     {
183       zone_names = (char *) malloc (chars);
184       if (zone_names == NULL)
185         goto lose;
186     }
187   if (num_leaps > 0)
188     {
189       leaps = (struct leap *) malloc (num_leaps * sizeof (struct leap));
190       if (leaps == NULL)
191         goto lose;
192     }
193
194   if (sizeof (time_t) < 4)
195       abort ();
196
197   if (fread(transitions, 4, num_transitions, f) != num_transitions ||
198       fread(type_idxs, 1, num_transitions, f) != num_transitions)
199     goto lose;
200
201   /* Check for bogus indices in the data file, so we can hereafter
202      safely use type_idxs[T] as indices into `types' and never crash.  */
203   for (i = 0; i < num_transitions; ++i)
204     if (type_idxs[i] >= num_types)
205       goto lose;
206
207   if (BYTE_ORDER != BIG_ENDIAN || sizeof (time_t) != 4)
208     {
209       /* Decode the transition times, stored as 4-byte integers in
210          network (big-endian) byte order.  We work from the end of
211          the array so as not to clobber the next element to be
212          processed when sizeof (time_t) > 4.  */
213       i = num_transitions;
214       while (i-- > 0)
215         transitions[i] = decode ((char *) transitions + i*4);
216     }
217
218   for (i = 0; i < num_types; ++i)
219     {
220       unsigned char x[4];
221       if (fread (x, 1, 4, f) != 4 ||
222           fread (&types[i].isdst, 1, 1, f) != 1 ||
223           fread (&types[i].idx, 1, 1, f) != 1)
224         goto lose;
225       if (types[i].idx >= chars) /* Bogus index in data file.  */
226         goto lose;
227       types[i].offset = (long int) decode (x);
228     }
229
230   if (fread (zone_names, 1, chars, f) != chars)
231     goto lose;
232
233   for (i = 0; i < num_leaps; ++i)
234     {
235       unsigned char x[4];
236       if (fread (x, 1, sizeof (x), f) != sizeof (x))
237         goto lose;
238       leaps[i].transition = (time_t) decode (x);
239       if (fread (x, 1, sizeof (x), f) != sizeof (x))
240         goto lose;
241       leaps[i].change = (long int) decode (x);
242     }
243
244   for (i = 0; i < num_isstd; ++i)
245     {
246       char c = getc (f);
247       if (c == EOF)
248         goto lose;
249       types[i].isstd = c != 0;
250     }
251   while (i < num_types)
252     types[i++].isstd = 0;
253
254   for (i = 0; i < num_isgmt; ++i)
255     {
256       char c = getc (f);
257       if (c == EOF)
258         goto lose;
259       types[i].isgmt = c != 0;
260     }
261   while (i < num_types)
262     types[i++].isgmt = 0;
263
264   fclose (f);
265
266   info = find_transition (0);
267   for (i = 0; i < num_types && i < sizeof (__tzname) / sizeof (__tzname[0]);
268        ++i)
269     __tzname[types[i].isdst] = &zone_names[types[i].idx];
270   if (info->isdst < sizeof (__tzname) / sizeof (__tzname[0]))
271     __tzname[info->isdst] = &zone_names[info->idx];
272
273   compute_tzname_max (chars);
274
275   __use_tzfile = 1;
276   return;
277
278  lose:;
279   fclose(f);
280 }
281 \f
282 /* The user specified a hand-made timezone, but not its DST rules.
283    We will use the names and offsets from the user, and the rules
284    from the TZDEFRULES file.  */
285
286 void
287 __tzfile_default (char *std, char *dst, long int stdoff, long int dstoff)
288 {
289   size_t stdlen, dstlen, i;
290   long int rule_offset, rule_stdoff, rule_dstoff;
291   int isdst;
292
293   __tzfile_read (TZDEFRULES);
294   if (!__use_tzfile)
295     return;
296
297   if (num_types < 2)
298     {
299       __use_tzfile = 0;
300       return;
301     }
302
303   /* Ignore the zone names read from the file.  */
304   free (zone_names);
305
306   /* Use the names the user specified.  */
307   stdlen = strlen (std) + 1;
308   dstlen = strlen (dst) + 1;
309   zone_names = malloc (stdlen + dstlen);
310   if (zone_names == NULL)
311     {
312       __use_tzfile = 0;
313       return;
314     }
315   memcpy (zone_names, std, stdlen);
316   memcpy (&zone_names[stdlen], dst, dstlen);
317
318   /* Find the standard and daylight time offsets used by the rule file.
319      We choose the offsets in the types of each flavor that are
320      transitioned to earliest in time.  */
321   rule_stdoff = rule_dstoff = 0;
322   for (i = 0; i < num_transitions; ++i)
323     {
324       if (!rule_stdoff && !types[type_idxs[i]].isdst)
325         rule_stdoff = types[type_idxs[i]].offset;
326       if (!rule_dstoff && types[type_idxs[i]].isdst)
327         rule_dstoff = types[type_idxs[i]].offset;
328       if (rule_stdoff && rule_dstoff)
329         break;
330     }
331
332   /* Now correct the transition times for the user-specified standard and
333      daylight offsets from GMT.  */
334   isdst = 0;
335   rule_offset = rule_offset;
336   for (i = 0; i < num_transitions; ++i)
337     {
338       struct ttinfo *trans_type = &types[type_idxs[i]];
339
340       /* We will use only types 0 (standard) and 1 (daylight).
341          Fix up this transition to point to whichever matches
342          the flavor of its original type.  */
343       type_idxs[i] = trans_type->isdst;
344
345       if (trans_type->isgmt)
346         /* The transition time is in GMT.  No correction to apply.  */ ;
347       else if (isdst && !trans_type->isstd)
348         /* The type says this transition is in "local wall clock time", and
349            wall clock time as of the previous transition was DST.  Correct
350            for the difference between the rule's DST offset and the user's
351            DST offset.  */
352         transitions[i] += dstoff - rule_dstoff;
353       else
354         /* This transition is in "local wall clock time", and wall clock
355            time as of this iteration is non-DST.  Correct for the
356            difference between the rule's standard offset and the user's
357            standard offset.  */
358         transitions[i] += stdoff - rule_stdoff;
359
360       /* The DST state of "local wall clock time" for the next iteration is
361          as specified by this transition.  */
362       isdst = trans_type->isdst;
363     }
364
365   /* Reset types 0 and 1 to describe the user's settings.  */
366   types[0].idx = 0;
367   types[0].offset = stdoff;
368   types[0].isdst = 0;
369   types[1].idx = stdlen;
370   types[1].offset = dstoff;
371   types[1].isdst = 1;
372
373   /* Reset the zone names to point to the user's names.  */
374   __tzname[0] = &zone_names[0];
375   __tzname[1] = &zone_names[stdlen];
376
377   compute_tzname_max (stdlen + dstlen);
378 }
379 \f
380 static struct ttinfo *
381 find_transition (time_t timer)
382 {
383   size_t i;
384
385   if (num_transitions == 0 || timer < transitions[0])
386     {
387       /* TIMER is before any transition (or there are no transitions).
388          Choose the first non-DST type
389          (or the first if they're all DST types).  */
390       i = 0;
391       while (i < num_types && types[i].isdst)
392         ++i;
393       if (i == num_types)
394         i = 0;
395     }
396   else
397     {
398       /* Find the first transition after TIMER, and
399          then pick the type of the transition before it.  */
400       for (i = 1; i < num_transitions; ++i)
401         if (timer < transitions[i])
402           break;
403       i = type_idxs[i - 1];
404     }
405
406   return &types[i];
407 }
408 \f
409 int
410 __tzfile_compute (time_t timer, long int *leap_correct, int *leap_hit)
411 {
412   struct ttinfo *info;
413   register size_t i;
414
415   info = find_transition (timer);
416   __daylight = info->isdst;
417   __timezone = info->offset;
418   for (i = 0; i < num_types && i < sizeof (__tzname) / sizeof (__tzname[0]);
419        ++i)
420     __tzname[types[i].isdst] = &zone_names[types[i].idx];
421   if (info->isdst < sizeof (__tzname) / sizeof (__tzname[0]))
422     __tzname[info->isdst] = &zone_names[info->idx];
423
424   *leap_correct = 0L;
425   *leap_hit = 0;
426
427   /* Find the last leap second correction transition time before TIMER.  */
428   i = num_leaps;
429   do
430     if (i-- == 0)
431       return 1;
432   while (timer < leaps[i].transition);
433
434   /* Apply its correction.  */
435   *leap_correct = leaps[i].change;
436
437   if (timer == leaps[i].transition && /* Exactly at the transition time.  */
438       ((i == 0 && leaps[i].change > 0) ||
439        leaps[i].change > leaps[i - 1].change))
440     {
441       *leap_hit = 1;
442       while (i > 0 &&
443              leaps[i].transition == leaps[i - 1].transition + 1 &&
444              leaps[i].change == leaps[i - 1].change + 1)
445         {
446           ++*leap_hit;
447           --i;
448         }
449     }
450
451   return 1;
452 }
453 \f
454 void
455 compute_tzname_max (size_t chars)
456 {
457   extern size_t __tzname_cur_max; /* Defined in __tzset.c. */
458
459   const char *p;
460
461   p = zone_names;
462   do
463     {
464       const char *start = p;
465       while (*p != '\0')
466         ++p;
467       if ((size_t) (p - start) > __tzname_cur_max)
468         __tzname_cur_max = p - start;
469     } while (++p < &zone_names[chars]);
470 }