3c7797eed7cc798815af1977ddea819eee83d742
[citadel.git] / webcit-ng / server / caldav_reports.c
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.
4
5 #include "webcit.h"
6
7 #define CAL "urn:ietf:params:xml:ns:caldav:"            // Shorthand for the XML namespace of CalDAV
8 #define CALLEN sizeof(CAL)-1                            // And the length of that string
9
10 // A CalDAV REPORT can only be one type.  This is stored in the report_type member.
11 enum cr_type {
12         cr_calendar_query,
13         cr_calendar_multiget,
14         cr_freebusy_query
15 };
16
17
18 // Data type for CalDAV Report Parameters.
19 // As we slog our way through the XML we learn what the client is asking for
20 // and build up the contents of this data type.
21 struct cr_params {
22         int comp_filter_nesting_level;
23         enum cr_type report_type;       // which RFC4791 section 7 REPORT are we generating
24         StrBuf *Chardata;               // XML chardata in between tags is built up here
25         StrBuf *Hrefs;                  // list of items requested by a `calendar-multiget` REPORT
26         Array *filters;                 // If the query contains a FILTER stanza, the filter criteria are populated here
27         int filter_nest;                // tag nesting level where a FILTER stanza begins
28 };
29
30
31 // XML parser callback
32 void caldav_xml_start(void *data, const char *el, const char **attr) {
33         struct cr_params *crp = (struct cr_params *) data;
34
35 #ifdef DEBUG_XML_PARSE
36         // logging
37         syslog(LOG_DEBUG, "<%s>", el);
38         for (int i = 0; attr[i] != NULL; i += 2) {
39                 syslog(LOG_DEBUG, "Attribute '%s' = '%s'", attr[i], attr[i + 1]);
40         }
41         // end logging
42 #endif
43
44         // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
45         if (!strcasecmp(el, CAL"calendar-query")) {
46                 crp->report_type = cr_calendar_query;
47         }
48
49         // RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
50         else if (!strcasecmp(el, CAL"calendar-multiget")) {
51                 crp->report_type = cr_calendar_multiget;
52         }
53
54         // RFC4791 7.10 "free-busy-query" REPORT
55         else if (!strcasecmp(el, CAL"free-busy-query")) {
56                 crp->report_type = cr_freebusy_query;
57         }
58
59         // RFC4791 9.7 create a filter array if this query contains a "filter" stanza
60         else if (!strcasecmp(el, CAL"filter")) {
61                 crp->filters = array_new(SIZ);
62                 crp->filter_nest = crp->comp_filter_nesting_level;
63         }
64
65         // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
66         else if (       (       (!strcasecmp(el, CAL"comp-filter"))
67                                 || (!strcasecmp(el, CAL"prop-filter"))
68                                 || (!strcasecmp(el, CAL"param-filter"))
69                                 || (!strcasecmp(el, CAL"is-not-defined"))
70                                 || (!strcasecmp(el, CAL"text-match"))
71                                 || (!strcasecmp(el, CAL"time-range"))
72                         )
73                         && (crp->filters)                       // Make sure we actually allocated an array
74         ) {
75
76                 if (!strcasecmp(el, CAL"comp-filter")) {
77                         ++crp->comp_filter_nesting_level;
78                 }
79
80                 char newfilter[SIZ];
81                 int a = 0;
82                 int len = snprintf(newfilter, SIZ, "%d|", crp->comp_filter_nesting_level - crp->filter_nest - 1);
83                 len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALLEN]);           // filter name without the namespace
84                 while (attr[a]) {
85                         len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]);    // now save the attributes
86                 }
87                 array_append(crp->filters, newfilter);
88         }
89
90 }
91
92
93 // XML parser callback
94 void caldav_xml_end(void *data, const char *el) {
95         struct cr_params *crp = (struct cr_params *) data;
96
97 #ifdef DEBUG_XML_PARSE
98         // logging
99         int i;
100         syslog(LOG_DEBUG, "</%s>", el);
101         // end logging
102 #endif
103
104         if (!strcasecmp(el, CAL"comp-filter")) {
105                 --crp->comp_filter_nesting_level;
106         }
107
108
109         if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
110                 if (crp->Hrefs == NULL) {       // append crp->Chardata to crp->Hrefs
111                         crp->Hrefs = NewStrBuf();
112                 }
113                 else {
114                         StrBufAppendBufPlain(crp->Hrefs, HKEY("|"), 0);
115                 }
116                 StrBufAppendBuf(crp->Hrefs, crp->Chardata, 0);
117         }
118
119         if (crp->Chardata != NULL) {            // Tag is closed; chardata is now out of scope.
120                 FreeStrBuf(&crp->Chardata);     // Free the buffer.
121                 crp->Chardata = NULL;
122         }
123 }
124
125
126 // XML parser callback
127 void caldav_xml_chardata(void *data, const XML_Char *s, int len) {
128         struct cr_params *crp = (struct cr_params *) data;
129
130         char *app = malloc(len+1);
131         if (!app) {
132                 return;
133         }
134         memcpy(app, s, len);
135         app[len] = 0;
136
137         if (crp->Chardata == NULL) {
138                 crp->Chardata = NewStrBuf();
139         }
140
141         StrBufAppendBufPlain(crp->Chardata, app, len, 0);
142
143 #ifdef DEBUG_XML_PARSE
144         // logging
145         string_trim(app);               // remove leading/trailing whitespace.  ok to mangle it because we've already appended.
146         if (!IsEmptyStr(app)) {
147                 int i;
148                 syslog(LOG_DEBUG, "%s", app, len);
149         }
150         // end logging
151 #endif
152
153         free(app);
154         return;
155 }
156
157
158 // Called by caldav_report_one_item() to fetch a message (by number) in the current room,
159 // and return only the icalendar data as a StrBuf.  Returns NULL if not found.
160 //
161 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
162 // of a REPORT operation to set our preferred MIME type to calendar data.
163 StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
164         char buf[1024];
165         StrBuf *Buf = NULL;
166
167         ctdl_printf(c, "MSG4 %ld", msgnum);
168         ctdl_readline(c, buf, sizeof(buf));
169         if (buf[0] != '1') {
170                 return NULL;
171         }
172
173         while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
174                 if (Buf != NULL) {              // already in body
175                         StrBufAppendPrintf(Buf, "%s\n", buf);
176                 }
177                 else if (IsEmptyStr(buf)) {     // beginning of body
178                         Buf = NewStrBuf();
179                 }
180         }
181
182         return Buf;
183 }
184
185
186 // Called by multiple REPORT types to actually perform the output in "multiget" format.
187 // We need to already know the source message number and the href, but also already have the output data.
188 void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
189
190         StrBufAppendPrintf(ReportOut, "<D:response>");
191         StrBufAppendPrintf(ReportOut, "<D:href>");
192         StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
193         StrBufAppendPrintf(ReportOut, "</D:href>");
194         StrBufAppendPrintf(ReportOut, "<D:propstat>");
195
196         if (Caldata != NULL) {
197                 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 200 OK", ChrPtr(ThisHref));
198                 StrBufAppendPrintf(ReportOut, "<D:status>");
199                 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
200                 StrBufAppendPrintf(ReportOut, "</D:status>");
201                 StrBufAppendPrintf(ReportOut, "<D:prop>");
202                 StrBufAppendPrintf(ReportOut, "<D:getetag>");
203                 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
204                 StrBufAppendPrintf(ReportOut, "</D:getetag>");
205                 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
206                 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
207                 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
208                 StrBufAppendPrintf(ReportOut, "</D:prop>");
209         }
210         else {
211                 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 404 not found", ChrPtr(ThisHref));
212                 StrBufAppendPrintf(ReportOut, "<D:status>");
213                 StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
214                 StrBufAppendPrintf(ReportOut, "</D:status>");
215         }
216
217         StrBufAppendPrintf(ReportOut, "</D:propstat>");
218         StrBufAppendPrintf(ReportOut, "</D:response>");
219 }
220
221
222 // Called by caldav_report() to output a single item.
223 // Our policy is to throw away the list of properties the client asked for, and just send everything.
224 void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
225         long msgnum;
226         StrBuf *Caldata = NULL;
227         char *euid;
228
229         euid = strrchr(ChrPtr(ThisHref), '/');
230         if (euid != NULL) {
231                 ++euid;
232         }
233         else {
234                 euid = (char *) ChrPtr(ThisHref);
235         }
236
237         char *unescaped_euid = strdup(euid);
238         if (!unescaped_euid) {
239                 return;
240         }
241         unescape_input(unescaped_euid);
242
243         msgnum = locate_message_by_uid(c, unescaped_euid);
244         free(unescaped_euid);
245         if (msgnum > 0) {
246                 Caldata = fetch_ical(c, msgnum);
247         }
248         else {
249                 Caldata = NULL;
250         }
251
252         cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
253
254         if (Caldata != NULL) {
255                 FreeStrBuf(&Caldata);
256         }
257 }
258
259
260 // Compare function for "time-range" tests (RFC4791 section 9.9)
261 // Returns nonzero if the supplied icalcomponent occurs within the specified time range
262 int caldav_time_range_filter_matches(icalcomponent *cal_in, char *start_str, char *end_str) {
263
264         struct icaltimetype start = (
265                 (!IsEmptyStr(start_str))
266                 ? icaltime_from_string(start_str)
267                 : icaltime_from_string("19010101T010101Z")
268         );
269         syslog(LOG_DEBUG, "   search start: %16s --> \033[36m%s\033[0m", start_str, icaltime_as_ical_string_r(start));
270
271         struct icaltimetype end = (
272                 (!IsEmptyStr(end_str))
273                 ? icaltime_from_string(end_str)
274                 : icaltime_from_string("99991231T235959Z")              // ISO8601 is not Y10K compliant
275         );
276         syslog(LOG_DEBUG, "   search   end: %16s --> \033[36m%s\033[0m", end_str, icaltime_as_ical_string_r(end));
277
278
279 // NOTE TO ME: The header file says
280 // "This converts both times to the UTC timezone and compares them."
281 //      LIBICAL_ICAL_EXPORT int icaltime_compare(const struct icaltimetype a, const struct icaltimetype b);
282 // How does it do that without knowing the time zone?  Does it use a private method to look up into the
283 // parent component to find a VTIMEZONE component?  Find out.  If it can do that, we don't have to dezonify.
284
285
286
287         // make a local copy of the component because we are going to modify it by converting times to UTC
288         icalcomponent *cal = icalcomponent_new_clone(cal_in);
289         ical_dezonify(cal);
290
291
292
293         icaltimetype dts = icalcomponent_get_dtstart(cal);
294         syslog(LOG_DEBUG, "component start: \033[36m%s\033[0m", icaltime_as_ical_string_r(dts));
295
296         icaltimetype dte = icalcomponent_get_dtend(cal);
297         syslog(LOG_DEBUG, "component   end: \033[36m%s\033[0m", icaltime_as_ical_string_r(dte));
298
299         int result = ical_ctdl_is_overlap(dts, dte, start, end);        // We have a convenience function for this.
300
301         icalcomponent_free(cal);
302         return(result);
303 }
304
305
306 // Recursive function to apply CalDAV FILTERS to a calendar item.
307 // Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
308 int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
309
310         int f = 0;                                      // filter number iterator
311         int qual = 1;                                   // 0 for disqualify, 1 for qualify
312         int previous_level = -1;
313         int disregard_further_comp_filters = 0;
314
315         while ( (f<array_len(filters)) && (qual) ) {
316
317                 // Tokenize the filter (a future performance hack would be to pre-tokenize instead of storing delimited strings)
318                 char this_filter[SIZ];
319                 safestrncpy(this_filter, array_get_element_at(filters, f), sizeof(this_filter));
320                 char *t[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } ;
321                 char *ft = this_filter;
322                 int num_tokens = 0;
323                 while ( (t[num_tokens]=strtok_r(ft, "|", &ft)) && (num_tokens<10) ) {
324                         ++num_tokens;
325                 }
326                 int this_rule_level = atoi(t[0]);
327                 syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, this_rule_level, array_get_element_at(filters, f) );
328
329                 // Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
330
331                 if (apply_at_level < previous_level) {
332                         syslog(LOG_DEBUG, "caldav: walking back down");
333                         return(qual);
334                 }
335
336                 else if (this_rule_level != apply_at_level) {
337                         syslog(LOG_DEBUG, "caldav: apply_at_level=%d, this_rule_level=%d, skipping this rule", apply_at_level, this_rule_level);
338                 }
339
340                 else if (       (!strcasecmp(t[1], "comp-filter"))              // RFC4791 9.7.1 - filter by component
341                                 && (!disregard_further_comp_filters)            // one is enough to succeed
342                         ) {
343                         syslog(LOG_DEBUG, "component filter at level %d", this_rule_level);
344
345                         // comp-filter requires exactly one parameter (name="VXXXX")
346                         if (num_tokens < 4) {
347                                 syslog(LOG_DEBUG, "caldav: comp-filter has no parameters - rejecting");
348                                 return(0);
349                         }
350
351                         // Root element is NOT a component, but the root filter is "comp-filter" -- reject!
352                         if ( (!icalcomponent_isa_component(cal)) && (this_rule_level == 0) ) {
353                                 syslog(LOG_DEBUG, "caldav: root element is not a component, rejecting");
354                                 return(0);
355                         }
356
357                         // Current element is a component and the filter is "comp-filter" -- see if it matches the requested type
358                         if (    (icalcomponent_isa_component(cal))
359                                 && (!strcasecmp(t[2], "name"))
360                         ) {
361                                 if (icalcomponent_isa(cal) == icalcomponent_string_to_kind(t[3]) ) {
362                                         syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, recursing...",
363                                                 apply_at_level,
364                                                 icalcomponent_kind_to_string(icalcomponent_isa(cal)), t[3]
365                                         );
366
367                                         // We have a match.  Drill down into the subcomponents.
368
369                                         icalcomponent *c = NULL;
370                                         int number_of_subcomponents = 0;
371                                         int number_of_matches = 0;
372                                         for (   c = icalcomponent_get_first_component(cal, ICAL_ANY_COMPONENT);
373                                                 (c != 0);                                                
374                                                 c = icalcomponent_get_next_component(cal, ICAL_ANY_COMPONENT)
375                                         ) {
376                                                 ++number_of_subcomponents;
377                                                 if (caldav_apply_filters(c, filters, apply_at_level+1)) {
378                                                         syslog(LOG_DEBUG, "Subcomponent %d might match", number_of_subcomponents);
379                                                         ++number_of_matches;
380                                                 }
381                                         }
382                                         if (number_of_matches > 0) {                    // something matched
383                                                 qual = 1;
384                                                 disregard_further_comp_filters = 1;
385
386                                         }
387                                         else if (number_of_subcomponents > 0) {         // nothing matched
388                                                 return(0);                              // but only fail if there *were* subcomponents.
389                                         }
390
391                                 }
392                                 else {
393                                         syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, rejecting",
394                                                 apply_at_level,
395                                                 icalcomponent_kind_to_string(icalcomponent_isa(cal)),
396                                                 t[3]
397                                         );
398                                         return(0);
399                                 }
400                         }
401
402                 }
403
404                 else if (!strcasecmp(t[1], "prop-filter")) {                    // RFC4791 9.7.2 - filter by property
405                         syslog(LOG_DEBUG, "property filter at level %d FIXME not implemented yet", this_rule_level);
406                 }
407
408                 else if (!strcasecmp(t[1], "param-filter")) {                   // RFC4791 9.7.3 - filter by parameter
409                         syslog(LOG_DEBUG, "parameter filter at level %d FIXME not implemented yet", this_rule_level);
410                 }
411
412                 else if (!strcasecmp(t[1], "is-not-defined")) {                 // RFC4791 9.7.4
413                         syslog(LOG_DEBUG, "is-not-defined filter at level %d FIXME not implemented yet", this_rule_level);
414                 }
415
416                 else if (!strcasecmp(t[1], "text-match")) {                     // RFC4791 9.7.5
417                         syslog(LOG_DEBUG, "text match filter at level %d FIXME not implemented yet", this_rule_level);
418                 }
419
420                 else if (!strcasecmp(t[1], "time-range")) {                     // RFC4791 9.9
421                         syslog(LOG_DEBUG, "time range filter at level %d FIXME not implemented yet", this_rule_level);
422                         for (int i=2; (i+1)<num_tokens; i+=2) {
423                                 char *tr_start = NULL;
424                                 char *tr_end = NULL;
425                                 if (!strcasecmp(t[i], "start")) {
426                                         tr_start = t[i+1];
427                                 }
428                                 else if (!strcasecmp(t[i], "end")) {
429                                         tr_end = t[i+1];
430                                 }
431                                 if (caldav_time_range_filter_matches(cal, tr_start, tr_end)) {
432                                         syslog(LOG_DEBUG, "time range matches");
433                                 }
434                                 else {
435                                         syslog(LOG_DEBUG, "time range does not match -- rejecting");
436                                         qual = 0;
437                                 }
438                         }
439                 }
440
441                 ++f;
442         }
443
444         syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual);
445         return(qual);
446 }
447
448
449 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
450 // is requested on a calendar room.  We fire up an XML Parser to decode the request and
451 // hopefully produce the correct output.
452 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
453         struct cr_params crp;
454         char buf[1024];
455
456         memset(&crp, 0, sizeof(struct cr_params));
457
458         XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
459         if (xp == NULL) {
460                 syslog(LOG_INFO, "Cannot create XML parser!");
461                 do_404(h);
462                 return;
463         }
464
465         XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
466         XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
467         XML_SetUserData(xp, &crp);
468         XML_SetDefaultHandler(xp, NULL);        // Disable internal entity expansion to prevent "billion laughs attack"
469         XML_Parse(xp, h->request_body, h->request_body_length, 1);
470         XML_ParserFree(xp);
471
472         if (crp.Chardata != NULL) {             // Discard any trailing chardata ... normally nothing here
473                 FreeStrBuf(&crp.Chardata);
474                 crp.Chardata = NULL;
475         }
476
477         // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
478         // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
479         ctdl_printf(c, "MSGP text/calendar");
480         ctdl_readline(c, buf, sizeof buf);
481
482         // Now begin the REPORT.
483         syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
484         StrBuf *ReportOut = NewStrBuf();
485         StrBufAppendPrintf(ReportOut,
486                 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
487                 "<D:multistatus "
488                 "xmlns:D=\"DAV:\" "
489                 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
490                 ">"
491         );
492
493         // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
494         if (crp.report_type == cr_calendar_query) {
495                 int i = 0;
496                 Array *msglist = get_msglist(c, "ALL");
497                 if (msglist != NULL) {
498                         for (i = 0; i < array_len(msglist); ++i) {
499                                 long m;
500                                 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
501
502                                 // load and parse one calendar item
503                                 StrBuf *one_item = fetch_ical(c, m);
504                                 icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
505
506                                 // Does this calendar item qualify for output?
507                                 int qualify = 1;
508
509                                 // If there was a filter stanza, run this calendar item through the filters.
510                                 syslog(LOG_DEBUG, "Evaluating message \033[33m%ld\033[0m...", m);
511                                 qualify = caldav_apply_filters(cal, crp.filters, 0);
512                                 syslog(LOG_DEBUG, "Message %ld %s\033[0m qualify", m, (qualify ? "\033[32mDOES" : "\033[31mDOES NOT"));
513                                 syslog(LOG_DEBUG, "");
514
515                                 // Did this calendar item match the query?  If so, output it.
516                                 if (qualify) {
517                                         // FIXME need to populate the Href instead of NULL
518                                         cal_multiget_out(m, NULL, one_item, ReportOut);
519                                 }
520
521                                 icalcomponent_free(cal);
522                                 FreeStrBuf(&one_item);
523
524                         }
525                         array_free(msglist);
526                 }
527         }
528
529         // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
530         // Can we move this back into citserver too?
531         else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
532
533                 StrBuf *ThisHref = NewStrBuf();
534                 const char *pvset = NULL;
535                 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
536                         StrBufTrim(ThisHref);                           // remove leading/trailing whitespace from the href
537                         caldav_report_one_item(h, c, ReportOut, ThisHref);
538                 }
539                 FreeStrBuf(&ThisHref);
540         }
541
542         // RFC4791 7.10 "free-busy-query" REPORT
543         else if (crp.report_type == cr_freebusy_query) {
544                 // FIXME build this REPORT.  At the moment we send an empty multistatus.
545         }
546
547         // Free any query parameters that might have been allocated during the xml parse
548         if (crp.Hrefs != NULL) {
549                 FreeStrBuf(&crp.Hrefs);
550                 crp.Hrefs = NULL;
551         }
552         if (crp.filters) {
553                 array_free(crp.filters);
554                 crp.filters = NULL;
555         }
556
557         StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");            // End the REPORT.
558
559         add_response_header(h, strdup("Content-type"), strdup("text/xml"));
560         h->response_code = 207;
561         h->response_string = strdup("Multi-Status");
562         h->response_body_length = StrLength(ReportOut);
563         h->response_body = SmashStrBuf(&ReportOut);
564 }