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.
10 * Everything here will work on both a fully encapsulated VCALENDAR component
11 * or any type of subcomponent.
13 * \ingroup Calendaring
18 #include "webserver.h"
21 #ifdef WEBCIT_WITH_CALENDAR_SERVICE
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.
29 icaltimezone *get_default_icaltimezone(void) {
31 icaltimezone *zone = NULL;
34 zone = icaltimezone_get_builtin_timezone(serv_info.serv_default_cal_zone);
37 zone = icaltimezone_get_utc_timezone();
44 * Back end function for ical_dezonify()
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.
50 void ical_dezonify_backend(icalcomponent *cal,
54 icaltimezone *t = NULL;
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 */
60 /* Give me nothing and I will give you nothing in return. */
61 if (cal == NULL) return;
63 /* Hunt for a TZID parameter in this property. */
64 param = icalproperty_get_first_parameter(prop, ICAL_TZID_PARAMETER);
66 /* Get the stringish name of this TZID. */
68 tzid = icalparameter_get_tzid(param);
70 /* Convert it to an icaltimezone type. */
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"); */
78 t = icalcomponent_get_timezone(cal, tzid);
79 /* lprintf(9, " * ...and I %s have tzdata for that zone.\n",
87 /* Now we know the timezone. Convert to UTC. */
89 if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
90 TheTime = icalproperty_get_dtstart(prop);
92 else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
93 TheTime = icalproperty_get_dtend(prop);
95 else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
96 TheTime = icalproperty_get_due(prop);
98 else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
99 TheTime = icalproperty_get_exdate(prop);
105 /* lprintf(9, " * Was: %s\n", icaltime_as_ical_string(TheTime)); */
107 if (TheTime.is_utc) {
108 /* lprintf(9, " * This property is ALREADY UTC.\n"); */
111 else if (utc_declared_as_tzid) {
112 /* lprintf(9, " * Replacing '%s' TZID with 'Z' suffix.\n", tzid); */
117 /* Do the conversion. */
119 /* lprintf(9, " * Timezone prop found. Converting to UTC.\n"); */
122 /* lprintf(9, " * Converting default timezone to UTC.\n"); */
126 t = get_default_icaltimezone();
129 icaltimezone_convert_time(&TheTime,
131 icaltimezone_get_utc_timezone()
133 icaltimezone_free (t, 1);
137 icalproperty_remove_parameter_by_kind(prop, ICAL_TZID_PARAMETER);
138 /* lprintf(9, " * Now: %s\n", icaltime_as_ical_string(TheTime)); */
140 /* Now add the converted property back in. */
141 if (icalproperty_isa(prop) == ICAL_DTSTART_PROPERTY) {
142 icalproperty_set_dtstart(prop, TheTime);
144 else if (icalproperty_isa(prop) == ICAL_DTEND_PROPERTY) {
145 icalproperty_set_dtend(prop, TheTime);
147 else if (icalproperty_isa(prop) == ICAL_DUE_PROPERTY) {
148 icalproperty_set_due(prop, TheTime);
150 else if (icalproperty_isa(prop) == ICAL_EXDATE_PROPERTY) {
151 icalproperty_set_exdate(prop, TheTime);
157 * Recursive portion of ical_dezonify()
159 void ical_dezonify_recurse(icalcomponent *cal, icalcomponent *rcal) {
164 * Recurse through all subcomponents *except* VTIMEZONE ones.
166 for (c=icalcomponent_get_first_component(
167 rcal, ICAL_ANY_COMPONENT);
169 c = icalcomponent_get_next_component(
170 rcal, ICAL_ANY_COMPONENT)
172 if (icalcomponent_isa(c) != ICAL_VTIMEZONE_COMPONENT) {
173 ical_dezonify_recurse(cal, c);
178 * Now look for DTSTART and DTEND properties
180 for (p=icalcomponent_get_first_property(rcal, ICAL_ANY_PROPERTY);
182 p = icalcomponent_get_next_property(rcal, ICAL_ANY_PROPERTY)
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)
190 ical_dezonify_backend(cal, rcal, p);
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.
201 void ical_dezonify(icalcomponent *cal) {
202 icalcomponent *vt = NULL;
204 /* lprintf(9, "ical_dezonify() started\n"); */
206 /* Convert all times to UTC */
207 ical_dezonify_recurse(cal, cal);
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);
216 /* lprintf(9, "ical_dezonify() completed\n"); */
220 #endif /* WEBCIT_WITH_CALENDAR_SERVICE */