Bring ical_dezonify() into caldav_reports.c
[citadel.git] / webcit-ng / server / caldav_reports.c
index ef9072829d65d070f56a543e909ffe163db2543b..22c90fea62ba981fffdc9b4e54b077e952db0e74 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
@@ -81,13 +68,18 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
                                || (!strcasecmp(el, CAL"param-filter"))
                                || (!strcasecmp(el, CAL"is-not-defined"))
                                || (!strcasecmp(el, CAL"text-match"))
+                               || (!strcasecmp(el, CAL"time-range"))
                        )
                        && (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
@@ -102,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();
@@ -155,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
@@ -272,12 +257,45 @@ 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 *supplied_cal, char *start_str, char *end_str) {
+
+       struct icaltimetype start = (start_str ? icaltime_from_string(start_str) : icaltime_null_time());
+       struct icaltimetype end = (end_str ? icaltime_from_string(end_str) : icaltime_null_time());
+
+       // make a local copy of the component because we are going to modify it by converting times to UTC
+       icalcomponent *cal = icalcomponent_new_clone(supplied_cal);
+       ical_dezonify(cal);
+
+       syslog(LOG_DEBUG, "\033[7mcaldav_time_range_filter_matches()\033[0m : Does this %s fall between %s and %s ?",
+               icalcomponent_kind_to_string(icalcomponent_isa(cal)),
+               start_str,
+               end_str
+       );
+
+       syslog(LOG_DEBUG, "Well, here it is:");
+       syslog(LOG_DEBUG, "\033[35m%s\033[0m", icalcomponent_as_ical_string_r(cal));
+
+       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));
+
+       icalcomponent_free(cal);
+       return(0);                                              // FIXME reject everything for now
+}
+
+
 // 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 caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
 
        int f = 0;                                      // filter number iterator
        int qual = 1;                                   // 0 for disqualify, 1 for qualify
+       int previous_level = -1;
+       int disregard_further_comp_filters = 0;
 
        while ( (f<array_len(filters)) && (qual) ) {
 
@@ -290,29 +308,78 @@ int caldav_apply_filters(void *cal, Array *filters) {
                while ( (t[num_tokens]=strtok_r(ft, "|", &ft)) && (num_tokens<10) ) {
                        ++num_tokens;
                }
-               int level = atoi(t[0]);
-               syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, level, array_get_element_at(filters, f) );
+               int this_rule_level = atoi(t[0]);
+               syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, this_rule_level, array_get_element_at(filters, f) );
 
                // Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
 
-               if (!strcasecmp(t[1], "comp-filter")) {                         // RFC4791 9.7.1 - filter by component
-                       syslog(LOG_DEBUG, "component filter at level %d", level);
+               if (apply_at_level < previous_level) {
+                       syslog(LOG_DEBUG, "caldav: walking back down");
+                       return(qual);
+               }
+
+               else if (this_rule_level != 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"))              // 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)) && (level == 0) ) {
+                       if ( (!icalcomponent_isa_component(cal)) && (this_rule_level == 0) ) {
                                syslog(LOG_DEBUG, "caldav: root element is not a component, rejecting");
                                return(0);
                        }
 
-                       // Root element IS a component and the root filter is "comp-filter" -- see if it matches the requested type
+                       // Current element is a component and the filter is "comp-filter" -- see if it matches the requested type
                        if (    (icalcomponent_isa_component(cal))
-                               && (level == 0)
                                && (!strcasecmp(t[2], "name"))
                        ) {
-                               if (icalcomponent_isa(cal) != icalcomponent_string_to_kind(t[3]) ) {
-                                       syslog(LOG_DEBUG, "caldav: root component is <%s>, looking for <%s>, rejecting",
+                               if (icalcomponent_isa(cal) == icalcomponent_string_to_kind(t[3]) ) {
+                                       syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, recursing...",
+                                               apply_at_level,
                                                icalcomponent_kind_to_string(icalcomponent_isa(cal)), t[3]
                                        );
+
+                                       // We have a match.  Drill down into the subcomponents.
+
+                                       icalcomponent *c = NULL;
+                                       int number_of_subcomponents = 0;
+                                       int number_of_matches = 0;
+                                       for (   c = icalcomponent_get_first_component(cal, ICAL_ANY_COMPONENT);
+                                               (c != 0);                                                
+                                               c = icalcomponent_get_next_component(cal, ICAL_ANY_COMPONENT)
+                                       ) {
+                                               ++number_of_subcomponents;
+                                               if (caldav_apply_filters(c, filters, apply_at_level+1)) {
+                                                       syslog(LOG_DEBUG, "Subcomponent %d might match", number_of_subcomponents);
+                                                       ++number_of_matches;
+                                               }
+                                       }
+                                       if (number_of_matches > 0) {                    // something matched
+                                               qual = 1;
+                                               disregard_further_comp_filters = 1;
+
+                                       }
+                                       else if (number_of_subcomponents > 0) {         // nothing matched
+                                               return(0);                              // but only fail if there *were* subcomponents.
+                                       }
+
+                               }
+                               else {
+                                       syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, rejecting",
+                                               apply_at_level,
+                                               icalcomponent_kind_to_string(icalcomponent_isa(cal)),
+                                               t[3]
+                                       );
                                        return(0);
                                }
                        }
@@ -320,24 +387,46 @@ int caldav_apply_filters(void *cal, Array *filters) {
                }
 
                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")) {                     // 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;
        }
 
+       syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual);
        return(qual);
 }
 
@@ -404,7 +493,7 @@ void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
 
                                // If there was a filter stanza, run this calendar item through the filters.
                                syslog(LOG_DEBUG, "Evaluating message \033[33m%ld\033[0m...", m);
-                               qualify = caldav_apply_filters(cal, crp.filters);
+                               qualify = caldav_apply_filters(cal, crp.filters, 0);
                                syslog(LOG_DEBUG, "Message %ld %s\033[0m qualify", m, (qualify ? "\033[32mDOES" : "\033[31mDOES NOT"));
                                syslog(LOG_DEBUG, "");