1 // This file contains functions which handle all of the CalDAV "REPORT" queries specified in RFC4791 section 7.
2 // Copyright (c) 2023-2024 by the citadel.org team
3 // This program is open source software. Use, duplication, or disclosure is subject to the GNU General Public License v3.
8 // A CalDAV REPORT can only be one type. This is stored in the report_type member.
16 // Data type for CalDAV Report Parameters.
17 // As we slog our way through the XML we learn what the client is asking for
18 // and build up the contents of this data type.
20 int tag_nesting_level; // not needed, just kept for pretty-printing
21 enum cr_type report_type; // which RFC4791 section 7 REPORT are we generating
22 StrBuf *Chardata; // XML chardata in between tags is built up here
23 StrBuf *Hrefs; // list of items requested by a `calendar-multiget` REPORT
24 Array *filters; // If the query contains a FILTER stanza, the filter criteria are populated here
28 // XML parser callback
29 void caldav_xml_start(void *data, const char *el, const char **attr) {
30 struct cr_params *crp = (struct cr_params *) data;
32 #ifdef DEBUG_XML_PARSE
37 for (i=0; i<crp->tag_nesting_level; ++i) {
40 syslog(LOG_DEBUG, "%s<%s>", indent, el);
41 ++crp->tag_nesting_level;
43 for (i=0; i<crp->tag_nesting_level; ++i) {
46 for (i = 0; attr[i] != NULL; i += 2) {
47 syslog(LOG_DEBUG, "%sAttribute '%s' = '%s'", indent, attr[i], attr[i + 1]);
52 // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
53 if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-query")) {
54 crp->report_type = cr_calendar_query;
57 // RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
58 else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-multiget")) {
59 crp->report_type = cr_calendar_multiget;
62 // RFC4791 7.10 "free-busy-query" REPORT
63 else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:free-busy-query")) {
64 crp->report_type = cr_freebusy_query;
67 // RFC4791 9.7 create a filter array if this query contains a "CALDAV:filter" stanza
68 else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:filter")) {
69 crp->filters = array_new(SIZ);
72 // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
73 else if ( ( (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:comp-filter"))
74 || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:prop-filter"))
75 || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:param-filter"))
76 || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:is-not-defined"))
77 || (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:text-match"))
79 && (crp->filters) // Make sure we actually allocated an array
83 int len = snprintf(newfilter, SIZ, &el[23]); // strip off "urn:ietf:params:xml:ns:caldav:" for our purposes
85 len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]); // now save the attributes
87 array_append(crp->filters, newfilter);
88 syslog(LOG_DEBUG, "%s", newfilter);
94 // XML parser callback
95 void caldav_xml_end(void *data, const char *el) {
96 struct cr_params *crp = (struct cr_params *) data;
98 --crp->tag_nesting_level;
100 #ifdef DEBUG_XML_PARSE
105 for (i=0; i<crp->tag_nesting_level; ++i) {
108 syslog(LOG_DEBUG, "%s</%s>", indent, el);
112 if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
113 if (crp->Hrefs == NULL) { // append crp->Chardata to crp->Hrefs
114 crp->Hrefs = NewStrBuf();
117 StrBufAppendBufPlain(crp->Hrefs, HKEY("|"), 0);
119 StrBufAppendBuf(crp->Hrefs, crp->Chardata, 0);
122 if (crp->Chardata != NULL) { // Tag is closed; chardata is now out of scope.
123 FreeStrBuf(&crp->Chardata); // Free the buffer.
124 crp->Chardata = NULL;
129 // XML parser callback
130 void caldav_xml_chardata(void *data, const XML_Char *s, int len) {
131 struct cr_params *crp = (struct cr_params *) data;
133 char *app = malloc(len+1);
140 if (crp->Chardata == NULL) {
141 crp->Chardata = NewStrBuf();
144 StrBufAppendBufPlain(crp->Chardata, app, len, 0);
146 #ifdef DEBUG_XML_PARSE
148 string_trim(app); // remove leading/trailing whitespace. ok to mangle it because we've already appended.
149 if (!IsEmptyStr(app)) {
153 for (i=0; i<crp->tag_nesting_level; ++i) {
156 syslog(LOG_DEBUG, "%s%s", indent, app, len);
166 // Called by caldav_report_one_item() to fetch a message (by number) in the current room,
167 // and return only the icalendar data as a StrBuf. Returns NULL if not found.
169 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
170 // of a REPORT operation to set our preferred MIME type to calendar data.
171 StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
175 ctdl_printf(c, "MSG4 %ld", msgnum);
176 ctdl_readline(c, buf, sizeof(buf));
181 while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
182 if (Buf != NULL) { // already in body
183 StrBufAppendPrintf(Buf, "%s\n", buf);
185 else if (IsEmptyStr(buf)) { // beginning of body
194 // Called by multiple REPORT types to actually perform the output in "multiget" format.
195 // We need to already know the source message number and the href, but also already have the output data.
196 void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
198 StrBufAppendPrintf(ReportOut, "<D:response>");
199 StrBufAppendPrintf(ReportOut, "<D:href>");
200 StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
201 StrBufAppendPrintf(ReportOut, "</D:href>");
202 StrBufAppendPrintf(ReportOut, "<D:propstat>");
204 if (Caldata != NULL) {
205 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 200 OK", ChrPtr(ThisHref));
206 StrBufAppendPrintf(ReportOut, "<D:status>");
207 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
208 StrBufAppendPrintf(ReportOut, "</D:status>");
209 StrBufAppendPrintf(ReportOut, "<D:prop>");
210 StrBufAppendPrintf(ReportOut, "<D:getetag>");
211 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
212 StrBufAppendPrintf(ReportOut, "</D:getetag>");
213 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
214 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
215 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
216 StrBufAppendPrintf(ReportOut, "</D:prop>");
219 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 404 not found", ChrPtr(ThisHref));
220 StrBufAppendPrintf(ReportOut, "<D:status>");
221 StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
222 StrBufAppendPrintf(ReportOut, "</D:status>");
225 StrBufAppendPrintf(ReportOut, "</D:propstat>");
226 StrBufAppendPrintf(ReportOut, "</D:response>");
230 // Called by caldav_report() to output a single item.
231 // Our policy is to throw away the list of properties the client asked for, and just send everything.
232 void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
234 StrBuf *Caldata = NULL;
237 euid = strrchr(ChrPtr(ThisHref), '/');
242 euid = (char *) ChrPtr(ThisHref);
245 char *unescaped_euid = strdup(euid);
246 if (!unescaped_euid) {
249 unescape_input(unescaped_euid);
251 msgnum = locate_message_by_uid(c, unescaped_euid);
252 free(unescaped_euid);
254 Caldata = fetch_ical(c, msgnum);
260 cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
262 if (Caldata != NULL) {
263 FreeStrBuf(&Caldata);
268 // Called by caldav_apply_filters() to apply ONE filter.
269 // Returns 0 if the calendar item does not match the filter.
270 // Returns 1 if the calendar item DOES match the filter.
271 int caldav_apply_one_filter(void *cal, char *filter) {
272 syslog(LOG_DEBUG, "applying filter: %s", filter);
277 // Recursive function to apply CalDAV FILTERS to a calendar item.
278 // Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
279 int caldav_apply_filters(void *cal, Array *filters, int index) {
281 // Apply *this* filter.
282 if (caldav_apply_one_filter(cal, array_get_element_at(filters, index)) == 0) {
286 // If we get to this point, the current filter has passed, and we move on to the next one.
287 if (index < array_len(filters)-1) {
288 return(caldav_apply_filters(cal, filters, index+1));
291 // If we got this far, every filter passed, and the calendar item qualifies for output.
296 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
297 // is requested on a calendar room. We fire up an XML Parser to decode the request and
298 // hopefully produce the correct output.
299 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
300 struct cr_params crp;
303 memset(&crp, 0, sizeof(struct cr_params));
305 XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
307 syslog(LOG_INFO, "Cannot create XML parser!");
312 XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
313 XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
314 XML_SetUserData(xp, &crp);
315 XML_SetDefaultHandler(xp, NULL); // Disable internal entity expansion to prevent "billion laughs attack"
316 XML_Parse(xp, h->request_body, h->request_body_length, 1);
319 if (crp.Chardata != NULL) { // Discard any trailing chardata ... normally nothing here
320 FreeStrBuf(&crp.Chardata);
324 // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
325 // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
326 ctdl_printf(c, "MSGP text/calendar");
327 ctdl_readline(c, buf, sizeof buf);
329 // Now begin the REPORT.
330 syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
331 StrBuf *ReportOut = NewStrBuf();
332 StrBufAppendPrintf(ReportOut,
333 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
336 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
340 // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
341 if (crp.report_type == cr_calendar_query) {
343 Array *msglist = get_msglist(c, "ALL");
344 if (msglist != NULL) {
345 for (i = 0; i < array_len(msglist); ++i) {
347 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
349 // load and parse one calendar item
350 StrBuf *one_item = fetch_ical(c, m);
351 icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
353 // Does this calendar item qualify for output?
356 // If there was a filter stanza, run this calendar item through the filters.
357 qualify = caldav_apply_filters(cal, crp.filters, 0);
358 syslog(LOG_DEBUG, "Message %ld does%s qualify", m, (qualify ? "" : " NOT"));
360 // Did this calendar item match the query? If so, output it.
362 // FIXME need to populate the Href instead of NULL
363 cal_multiget_out(m, NULL, one_item, ReportOut);
366 icalcomponent_free(cal);
367 FreeStrBuf(&one_item);
374 // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
375 // Can we move this back into citserver too?
376 else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
378 StrBuf *ThisHref = NewStrBuf();
379 const char *pvset = NULL;
380 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
381 StrBufTrim(ThisHref); // remove leading/trailing whitespace from the href
382 caldav_report_one_item(h, c, ReportOut, ThisHref);
384 FreeStrBuf(&ThisHref);
387 // RFC4791 7.10 "free-busy-query" REPORT
388 else if (crp.report_type == cr_freebusy_query) {
389 // FIXME build this REPORT. At the moment we send an empty multistatus.
392 // Free any query parameters that might have been allocated during the xml parse
393 if (crp.Hrefs != NULL) {
394 FreeStrBuf(&crp.Hrefs);
398 array_free(crp.filters);
402 StrBufAppendPrintf(ReportOut, "</D:multistatus>\n"); // End the REPORT.
404 add_response_header(h, strdup("Content-type"), strdup("text/xml"));
405 h->response_code = 207;
406 h->response_string = strdup("Multi-Status");
407 h->response_body_length = StrLength(ReportOut);
408 h->response_body = SmashStrBuf(&ReportOut);