2 * Function to go through an ical component set and convert all non-UTC
3 * date/time properties to UTC. It also strips out any VTIMEZONE
4 * subcomponents afterwards, because they're irrelevant.
11 #include <sys/types.h>
17 #include <libical/ical.h>
18 #include <libcitadel.h>
21 #include "citserver.h"
22 #include "sysdep_decls.h"
25 #include "ical_dezonify.h"
27 #include "ctdl_module.h"
31 * Figure out which time zone needs to be used for timestamps that are
32 * not UTC and do not have a time zone specified.
34 icaltimezone *get_default_icaltimezone(void) {
36 icaltimezone *zone = NULL;
37 char *default_zone_name = CtdlGetConfigStr("c_default_cal_zone");
40 zone = icaltimezone_get_builtin_timezone(default_zone_name);
44 "Unable to load '%s' time zone. Defaulting to UTC.\n",
46 zone = icaltimezone_get_utc_timezone();
49 syslog(LOG_ALERT, "Unable to load UTC time zone!\n");
56 * Back end function for ical_dezonify()
58 * We supply this with the master component, the relevant component,
59 * and the property (which will be a DTSTART, DTEND, etc.)
60 * which we want to convert to UTC.
62 void ical_dezonify_backend(icalcomponent *cal,
66 icaltimezone *t = NULL;
68 const char *tzid = NULL;
69 struct icaltimetype TheTime;
70 int utc_declared_as_tzid = 0; /**< Component declared 'TZID=GMT' instead of using Z syntax */
72 /* Give me nothing and I will give you nothing in return. */
73 if (cal == NULL) return;
75 /* Hunt for a TZID parameter in this property. */
76 param = icalproperty_get_first_parameter(prop, ICAL_TZID_PARAMETER);
78 /* Get the stringish name of this TZID. */
80 tzid = icalparameter_get_tzid(param);
82 /* Convert it to an icaltimezone type. */
84 /* syslog(LOG_DEBUG, " * Stringy supplied timezone is: '%s'\n", tzid); */
85 if ( (!strcasecmp(tzid, "UTC")) || (!strcasecmp(tzid, "GMT")) ) {
86 utc_declared_as_tzid = 1;
87 /* syslog(LOG_DEBUG, " * ...and we handle that internally.\n"); */
90 /* try attached first */
91 t = icalcomponent_get_timezone(cal, tzid);
93 syslog(LOG_DEBUG, " * ...and I %s have tzdata for that zone.\n",
97 /* then try built-in timezones */
99 t = icaltimezone_get_builtin_timezone(tzid);
102 syslog(LOG_DEBUG, " * Using system tzdata!\n");
111 /* Now we know the timezone. Convert to UTC. */
113 if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
114 TheTime = icalproperty_get_dtstart(prop);
116 else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
117 TheTime = icalproperty_get_dtend(prop);
119 else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
120 TheTime = icalproperty_get_due(prop);
122 else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
123 TheTime = icalproperty_get_exdate(prop);
129 /* syslog(LOG_DEBUG, " * Was: %s\n", icaltime_as_ical_string(TheTime)); */
131 if (TheTime.is_utc) {
132 /* syslog(LOG_DEBUG, " * This property is ALREADY UTC.\n"); */
135 else if (utc_declared_as_tzid) {
136 /* syslog(LOG_DEBUG, " * Replacing '%s' TZID with 'Z' suffix.\n", tzid); */
141 /* Do the conversion. */
143 /* syslog(LOG_DEBUG, " * Timezone prop found. Converting to UTC.\n"); */
146 /* syslog(LOG_DEBUG, " * Converting default timezone to UTC.\n"); */
150 t = get_default_icaltimezone();
153 icaltimezone_convert_time(&TheTime,
155 icaltimezone_get_utc_timezone()
160 icalproperty_remove_parameter_by_kind(prop, ICAL_TZID_PARAMETER);
161 /* syslog(LOG_DEBUG, " * Now: %s\n", icaltime_as_ical_string(TheTime)); */
163 /* Now add the converted property back in. */
164 if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
165 icalproperty_set_dtstart(prop, TheTime);
167 else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
168 icalproperty_set_dtend(prop, TheTime);
170 else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
171 icalproperty_set_due(prop, TheTime);
173 else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
174 icalproperty_set_exdate(prop, TheTime);
180 * Recursive portion of ical_dezonify()
182 void ical_dezonify_recurse(icalcomponent *cal, icalcomponent *rcal) {
187 * Recurse through all subcomponents *except* VTIMEZONE ones.
189 for (c=icalcomponent_get_first_component(
190 rcal, ICAL_ANY_COMPONENT);
192 c = icalcomponent_get_next_component(
193 rcal, ICAL_ANY_COMPONENT)
195 if (icalcomponent_isa(c) != ICAL_VTIMEZONE_COMPONENT) {
196 ical_dezonify_recurse(cal, c);
201 * Now look for DTSTART and DTEND properties
203 for (p=icalcomponent_get_first_property(rcal, ICAL_ANY_PROPERTY);
205 p = icalcomponent_get_next_property(rcal, ICAL_ANY_PROPERTY)
208 (icalproperty_isa(p) == ICAL_DTSTART_PROPERTY)
209 || (icalproperty_isa(p) == ICAL_DTEND_PROPERTY)
210 || (icalproperty_isa(p) == ICAL_DUE_PROPERTY)
211 || (icalproperty_isa(p) == ICAL_EXDATE_PROPERTY)
213 ical_dezonify_backend(cal, rcal, p);
220 * Convert all DTSTART and DTEND properties in all subcomponents to UTC.
221 * This function will search any VTIMEZONE subcomponents to learn the
222 * relevant timezone information.
224 void ical_dezonify(icalcomponent *cal) {
225 icalcomponent *vt = NULL;
227 /* syslog(LOG_DEBUG, "ical_dezonify() started\n"); */
229 /* Convert all times to UTC */
230 ical_dezonify_recurse(cal, cal);
232 /* Strip out VTIMEZONE subcomponents -- we don't need them anymore */
233 while (vt = icalcomponent_get_first_component(
234 cal, ICAL_VTIMEZONE_COMPONENT), vt != NULL) {
235 icalcomponent_remove_component(cal, vt);
236 icalcomponent_free(vt);
239 /* syslog(LOG_DEBUG, "ical_dezonify() completed\n"); */