Did a little more style updating. Realized that I started this thing in 2018 and...
[citadel] / webcit-ng / caldav_reports.c
1 //
2 // This file contains functions which handle all of the CalDAV "REPORT" queries
3 // specified in RFC4791 section 7.
4 //
5 // Copyright (c) 2018 by the citadel.org team
6 //
7 // This program is open source software.  It runs great on the
8 // Linux operating system (and probably elsewhere).  You can use,
9 // copy, and run it under the terms of the GNU General Public
10 // License version 3.
11 //
12 // This program is distributed in the hope that it will be useful,
13 // but WITHOUT ANY WARRANTY; without even the implied warranty of
14 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15 // GNU General Public License for more details.
16
17 #include "webcit.h"
18
19
20 // A CalDAV REPORT can only be one type.  This is stored in the report_type member.
21 enum cr_type {
22         cr_calendar_query,
23         cr_calendar_multiget,
24         cr_freebusy_query
25 };
26
27
28 // Data type for CalDAV Report Parameters.
29 // As we slog our way through the XML we learn what the client is asking for
30 // and build up the contents of this data type.
31 struct cr_parms {
32         int tag_nesting_level;          // not needed, just kept for pretty-printing
33         enum cr_type report_type;       // which RFC4791 section 7 REPORT are we generating
34         StrBuf *Chardata;               // XML chardata in between tags is built up here
35         StrBuf *Hrefs;                  // list of items requested by a calendar-multiget report
36 };
37
38
39 // XML parser callback
40 void caldav_xml_start(void *data, const char *el, const char **attr) {
41         struct cr_parms *crp = (struct cr_parms *) data;
42         int i;
43
44         // syslog(LOG_DEBUG, "CALDAV ELEMENT START: <%s> %d", el, crp->tag_nesting_level);
45
46         for (i = 0; attr[i] != NULL; i += 2) {
47                 syslog(LOG_DEBUG, "                    Attribute '%s' = '%s'", attr[i], attr[i + 1]);
48         }
49
50         if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-multiget")) {
51                 crp->report_type = cr_calendar_multiget;
52         }
53
54         else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:calendar-query")) {
55                 crp->report_type = cr_calendar_query;
56         }
57
58         else if (!strcasecmp(el, "urn:ietf:params:xml:ns:caldav:free-busy-query")) {
59                 crp->report_type = cr_freebusy_query;
60         }
61
62         ++crp->tag_nesting_level;
63 }
64
65
66 // XML parser callback
67 void caldav_xml_end(void *data, const char *el) {
68         struct cr_parms *crp = (struct cr_parms *) data;
69         --crp->tag_nesting_level;
70
71         if (crp->Chardata != NULL) {
72                 // syslog(LOG_DEBUG, "CALDAV CHARDATA     : %s", ChrPtr(crp->Chardata));
73         }
74         // syslog(LOG_DEBUG, "CALDAV ELEMENT END  : <%s> %d", el, crp->tag_nesting_level);
75
76         if ((!strcasecmp(el, "DAV::href")) || (!strcasecmp(el, "DAV:href"))) {
77                 if (crp->Hrefs == NULL) {       // append crp->Chardata to crp->Hrefs
78                         crp->Hrefs = NewStrBuf();
79                 } else {
80                         StrBufAppendBufPlain(crp->Hrefs, HKEY("|"), 0);
81                 }
82                 StrBufAppendBuf(crp->Hrefs, crp->Chardata, 0);
83         }
84
85         if (crp->Chardata != NULL) {            // Tag is closed; chardata is now out of scope.
86                 FreeStrBuf(&crp->Chardata);     // Free the buffer.
87                 crp->Chardata = NULL;
88         }
89 }
90
91
92 // XML parser callback
93 void caldav_xml_chardata(void *data, const XML_Char * s, int len) {
94         struct cr_parms *crp = (struct cr_parms *) data;
95
96         if (crp->Chardata == NULL) {
97                 crp->Chardata = NewStrBuf();
98         }
99
100         StrBufAppendBufPlain(crp->Chardata, s, len, 0);
101
102         return;
103 }
104
105
106 // Called by caldav_response() to fetch a message (by number) in the current room,
107 // and return only the icalendar data as a StrBuf.  Returns NULL if not found.
108 //
109 // NOTE: this function expects that "MSGP text/calendar" was issued at the beginning
110 // of a REPORT operation to set our preferred MIME type to calendar data.
111 StrBuf *fetch_ical(struct ctdlsession * c, long msgnum) {
112         char buf[1024];
113         StrBuf *Buf = NULL;
114
115         ctdl_printf(c, "MSG4 %ld", msgnum);
116         ctdl_readline(c, buf, sizeof(buf));
117         if (buf[0] != '1') {
118                 return NULL;
119         }
120
121         while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
122                 if (Buf != NULL) {      // already in body
123                         StrBufAppendPrintf(Buf, "%s\n", buf);
124                 } else if (IsEmptyStr(buf)) {   // beginning of body
125                         Buf = NewStrBuf();
126                 }
127         }
128
129         return Buf;
130
131 // webcit[13039]: msgn=53CE87AF-00392161@uncensored.citadel.org
132 // webcit[13039]: path=IGnatius T Foobar
133 // webcit[13039]: time=1208008800
134 // webcit[13039]: from=IGnatius T Foobar
135 // webcit[13039]: room=0000000001.Calendar
136 // webcit[13039]: node=uncnsrd
137 // webcit[13039]: hnod=Uncensored
138 // webcit[13039]: exti=040000008200E00074C5B7101A82E0080000000080C728F83E84C801000000000000000010000000E857E0DC57F53947ADF0BB91EE3A502F
139 // webcit[13039]: subj==?UTF-8?B?V2VzbGV5J3MgYmlydGhkYXkgcGFydHk=
140 // webcit[13039]: ?=
141 // webcit[13039]: part=||1||text/calendar|1127||
142 // webcit[13039]: text
143 // webcit[13039]: Content-type: text/calendar
144 // webcit[13039]: Content-length: 1127
145 // webcit[13039]: Content-transfer-encoding: 7bit
146 // webcit[13039]: X-Citadel-MSG4-Partnum: 1
147 // webcit[13039]:
148 // webcit[13039]: BEGIN:VCALENDAR
149 }
150
151
152 // Called by caldav_report() to output a single item.
153 // Our policy is to throw away the list of properties the client asked for, and just send everything.
154 void caldav_response(struct http_transaction *h, struct ctdlsession *c, StrBuf * ReportOut, StrBuf * ThisHref) {
155         long msgnum;
156         StrBuf *Caldata = NULL;
157         char *euid;
158
159         euid = strrchr(ChrPtr(ThisHref), '/');
160         if (euid != NULL) {
161                 ++euid;
162         } else {
163                 euid = (char *) ChrPtr(ThisHref);
164         }
165
166         char *unescaped_euid = strdup(euid);
167         if (!unescaped_euid)
168                 return;
169         unescape_input(unescaped_euid);
170
171         StrBufAppendPrintf(ReportOut, "<D:response>");
172         StrBufAppendPrintf(ReportOut, "<D:href>");
173         StrBufXMLEscAppend(ReportOut, ThisHref, NULL, 0, 0);
174         StrBufAppendPrintf(ReportOut, "</D:href>");
175         StrBufAppendPrintf(ReportOut, "<D:propstat>");
176
177         msgnum = locate_message_by_uid(c, unescaped_euid);
178         free(unescaped_euid);
179         if (msgnum > 0) {
180                 Caldata = fetch_ical(c, msgnum);
181         }
182
183         if (Caldata != NULL) {
184                 // syslog(LOG_DEBUG, "caldav_response(%s) 200 OK", ChrPtr(ThisHref));
185                 StrBufAppendPrintf(ReportOut, "<D:status>");
186                 StrBufAppendPrintf(ReportOut, "HTTP/1.1 200 OK");
187                 StrBufAppendPrintf(ReportOut, "</D:status>");
188                 StrBufAppendPrintf(ReportOut, "<D:prop>");
189                 StrBufAppendPrintf(ReportOut, "<D:getetag>");
190                 StrBufAppendPrintf(ReportOut, "%ld", msgnum);
191                 StrBufAppendPrintf(ReportOut, "</D:getetag>");
192                 StrBufAppendPrintf(ReportOut, "<C:calendar-data>");
193                 StrBufXMLEscAppend(ReportOut, Caldata, NULL, 0, 0);
194                 StrBufAppendPrintf(ReportOut, "</C:calendar-data>");
195                 StrBufAppendPrintf(ReportOut, "</D:prop>");
196                 FreeStrBuf(&Caldata);
197                 Caldata = NULL;
198         } else {
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>");
203         }
204
205         StrBufAppendPrintf(ReportOut, "</D:propstat>");
206         StrBufAppendPrintf(ReportOut, "</D:response>");
207 }
208
209
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) {
214         struct cr_parms crp;
215         char buf[1024];
216
217         memset(&crp, 0, sizeof(struct cr_parms));
218
219         XML_Parser xp = XML_ParserCreateNS("UTF-8", ':');
220         if (xp == NULL) {
221                 syslog(LOG_INFO, "Cannot create XML parser!");
222                 do_404(h);
223                 return;
224         }
225
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);
231         XML_ParserFree(xp);
232
233         if (crp.Chardata != NULL) {     // Discard any trailing chardata ... normally nothing here
234                 FreeStrBuf(&crp.Chardata);
235                 crp.Chardata = NULL;
236         }
237
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);
242
243         // Now begin the REPORT.
244         syslog(LOG_DEBUG, "CalDAV REPORT type is: %d", crp.report_type);
245         StrBuf *ReportOut = NewStrBuf();
246         StrBufAppendPrintf(ReportOut, "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
247                            "<D:multistatus " "xmlns:D=\"DAV:\" " "xmlns:C=\"urn:ietf:params:xml:ns:caldav\"" ">");
248
249         if (crp.Hrefs != NULL) {        // Output all qualifying calendar items!
250                 StrBuf *ThisHref = NewStrBuf();
251                 const char *pvset = NULL;
252                 while (StrBufExtract_NextToken(ThisHref, crp.Hrefs, &pvset, '|') >= 0) {
253                         caldav_response(h, c, ReportOut, ThisHref);
254                 }
255                 FreeStrBuf(&ThisHref);
256                 FreeStrBuf(&crp.Hrefs);
257                 crp.Hrefs = NULL;
258         }
259
260         StrBufAppendPrintf(ReportOut, "</D:multistatus>\n");    // End the REPORT.
261
262         add_response_header(h, strdup("Content-type"), strdup("text/xml"));
263         h->response_code = 207;
264         h->response_string = strdup("Multi-Status");
265         h->response_body_length = StrLength(ReportOut);
266         h->response_body = SmashStrBuf(&ReportOut);
267 }