Do not convert compared times to UTC.
[citadel.git] / webcit-ng / server / caldav_reports.c
index 0c281efb43554c6f392f1f80f18f13705bff0b4f..481d118d1c894cd6a9f27b59f596a628664c937d 100644 (file)
@@ -19,7 +19,7 @@ enum cr_type {
 // As we slog our way through the XML we learn what the client is asking for
 // and build up the contents of this data type.
 struct cr_params {
-       int tag_nesting_level;          // not needed, just kept for pretty-printing
+       int comp_filter_nesting_level;
        enum cr_type report_type;       // which RFC4791 section 7 REPORT are we generating
        StrBuf *Chardata;               // XML chardata in between tags is built up here
        StrBuf *Hrefs;                  // list of items requested by a `calendar-multiget` REPORT
@@ -34,22 +34,9 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
 
 #ifdef DEBUG_XML_PARSE
        // logging
-       int i;
-       char indent[256];
-       indent[0] = 0;
-       for (i=0; i<crp->tag_nesting_level; ++i) {
-               strcat(indent, "  ");
-       }
-       syslog(LOG_DEBUG, "%s<%s>", indent, el);
-#endif
-       ++crp->tag_nesting_level;
-#ifdef DEBUG_XML_PARSE
-       indent[0] = 0;
-       for (i=0; i<crp->tag_nesting_level; ++i) {
-               strcat(indent, "  ");
-       }
-       for (i = 0; attr[i] != NULL; i += 2) {
-               syslog(LOG_DEBUG, "%sAttribute '%s' = '%s'", indent, attr[i], attr[i + 1]);
+       syslog(LOG_DEBUG, "<%s>", el);
+       for (int i = 0; attr[i] != NULL; i += 2) {
+               syslog(LOG_DEBUG, "Attribute '%s' = '%s'", attr[i], attr[i + 1]);
        }
        // end logging
 #endif
@@ -72,7 +59,7 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
        // RFC4791 9.7 create a filter array if this query contains a "filter" stanza
        else if (!strcasecmp(el, CAL"filter")) {
                crp->filters = array_new(SIZ);
-               crp->filter_nest = crp->tag_nesting_level;
+               crp->filter_nest = crp->comp_filter_nesting_level;
        }
 
        // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
@@ -86,9 +73,13 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
                        && (crp->filters)                       // Make sure we actually allocated an array
        ) {
 
+               if (!strcasecmp(el, CAL"comp-filter")) {
+                       ++crp->comp_filter_nesting_level;
+               }
+
                char newfilter[SIZ];
                int a = 0;
-               int len = snprintf(newfilter, SIZ, "%d|", crp->tag_nesting_level - crp->filter_nest - 1);
+               int len = snprintf(newfilter, SIZ, "%d|", crp->comp_filter_nesting_level - crp->filter_nest - 1);
                len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALLEN]);           // filter name without the namespace
                while (attr[a]) {
                        len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]);    // now save the attributes
@@ -103,20 +94,18 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
 void caldav_xml_end(void *data, const char *el) {
        struct cr_params *crp = (struct cr_params *) data;
 
-       --crp->tag_nesting_level;
-
 #ifdef DEBUG_XML_PARSE
        // logging
        int i;
-       char indent[256];
-       indent[0] = 0;
-       for (i=0; i<crp->tag_nesting_level; ++i) {
-               strcat(indent, "  ");
-       }
-       syslog(LOG_DEBUG, "%s</%s>", indent, el);
+       syslog(LOG_DEBUG, "</%s>", el);
        // end logging
 #endif
 
+       if (!strcasecmp(el, CAL"comp-filter")) {
+               --crp->comp_filter_nesting_level;
+       }
+
+
        if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
                if (crp->Hrefs == NULL) {       // append crp->Chardata to crp->Hrefs
                        crp->Hrefs = NewStrBuf();
@@ -156,12 +145,7 @@ void caldav_xml_chardata(void *data, const XML_Char *s, int len) {
        string_trim(app);               // remove leading/trailing whitespace.  ok to mangle it because we've already appended.
        if (!IsEmptyStr(app)) {
                int i;
-               char indent[256];
-               indent[0] = 0;
-               for (i=0; i<crp->tag_nesting_level; ++i) {
-                       strcat(indent, "  ");
-               }
-               syslog(LOG_DEBUG, "%s%s", indent, app, len);
+               syslog(LOG_DEBUG, "%s", app, len);
        }
        // end logging
 #endif
@@ -273,6 +257,41 @@ void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, S
 }
 
 
+// Compare function for "time-range" tests (RFC4791 section 9.9)
+// Returns nonzero if the supplied icalcomponent occurs within the specified time range
+int caldav_time_range_filter_matches(icalcomponent *cal, char *start_str, char *end_str) {
+
+       struct icaltimetype start = (
+               (!IsEmptyStr(start_str))
+               ? icaltime_from_string(start_str)
+               : icaltime_from_string("19010101T010101Z")
+       );
+       syslog(LOG_DEBUG, "   search start: %16s --> \033[36m%s\033[0m", start_str, icaltime_as_ical_string_r(start));
+
+       struct icaltimetype end = (
+               (!IsEmptyStr(end_str))
+               ? icaltime_from_string(end_str)
+               : icaltime_from_string("99991231T235959Z")              // ISO8601 is not Y10K compliant
+       );
+       syslog(LOG_DEBUG, "   search   end: %16s --> \033[36m%s\033[0m", end_str, icaltime_as_ical_string_r(end));
+
+       // IMPLEMENTATION NOTE:
+       // ical_ctdl_is_overlap() works because icaltime_compare() is really smart.
+       // It looks at the time zone of the dtstart/dtend and can apparently go back up the icalcomponent
+       // hierarchy to find its time zone data.  I tested this by creating an event with a fictional
+       // time zone and it did the right thing.  It even showed the fictional name to me.  This saves us
+       // from having to convert everything to UTC before comparing.  Nice!
+
+       icaltimetype dts = icalcomponent_get_dtstart(cal);
+       syslog(LOG_DEBUG, "component start: \033[36m%s\033[0m", icaltime_as_ical_string_r(dts));
+
+       icaltimetype dte = icalcomponent_get_dtend(cal);
+       syslog(LOG_DEBUG, "component   end: \033[36m%s\033[0m", icaltime_as_ical_string_r(dte));
+
+       return(ical_ctdl_is_overlap(dts, dte, start, end));     // We have a convenience function for this.
+}
+
+
 // Recursive function to apply CalDAV FILTERS to a calendar item.
 // Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
 int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
@@ -307,11 +326,17 @@ int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
                        syslog(LOG_DEBUG, "caldav: apply_at_level=%d, this_rule_level=%d, skipping this rule", apply_at_level, this_rule_level);
                }
 
-               else if (       (!strcasecmp(t[1], "comp-filter"))
-                               && (!disregard_further_comp_filters)
-                       ) {                                                     // RFC4791 9.7.1 - filter by component
+               else if (       (!strcasecmp(t[1], "comp-filter"))              // RFC4791 9.7.1 - filter by component
+                               && (!disregard_further_comp_filters)            // one is enough to succeed
+                       ) {
                        syslog(LOG_DEBUG, "component filter at level %d", this_rule_level);
 
+                       // comp-filter requires exactly one parameter (name="VXXXX")
+                       if (num_tokens < 4) {
+                               syslog(LOG_DEBUG, "caldav: comp-filter has no parameters - rejecting");
+                               return(0);
+                       }
+
                        // Root element is NOT a component, but the root filter is "comp-filter" -- reject!
                        if ( (!icalcomponent_isa_component(cal)) && (this_rule_level == 0) ) {
                                syslog(LOG_DEBUG, "caldav: root element is not a component, rejecting");
@@ -366,23 +391,40 @@ int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
                }
 
                else if (!strcasecmp(t[1], "prop-filter")) {                    // RFC4791 9.7.2 - filter by property
-                       syslog(LOG_DEBUG, "property filter FIXME not implemented yet");
+                       syslog(LOG_DEBUG, "property filter at level %d FIXME not implemented yet", this_rule_level);
                }
 
                else if (!strcasecmp(t[1], "param-filter")) {                   // RFC4791 9.7.3 - filter by parameter
-                       syslog(LOG_DEBUG, "parameter filter FIXME not implemented yet");
+                       syslog(LOG_DEBUG, "parameter filter at level %d FIXME not implemented yet", this_rule_level);
                }
 
                else if (!strcasecmp(t[1], "is-not-defined")) {                 // RFC4791 9.7.4
-                       syslog(LOG_DEBUG, "is-not-defined filter FIXME not implemented yet");
+                       syslog(LOG_DEBUG, "is-not-defined filter at level %d FIXME not implemented yet", this_rule_level);
                }
 
                else if (!strcasecmp(t[1], "text-match")) {                     // RFC4791 9.7.5
-                       syslog(LOG_DEBUG, "text match filter FIXME not implemented yet");
+                       syslog(LOG_DEBUG, "text match filter at level %d FIXME not implemented yet", this_rule_level);
                }
 
-               else if (!strcasecmp(t[1], "time-range")) {
-                       syslog(LOG_DEBUG, "time range filter \033[33mFIXME\033[0m not implemented yet");
+               else if (!strcasecmp(t[1], "time-range")) {                     // RFC4791 9.9
+                       syslog(LOG_DEBUG, "time range filter at level %d FIXME not implemented yet", this_rule_level);
+                       for (int i=2; (i+1)<num_tokens; i+=2) {
+                               char *tr_start = NULL;
+                               char *tr_end = NULL;
+                               if (!strcasecmp(t[i], "start")) {
+                                       tr_start = t[i+1];
+                               }
+                               else if (!strcasecmp(t[i], "end")) {
+                                       tr_end = t[i+1];
+                               }
+                               if (caldav_time_range_filter_matches(cal, tr_start, tr_end)) {
+                                       syslog(LOG_DEBUG, "time range matches");
+                               }
+                               else {
+                                       syslog(LOG_DEBUG, "time range does not match -- rejecting");
+                                       qual = 0;
+                               }
+                       }
                }
 
                ++f;