webcit/ical_dezonify.c

   1 /*
   2  * $Id$
   3  */
   4 /**
   5  * \defgroup IcalDezonify normalize ical dates to UTC
   6  * Function to go through an ical component set and convert all non-UTC
   7  * date/time properties to UTC.  It also strips out any VTIMEZONE
   8  * subcomponents afterwards, because they're irrelevant.
   9  *
  10  * Everything here will work on both a fully encapsulated VCALENDAR component
  11  * or any type of subcomponent.
  12  *
  13  * \ingroup Calendaring
  14  */
  15 /*@{*/
  16
  17 #include "webcit.h"
  18 #include "webserver.h"
  19
  20
  21 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
  22
  23
  24 /*
  25  * Figure out which time zone needs to be used for timestamps that are
  26  * not UTC and do not have a time zone specified.
  27  *
  28  */
  29 icaltimezone *get_default_icaltimezone(void) {
  30
  31         icaltimezone *zone = NULL;
  32
  33         if (!zone) {
  34                 zone = icaltimezone_get_builtin_timezone(serv_info.serv_default_cal_zone);
  35         }
  36         if (!zone) {
  37                 zone = icaltimezone_get_utc_timezone();
  38         }
  39         return zone;
  40 }
  41
  42
  43 /*
  44  * Back end function for ical_dezonify()
  45  *
  46  * We supply this with the master component, the relevant component,
  47  * and the property (which will be a DTSTART, DTEND, etc.)
  48  * which we want to convert to UTC.
  49  */
  50 void ical_dezonify_backend(icalcomponent *cal,
  51                         icalcomponent *rcal,
  52                         icalproperty *prop) {
  53
  54         icaltimezone *t = NULL;
  55         icalparameter *param;
  56         const char *tzid = NULL;
  57         struct icaltimetype TheTime;
  58         int utc_declared_as_tzid = 0;   /**< Component declared 'TZID=GMT' instead of using Z syntax */
  59
  60         /* Give me nothing and I will give you nothing in return. */
  61         if (cal == NULL) return;
  62
  63         /* Hunt for a TZID parameter in this property. */
  64         param = icalproperty_get_first_parameter(prop, ICAL_TZID_PARAMETER);
  65
  66         /* Get the stringish name of this TZID. */
  67         if (param != NULL) {
  68                 tzid = icalparameter_get_tzid(param);
  69
  70                 /* Convert it to an icaltimezone type. */
  71                 if (tzid != NULL) {
  72                         /* lprintf(9, "                * Stringy supplied timezone is: '%s'\n", tzid); */
  73                         if ( (!strcasecmp(tzid, "UTC")) || (!strcasecmp(tzid, "GMT")) ) {
  74                                 utc_declared_as_tzid = 1;
  75                                 /* lprintf(9, "                * ...and we handle that internally.\n"); */
  76                         }
  77                         else {
  78                                 t = icalcomponent_get_timezone(cal, tzid);
  79                                 /* lprintf(9, "                * ...and I %s have tzdata for that zone.\n",
  80                                         (t ? "DO" : "DO NOT")
  81                                 ); */
  82                         }
  83                 }
  84
  85         }
  86
  87         /* Now we know the timezone.  Convert to UTC. */
  88
  89         if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
  90                 TheTime = icalproperty_get_dtstart(prop);
  91         }
  92         else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
  93                 TheTime = icalproperty_get_dtend(prop);
  94         }
  95         else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
  96                 TheTime = icalproperty_get_due(prop);
  97         }
  98         else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
  99                 TheTime = icalproperty_get_exdate(prop);
 100         }
 101         else {
 102                 return;
 103         }
 104
 105         /* lprintf(9, "                * Was: %s\n", icaltime_as_ical_string(TheTime)); */
 106
 107         if (TheTime.is_utc) {
 108                 /* lprintf(9, "                * This property is ALREADY UTC.\n"); */
 109         }
 110
 111         else if (utc_declared_as_tzid) {
 112                 /* lprintf(9, "                * Replacing '%s' TZID with 'Z' suffix.\n", tzid); */
 113                 TheTime.is_utc = 1;
 114         }
 115
 116         else {
 117                 /* Do the conversion. */
 118                 if (t != NULL) {
 119                         /* lprintf(9, "                * Timezone prop found.  Converting to UTC.\n"); */
 120                 }
 121                 else {
 122                         /* lprintf(9, "                * Converting default timezone to UTC.\n"); */
 123                 }
 124
 125                 if (t == NULL) {
 126                         t = get_default_icaltimezone();
 127                 }
 128
 129                 icaltimezone_convert_time(&TheTime,
 130                                         t,
 131                                         icaltimezone_get_utc_timezone()
 132                 );
 133                 TheTime.is_utc = 1;
 134         }
 135
 136         icalproperty_remove_parameter_by_kind(prop, ICAL_TZID_PARAMETER);
 137         /* lprintf(9, "                * Now: %s\n", icaltime_as_ical_string(TheTime)); */
 138
 139         /* Now add the converted property back in. */
 140         if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
 141                 icalproperty_set_dtstart(prop, TheTime);
 142         }
 143         else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
 144                 icalproperty_set_dtend(prop, TheTime);
 145         }
 146         else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
 147                 icalproperty_set_due(prop, TheTime);
 148         }
 149         else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
 150                 icalproperty_set_exdate(prop, TheTime);
 151         }
 152 }
 153
 154
 155 /*
 156  * Recursive portion of ical_dezonify()
 157  */
 158 void ical_dezonify_recurse(icalcomponent *cal, icalcomponent *rcal) {
 159         icalcomponent *c;
 160         icalproperty *p;
 161
 162         /*
 163          * Recurse through all subcomponents *except* VTIMEZONE ones.
 164          */
 165         for (c=icalcomponent_get_first_component(
 166                                         rcal, ICAL_ANY_COMPONENT);
 167                 c != NULL;
 168                 c = icalcomponent_get_next_component(
 169                                         rcal, ICAL_ANY_COMPONENT)
 170         ) {
 171                 if (icalcomponent_isa(c) != ICAL_VTIMEZONE_COMPONENT) {
 172                         ical_dezonify_recurse(cal, c);
 173                 }
 174         }
 175
 176         /*
 177          * Now look for DTSTART and DTEND properties
 178          */
 179         for (p=icalcomponent_get_first_property(rcal, ICAL_ANY_PROPERTY);
 180                 p != NULL;
 181                 p = icalcomponent_get_next_property(rcal, ICAL_ANY_PROPERTY)
 182         ) {
 183                 if (
 184                         (icalproperty_isa(p) == ICAL_DTSTART_PROPERTY)
 185                         || (icalproperty_isa(p) == ICAL_DTEND_PROPERTY)
 186                         || (icalproperty_isa(p) == ICAL_DUE_PROPERTY)
 187                         || (icalproperty_isa(p) == ICAL_EXDATE_PROPERTY)
 188                    ) {
 189                         ical_dezonify_backend(cal, rcal, p);
 190                 }
 191         }
 192 }
 193
 194
 195 /*
 196  * Convert all DTSTART and DTEND properties in all subcomponents to UTC.
 197  * This function will search any VTIMEZONE subcomponents to learn the
 198  * relevant timezone information.
 199  */
 200 void ical_dezonify(icalcomponent *cal) {
 201         icalcomponent *vt = NULL;
 202
 203         /* lprintf(9, "ical_dezonify() started\n"); */
 204
 205         /* Convert all times to UTC */
 206         ical_dezonify_recurse(cal, cal);
 207
 208         /* Strip out VTIMEZONE subcomponents -- we don't need them anymore */
 209         while (vt = icalcomponent_get_first_component(
 210                         cal, ICAL_VTIMEZONE_COMPONENT), vt != NULL) {
 211                 icalcomponent_remove_component(cal, vt);
 212                 icalcomponent_free(vt);
 213         }
 214
 215         /* lprintf(9, "ical_dezonify() completed\n"); */
 216 }
 217
 218
 219 #endif /* WEBCIT_WITH_CALENDAR_SERVICE */