#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 {
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.
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
#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
// 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->tag_nesting_level;
+ 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"))
+ 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, CALDAV"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);
- len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALLEN]); // filter name without the namespace
+ int len = snprintf(newfilter, SIZ, "%d|", crp->comp_filter_nesting_level - crp->filter_nest - 1);
+ 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);
}
-
}
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, CALDAV"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();
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
}
+// 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) {
+
+ // syslog(LOG_DEBUG, "caldav_time_range_filter_matches() comparing:\n\033[35m%s\033[0m", icalcomponent_as_ical_string(cal));
+
+ // NOTE TO ME:
+ // Recurrence info is available at this level. We can handle it here.
+
+ // 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%-16s\033[0m (%s)", icaltime_as_ical_string_r(dts), icaltime_get_tzid(dts));
+
+ icaltimetype dte = icalcomponent_get_dtend(cal);
+ syslog(LOG_DEBUG, "component end: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(dte), icaltime_get_tzid(dte));
+
+ struct icaltimetype start = icaltime_from_string(start_str);
+ syslog(LOG_DEBUG, " search start: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(start), icaltime_get_tzid(start));
+
+ struct icaltimetype end = icaltime_from_string(end_str);
+ syslog(LOG_DEBUG, " search end: \033[36m%-16s\033[0m (%s)", icaltime_as_ical_string_r(end), icaltime_get_tzid(end));
+
+ 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 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;
while ( (f<array_len(filters)) && (qual) ) {
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);
}
}
}
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 add recurrence", this_rule_level);
+ for (int i=2; (i+1)<num_tokens; i+=2) {
+ 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];
+ }
+ 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);
}
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);
- 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);
projects / citadel.git / blobdiff