// 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
};
// 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);
+ ++crp->tag_nesting_level;
+ 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]);
}
crp->report_type = cr_freebusy_query;
}
- ++crp->tag_nesting_level;
+ // RFC4791 9.7 create a filter array if this query contains a "CALDAV:filter" stanza
+ else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:filter")) {
+ crp->filters = array_new(SIZ);
+ }
+
+ // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
+ else if ( ( (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:comp-filter"))
+ || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:prop-filter"))
+ || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:param-filter"))
+ || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:is-not-defined"))
+ || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:text-match"))
+ )
+ && (crp->filters) // Make sure we actually allocated an array
+ ) {
+ char newfilter[SIZ];
+ int a = 0;
+ int len = snprintf(newfilter, SIZ, &el[30]); // strip off "urn:ietf:params:xml:ns:caldav:" for our purposes
+ 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) {
memcpy(app, s, len);
app[len] = 0;
+ if (crp->Chardata == NULL) {
+ crp->Chardata = NewStrBuf();
+ }
+
+ StrBufAppendBufPlain(crp->Chardata, app, len, 0);
+
#ifdef DEBUG_XML_PARSE
// logging
- int i;
- char indent[256];
- indent[0] = 0;
- for (i=0; i<crp->tag_nesting_level; ++i) {
- strcat(indent, "··");
+ 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%s", indent, app);
// end logging
#endif
-
- if (crp->Chardata == NULL) {
- crp->Chardata = NewStrBuf();
- }
-
- //StrBufAppendBufPlain(crp->Chardata, s, len, 0);
- StrBufAppendBufPlain(crp->Chardata, app, len, 0);
free(app);
-
return;
}
}
+// Called by caldav_apply_filters() to apply ONE filter.
+// Returns 0 if the calendar item does not match the filter.
+// Returns 1 if the calendar item DOES match the filter.
+int caldav_apply_one_filter(void *cal, char *filter) {
+ syslog(LOG_DEBUG, "applying filter: %s", filter);
+
+ char this_filter[SIZ]; // we have to copy the filter string because we will destructively tokenize it
+ safestrncpy(this_filter, filter, sizeof(this_filter));
+
+ char *t[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } ;
+ char *f = this_filter;
+ int num_tokens = 0;
+ while ( (t[num_tokens]=strtok_r(f, "|", &f)) && (num_tokens<10) ) {
+ ++num_tokens;
+ }
+
+ // Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
+
+ if (!strcasecmp(t[0], "comp-filter")) { // RFC4791 9.7.1 - filter by component
+ syslog(LOG_DEBUG, "component filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[0], "prop-filter")) { // RFC4791 9.7.2 - filter by property
+ syslog(LOG_DEBUG, "property filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[0], "param-filter")) { // RFC4791 9.7.3 - filter by parameter
+ syslog(LOG_DEBUG, "parameter filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[0], "is-not-defined")) { // RFC4791 9.7.4
+ syslog(LOG_DEBUG, "is-not-defined filter FIXME not implemented yet");
+ }
+
+ else if (!strcasecmp(t[0], "text-match")) { // RFC4791 9.7.5
+ syslog(LOG_DEBUG, "text match filter FIXME not implemented yet");
+ }
+
+ return(1);
+}
+
+
+// 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 index) {
+
+ // Apply *this* filter.
+ if (caldav_apply_one_filter(cal, array_get_element_at(filters, index)) == 0) {
+ return(0);
+ }
+
+ // If we get to this point, the current filter has passed, and we move on to the next one.
+ if (index < array_len(filters)-1) {
+ return(caldav_apply_filters(cal, filters, index+1));
+ }
+
+ // If we got this far, every filter passed, and the calendar item qualifies for output.
+ return(1);
+}
+
+
// 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.
+ qualify = caldav_apply_filters(cal, crp.filters, 0);
+ syslog(LOG_DEBUG, "Message %ld does%s qualify", m, (qualify ? "" : " NOT"));
// 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.
projects / citadel.git / blobdiff