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_response() 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
128 // webcit[13039]: msgn=53CE87AF-00392161@uncensored.citadel.org
129 // webcit[13039]: path=IGnatius T Foobar
130 // webcit[13039]: time=1208008800
131 // webcit[13039]: from=IGnatius T Foobar
132 // webcit[13039]: room=0000000001.Calendar
133 // webcit[13039]: node=uncnsrd
134 // webcit[13039]: hnod=Uncensored
135 // webcit[13039]: exti=040000E00074C5B7101A82E0080000000080C728F83E84C801000000000000000010000000E857E0DC57F53947ADF0BB91EE3A502F
136 // webcit[13039]: subj==?UTF-8?B?V2VzbGV5J3MgYmlydGhkYXkgcGFydHk=
138 // webcit[13039]: part=||1||text/calendar|1127||
139 // webcit[13039]: text
140 // webcit[13039]: Content-type: text/calendar
141 // webcit[13039]: Content-length: 1127
142 // webcit[13039]: Content-transfer-encoding: 7bit
143 // webcit[13039]: X-Citadel-MSG4-Partnum: 1
145 // webcit[13039]: BEGIN:VCALENDAR
149 // Called by caldav_report() to output a single item.
150 // Our policy is to throw away the list of properties the client asked for, and just send everything.
151 void caldav_response(struct http_transaction *h, struct ctdlsession *c, StrBuf *ReportOut, StrBuf *ThisHref) {
153 StrBuf *Caldata = NULL;
156 euid = strrchr(ChrPtr(ThisHref), '/');
161 euid = (char *) ChrPtr(ThisHref);
164 char *unescaped_euid = strdup(euid);
165 if (!unescaped_euid) {
168 unescape_input(unescaped_euid);
170 StrBufAppendPrintf(ReportOut, "<D:response>");
171 StrBufAppendPrintf(ReportOut, "<D:href>");
172 StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
173 StrBufAppendPrintf(ReportOut, "</D:href>");
174 StrBufAppendPrintf(ReportOut, "<D:propstat>");
176 msgnum = locate_message_by_uid(c, unescaped_euid);
177 free(unescaped_euid);
179 Caldata = fetch_ical(c, msgnum);
182 if (Caldata != NULL) {
183 // syslog(LOG_DEBUG, "caldav_response(%s) 200 OK", ChrPtr(ThisHref));
184 StrBufAppendPrintf(ReportOut, "<D:status>");
185 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
186 StrBufAppendPrintf(ReportOut, "</D:status>");
187 StrBufAppendPrintf(ReportOut, "<D:prop>");
188 StrBufAppendPrintf(ReportOut, "<D:getetag>");
189 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
190 StrBufAppendPrintf(ReportOut, "</D:getetag>");
191 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
192 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
193 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
194 StrBufAppendPrintf(ReportOut, "</D:prop>");
195 FreeStrBuf(&Caldata);
199 // syslog(LOG_DEBUG, "caldav_response(%s) 404 not found", ChrPtr(ThisHref));
200 StrBufAppendPrintf(ReportOut, "<D:status>");
201 StrBufAppendPrintf(ReportOut, "HTTP/1.1 404 not found");
202 StrBufAppendPrintf(ReportOut, "</D:status>");
205 StrBufAppendPrintf(ReportOut, "</D:propstat>");
206 StrBufAppendPrintf(ReportOut, "</D:response>");
210 // Called by report_the_room_itself() in room_functions.c when a CalDAV REPORT method
211 // is requested on a calendar room. We fire up an XML Parser to decode the request and
212 // hopefully produce the correct output.
213 void caldav_report(struct http_transaction *h, struct ctdlsession *c) {
217 memset(&crp, 0, sizeof(struct cr_parms));
219 XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
221 syslog(LOG_INFO, "Cannot create XML parser!");
226 XML_SetElementHandler(xp, caldav_xml_start, caldav_xml_end);
227 XML_SetCharacterDataHandler(xp, caldav_xml_chardata);
228 XML_SetUserData(xp, &crp);
229 XML_SetDefaultHandler(xp, NULL); // Disable internal entity expansion to prevent "billion laughs attack"
230 XML_Parse(xp, h->request_body, h->request_body_length, 1);
233 if (crp.Chardata != NULL) { // Discard any trailing chardata ... normally nothing here
234 FreeStrBuf(&crp.Chardata);
238 // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
239 // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
240 ctdl_printf(c, "MSGP text/calendar");
241 ctdl_readline(c, buf, sizeof buf);
243 // Now begin the REPORT.
244 syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
245 StrBuf *ReportOut = NewStrBuf();
246 StrBufAppendPrintf(ReportOut,
247 "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
250 "xmlns:C=\"urn:ietf:params:xml:ns:caldav\""
254 // RFC4791 7.9 "calendar-multiget" REPORT - go get the specific Hrefs the client asked for.
255 if ( (crp.report_type == cr_calendar_multiget) && (crp.Hrefs != NULL) ) {
256 StrBuf *ThisHref = NewStrBuf();
257 const char *pvset = NULL;
258 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
259 StrBufTrim(ThisHref); // remove leading/trailing whitespace from the href
260 caldav_response(h, c, ReportOut, ThisHref);
262 FreeStrBuf(&ThisHref);
263 FreeStrBuf(&crp.Hrefs);
267 StrBufAppendPrintf(ReportOut, "</D:multistatus>\n"); // End the REPORT.
269 add_response_header(h, strdup("Content-type"), strdup("text/xml"));
270 h->response_code = 207;
271 h->response_string = strdup("Multi-Status");
272 h->response_body_length = StrLength(ReportOut);
273 h->response_body = SmashStrBuf(&ReportOut);
280 // Client is requesting a message list (make this code work for calendar-query REPORT)
281 void XXXXXXXXXXXXXX(struct http_transaction *h, struct ctdlsession *c, char *range) {
284 // Determine the date/time range requested by the client
285 time_t lo = atol(range);
286 char *colon = strchr(range, ':');
287 time_t hi = colon ? atol(++colon) : LONG_MAX;
289 // Rule out impossible ranges
295 // Begin by requesting all messages in the room
297 Array *msglist = get_msglist(c, "ALL");
298 if (msglist == NULL) {
303 // We're going to make a lot of MSG4 calls, and the preferred MIME type we want is "text/calendar".
304 // The iCalendar standard is mature now, and we are no longer interested in text/x-vcal or application/ics.
305 ctdl_printf(c, "MSGP text/calendar");
306 ctdl_readline(c, buf, sizeof buf);
308 // Iterate through our message list.
309 for (i = 0; i < array_len(msglist); ++i) {
311 memcpy(&m, array_get_element_at(msglist, i), sizeof(long));
312 syslog(LOG_DEBUG, "FIXME %ld", m);
315 // 1. fetch the message from citadel server
317 // 3. figure out range
318 // we should steal code from webcit-classic for this
321 one_item = fetch_ical(c, m);
322 syslog(LOG_DEBUG, "calendar item:\n---\n\033[33m%s\n---\033[0m", ChrPtr(one_item));
323 FreeStrBuf(&one_item);
328 // FIXME we still fail because we aren't finished yet
329 add_response_header(h, strdup("Content-type"), strdup("application/json"));
330 h->response_code = 200;
331 h->response_string = strdup("OK");
332 h->response_body = "{ \"one\":111 , \"two\":222 , \"three\":333 }";
333 h->response_body_length = strlen(h->response_body);