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 tag_nesting_level;          // not needed, just kept for pretty-printing
  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         int i;
  38         char indent[256];
  39         indent[0] = 0;
  40         for (i=0; i<crp->tag_nesting_level; ++i) {
  41                 strcat(indent, "  ");
  42         }
  43         syslog(LOG_DEBUG, "%s<%s>", indent, el);
  44 #endif
  45         ++crp->tag_nesting_level;
  46 #ifdef DEBUG_XML_PARSE
  47         indent[0] = 0;
  48         for (i=0; i<crp->tag_nesting_level; ++i) {
  49                 strcat(indent, "  ");
  50         }
  51         for (i = 0; attr[i] != NULL; i += 2) {
  52                 syslog(LOG_DEBUG, "%sAttribute '%s' = '%s'", indent, attr[i], attr[i + 1]);
  53         }
  54         // end logging
  55 #endif
  56
  57         // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
  58         if (!strcasecmp(el, CAL"calendar-query")) {
  59                 crp->report_type = cr_calendar_query;
  60         }
  61
  62         // RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
  63         else if (!strcasecmp(el, CAL"calendar-multiget")) {
  64                 crp->report_type = cr_calendar_multiget;
  65         }
  66
  67         // RFC4791 7.10 "free-busy-query" REPORT
  68         else if (!strcasecmp(el, CAL"free-busy-query")) {
  69                 crp->report_type = cr_freebusy_query;
  70         }
  71
  72         // RFC4791 9.7 create a filter array if this query contains a "filter" stanza
  73         else if (!strcasecmp(el, CAL"filter")) {
  74                 crp->filters = array_new(SIZ);
  75                 crp->filter_nest = crp->tag_nesting_level;
  76         }
  77
  78         // Handle the filters defined in RFC4791 9.7.1 through 9.7.5
  79         else if (       (       (!strcasecmp(el, CAL"comp-filter"))
  80                                 || (!strcasecmp(el, CAL"prop-filter"))
  81                                 || (!strcasecmp(el, CAL"param-filter"))
  82                                 || (!strcasecmp(el, CAL"is-not-defined"))
  83                                 || (!strcasecmp(el, CAL"text-match"))
  84                         )
  85                         && (crp->filters)                       // Make sure we actually allocated an array
  86         ) {
  87
  88                 char newfilter[SIZ];
  89                 int a = 0;
  90                 int len = snprintf(newfilter, SIZ, "%d|", crp->tag_nesting_level - crp->filter_nest - 1);
  91                 len += snprintf(&newfilter[len], SIZ-len, "%s", &el[CALLEN]);           // filter name without the namespace
  92                 while (attr[a]) {
  93                         len += snprintf(&newfilter[len], SIZ-len, "|%s", attr[a++]);    // now save the attributes
  94                 }
  95                 array_append(crp->filters, newfilter);
  96         }
  97
  98 }
  99
 100
 101 // XML parser callback
 102 void caldav_xml_end(void *data, const char *el) {
 103         struct cr_params *crp = (struct cr_params *) data;
 104
 105         --crp->tag_nesting_level;
 106
 107 #ifdef DEBUG_XML_PARSE
 108         // logging
 109         int i;
 110         char indent[256];
 111         indent[0] = 0;
 112         for (i=0; i<crp->tag_nesting_level; ++i) {
 113                 strcat(indent, "  ");
 114         }
 115         syslog(LOG_DEBUG, "%s</%s>", indent, el);
 116         // end logging
 117 #endif
 118
 119         if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
 120                 if (crp->Hrefs == NULL) {       // append crp->Chardata to crp->Hrefs
 121                         crp->Hrefs = NewStrBuf();
 122                 }
 123                 else {
 124                         StrBufAppendBufPlain(crp->Hrefs, HKEY("|"), 0);
 125                 }
 126                 StrBufAppendBuf(crp->Hrefs, crp->Chardata, 0);
 127         }
 128
 129         if (crp->Chardata != NULL) {            // Tag is closed; chardata is now out of scope.
 130                 FreeStrBuf(&crp->Chardata);     // Free the buffer.
 131                 crp->Chardata = NULL;
 132         }
 133 }
 134
 135
 136 // XML parser callback
 137 void caldav_xml_chardata(void *data, const XML_Char *s, int len) {
 138         struct cr_params *crp = (struct cr_params *) data;
 139
 140         char *app = malloc(len+1);
 141         if (!app) {
 142                 return;
 143         }
 144         memcpy(app, s, len);
 145         app[len] = 0;
 146
 147         if (crp->Chardata == NULL) {
 148                 crp->Chardata = NewStrBuf();
 149         }
 150
 151         StrBufAppendBufPlain(crp->Chardata, app, len, 0);
 152
 153 #ifdef DEBUG_XML_PARSE
 154         // logging
 155         string_trim(app);               // remove leading/trailing whitespace.  ok to mangle it because we've already appended.
 156         if (!IsEmptyStr(app)) {
 157                 int i;
 158                 char indent[256];
 159                 indent[0] = 0;
 160                 for (i=0; i<crp->tag_nesting_level; ++i) {
 161                         strcat(indent, "  ");
 162                 }
 163                 syslog(LOG_DEBUG, "%s%s", indent, app, len);
 164         }
 165         // end logging
 166 #endif
 167
 168         free(app);
 169         return;
 170 }
 171
 172
 173 // Called by caldav_report_one_item() to fetch a message (by number) in the current room,
 174 // and return only the icalendar data as a StrBuf.  Returns NULL if not found.
 175 //
 176 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
 177 // of a REPORT operation to set our preferred MIME type to calendar data.
 178 StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
 179         char buf[1024];
 180         StrBuf *Buf = NULL;
 181
 182         ctdl_printf(c, "MSG4 %ld", msgnum);
 183         ctdl_readline(c, buf, sizeof(buf));
 184         if (buf[0] != '1') {
 185                 return NULL;
 186         }
 187
 188         while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
 189                 if (Buf != NULL) {              // already in body
 190                         StrBufAppendPrintf(Buf, "%s\n", buf);
 191                 }
 192                 else if (IsEmptyStr(buf)) {     // beginning of body
 193                         Buf = NewStrBuf();
 194                 }
 195         }
 196
 197         return Buf;
 198 }
 199
 200
 201 // Called by multiple REPORT types to actually perform the output in "multiget" format.
 202 // We need to already know the source message number and the href, but also already have the output data.
 203 void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
 204
 205         StrBufAppendPrintf(ReportOut, "<D:response>");
 206         StrBufAppendPrintf(ReportOut, "<D:href>");
 207         StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
 208         StrBufAppendPrintf(ReportOut, "</D:href>");
 209         StrBufAppendPrintf(ReportOut, "<D:propstat>");
 210
 211         if (Caldata != NULL) {
 212                 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 200 OK", ChrPtr(ThisHref));
 213                 StrBufAppendPrintf(ReportOut, "<D:status>");
 214                 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
 215                 StrBufAppendPrintf(ReportOut, "</D:status>");
 216                 StrBufAppendPrintf(ReportOut, "<D:prop>");
 217                 StrBufAppendPrintf(ReportOut, "<D:getetag>");
 218                 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
 219                 StrBufAppendPrintf(ReportOut, "</D:getetag>");
 220                 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
 221                 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
 222                 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
 223                 StrBufAppendPrintf(ReportOut, "</D:prop>");
 224         }
 225         else {
 226                 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 404 not found", ChrPtr(ThisHref));
 227                 StrBufAppendPrintf(ReportOut, "<D:status>");
 228                 StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
 229                 StrBufAppendPrintf(ReportOut, "</D:status>");
 230         }
 231
 232         StrBufAppendPrintf(ReportOut, "</D:propstat>");
 233         StrBufAppendPrintf(ReportOut, "</D:response>");
 234 }
 235
 236
 237 // Called by caldav_report() to output a single item.
 238 // Our policy is to throw away the list of properties the client asked for, and just send everything.
 239 void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
 240         long msgnum;
 241         StrBuf *Caldata = NULL;
 242         char *euid;
 243
 244         euid = strrchr(ChrPtr(ThisHref), '/');
 245         if (euid != NULL) {
 246                 ++euid;
 247         }
 248         else {
 249                 euid = (char *) ChrPtr(ThisHref);
 250         }
 251
 252         char *unescaped_euid = strdup(euid);
 253         if (!unescaped_euid) {
 254                 return;
 255         }
 256         unescape_input(unescaped_euid);
 257
 258         msgnum = locate_message_by_uid(c, unescaped_euid);
 259         free(unescaped_euid);
 260         if (msgnum > 0) {
 261                 Caldata = fetch_ical(c, msgnum);
 262         }
 263         else {
 264                 Caldata = NULL;
 265         }
 266
 267         cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
 268
 269         if (Caldata != NULL) {
 270                 FreeStrBuf(&Caldata);
 271         }
 272 }
 273
 274
 275 // Recursive function to apply CalDAV FILTERS to a calendar item.
 276 // Returns zero if the calendar item was disqualified by a filter, nonzero if the calendar item still qualifies.
 277 int caldav_apply_filters(void *cal, Array *filters) {
 278
 279         int f = 0;                                      // filter number iterator
 280         int qual = 1;                                   // 0 for disqualify, 1 for qualify
 281
 282         while ( (f<array_len(filters)) && (qual) ) {
 283                 syslog(LOG_DEBUG, "caldav_apply_filters(%d) %s", f, array_get_element_at(filters, f) );
 284
 285                 // Tokenize the filter (a future performance hack would be to pre-tokenize instead of storing delimited strings)
 286                 char this_filter[SIZ];
 287                 safestrncpy(this_filter, array_get_element_at(filters, f), sizeof(this_filter));
 288                 char *t[10] = { NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL, NULL } ;
 289                 char *ft = this_filter;
 290                 int num_tokens = 0;
 291                 while ( (t[num_tokens]=strtok_r(ft, "|", &ft)) && (num_tokens<10) ) {
 292                         ++num_tokens;
 293                 }
 294                 int level = atoi(t[0]);
 295
 296                 // Handle the individual filters defined in RFC4791 9.7.1 through 9.7.5
 297
 298                 if (!strcasecmp(t[1], "comp-filter")) {                         // RFC4791 9.7.1 - filter by component
 299                         syslog(LOG_DEBUG, "component filter at level %d FIXME not implemented yet", level);
 300                         if (icalcomponent_isa_component(cal)) {
 301                                 // yes this is a component
 302                         }
 303                 }
 304
 305                 else if (!strcasecmp(t[1], "prop-filter")) {                    // RFC4791 9.7.2 - filter by property
 306                         syslog(LOG_DEBUG, "property filter FIXME not implemented yet");
 307                 }
 308
 309                 else if (!strcasecmp(t[1], "param-filter")) {                   // RFC4791 9.7.3 - filter by parameter
 310                         syslog(LOG_DEBUG, "parameter filter FIXME not implemented yet");
 311                 }
 312
 313                 else if (!strcasecmp(t[1], "is-not-defined")) {                 // RFC4791 9.7.4
 314                         syslog(LOG_DEBUG, "is-not-defined filter FIXME not implemented yet");
 315                 }
 316
 317                 else if (!strcasecmp(t[1], "text-match")) {                     // RFC4791 9.7.5
 318                         syslog(LOG_DEBUG, "text match filter FIXME not implemented yet");
 319                 }
 320
 321                 ++f;
 322         }
 323
 324         return(qual);
 325 }
 326
 327
 328 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
 329 // is requested on a calendar room.  We fire up an XML Parser to decode the request and
 330 // hopefully produce the correct output.
 331 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
 332         struct cr_params crp;
 333         char buf[1024];
 334
 335         memset(&crp, 0, sizeof(struct cr_params));
 336
 337         XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
 338         if (xp == NULL) {
 339                 syslog(LOG_INFO, "Cannot create XML parser!");
 340                 do_404(h);
 341                 return;
 342         }
 343
 344         XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
 345         XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
 346         XML_SetUserData(xp, &crp);
 347         XML_SetDefaultHandler(xp, NULL);        // Disable internal entity expansion to prevent "billion laughs attack"
 348         XML_Parse(xp, h->request_body, h->request_body_length, 1);
 349         XML_ParserFree(xp);
 350
 351         if (crp.Chardata != NULL) {             // Discard any trailing chardata ... normally nothing here
 352                 FreeStrBuf(&crp.Chardata);
 353                 crp.Chardata = NULL;
 354         }
 355
 356         // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
 357         // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
 358         ctdl_printf(c, "MSGP text/calendar");
 359         ctdl_readline(c, buf, sizeof buf);
 360
 361         // Now begin the REPORT.
 362         syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
 363         StrBuf *ReportOut = NewStrBuf();
 364         StrBufAppendPrintf(ReportOut,
 365                 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
 366                 "<D:multistatus "
 367                 "xmlns:D=\"DAV:\" "
 368                 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
 369                 ">"
 370         );
 371
 372         // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
 373         if (crp.report_type == cr_calendar_query) {
 374                 int i = 0;
 375                 Array *msglist = get_msglist(c, "ALL");
 376                 if (msglist != NULL) {
 377                         for (i = 0; i < array_len(msglist); ++i) {
 378                                 long m;
 379                                 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
 380
 381                                 // load and parse one calendar item
 382                                 StrBuf *one_item = fetch_ical(c, m);
 383                                 icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
 384
 385                                 // Does this calendar item qualify for output?
 386                                 int qualify = 1;
 387
 388                                 // If there was a filter stanza, run this calendar item through the filters.
 389                                 qualify = caldav_apply_filters(cal, crp.filters);
 390                                 syslog(LOG_DEBUG, "Message %ld does%s qualify", m, (qualify ? "" : " NOT"));
 391
 392                                 // Did this calendar item match the query?  If so, output it.
 393                                 if (qualify) {
 394                                         // FIXME need to populate the Href instead of NULL
 395                                         cal_multiget_out(m, NULL, one_item, ReportOut);
 396                                 }
 397
 398                                 icalcomponent_free(cal);
 399                                 FreeStrBuf(&one_item);
 400
 401                         }
 402                         array_free(msglist);
 403                 }
 404         }
 405
 406         // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
 407         // Can we move this back into citserver too?
 408         else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
 409
 410                 StrBuf *ThisHref = NewStrBuf();
 411                 const char *pvset = NULL;
 412                 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
 413                         StrBufTrim(ThisHref);                           // remove leading/trailing whitespace from the href
 414                         caldav_report_one_item(h, c, ReportOut, ThisHref);
 415                 }
 416                 FreeStrBuf(&ThisHref);
 417         }
 418
 419         // RFC4791 7.10 "free-busy-query" REPORT
 420         else if (crp.report_type == cr_freebusy_query) {
 421                 // FIXME build this REPORT.  At the moment we send an empty multistatus.
 422         }
 423
 424         // Free any query parameters that might have been allocated during the xml parse
 425         if (crp.Hrefs != NULL) {
 426                 FreeStrBuf(&crp.Hrefs);
 427                 crp.Hrefs = NULL;
 428         }
 429         if (crp.filters) {
 430                 array_free(crp.filters);
 431                 crp.filters = NULL;
 432         }
 433
 434         StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");            // End the REPORT.
 435
 436         add_response_header(h, strdup("Content-type"), strdup("text/xml"));
 437         h->response_code = 207;
 438         h->response_string = strdup("Multi-Status");
 439         h->response_body_length = StrLength(ReportOut);
 440         h->response_body = SmashStrBuf(&ReportOut);
 441 }