1 // This file contains functions which handle all of the CalDAV "REPORT" queries
2 // specified in RFC4791 section 7.
4 // Copyright (c) 2023-2024 by the citadel.org team
6 // This program is open source software. Use, duplication, or
7 // disclosure is subject to the GNU General Public License v3.
12 // A CalDAV REPORT can only be one type. This is stored in the report_type member.
20 // Data type for CalDAV Report Parameters.
21 // As we slog our way through the XML we learn what the client is asking for
22 // and build up the contents of this data type.
24 int tag_nesting_level; // not needed, just kept for pretty-printing
25 enum cr_type report_type; // which RFC4791 section 7 REPORT are we generating
26 StrBuf *Chardata; // XML chardata in between tags is built up here
27 StrBuf *Hrefs; // list of items requested by a `calendar-multiget` REPORT
31 // XML parser callback
32 void caldav_xml_start(void *data, const char *el, const char **attr) {
33 struct cr_parms *crp = (struct cr_parms *) data;
36 // syslog(LOG_DEBUG, "CALDAV ELEMENT START: <%s> %d", el, crp->tag_nesting_level);
38 for (i = 0; attr[i] != NULL; i += 2) {
39 syslog(LOG_DEBUG, " Attribute '%s' = '%s'", attr[i], attr[i + 1]);
42 // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
43 if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-query")) {
44 crp->report_type = cr_calendar_query;
47 // RFC4791 7.9 "calendar-multiget" REPORT - Client will supply a list of specific hrefs.
48 else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-multiget")) {
49 crp->report_type = cr_calendar_multiget;
52 // RFC4791 7.10 "free-busy-query" REPORT
53 else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:free-busy-query")) {
54 crp->report_type = cr_freebusy_query;
57 ++crp->tag_nesting_level;
61 // XML parser callback
62 void caldav_xml_end(void *data, const char *el) {
63 struct cr_parms *crp = (struct cr_parms *) data;
64 --crp->tag_nesting_level;
66 if (crp->Chardata != NULL) {
67 // syslog(LOG_DEBUG, "CALDAV CHARDATA : %s", ChrPtr(crp->Chardata));
69 // syslog(LOG_DEBUG, "CALDAV ELEMENT END : <%s> %d", el, crp->tag_nesting_level);
71 if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
72 if (crp->Hrefs == NULL) { // append crp->Chardata to crp->Hrefs
73 crp->Hrefs = NewStrBuf();
76 StrBufAppendBufPlain(crp->Hrefs, HKEY("|"), 0);
78 StrBufAppendBuf(crp->Hrefs, crp->Chardata, 0);
81 if (crp->Chardata != NULL) { // Tag is closed; chardata is now out of scope.
82 FreeStrBuf(&crp->Chardata); // Free the buffer.
88 // XML parser callback
89 void caldav_xml_chardata(void *data, const XML_Char * s, int len) {
90 struct cr_parms *crp = (struct cr_parms *) data;
92 if (crp->Chardata == NULL) {
93 crp->Chardata = NewStrBuf();
96 StrBufAppendBufPlain(crp->Chardata, s, len, 0);
102 // Called by caldav_report_one_item() to fetch a message (by number) in the current room,
103 // and return only the icalendar data as a StrBuf. Returns NULL if not found.
105 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
106 // of a REPORT operation to set our preferred MIME type to calendar data.
107 StrBuf *fetch_ical(struct ctdlsession *c, long msgnum) {
111 ctdl_printf(c, "MSG4 %ld", msgnum);
112 ctdl_readline(c, buf, sizeof(buf));
117 while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
118 if (Buf != NULL) { // already in body
119 StrBufAppendPrintf(Buf, "%s\n", buf);
121 else if (IsEmptyStr(buf)) { // beginning of body
130 // Called by multiple REPORT types to actually perform the output in "multiget" format.
131 // We need to already know the source message number and the href, but also already have the output data.
132 void cal_multiget_out(long msgnum, StrBuf *ThisHref, StrBuf *Caldata, StrBuf *ReportOut) {
134 StrBufAppendPrintf(ReportOut, "<D:response>");
135 StrBufAppendPrintf(ReportOut, "<D:href>");
136 StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
137 StrBufAppendPrintf(ReportOut, "</D:href>");
138 StrBufAppendPrintf(ReportOut, "<D:propstat>");
140 if (Caldata != NULL) {
141 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 200 OK", ChrPtr(ThisHref));
142 StrBufAppendPrintf(ReportOut, "<D:status>");
143 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
144 StrBufAppendPrintf(ReportOut, "</D:status>");
145 StrBufAppendPrintf(ReportOut, "<D:prop>");
146 StrBufAppendPrintf(ReportOut, "<D:getetag>");
147 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
148 StrBufAppendPrintf(ReportOut, "</D:getetag>");
149 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
150 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
151 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
152 StrBufAppendPrintf(ReportOut, "</D:prop>");
155 // syslog(LOG_DEBUG, "caldav_report_one_item(%s) 404 not found", ChrPtr(ThisHref));
156 StrBufAppendPrintf(ReportOut, "<D:status>");
157 StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
158 StrBufAppendPrintf(ReportOut, "</D:status>");
161 StrBufAppendPrintf(ReportOut, "</D:propstat>");
162 StrBufAppendPrintf(ReportOut, "</D:response>");
166 // Called by caldav_report() to output a single item.
167 // Our policy is to throw away the list of properties the client asked for, and just send everything.
168 void caldav_report_one_item(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
170 StrBuf *Caldata = NULL;
173 euid = strrchr(ChrPtr(ThisHref), '/');
178 euid = (char *) ChrPtr(ThisHref);
181 char *unescaped_euid = strdup(euid);
182 if (!unescaped_euid) {
185 unescape_input(unescaped_euid);
187 msgnum = locate_message_by_uid(c, unescaped_euid);
188 free(unescaped_euid);
190 Caldata = fetch_ical(c, msgnum);
196 cal_multiget_out(msgnum, ThisHref, Caldata, ReportOut);
198 if (Caldata != NULL) {
199 FreeStrBuf(&Caldata);
204 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
205 // is requested on a calendar room. We fire up an XML Parser to decode the request and
206 // hopefully produce the correct output.
207 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
211 memset(&crp, 0, sizeof(struct cr_parms));
213 XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
215 syslog(LOG_INFO, "Cannot create XML parser!");
220 XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
221 XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
222 XML_SetUserData(xp, &crp);
223 XML_SetDefaultHandler(xp, NULL); // Disable internal entity expansion to prevent "billion laughs attack"
224 XML_Parse(xp, h->request_body, h->request_body_length, 1);
227 if (crp.Chardata != NULL) { // Discard any trailing chardata ... normally nothing here
228 FreeStrBuf(&crp.Chardata);
232 // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
233 // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
234 ctdl_printf(c, "MSGP text/calendar");
235 ctdl_readline(c, buf, sizeof buf);
237 // Now begin the REPORT.
238 syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
239 StrBuf *ReportOut = NewStrBuf();
240 StrBufAppendPrintf(ReportOut,
241 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
244 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
248 // RFC4791 7.8 "calendar-query" REPORT - Client will send a lot of search criteria.
249 if (crp.report_type == cr_calendar_query) {
251 Array *msglist = get_msglist(c, "ALL");
252 if (msglist != NULL) {
253 for (i = 0; i < array_len(msglist); ++i) {
255 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
257 // load and parse one calendar item
258 StrBuf *one_item = fetch_ical(c, m);
259 icalcomponent *cal = icalcomponent_new_from_string(ChrPtr(one_item));
261 // qualify will be set to nonzero if this calendar item is a match for the QUERY.
264 // this is a horrible temporary hack to output every item (for now)
267 // Did this calendar item match the query? If so, output it.
269 // FIXME need to populate the Href instead of NULL
270 cal_multiget_out(m, NULL, one_item, ReportOut);
273 icalcomponent_free(cal);
274 FreeStrBuf(&one_item);
281 // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
282 // Can we move this back into citserver too?
283 else if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
285 StrBuf *ThisHref = NewStrBuf();
286 const char *pvset = NULL;
287 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
288 StrBufTrim(ThisHref); // remove leading/trailing whitespace from the href
289 caldav_report_one_item(h, c, ReportOut, ThisHref);
291 FreeStrBuf(&ThisHref);
294 // RFC4791 7.10 "free-busy-query" REPORT
295 else if (crp.report_type == cr_freebusy_query) {
296 // FIXME build this REPORT. At the moment we send an empty multistatus.
299 // Free any query parameters that might have been allocated during the xml parse
300 if (crp.Hrefs != NULL) {
301 FreeStrBuf(&crp.Hrefs);
305 StrBufAppendPrintf(ReportOut, "</D:multistatus>\n"); // End the REPORT.
307 add_response_header(h, strdup("Content-type"), strdup("text/xml"));
308 h->response_code = 207;
309 h->response_string = strdup("Multi-Status");
310 h->response_body_length = StrLength(ReportOut);
311 h->response_body = SmashStrBuf(&ReportOut);