#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
// A CalDAV REPORT can only be one type. This is stored in the report_type member.
enum cr_type {
// 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_parms {
+struct cr_params {
int tag_nesting_level; // not needed, just kept for pretty-printing
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
+ Array *filters; // If the query contains a FILTER stanza, the filter criteria are populated here
+ int filter_nest; // tag nesting level where a FILTER stanza begins
};
// XML parser callback
void caldav_xml_start(void *data, const char *el, const char **attr) {
- struct cr_parms *crp = (struct cr_parms *) data;
+ struct cr_params *crp = (struct cr_params *) data;
#ifdef DEBUG_XML_PARSE
// logging
char indent[256];
indent[0] = 0;
for (i=0; i<crp->tag_nesting_level; ++i) {
- strcat(indent, "··");
+ 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, "··");
+ strcat(indent, " ");
}
for (i = 0; attr[i] != NULL; i += 2) {
syslog(LOG_DEBUG, "%sAttribute '%s' = '%s'", indent, attr[i], attr[i + 1]);
#endif
// RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
- if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-query")) {
+ if (!strcasecmp(el, CAL"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, "urn:ietf:params:xml:ns:caldav:calendar-multiget")) {
+ else if (!strcasecmp(el, CAL"calendar-multiget")) {
crp->report_type = cr_calendar_multiget;
}
// RFC4791 7.10 "free-busy-query" REPORT
- else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:free-busy-query")) {
+ else if (!strcasecmp(el, CAL"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")) {
+ crp->filters = array_new(SIZ);
+ crp->filter_nest = crp->tag_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"))
+ )
+ && (crp->filters) // Make sure we actually allocated an array
+ ) {
+
+ 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
+ while (attr[a]) {
+ len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]); // now save the attributes
+ }
+ array_append(crp->filters, newfilter);
+ }
+
}
// XML parser callback
void caldav_xml_end(void *data, const char *el) {
- struct cr_parms *crp = (struct cr_parms *) data;
+ struct cr_params *crp = (struct cr_params *) data;
--crp->tag_nesting_level;
char indent[256];
indent[0] = 0;
for (i=0; i<crp->tag_nesting_level; ++i) {
- strcat(indent, "··");
+ strcat(indent, " ");
}
syslog(LOG_DEBUG, "%s</%s>", indent, el);
// end logging
// XML parser callback
void caldav_xml_chardata(void *data, const XML_Char *s, int len) {
- struct cr_parms *crp = (struct cr_parms *) data;
+ struct cr_params *crp = (struct cr_params *) data;
char *app = malloc(len+1);
if (!app) {
char indent[256];
indent[0] = 0;
for (i=0; i<crp->tag_nesting_level; ++i) {
- strcat(indent, "··");
+ strcat(indent, " ");
}
syslog(LOG_DEBUG, "%s%s", indent, app, len);
}
}
+// 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 f = 0; // filter number iterator
+ int qual = 1; // 0 for disqualify, 1 for qualify
+
+ while ( (f<array_len(filters)) && (qual) ) {
+
+ // Tokenize the filter (a future performance hack would be to pre-tokenize instead of storing delimited strings)
+ char this_filter[SIZ];
+ safestrncpy(this_filter, array_get_element_at(filters, f), sizeof(this_filter));
+ char *t[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } ;
+ char *ft = this_filter;
+ int num_tokens = 0;
+ 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) );
+
+ // 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);
+
+ // Root element is NOT a component, but the root filter is "comp-filter" -- reject!
+ if ( (!icalcomponent_isa_component(cal)) && (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
+ 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",
+ 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");
+ }
+
+ else if (!strcasecmp(t[1], "param-filter")) { // RFC4791 9.7.3 - filter by parameter
+ syslog(LOG_DEBUG, "parameter filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[1], "is-not-defined")) { // RFC4791 9.7.4
+ syslog(LOG_DEBUG, "is-not-defined filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[1], "text-match")) { // RFC4791 9.7.5
+ syslog(LOG_DEBUG, "text match filter FIXME not implemented yet");
+ }
+
+ ++f;
+ }
+
+ return(qual);
+}
+
+
// Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
// is requested on a calendar room. We fire up an XML Parser to decode the request and
// hopefully produce the correct output.
void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
- struct cr_parms crp;
+ struct cr_params crp;
char buf[1024];
- memset(&crp, 0, sizeof(struct cr_parms));
+ memset(&crp, 0, sizeof(struct cr_params));
XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
if (xp == NULL) {
StrBuf *one_item = fetch_ical(c, m);
icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
- // qualify will be set to nonzero if this calendar item is a match for the QUERY.
- int qualify = 0;
+ // Does this calendar item qualify for output?
+ int qualify = 1;
- // this is a horrible temporary hack to output every item (for now)
- qualify = 1;
+ // 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);
+ 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) {
FreeStrBuf(&crp.Hrefs);
crp.Hrefs = NULL;
}
+ if (crp.filters) {
+ array_free(crp.filters);
+ crp.filters = NULL;
+ }
StrBufAppendPrintf(ReportOut, "</D:multistatus>\n"); // End the REPORT.