2 * Copyright © 2010 Codethink Limited
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Lesser General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the licence, or (at your option) any later version.
9 * This 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 * Lesser General Public License for more details.
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
19 * Author: Ryan Lortie <desrt@desrt.ca>
24 #include "gtimezone.h"
30 #include "gmappedfile.h"
31 #include "gtestutils.h"
32 #include "gfileutils.h"
33 #include "gstrfuncs.h"
36 #include "gbufferprivate.h"
41 * @short_description: A structure representing a time zone
42 * @see_also: #GDateTime
44 * #GTimeZone is a structure that represents a time zone, at no
45 * particular point in time. It is refcounted and immutable.
47 * A time zone contains a number of intervals. Each interval has
48 * an abbreviation to describe it, an offet to UTC and a flag indicating
49 * if the daylight savings time is in effect during that interval. A
50 * time zone always has at least one interval -- interval 0.
52 * Every UTC time is contained within exactly one interval, but a given
53 * local time may be contained within zero, one or two intervals (due to
54 * incontinuities associated with daylight savings time).
56 * An interval may refer to a specific period of time (eg: the duration
57 * of daylight savings time during 2010) or it may refer to many periods
58 * of time that share the same properties (eg: all periods of daylight
59 * savings time). It is also possible (usually for political reasons)
60 * that some properties (like the abbreviation) change between intervals
61 * without other properties changing.
63 * #GTimeZone is available since GLib 2.26.
69 * #GDateTime is an opaque structure whose members cannot be accessed
75 /* zoneinfo file format {{{1 */
78 typedef struct { gchar bytes[8]; } gint64_be;
79 typedef struct { gchar bytes[4]; } gint32_be;
80 typedef struct { gchar bytes[4]; } guint32_be;
82 static inline gint64 gint64_from_be (const gint64_be be) {
83 gint64 tmp; memcpy (&tmp, &be, sizeof tmp); return GINT64_FROM_BE (tmp);
86 static inline gint32 gint32_from_be (const gint32_be be) {
87 gint32 tmp; memcpy (&tmp, &be, sizeof tmp); return GINT32_FROM_BE (tmp);
90 static inline guint32 guint32_from_be (const guint32_be be) {
91 guint32 tmp; memcpy (&tmp, &be, sizeof tmp); return GUINT32_FROM_BE (tmp);
98 guchar tzh_reserved[15];
100 guint32_be tzh_ttisgmtcnt;
101 guint32_be tzh_ttisstdcnt;
102 guint32_be tzh_leapcnt;
103 guint32_be tzh_timecnt;
104 guint32_be tzh_typecnt;
105 guint32_be tzh_charcnt;
115 /* GTimeZone structure and lifecycle {{{1 */
122 const struct tzhead *header;
123 const struct ttinfo *infos;
124 const gint64_be *trans;
125 const guint8 *indices;
132 G_LOCK_DEFINE_STATIC (time_zones);
133 static GHashTable/*<string?, GTimeZone>*/ *time_zones;
139 * Decreases the reference count on @tz.
144 g_time_zone_unref (GTimeZone *tz)
149 ref_count = g_atomic_int_get (&tz->ref_count);
151 g_assert (ref_count > 0);
155 if (tz->name != NULL)
159 /* someone else might have grabbed a ref in the meantime */
160 if G_UNLIKELY (g_atomic_int_get (&tz->ref_count) != 1)
162 G_UNLOCK(time_zones);
166 g_hash_table_remove (time_zones, tz->name);
167 G_UNLOCK(time_zones);
171 g_buffer_unref (tz->zoneinfo);
175 g_slice_free (GTimeZone, tz);
178 else if G_UNLIKELY (!g_atomic_int_compare_and_exchange (&tz->ref_count,
188 * Increases the reference count on @tz.
190 * Returns: a new reference to @tz.
195 g_time_zone_ref (GTimeZone *tz)
197 g_assert (tz->ref_count > 0);
199 g_atomic_int_inc (&tz->ref_count);
204 /* fake zoneinfo creation (for RFC3339/ISO 8601 timezones) {{{1 */
206 * parses strings of the form 'hh' 'hhmm' or 'hh:mm' where:
211 parse_time (const gchar *time_,
214 if (*time_ < '0' || '2' < *time_)
217 *offset = 10 * 60 * 60 * (*time_++ - '0');
219 if (*time_ < '0' || '9' < *time_)
222 *offset += 60 * 60 * (*time_++ - '0');
224 if (*offset > 23 * 60 * 60)
233 if (*time_ < '0' || '5' < *time_)
236 *offset += 10 * 60 * (*time_++ - '0');
238 if (*time_ < '0' || '9' < *time_)
241 *offset += 60 * (*time_++ - '0');
243 return *time_ == '\0';
247 parse_constant_offset (const gchar *name,
257 return parse_time (name, offset);
260 if (parse_time (name, offset))
272 zone_for_constant_offset (const gchar *name)
274 const gchar fake_zoneinfo_headers[] =
275 "TZif" "2..." "...." "...." "...."
276 "\0\0\0\0" "\0\0\0\0" "\0\0\0\0" "\0\0\0\0" "\0\0\0\0" "\0\0\0\0"
277 "TZif" "2..." "...." "...." "...."
278 "\0\0\0\0" "\0\0\0\0" "\0\0\0\0" "\0\0\0\0" "\0\0\0\1" "\0\0\0\7";
280 struct tzhead headers[2];
286 if (name == NULL || !parse_constant_offset (name, &offset))
289 offset = GINT32_TO_BE (offset);
291 fake = g_malloc (sizeof *fake);
292 memcpy (fake, fake_zoneinfo_headers, sizeof fake_zoneinfo_headers);
293 memcpy (&fake->info.tt_gmtoff, &offset, sizeof offset);
294 fake->info.tt_isdst = FALSE;
295 fake->info.tt_abbrind = 0;
296 strcpy (fake->abbr, name);
298 return g_buffer_new_take_data (fake, sizeof *fake);
301 /* Construction {{{1 */
304 * @identifier: (allow-none): a timezone identifier
306 * Creates a #GTimeZone corresponding to @identifier.
308 * @identifier can either be an RFC3339/ISO 8601 time offset or
309 * something that would pass as a valid value for the
310 * <varname>TZ</varname> environment variable (including %NULL).
312 * Valid RFC3339 time offsets are <literal>"Z"</literal> (for UTC) or
313 * <literal>"±hh:mm"</literal>. ISO 8601 additionally specifies
314 * <literal>"±hhmm"</literal> and <literal>"±hh"</literal>.
316 * The <varname>TZ</varname> environment variable typically corresponds
317 * to the name of a file in the zoneinfo database, but there are many
318 * other possibilities. Note that those other possibilities are not
319 * currently implemented, but are planned.
321 * g_time_zone_new_local() calls this function with the value of the
322 * <varname>TZ</varname> environment variable. This function itself is
323 * independent of the value of <varname>TZ</varname>, but if @identifier
324 * is %NULL then <filename>/etc/localtime</filename> will be consulted
325 * to discover the correct timezone.
328 * url='http://tools.ietf.org/html/rfc3339#section-5.6'>RFC3339
329 * §5.6</ulink> for a precise definition of valid RFC3339 time offsets
330 * (the <varname>time-offset</varname> expansion) and ISO 8601 for the
331 * full list of valid time offsets. See <ulink
332 * url='http://www.gnu.org/s/libc/manual/html_node/TZ-Variable.html'>The
333 * GNU C Library manual</ulink> for an explanation of the possible
334 * values of the <varname>TZ</varname> environment variable.
336 * You should release the return value by calling g_time_zone_unref()
337 * when you are done with it.
339 * Returns: the requested timezone
344 g_time_zone_new (const gchar *identifier)
349 if (time_zones == NULL)
350 time_zones = g_hash_table_new (g_str_hash, g_str_equal);
353 tz = g_hash_table_lookup (time_zones, identifier);
359 tz = g_slice_new0 (GTimeZone);
360 tz->name = g_strdup (identifier);
363 tz->zoneinfo = zone_for_constant_offset (identifier);
365 if (tz->zoneinfo == NULL)
369 if (identifier != NULL)
373 tzdir = getenv ("TZDIR");
375 tzdir = "/usr/share/zoneinfo";
377 filename = g_build_filename (tzdir, identifier, NULL);
380 filename = g_strdup ("/etc/localtime");
382 tz->zoneinfo = (GBuffer *) g_mapped_file_new (filename, FALSE, NULL);
386 if (tz->zoneinfo != NULL)
388 const struct tzhead *header = tz->zoneinfo->data;
389 gsize size = tz->zoneinfo->size;
391 /* we only bother to support version 2 */
392 if (size < sizeof (struct tzhead) || memcmp (header, "TZif2", 5))
394 g_buffer_unref (tz->zoneinfo);
401 /* we trust the file completely. */
402 tz->header = (const struct tzhead *)
403 (((const gchar *) (header + 1)) +
404 guint32_from_be(header->tzh_ttisgmtcnt) +
405 guint32_from_be(header->tzh_ttisstdcnt) +
406 8 * guint32_from_be(header->tzh_leapcnt) +
407 5 * guint32_from_be(header->tzh_timecnt) +
408 6 * guint32_from_be(header->tzh_typecnt) +
409 guint32_from_be(header->tzh_charcnt));
411 typecnt = guint32_from_be (tz->header->tzh_typecnt);
412 tz->timecnt = guint32_from_be (tz->header->tzh_timecnt);
413 tz->trans = (gconstpointer) (tz->header + 1);
414 tz->indices = (gconstpointer) (tz->trans + tz->timecnt);
415 tz->infos = (gconstpointer) (tz->indices + tz->timecnt);
416 tz->abbrs = (gconstpointer) (tz->infos + typecnt);
421 g_hash_table_insert (time_zones, tz->name, tz);
423 g_atomic_int_inc (&tz->ref_count);
424 G_UNLOCK (time_zones);
430 * g_time_zone_new_utc:
432 * Creates a #GTimeZone corresponding to UTC.
434 * This is equivalent to calling g_time_zone_new() with a value like
435 * "Z", "UTC", "+00", etc.
437 * You should release the return value by calling g_time_zone_unref()
438 * when you are done with it.
440 * Returns: the universal timezone
445 g_time_zone_new_utc (void)
447 return g_time_zone_new ("UTC");
451 * g_time_zone_new_local:
453 * Creates a #GTimeZone corresponding to local time. The local time
454 * zone may change between invocations to this function; for example,
455 * if the system administrator changes it.
457 * This is equivalent to calling g_time_zone_new() with the value of the
458 * <varname>TZ</varname> environment variable (including the possibility
461 * You should release the return value by calling g_time_zone_unref()
462 * when you are done with it.
464 * Returns: the local timezone
469 g_time_zone_new_local (void)
471 return g_time_zone_new (getenv ("TZ"));
474 /* Internal helpers {{{1 */
475 inline static const struct ttinfo *
476 interval_info (GTimeZone *tz,
480 return tz->infos + tz->indices[interval - 1];
486 interval_start (GTimeZone *tz,
490 return gint64_from_be (tz->trans[interval - 1]);
496 interval_end (GTimeZone *tz,
499 if (interval < tz->timecnt)
500 return gint64_from_be (tz->trans[interval]) - 1;
506 interval_offset (GTimeZone *tz,
509 return gint32_from_be (interval_info (tz, interval)->tt_gmtoff);
512 inline static gboolean
513 interval_isdst (GTimeZone *tz,
516 return interval_info (tz, interval)->tt_isdst;
520 interval_abbrind (GTimeZone *tz,
523 return interval_info (tz, interval)->tt_abbrind;
527 interval_local_start (GTimeZone *tz,
531 return interval_start (tz, interval) + interval_offset (tz, interval);
537 interval_local_end (GTimeZone *tz,
540 if (interval < tz->timecnt)
541 return interval_end (tz, interval) + interval_offset (tz, interval);
547 interval_valid (GTimeZone *tz,
550 return interval <= tz->timecnt;
553 /* g_time_zone_find_interval() {{{1 */
556 * g_time_zone_adjust_time:
558 * @type: the #GTimeType of @time_
559 * @time_: a pointer to a number of seconds since January 1, 1970
561 * Finds an interval within @tz that corresponds to the given @time_,
562 * possibly adjusting @time_ if required to fit into an interval.
563 * The meaning of @time_ depends on @type.
565 * This function is similar to g_time_zone_find_interval(), with the
566 * difference that it always succeeds (by making the adjustments
569 * In any of the cases where g_time_zone_find_interval() succeeds then
570 * this function returns the same value, without modifying @time_.
572 * This function may, however, modify @time_ in order to deal with
573 * non-existent times. If the non-existent local @time_ of 02:30 were
574 * requested on March 13th 2010 in Toronto then this function would
575 * adjust @time_ to be 03:00 and return the interval containing the
578 * Returns: the interval containing @time_, never -1
583 g_time_zone_adjust_time (GTimeZone *tz,
589 if (tz->zoneinfo == NULL)
592 /* find the interval containing *time UTC
593 * TODO: this could be binary searched (or better) */
594 for (i = 0; i < tz->timecnt; i++)
595 if (*time_ <= interval_end (tz, i))
598 g_assert (interval_start (tz, i) <= *time_ && *time_ <= interval_end (tz, i));
600 if (type != G_TIME_TYPE_UNIVERSAL)
602 if (*time_ < interval_local_start (tz, i))
603 /* if time came before the start of this interval... */
607 /* if it's not in the previous interval... */
608 if (*time_ > interval_local_end (tz, i))
610 /* it doesn't exist. fast-forward it. */
612 *time_ = interval_local_start (tz, i);
616 else if (*time_ > interval_local_end (tz, i))
617 /* if time came after the end of this interval... */
621 /* if it's not in the next interval... */
622 if (*time_ < interval_local_start (tz, i))
623 /* it doesn't exist. fast-forward it. */
624 *time_ = interval_local_start (tz, i);
627 else if (interval_isdst (tz, i) != type)
628 /* it's in this interval, but dst flag doesn't match.
629 * check neighbours for a better fit. */
631 if (i && *time_ <= interval_local_end (tz, i - 1))
634 else if (i < tz->timecnt &&
635 *time_ >= interval_local_start (tz, i + 1))
644 * g_time_zone_find_interval:
646 * @type: the #GTimeType of @time_
647 * @time_: a number of seconds since January 1, 1970
649 * Finds an the interval within @tz that corresponds to the given @time_.
650 * The meaning of @time_ depends on @type.
652 * If @type is %G_TIME_TYPE_UNIVERSAL then this function will always
653 * succeed (since universal time is monotonic and continuous).
655 * Otherwise @time_ is treated is local time. The distinction between
656 * %G_TIME_TYPE_STANDARD and %G_TIME_TYPE_DAYLIGHT is ignored except in
657 * the case that the given @time_ is ambiguous. In Toronto, for example,
658 * 01:30 on November 7th 2010 occured twice (once inside of daylight
659 * savings time and the next, an hour later, outside of daylight savings
660 * time). In this case, the different value of @type would result in a
661 * different interval being returned.
663 * It is still possible for this function to fail. In Toronto, for
664 * example, 02:00 on March 14th 2010 does not exist (due to the leap
665 * forward to begin daylight savings time). -1 is returned in that
668 * Returns: the interval containing @time_, or -1 in case of failure
673 g_time_zone_find_interval (GTimeZone *tz,
679 if (tz->zoneinfo == NULL)
682 for (i = 0; i < tz->timecnt; i++)
683 if (time_ <= interval_end (tz, i))
686 if (type == G_TIME_TYPE_UNIVERSAL)
689 if (time_ < interval_local_start (tz, i))
691 if (time_ > interval_local_end (tz, --i))
695 else if (time_ > interval_local_end (tz, i))
697 if (time_ < interval_local_start (tz, ++i))
701 else if (interval_isdst (tz, i) != type)
703 if (i && time_ <= interval_local_end (tz, i - 1))
706 else if (i < tz->timecnt && time_ >= interval_local_start (tz, i + 1))
713 /* Public API accessors {{{1 */
716 * g_time_zone_get_abbreviation:
718 * @interval: an interval within the timezone
720 * Determines the time zone abbreviation to be used during a particular
721 * @interval of time in the time zone @tz.
723 * For example, in Toronto this is currently "EST" during the winter
724 * months and "EDT" during the summer months when daylight savings time
727 * Returns: the time zone abbreviation, which belongs to @tz
732 g_time_zone_get_abbreviation (GTimeZone *tz,
735 g_return_val_if_fail (interval_valid (tz, interval), NULL);
737 if (tz->header == NULL)
740 return tz->abbrs + interval_abbrind (tz, interval);
744 * g_time_zone_get_offset:
746 * @interval: an interval within the timezone
748 * Determines the offset to UTC in effect during a particular @interval
749 * of time in the time zone @tz.
751 * The offset is the number of seconds that you add to UTC time to
752 * arrive at local time for @tz (ie: negative numbers for time zones
753 * west of GMT, positive numbers for east).
755 * Returns: the number of seconds that should be added to UTC to get the
761 g_time_zone_get_offset (GTimeZone *tz,
764 g_return_val_if_fail (interval_valid (tz, interval), 0);
766 if (tz->header == NULL)
769 return interval_offset (tz, interval);
773 * g_time_zone_is_dst:
775 * @interval: an interval within the timezone
777 * Determines if daylight savings time is in effect during a particular
778 * @interval of time in the time zone @tz.
780 * Returns: %TRUE if daylight savings time is in effect
785 g_time_zone_is_dst (GTimeZone *tz,
788 g_return_val_if_fail (interval_valid (tz, interval), FALSE);
790 if (tz->header == NULL)
793 return interval_isdst (tz, interval);
797 /* vim:set foldmethod=marker: */