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