X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=webcit-ng%2Fserver%2Fcaldav_reports.c;h=6f6fde733b50bd00e3126a08d69ef1786ffae1ef;hb=02bffe90aa686b47878c060af52fd6da66721d9e;hp=f042c70311388b6194752a7f40a30374ef097af1;hpb=dd9248637b2d2d26c30ace03a97b2877c49af399;p=citadel.git diff --git a/webcit-ng/server/caldav_reports.c b/webcit-ng/server/caldav_reports.c index f042c7031..6f6fde733 100644 --- a/webcit-ng/server/caldav_reports.c +++ b/webcit-ng/server/caldav_reports.c @@ -1,13 +1,11 @@ -// This file contains functions which handle all of the CalDAV "REPORT" queries -// specified in RFC4791 section 7. -// +// This file contains functions which handle all of the CalDAV "REPORT" queries specified in RFC4791 section 7. // Copyright (c) 2023-2024 by the citadel.org team -// -// This program is open source software. Use, duplication, or -// disclosure is subject to the GNU General Public License v3. +// This program is open source software. Use, duplication, or disclosure is subject to the GNU General Public License v3. #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 { @@ -20,53 +18,104 @@ 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; - int i; - - // syslog(LOG_DEBUG, "CALDAV ELEMENT START: <%s> %d", el, crp->tag_nesting_level); + struct cr_params *crp = (struct cr_params *) data; +#ifdef DEBUG_XML_PARSE + // logging + int i; + char indent[256]; + indent[0] = 0; + for (i=0; itag_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; itag_nesting_level; ++i) { + strcat(indent, " "); + } for (i = 0; attr[i] != NULL; i += 2) { - syslog(LOG_DEBUG, " Attribute '%s' = '%s'", attr[i], attr[i + 1]); + syslog(LOG_DEBUG, "%sAttribute '%s' = '%s'", indent, 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, "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; } - ++crp->tag_nesting_level; + // 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")) + || (!strcasecmp(el, CAL"time-range")) + ) + && (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; - if (crp->Chardata != NULL) { - // syslog(LOG_DEBUG, "CALDAV CHARDATA : %s", ChrPtr(crp->Chardata)); +#ifdef DEBUG_XML_PARSE + // logging + int i; + char indent[256]; + indent[0] = 0; + for (i=0; itag_nesting_level; ++i) { + strcat(indent, " "); } - // syslog(LOG_DEBUG, "CALDAV ELEMENT END : <%s> %d", el, crp->tag_nesting_level); + syslog(LOG_DEBUG, "%s", indent, el); + // end logging +#endif if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) { if (crp->Hrefs == NULL) { // append crp->Chardata to crp->Hrefs @@ -86,15 +135,38 @@ void caldav_xml_end(void *data, const char *el) { // XML parser callback -void caldav_xml_chardata(void *data, const XML_Char * s, int len) { - struct cr_parms *crp = (struct cr_parms *) data; +void caldav_xml_chardata(void *data, const XML_Char *s, int len) { + struct cr_params *crp = (struct cr_params *) data; + + char *app = malloc(len+1); + if (!app) { + return; + } + memcpy(app, s, len); + app[len] = 0; if (crp->Chardata == NULL) { crp->Chardata = NewStrBuf(); } - StrBufAppendBufPlain(crp->Chardata, s, len, 0); + StrBufAppendBufPlain(crp->Chardata, app, len, 0); + +#ifdef DEBUG_XML_PARSE + // logging + 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; itag_nesting_level; ++i) { + strcat(indent, " "); + } + syslog(LOG_DEBUG, "%s%s", indent, app, len); + } + // end logging +#endif + free(app); return; } @@ -201,14 +273,134 @@ void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, S } +// 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 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", 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 (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")) + && (!disregard_further_comp_filters) + ) { // RFC4791 9.7.1 - filter by component + syslog(LOG_DEBUG, "component filter at level %d", this_rule_level); + + // Root element is NOT a component, but the root filter is "comp-filter" -- reject! + if ( (!icalcomponent_isa_component(cal)) && (this_rule_level == 0) ) { + syslog(LOG_DEBUG, "caldav: root element is not a component, rejecting"); + return(0); + } + + // Current element is a component and the filter is "comp-filter" -- see if it matches the requested type + if ( (icalcomponent_isa_component(cal)) + && (!strcasecmp(t[2], "name")) + ) { + 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 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 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 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 at level %d FIXME not implemented yet", this_rule_level); + } + + else if (!strcasecmp(t[1], "time-range")) { + syslog(LOG_DEBUG, "time range filter at level %d FIXME not implemented yet", this_rule_level); + } + + ++f; + } + + syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual); + 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) { @@ -224,7 +416,7 @@ void caldav_report(struct http_transaction *h, struct ctdlsession *c) { XML_Parse(xp, h->request_body, h->request_body_length, 1); XML_ParserFree(xp); - if (crp.Chardata != NULL) { // Discard any trailing chardata ... normally nothing here + if (crp.Chardata != NULL) { // Discard any trailing chardata ... normally nothing here FreeStrBuf(&crp.Chardata); crp.Chardata = NULL; } @@ -258,10 +450,18 @@ 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)); - // this is a horrible temporary hack to output every item + // Does this calendar item qualify for output? int 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, 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) { + // FIXME need to populate the Href instead of NULL cal_multiget_out(m, NULL, one_item, ReportOut); } @@ -296,6 +496,10 @@ void caldav_report(struct http_transaction *h, struct ctdlsession *c) { FreeStrBuf(&crp.Hrefs); crp.Hrefs = NULL; } + if (crp.filters) { + array_free(crp.filters); + crp.filters = NULL; + } StrBufAppendPrintf(ReportOut, "\n"); // End the REPORT.