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 // Recursive function to apply CalDAV FILTERS to a calendar item.
 261 // Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
 262 int caldav_apply_filters(void *cal, Array *filters, int apply_at_level) {
 263
 264         int f = 0;                                      // filter number iterator
 265         int qual = 1;                                   // 0 for disqualify, 1 for qualify
 266         int previous_level = -1;
 267         int disregard_further_comp_filters = 0;
 268
 269         while ( (f<array_len(filters)) && (qual) ) {
 270
 271                 // Tokenize the filter (a future performance hack would be to pre-tokenize instead of storing delimited strings)
 272                 char this_filter[SIZ];
 273                 safestrncpy(this_filter, array_get_element_at(filters, f), sizeof(this_filter));
 274                 char *t[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } ;
 275                 char *ft = this_filter;
 276                 int num_tokens = 0;
 277                 while ( (t[num_tokens]=strtok_r(ft, "|", &ft)) && (num_tokens<10) ) {
 278                         ++num_tokens;
 279                 }
 280                 int this_rule_level = atoi(t[0]);
 281                 syslog(LOG_DEBUG, "caldav_apply_filters() filter=%d, level=%d, <%s>", f, this_rule_level, array_get_element_at(filters, f) );
 282
 283                 // Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
 284
 285                 if (apply_at_level < previous_level) {
 286                         syslog(LOG_DEBUG, "caldav: walking back down");
 287                         return(qual);
 288                 }
 289
 290                 else if (this_rule_level != apply_at_level) {
 291                         syslog(LOG_DEBUG, "caldav: apply_at_level=%d, this_rule_level=%d, skipping this rule", apply_at_level, this_rule_level);
 292                 }
 293
 294                 else if (       (!strcasecmp(t[1], "comp-filter"))
 295                                 && (!disregard_further_comp_filters)
 296                         ) {                                                     // RFC4791 9.7.1 - filter by component
 297                         syslog(LOG_DEBUG, "component filter at level %d", this_rule_level);
 298
 299                         // Root element is NOT a component, but the root filter is "comp-filter" -- reject!
 300                         if ( (!icalcomponent_isa_component(cal)) && (this_rule_level == 0) ) {
 301                                 syslog(LOG_DEBUG, "caldav: root element is not a component, rejecting");
 302                                 return(0);
 303                         }
 304
 305                         // Current element is a component and the filter is "comp-filter" -- see if it matches the requested type
 306                         if (    (icalcomponent_isa_component(cal))
 307                                 && (!strcasecmp(t[2], "name"))
 308                         ) {
 309                                 if (icalcomponent_isa(cal) == icalcomponent_string_to_kind(t[3]) ) {
 310                                         syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, recursing...",
 311                                                 apply_at_level,
 312                                                 icalcomponent_kind_to_string(icalcomponent_isa(cal)), t[3]
 313                                         );
 314
 315                                         // We have a match.  Drill down into the subcomponents.
 316
 317                                         icalcomponent *c = NULL;
 318                                         int number_of_subcomponents = 0;
 319                                         int number_of_matches = 0;
 320                                         for (   c = icalcomponent_get_first_component(cal, ICAL_ANY_COMPONENT);
 321                                                 (c != 0);
 322                                                 c = icalcomponent_get_next_component(cal, ICAL_ANY_COMPONENT)
 323                                         ) {
 324                                                 ++number_of_subcomponents;
 325                                                 if (caldav_apply_filters(c, filters, apply_at_level+1)) {
 326                                                         syslog(LOG_DEBUG, "Subcomponent %d might match", number_of_subcomponents);
 327                                                         ++number_of_matches;
 328                                                 }
 329                                         }
 330                                         if (number_of_matches > 0) {                    // something matched
 331                                                 qual = 1;
 332                                                 disregard_further_comp_filters = 1;
 333
 334                                         }
 335                                         else if (number_of_subcomponents > 0) {         // nothing matched
 336                                                 return(0);                              // but only fail if there *were* subcomponents.
 337                                         }
 338
 339                                 }
 340                                 else {
 341                                         syslog(LOG_DEBUG, "caldav: component at level %d is <%s>, looking for <%s>, rejecting",
 342                                                 apply_at_level,
 343                                                 icalcomponent_kind_to_string(icalcomponent_isa(cal)),
 344                                                 t[3]
 345                                         );
 346                                         return(0);
 347                                 }
 348                         }
 349
 350                 }
 351
 352                 else if (!strcasecmp(t[1], "prop-filter")) {                    // RFC4791 9.7.2 - filter by property
 353                         syslog(LOG_DEBUG, "property filter at level %d FIXME not implemented yet", this_rule_level);
 354                 }
 355
 356                 else if (!strcasecmp(t[1], "param-filter")) {                   // RFC4791 9.7.3 - filter by parameter
 357                         syslog(LOG_DEBUG, "parameter filter at level %d FIXME not implemented yet", this_rule_level);
 358                 }
 359
 360                 else if (!strcasecmp(t[1], "is-not-defined")) {                 // RFC4791 9.7.4
 361                         syslog(LOG_DEBUG, "is-not-defined filter at level %d FIXME not implemented yet", this_rule_level);
 362                 }
 363
 364                 else if (!strcasecmp(t[1], "text-match")) {                     // RFC4791 9.7.5
 365                         syslog(LOG_DEBUG, "text match filter at level %d FIXME not implemented yet", this_rule_level);
 366                 }
 367
 368                 else if (!strcasecmp(t[1], "time-range")) {
 369                         syslog(LOG_DEBUG, "time range filter at level %d FIXME not implemented yet", this_rule_level);
 370                 }
 371
 372                 ++f;
 373         }
 374
 375         syslog(LOG_DEBUG, "caldav: we reached the end of level %d , returning %d", apply_at_level, qual);
 376         return(qual);
 377 }
 378
 379
 380 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
 381 // is requested on a calendar room.  We fire up an XML Parser to decode the request and
 382 // hopefully produce the correct output.
 383 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
 384         struct cr_params crp;
 385         char buf[1024];
 386
 387         memset(&crp, 0, sizeof(struct cr_params));
 388
 389         XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
 390         if (xp == NULL) {
 391                 syslog(LOG_INFO, "Cannot create XML parser!");
 392                 do_404(h);
 393                 return;
 394         }
 395
 396         XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
 397         XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
 398         XML_SetUserData(xp, &crp);
 399         XML_SetDefaultHandler(xp, NULL);        // Disable internal entity expansion to prevent "billion laughs attack"
 400         XML_Parse(xp, h->request_body, h->request_body_length, 1);
 401         XML_ParserFree(xp);
 402
 403         if (crp.Chardata != NULL) {             // Discard any trailing chardata ... normally nothing here
 404                 FreeStrBuf(&crp.Chardata);
 405                 crp.Chardata = NULL;
 406         }
 407
 408         // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
 409         // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
 410         ctdl_printf(c, "MSGP text/calendar");
 411         ctdl_readline(c, buf, sizeof buf);
 412
 413         // Now begin the REPORT.
 414         syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
 415         StrBuf *ReportOut = NewStrBuf();
 416         StrBufAppendPrintf(ReportOut,
 417                 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
 418                 "<D:multistatus "
 419                 "xmlns:D=\"DAV:\" "
 420                 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
 421                 ">"
 422         );
 423
 424         // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
 425         if (crp.report_type == cr_calendar_query) {
 426                 int i = 0;
 427                 Array *msglist = get_msglist(c, "ALL");
 428                 if (msglist != NULL) {
 429                         for (i = 0; i < array_len(msglist); ++i) {
 430                                 long m;
 431                                 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
 432
 433                                 // load and parse one calendar item
 434                                 StrBuf *one_item = fetch_ical(c, m);
 435                                 icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
 436
 437                                 // Does this calendar item qualify for output?
 438                                 int qualify = 1;
 439
 440                                 // If there was a filter stanza, run this calendar item through the filters.
 441                                 syslog(LOG_DEBUG, "Evaluating message \033[33m%ld\033[0m...", m);
 442                                 qualify = caldav_apply_filters(cal, crp.filters, 0);
 443                                 syslog(LOG_DEBUG, "Message %ld %s\033[0m qualify", m, (qualify ? "\033[32mDOES" : "\033[31mDOES NOT"));
 444                                 syslog(LOG_DEBUG, "");
 445
 446                                 // Did this calendar item match the query?  If so, output it.
 447                                 if (qualify) {
 448                                         // FIXME need to populate the Href instead of NULL
 449                                         cal_multiget_out(m, NULL, one_item, ReportOut);
 450                                 }
 451
 452                                 icalcomponent_free(cal);
 453                                 FreeStrBuf(&one_item);
 454
 455                         }
 456                         array_free(msglist);
 457                 }
 458         }
 459
 460         // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
 461         // Can we move this back into citserver too?
 462         else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
 463
 464                 StrBuf *ThisHref = NewStrBuf();
 465                 const char *pvset = NULL;
 466                 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
 467                         StrBufTrim(ThisHref);                           // remove leading/trailing whitespace from the href
 468                         caldav_report_one_item(h, c, ReportOut, ThisHref);
 469                 }
 470                 FreeStrBuf(&ThisHref);
 471         }
 472
 473         // RFC4791 7.10 "free-busy-query" REPORT
 474         else if (crp.report_type == cr_freebusy_query) {
 475                 // FIXME build this REPORT.  At the moment we send an empty multistatus.
 476         }
 477
 478         // Free any query parameters that might have been allocated during the xml parse
 479         if (crp.Hrefs != NULL) {
 480                 FreeStrBuf(&crp.Hrefs);
 481                 crp.Hrefs = NULL;
 482         }
 483         if (crp.filters) {
 484                 array_free(crp.filters);
 485                 crp.filters = NULL;
 486         }
 487
 488         StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");            // End the REPORT.
 489
 490         add_response_header(h, strdup("Content-type"), strdup("text/xml"));
 491         h->response_code = 207;
 492         h->response_string = strdup("Multi-Status");
 493         h->response_body_length = StrLength(ReportOut);
 494         h->response_body = SmashStrBuf(&ReportOut);
 495 }