Citadel Server and libcitadel version 922
[citadel.git] / citadel / ical_dezonify.c
index f7ead4e3da53940210662f2876cd134cb8152fa9..04d41e7c90b0887cd5c2b02dac946bd8028d4c4c 100644 (file)
@@ -1,30 +1,62 @@
-/* 
- * $Id$ 
- *
+/*
  * Function to go through an ical component set and convert all non-UTC
  * date/time properties to UTC.  It also strips out any VTIMEZONE
  * subcomponents afterwards, because they're irrelevant.
  *
+ * Copyright (c) 1987-2017 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
 
 #include "sysdep.h"
+#include <stdlib.h>
 #include <unistd.h>
 #include <sys/types.h>
 #include <limits.h>
 #include <stdio.h>
 #include <string.h>
 #include <strings.h>
+#include <syslog.h>
+#include <libical/ical.h>
+#include <libcitadel.h>
 #include "citadel.h"
 #include "server.h"
 #include "citserver.h"
 #include "sysdep_decls.h"
 #include "support.h"
 #include "config.h"
-
-#ifdef HAVE_ICAL_H
-#include <ical.h>
 #include "ical_dezonify.h"
+#include "ctdl_module.h"
+
+
+/*
+ * Figure out which time zone needs to be used for timestamps that are
+ * not UTC and do not have a time zone specified.
+ */
+icaltimezone *get_default_icaltimezone(void) {
+
+        icaltimezone *zone = NULL;
+       char *default_zone_name = CtdlGetConfigStr("c_default_cal_zone");
+
+        if (!zone) {
+                zone = icaltimezone_get_builtin_timezone(default_zone_name);
+        }
+        if (!zone) {
+               syslog(LOG_ERR, "ical: Unable to load '%s' time zone.  Defaulting to UTC.", default_zone_name);
+                zone = icaltimezone_get_utc_timezone();
+       }
+       if (!zone) {
+               syslog(LOG_ERR, "ical: unable to load UTC time zone!");
+       }
+        return zone;
+}
 
 
 /*
@@ -38,25 +70,50 @@ void ical_dezonify_backend(icalcomponent *cal,
                        icalcomponent *rcal,
                        icalproperty *prop) {
 
-       icaltimezone *t;
+       icaltimezone *t = NULL;
        icalparameter *param;
-       const char *tzid;
+       const char *tzid = NULL;
        struct icaltimetype TheTime;
+       int utc_declared_as_tzid = 0;   /**< Component declared 'TZID=GMT' instead of using Z syntax */
 
        /* Give me nothing and I will give you nothing in return. */
        if (cal == NULL) return;
 
        /* Hunt for a TZID parameter in this property. */
        param = icalproperty_get_first_parameter(prop, ICAL_TZID_PARAMETER);
-       if (param == NULL) return;
 
        /* Get the stringish name of this TZID. */
-       tzid = icalparameter_get_tzid(param);
-       if (tzid == NULL) return;
+       if (param != NULL) {
+               tzid = icalparameter_get_tzid(param);
+
+               /* Convert it to an icaltimezone type. */
+               if (tzid != NULL) {
+                       /* syslog(LOG_DEBUG, "                * Stringy supplied timezone is: '%s'\n", tzid); */
+                       if ( (!strcasecmp(tzid, "UTC")) || (!strcasecmp(tzid, "GMT")) ) {
+                               utc_declared_as_tzid = 1;
+                               /* syslog(LOG_DEBUG, "                * ...and we handle that internally.\n"); */
+                       }
+                       else {
+                               /* try attached first */
+                               t = icalcomponent_get_timezone(cal, tzid);
+/*
+                               syslog(LOG_DEBUG, "                * ...and I %s have tzdata for that zone.\n",
+                                       (t ? "DO" : "DO NOT")
+                               );
+*/
+                               /* then try built-in timezones */
+                               if (!t) {
+                                       t = icaltimezone_get_builtin_timezone(tzid);
+/*
+                                       if (t) {
+                                               syslog(LOG_DEBUG, "                * Using system tzdata!\n");
+                                       }
+*/
+                               }
+                       }
+               }
 
-       /* Convert it to an icaltimezone type. */
-       t = icalcomponent_get_timezone(cal, tzid);
-       if (t == NULL) return;
+       }
 
        /* Now we know the timezone.  Convert to UTC. */
 
@@ -76,13 +133,39 @@ void ical_dezonify_backend(icalcomponent *cal,
                return;
        }
 
-       /* Do the conversion. */
-       icaltimezone_convert_time(&TheTime,
-                               t,
-                               icaltimezone_get_utc_timezone()
-       );
-       TheTime.is_utc = 1;
+       /* syslog(LOG_DEBUG, "                * Was: %s\n", icaltime_as_ical_string(TheTime)); */
+
+       if (icaltime_is_utc(TheTime)) {
+               /* syslog(LOG_DEBUG, "                * This property is ALREADY UTC.\n"); */
+       }
+
+       else if (utc_declared_as_tzid) {
+               /* syslog(LOG_DEBUG, "                * Replacing '%s' TZID with 'Z' suffix.\n", tzid); */
+               TheTime.zone = icaltimezone_get_utc_timezone();
+       }
+
+       else {
+               /* Do the conversion. */
+               if (t != NULL) {
+                       /* syslog(LOG_DEBUG, "                * Timezone prop found.  Converting to UTC.\n"); */
+               }
+               else {
+                       /* syslog(LOG_DEBUG, "                * Converting default timezone to UTC.\n"); */
+               }
+
+               if (t == NULL) {
+                       t = get_default_icaltimezone();
+               }
+
+               icaltimezone_convert_time(&TheTime,
+                                       t,
+                                       icaltimezone_get_utc_timezone()
+               );
+               TheTime.zone = icaltimezone_get_utc_timezone();
+       }
+
        icalproperty_remove_parameter_by_kind(prop, ICAL_TZID_PARAMETER);
+       /* syslog(LOG_DEBUG, "                * Now: %s\n", icaltime_as_ical_string(TheTime)); */
 
        /* Now add the converted property back in. */
        if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
@@ -103,7 +186,7 @@ void ical_dezonify_backend(icalcomponent *cal,
 /*
  * Recursive portion of ical_dezonify()
  */
-void ical_dezonify_recur(icalcomponent *cal, icalcomponent *rcal) {
+void ical_dezonify_recurse(icalcomponent *cal, icalcomponent *rcal) {
        icalcomponent *c;
        icalproperty *p;
 
@@ -117,18 +200,16 @@ void ical_dezonify_recur(icalcomponent *cal, icalcomponent *rcal) {
                                        rcal, ICAL_ANY_COMPONENT)
        ) {
                if (icalcomponent_isa(c) != ICAL_VTIMEZONE_COMPONENT) {
-                       ical_dezonify_recur(cal, c);
+                       ical_dezonify_recurse(cal, c);
                }
        }
 
        /*
         * Now look for DTSTART and DTEND properties
         */
-       for (p=icalcomponent_get_first_property(
-                               rcal, ICAL_ANY_PROPERTY);
+       for (p=icalcomponent_get_first_property(rcal, ICAL_ANY_PROPERTY);
                p != NULL;
-               p = icalcomponent_get_next_property(
-                               rcal, ICAL_ANY_PROPERTY)
+               p = icalcomponent_get_next_property(rcal, ICAL_ANY_PROPERTY)
        ) {
                if (
                        (icalproperty_isa(p) == ICAL_DTSTART_PROPERTY)
@@ -150,8 +231,10 @@ void ical_dezonify_recur(icalcomponent *cal, icalcomponent *rcal) {
 void ical_dezonify(icalcomponent *cal) {
        icalcomponent *vt = NULL;
 
+       /* syslog(LOG_DEBUG, "ical_dezonify() started\n"); */
+
        /* Convert all times to UTC */
-       ical_dezonify_recur(cal, cal);
+       ical_dezonify_recurse(cal, cal);
 
        /* Strip out VTIMEZONE subcomponents -- we don't need them anymore */
        while (vt = icalcomponent_get_first_component(
@@ -160,7 +243,5 @@ void ical_dezonify(icalcomponent *cal) {
                icalcomponent_free(vt);
        }
 
+       /* syslog(LOG_DEBUG, "ical_dezonify() completed\n"); */
 }
-
-
-#endif /* HAVE_ICAL_H */