Completed time range search of recurring events.
[citadel.git] / webcit-ng / server / caldav_reports.c
index 758a4a2f1295cdfb6211d086e78c0876aacad13c..8930bfb328b325d626323b586498c67aef3eeab1 100644 (file)
@@ -4,8 +4,11 @@
 
 #include "webcit.h"
 
-#define CAL "urn:ietf:params:xml:ns:caldav:"           // Shorthand for the XML namespace of CalDAV
-#define CALLEN sizeof(CAL)-1                           // And the length of that string
+#define CALDAV "urn:ietf:params:xml:ns:caldav:"                // Shorthand for the XML namespace of CalDAV
+#define CALDAVLEN sizeof(CALDAV)-1                     // And the length of that string
+
+const char *the_beginning_of_time      = "19010101T010101Z";
+const char *the_end_of_time            = "99991231T235959Z";
 
 // A CalDAV REPORT can only be one type.  This is stored in the report_type member.
 enum cr_type {
@@ -14,7 +17,6 @@ enum cr_type {
        cr_freebusy_query
 };
 
-
 // Data type for CalDAV Report Parameters.
 // 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.
@@ -42,51 +44,50 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
 #endif
 
        // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
-       if (!strcasecmp(el, CAL"calendar-query")) {
+       if (!strcasecmp(el, CALDAV"calendar-query")) {
                crp->report_type = cr_calendar_query;
        }
 
        // RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
-       else if (!strcasecmp(el, CAL"calendar-multiget")) {
+       else if (!strcasecmp(el, CALDAV"calendar-multiget")) {
                crp->report_type = cr_calendar_multiget;
        }
 
        // RFC4791 7.10 "free-busy-query" REPORT
-       else if (!strcasecmp(el, CAL"free-busy-query")) {
+       else if (!strcasecmp(el, CALDAV"free-busy-query")) {
                crp->report_type = cr_freebusy_query;
        }
 
        // RFC4791 9.7 create a filter array if this query contains a "filter" stanza
-       else if (!strcasecmp(el, CAL"filter")) {
+       else if (!strcasecmp(el, CALDAV"filter")) {
                crp->filters = array_new(SIZ);
                crp->filter_nest = crp->comp_filter_nesting_level;
        }
 
        // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
-       else if (       (       (!strcasecmp(el, CAL"comp-filter"))
-                               || (!strcasecmp(el, CAL"prop-filter"))
-                               || (!strcasecmp(el, CAL"param-filter"))
-                               || (!strcasecmp(el, CAL"is-not-defined"))
-                               || (!strcasecmp(el, CAL"text-match"))
-                               || (!strcasecmp(el, CAL"time-range"))
+       else if (       (       (!strcasecmp(el, CALDAV"comp-filter"))
+                               || (!strcasecmp(el, CALDAV"prop-filter"))
+                               || (!strcasecmp(el, CALDAV"param-filter"))
+                               || (!strcasecmp(el, CALDAV"is-not-defined"))
+                               || (!strcasecmp(el, CALDAV"text-match"))
+                               || (!strcasecmp(el, CALDAV"time-range"))
                        )
                        && (crp->filters)                       // Make sure we actually allocated an array
        ) {
 
-               if (!strcasecmp(el, CAL"comp-filter")) {
+               if (!strcasecmp(el, CALDAV"comp-filter")) {
                        ++crp->comp_filter_nesting_level;
                }
 
                char newfilter[SIZ];
                int a = 0;
                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
+               len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALDAVLEN]);        // filter name without the namespace
                while (attr[a]) {
                        len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]);    // now save the attributes
                }
                array_append(crp->filters, newfilter);
        }
-
 }
 
 
@@ -101,7 +102,7 @@ void caldav_xml_end(void *data, const char *el) {
        // end logging
 #endif
 
-       if (!strcasecmp(el, CAL"comp-filter")) {
+       if (!strcasecmp(el, CALDAV"comp-filter")) {
                --crp->comp_filter_nesting_level;
        }
 
@@ -259,34 +260,60 @@ 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());
+//
+// 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!
+//
+int caldav_time_range_filter_matches(icalcomponent *cal, char *start_str, char *end_str) {
+       struct icaltimetype dtstart = icalcomponent_get_dtstart(cal);
+       struct icaltimetype dtend = icalcomponent_get_dtend(cal);
 
-       // 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);
+       struct icaltimetype search_start = icaltime_from_string(start_str);
+       syslog(LOG_DEBUG, "   search start: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(search_start), icaltime_get_tzid(search_start));
 
-       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
-       );
+       struct icaltimetype search_end = icaltime_from_string(end_str);
+       syslog(LOG_DEBUG, "   search   end: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(search_end), icaltime_get_tzid(search_end));
 
-       syslog(LOG_DEBUG, "Well, here it is:");
-       syslog(LOG_DEBUG, "\033[35m%s\033[0m", icalcomponent_as_ical_string_r(cal));
+       // If it is a recurring event, RRULE is available at this level.  We can handle it here.
 
-       icaltimetype dts = icalcomponent_get_dtstart(cal);
-       syslog(LOG_DEBUG, "component start: \033[36m%s\033[0m", icaltime_as_ical_string_r(dts));
+       icalproperty *rrule;                                                                                                          
+       rrule = icalcomponent_get_first_property(cal, ICAL_RRULE_PROPERTY);
+       if (rrule) {
+               if (icaltime_is_null_time(dtend)) {
+                       dtend = dtstart;
+               }
+               struct icaldurationtype dur = icaltime_subtract(dtend, dtstart);        // recurrences need duration to find dtend
+               struct icalrecurrencetype recur = icalproperty_get_rrule(rrule);
+
+               icalrecur_iterator *ritr = icalrecur_iterator_new(recur, dtstart);      // iterate through recurrences
+               int rcount = 0;
+               syslog(LOG_DEBUG, "\033[7m RECURRENCE: \033[0m");
+               while (dtstart = icalrecur_iterator_next(ritr), !icaltime_is_null_time(dtstart)) {
+                       dtend = icaltime_add(dtstart, dur);
+                       syslog(LOG_DEBUG, "recurrence %3d start: \033[36m%-16s\033[0m (%s)", rcount, icaltime_as_ical_string_r(dtstart), icaltime_get_tzid(dtstart));
+                       syslog(LOG_DEBUG, "recurrence %3d   end: \033[36m%-16s\033[0m (%s)", rcount, icaltime_as_ical_string_r(dtend), icaltime_get_tzid(dtend));
+
+                       // Does THIS recurrence match the query?
+                       if (ical_ctdl_is_overlap(dtstart, dtend, search_start, search_end)) {
+                               icalrecur_iterator_free(ritr);
+                               return(1);
+                       }
 
-       icaltimetype dte = icalcomponent_get_dtend(cal);
-       syslog(LOG_DEBUG, "component   end: \033[36m%s\033[0m", icaltime_as_ical_string_r(dte));
+                       ++rcount;
+               }
 
-       int result = ical_ctdl_is_overlap(dts, dte, start, end);        // We have a convenience function for this.
+               icalrecur_iterator_free(ritr);
+               return(0);                              // compared all recurrences, no match was found for any of them
+       }
 
-       icalcomponent_free(cal);
-       return(result);
+       // For non recurring events, do a simple time range compare.
+       syslog(LOG_DEBUG, "event start: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(dtstart), icaltime_get_tzid(dtstart));
+       syslog(LOG_DEBUG, "event   end: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(dtend), icaltime_get_tzid(dtend));
+       return(ical_ctdl_is_overlap(dtstart, dtend, search_start, search_end)); // We have a convenience function for this.
 }
 
 
@@ -294,8 +321,8 @@ int caldav_time_range_filter_matches(icalcomponent *supplied_cal, char *start_st
 // 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) {
 
-       int f = 0;                                      // filter number iterator
-       int qual = 1;                                   // 0 for disqualify, 1 for qualify
+       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;
 
@@ -405,10 +432,10 @@ int caldav_apply_filters(void *cal, Array *filters, int apply_at_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);
+                       syslog(LOG_DEBUG, "time range filter at level %d FIXME add recurrence", this_rule_level);
                        for (int i=2; (i+1)<num_tokens; i+=2) {
-                               char *tr_start = NULL;
-                               char *tr_end = NULL;
+                               char *tr_start  = (char *)the_beginning_of_time;        // default if not specified
+                               char *tr_end    = (char *)the_end_of_time;              // default if not specified
                                if (!strcasecmp(t[i], "start")) {
                                        tr_start = t[i+1];
                                }
@@ -490,20 +517,17 @@ void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
                                StrBuf *one_item = fetch_ical(c, m);
                                icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
 
-                               // Does this calendar item qualify for output?
-                               int qualify = 1;
-
-                               // If there was a filter stanza, run this calendar item through the filters.
+                               // Does this calendar item qualify for output?  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, 0);
-                               syslog(LOG_DEBUG, "Message %ld %s\033[0m qualify", m, (qualify ? "\033[32mDOES" : "\033[31mDOES NOT"));
-                               syslog(LOG_DEBUG, "");
-
-                               // Did this calendar item match the query?  If so, output it.
-                               if (qualify) {
+                               if (caldav_apply_filters(cal, crp.filters, 0)) {
+                                       syslog(LOG_DEBUG, "Message %ld \033[32mQUALIFIES\033[0m");
                                        // FIXME need to populate the Href instead of NULL
                                        cal_multiget_out(m, NULL, one_item, ReportOut);
                                }
+                               else {
+                                       syslog(LOG_DEBUG, "Message %ld \033[31mDOES NOT QUALIFY\033[0m");
+                               }
+                               syslog(LOG_DEBUG, "");
 
                                icalcomponent_free(cal);
                                FreeStrBuf(&one_item);