]> code.citadel.org Git - citadel.git/blobdiff - webcit-ng/server/caldav_reports.c
Unified multistatus output for all REPORT outputs.
[citadel.git] / webcit-ng / server / caldav_reports.c
index 7fe12ff3ae2b38c0a6245f5d45fe4023da6fc8da..f042c70311388b6194752a7f40a30374ef097af1 100644 (file)
@@ -1,10 +1,10 @@
 // This file contains functions which handle all of the CalDAV "REPORT" queries
 // specified in RFC4791 section 7.
 //
-// Copyright (c) 2023 by the citadel.org team
+// Copyright (c) 2023-2024 by the citadel.org team
 //
 // This program is open source software.  Use, duplication, or
-// disclosure are subject to the GNU General Public License v3.
+// disclosure is subject to the GNU General Public License v3.
 
 #include "webcit.h"
 
@@ -24,7 +24,7 @@ struct cr_parms {
        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
+       StrBuf *Hrefs;                  // list of items requested by a `calendar-multiget` REPORT
 };
 
 
@@ -39,14 +39,17 @@ void caldav_xml_start(void *data, const char *el, const char **attr) {
                syslog(LOG_DEBUG, "                    Attribute '%s' = '%s'", attr[i], attr[i + 1]);
        }
 
-       if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-multiget")) {
-               crp->report_type = cr_calendar_multiget;
+       // 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")) {
+               crp->report_type = cr_calendar_query;
        }
 
-       else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav: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")) {
+               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")) {
                crp->report_type = cr_freebusy_query;
        }
@@ -96,7 +99,7 @@ void caldav_xml_chardata(void *data, const XML_Char * s, int len) {
 }
 
 
-// Called by caldav_response() to fetch a message (by number) in the current room,
+// Called by caldav_report_one_item() to fetch a message (by number) in the current room,
 // and return only the icalendar data as a StrBuf.  Returns NULL if not found.
 //
 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
@@ -112,7 +115,7 @@ StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
        }
 
        while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
-               if (Buf != NULL) {      // already in body
+               if (Buf != NULL) {              // already in body
                        StrBufAppendPrintf(Buf, "%s\n", buf);
                }
                else if (IsEmptyStr(buf)) {     // beginning of body
@@ -121,31 +124,48 @@ StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
        }
 
        return Buf;
+}
+
+
+// Called by multiple REPORT types to actually perform the output in "multiget" format.
+// We need to already know the source message number and the href, but also already have the output data.
+void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
+
+       StrBufAppendPrintf(ReportOut, "<D:response>");
+       StrBufAppendPrintf(ReportOut, "<D:href>");
+       StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
+       StrBufAppendPrintf(ReportOut, "</D:href>");
+       StrBufAppendPrintf(ReportOut, "<D:propstat>");
 
-// webcit[13039]: msgn=53CE87AF-00392161@uncensored.citadel.org
-// webcit[13039]: path=IGnatius T Foobar
-// webcit[13039]: time=1208008800
-// webcit[13039]: from=IGnatius T Foobar
-// webcit[13039]: room=0000000001.Calendar
-// webcit[13039]: node=uncnsrd
-// webcit[13039]: hnod=Uncensored
-// webcit[13039]: exti=040000E00074C5B7101A82E0080000000080C728F83E84C801000000000000000010000000E857E0DC57F53947ADF0BB91EE3A502F
-// webcit[13039]: subj==?UTF-8?B?V2VzbGV5J3MgYmlydGhkYXkgcGFydHk=
-// webcit[13039]: ?=
-// webcit[13039]: part=||1||text/calendar|1127||
-// webcit[13039]: text
-// webcit[13039]: Content-type: text/calendar
-// webcit[13039]: Content-length: 1127
-// webcit[13039]: Content-transfer-encoding: 7bit
-// webcit[13039]: X-Citadel-MSG4-Partnum: 1
-// webcit[13039]:
-// webcit[13039]: BEGIN:VCALENDAR
+       if (Caldata != NULL) {
+               // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 200 OK", ChrPtr(ThisHref));
+               StrBufAppendPrintf(ReportOut, "<D:status>");
+               StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
+               StrBufAppendPrintf(ReportOut, "</D:status>");
+               StrBufAppendPrintf(ReportOut, "<D:prop>");
+               StrBufAppendPrintf(ReportOut, "<D:getetag>");
+               StrBufAppendPrintf(ReportOut, "%ld", msgnum);
+               StrBufAppendPrintf(ReportOut, "</D:getetag>");
+               StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
+               StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
+               StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
+               StrBufAppendPrintf(ReportOut, "</D:prop>");
+       }
+       else {
+               // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 404 not found", ChrPtr(ThisHref));
+               StrBufAppendPrintf(ReportOut, "<D:status>");
+               StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
+               StrBufAppendPrintf(ReportOut, "</D:status>");
+       }
+
+       StrBufAppendPrintf(ReportOut, "</D:propstat>");
+       StrBufAppendPrintf(ReportOut, "</D:response>");
 }
 
 
 // Called by caldav_report() to output a single item.
 // Our policy is to throw away the list of properties the client asked for, and just send everything.
-void caldav_response(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
+void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
        long msgnum;
        StrBuf *Caldata = NULL;
        char *euid;
@@ -164,43 +184,20 @@ void caldav_response(struct http_transaction *h, struct ctdlsession *c, StrBuf *
        }
        unescape_input(unescaped_euid);
 
-       StrBufAppendPrintf(ReportOut, "<D:response>");
-       StrBufAppendPrintf(ReportOut, "<D:href>");
-       StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
-       StrBufAppendPrintf(ReportOut, "</D:href>");
-       StrBufAppendPrintf(ReportOut, "<D:propstat>");
-
        msgnum = locate_message_by_uid(c, unescaped_euid);
        free(unescaped_euid);
        if (msgnum > 0) {
                Caldata = fetch_ical(c, msgnum);
        }
+       else {
+               Caldata = NULL;
+       }
+
+       cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
 
        if (Caldata != NULL) {
-               // syslog(LOG_DEBUG, "caldav_response(%s) 200 OK", ChrPtr(ThisHref));
-               StrBufAppendPrintf(ReportOut, "<D:status>");
-               StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
-               StrBufAppendPrintf(ReportOut, "</D:status>");
-               StrBufAppendPrintf(ReportOut, "<D:prop>");
-               StrBufAppendPrintf(ReportOut, "<D:getetag>");
-               StrBufAppendPrintf(ReportOut, "%ld", msgnum);
-               StrBufAppendPrintf(ReportOut, "</D:getetag>");
-               StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
-               StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
-               StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
-               StrBufAppendPrintf(ReportOut, "</D:prop>");
                FreeStrBuf(&Caldata);
-               Caldata = NULL;
-       }
-       else {
-               // syslog(LOG_DEBUG, "caldav_response(%s) 404 not found", ChrPtr(ThisHref));
-               StrBufAppendPrintf(ReportOut, "<D:status>");
-               StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
-               StrBufAppendPrintf(ReportOut, "</D:status>");
        }
-
-       StrBufAppendPrintf(ReportOut, "</D:propstat>");
-       StrBufAppendPrintf(ReportOut, "</D:response>");
 }
 
 
@@ -248,18 +245,59 @@ void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
                ">"
        );
 
-       if (crp.Hrefs != NULL) {        // Output all qualifying calendar items!
+       // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
+       if (crp.report_type == cr_calendar_query) {
+               int i = 0;
+               Array *msglist = get_msglist(c, "ALL");
+               if (msglist != NULL) {
+                       for (i = 0; i < array_len(msglist); ++i) {
+                               long m;
+                               memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
+
+                               // load and parse one calendar item
+                               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
+                               int qualify = 1;
+
+                               if (qualify) {
+                                       cal_multiget_out(m, NULL, one_item, ReportOut);
+                               }
+
+                               icalcomponent_free(cal);
+                               FreeStrBuf(&one_item);
+
+                       }
+                       array_free(msglist);
+               }
+       }
+
+       // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
+       // Can we move this back into citserver too?
+       else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
+
                StrBuf *ThisHref = NewStrBuf();
                const char *pvset = NULL;
                while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
-                       caldav_response(h, c, ReportOut, ThisHref);
+                       StrBufTrim(ThisHref);                           // remove leading/trailing whitespace from the href
+                       caldav_report_one_item(h, c, ReportOut, ThisHref);
                }
                FreeStrBuf(&ThisHref);
+       }
+
+       // RFC4791 7.10 "free-busy-query" REPORT
+       else if (crp.report_type == cr_freebusy_query) {
+               // FIXME build this REPORT.  At the moment we send an empty multistatus.
+       }
+
+       // Free any query parameters that might have been allocated during the xml parse
+       if (crp.Hrefs != NULL) {
                FreeStrBuf(&crp.Hrefs);
                crp.Hrefs = NULL;
        }
 
-       StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");    // End the REPORT.
+       StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");            // End the REPORT.
 
        add_response_header(h, strdup("Content-type"), strdup("text/xml"));
        h->response_code = 207;