4 // Copyright (c) 1996-2021 by the citadel.org team
6 // This program is open source software. It runs great on the
7 // Linux operating system (and probably elsewhere). You can use,
8 // copy, and run it under the terms of the GNU General Public
11 // This program is distributed in the hope that it will be useful,
12 // but WITHOUT ANY WARRANTY; without even the implied warranty of
13 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 // GNU General Public License for more details.
20 * Return a "zero-terminated" array of message numbers in the current room.
21 * Caller owns the memory and must free it. Returns NULL if any problems.
23 long *get_msglist(struct ctdlsession *c, char *which_msgs) {
29 ctdl_printf(c, "MSGS %s", which_msgs);
30 ctdl_readline(c, buf, sizeof(buf));
33 if (num_msgs >= num_alloc) {
36 msglist = malloc(num_alloc * sizeof(long));
39 msglist = realloc(msglist, num_alloc * sizeof(long));
42 ctdl_readline(c, buf, sizeof(buf));
43 msglist[num_msgs++] = atol(buf);
44 } while (strcmp(buf, "000")); // this makes the last element a "0" terminator
51 * Supplied with a list of potential matches from an If-Match: or If-None-Match: header, and
52 * a message number (which we always use as the entity tag in Citadel), return nonzero if the
53 * message number matches any of the supplied tags in the string.
55 int match_etags(char *taglist, long msgnum) {
56 int num_tags = num_tokens(taglist, ',');
60 if (msgnum <= 0) { // no msgnum? no match.
64 for (i = 0; i < num_tags; ++i) {
65 extract_token(tag, taglist, i, ',', sizeof tag);
67 char *lq = (strchr(tag, '"'));
68 char *rq = (strrchr(tag, '"'));
69 if (lq < rq) { // has two double quotes
74 if (!strcmp(tag, "*")) { // wildcard match
77 long tagmsgnum = atol(tag);
78 if ((tagmsgnum > 0) && (tagmsgnum == msgnum)) { // match
83 return (0); // no match
88 * Client is requesting a message list
90 void json_msglist(struct http_transaction *h, struct ctdlsession *c, char *which) {
92 long *msglist = get_msglist(c, which);
93 JsonValue *j = NewJsonArray(HKEY("msgs"));
95 if (msglist != NULL) {
96 for (i = 0; msglist[i] > 0; ++i) {
97 JsonArrayAppend(j, NewJsonNumber(HKEY("m"), msglist[i]));
102 StrBuf *sj = NewStrBuf();
103 SerializeJson(sj, j, 1); // '1' == free the source array
105 add_response_header(h, strdup("Content-type"), strdup("application/json"));
106 h->response_code = 200;
107 h->response_string = strdup("OK");
108 h->response_body_length = StrLength(sj);
109 h->response_body = SmashStrBuf(&sj);
115 * Client requested an object in a room.
117 void object_in_room(struct http_transaction *h, struct ctdlsession *c) {
120 char unescaped_euid[1024];
122 extract_token(buf, h->uri, 4, '/', sizeof buf);
124 if (!strncasecmp(buf, "msgs.", 5)) // Client is requesting a list of message numbers
126 json_msglist(h, c, &buf[5]);
130 if (!strncasecmp(buf, "threads", 5)) // Client is requesting a threaded view (still kind of fuzzy here)
132 threaded_view(h, c, &buf[5]);
136 if (!strncasecmp(buf, "flat", 5)) // Client is requesting a flat view (still kind of fuzzy here)
138 flat_view(h, c, &buf[5]);
143 if ((c->room_default_view == VIEW_CALENDAR) // room types where objects are referenced by EUID
144 || (c->room_default_view == VIEW_TASKS)
145 || (c->room_default_view == VIEW_ADDRESSBOOK)
147 safestrncpy(unescaped_euid, buf, sizeof unescaped_euid);
148 unescape_input(unescaped_euid);
149 msgnum = locate_message_by_uid(c, unescaped_euid);
155 * All methods except PUT require the message to already exist
157 if ((msgnum <= 0) && (strcasecmp(h->method, "PUT"))) {
162 * If we get to this point we have a valid message number in an accessible room.
164 syslog(LOG_DEBUG, "msgnum is %ld, method is %s", msgnum, h->method);
167 * A sixth component in the URL can be one of two things:
168 * (1) a MIME part specifier, in which case the client wants to download that component within the message
169 * (2) a content-type, in which ase the client wants us to try to render it a certain way
171 if (num_tokens(h->uri, '/') == 6) {
172 extract_token(buf, h->uri, 5, '/', sizeof buf);
173 if (!IsEmptyStr(buf)) {
174 if (!strcasecmp(buf, "json")) {
175 json_render_one_message(h, c, msgnum);
177 download_mime_component(h, c, msgnum, buf);
184 * Ok, we want a full message, but first let's check for the if[-none]-match headers.
186 char *if_match = header_val(h, "If-Match");
187 if ((if_match != NULL) && (!match_etags(if_match, msgnum))) {
192 char *if_none_match = header_val(h, "If-None-Match");
193 if ((if_none_match != NULL) && (match_etags(if_none_match, msgnum))) {
202 if (!strcasecmp(h->method, "DELETE")) {
203 dav_delete_message(h, c, msgnum);
205 else if (!strcasecmp(h->method, "GET")) {
206 dav_get_message(h, c, msgnum);
208 else if (!strcasecmp(h->method, "PUT")) {
209 dav_put_message(h, c, unescaped_euid, msgnum);
212 do_404(h); // Got this far but the method made no sense? Bummer.
219 * Called by the_room_itself() when the HTTP method is REPORT
221 void report_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
222 if (c->room_default_view == VIEW_CALENDAR) {
223 caldav_report(h, c); // CalDAV REPORTs ... fmgwac
227 do_404(h); // future implementations like CardDAV will require code paths here
232 * Called by the_room_itself() when the HTTP method is OPTIONS
234 void options_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
235 h->response_code = 200;
236 h->response_string = strdup("OK");
237 if (c->room_default_view == VIEW_CALENDAR) {
238 add_response_header(h, strdup("DAV"), strdup("1, calendar-access")); // offer CalDAV
240 else if (c->room_default_view == VIEW_ADDRESSBOOK) {
241 add_response_header(h, strdup("DAV"), strdup("1, addressbook")); // offer CardDAV
244 add_response_header(h, strdup("DAV"), strdup("1")); // ordinary WebDAV for all other room types
246 add_response_header(h, strdup("Allow"), strdup("OPTIONS, PROPFIND, GET, PUT, REPORT, DELETE"));
251 * Called by the_room_itself() when the HTTP method is PROPFIND
253 void propfind_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
256 int dav_depth = (header_val(h, "Depth") ? atoi(header_val(h, "Depth")) : INT_MAX);
257 syslog(LOG_DEBUG, "Client PROPFIND requested depth: %d", dav_depth);
258 StrBuf *Buf = NewStrBuf();
260 StrBufAppendPrintf(Buf, "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
261 "<D:multistatus " "xmlns:D=\"DAV:\" " "xmlns:C=\"urn:ietf:params:xml:ns:caldav\"" ">");
263 /* Transmit the collection resource */
264 StrBufAppendPrintf(Buf, "<D:response>");
265 StrBufAppendPrintf(Buf, "<D:href>");
266 StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
267 StrBufAppendPrintf(Buf, "/ctdl/r/");
268 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
269 StrBufAppendPrintf(Buf, "</D:href>");
271 StrBufAppendPrintf(Buf, "<D:propstat>");
272 StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
273 StrBufAppendPrintf(Buf, "<D:prop>");
274 StrBufAppendPrintf(Buf, "<D:displayname>");
275 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
276 StrBufAppendPrintf(Buf, "</D:displayname>");
278 StrBufAppendPrintf(Buf, "<D:owner />"); // empty owner ought to be legal; see rfc3744 section 5.1
280 StrBufAppendPrintf(Buf, "<D:resourcetype><D:collection />");
281 switch (c->room_default_view) {
283 StrBufAppendPrintf(Buf, "<C:calendar />"); // RFC4791 section 4.2
286 StrBufAppendPrintf(Buf, "</D:resourcetype>");
288 int enumerate_by_euid = 0; // nonzero if messages will be retrieved by euid instead of msgnum
289 switch (c->room_default_view) {
290 case VIEW_CALENDAR: // RFC4791 section 5.2
291 StrBufAppendPrintf(Buf, "<C:supported-calendar-component-set><C:comp name=\"VEVENT\"/></C:supported-calendar-component-set>");
292 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
293 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
294 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
295 enumerate_by_euid = 1;
297 case VIEW_TASKS: // RFC4791 section 5.2
298 StrBufAppendPrintf(Buf, "<C:supported-calendar-component-set><C:comp name=\"VTODO\"/></C:supported-calendar-component-set>");
299 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
300 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
301 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
302 enumerate_by_euid = 1;
304 case VIEW_ADDRESSBOOK: // FIXME put some sort of CardDAV crapola here when we implement it
305 enumerate_by_euid = 1;
307 case VIEW_WIKI: // FIXME invent "WikiDAV" ?
308 enumerate_by_euid = 1;
312 /* FIXME get the mtime
313 StrBufAppendPrintf(Buf, "<D:getlastmodified>");
315 StrBufAppendPrintf(Buf, "</D:getlastmodified>");
318 StrBufAppendPrintf(Buf, "</D:prop>");
319 StrBufAppendPrintf(Buf, "</D:propstat>");
320 StrBufAppendPrintf(Buf, "</D:response>\n");
322 // If a depth greater than zero was specified, transmit the collection listing
325 long *msglist = get_msglist(c, "ALL");
328 for (i = 0; (msglist[i] > 0); ++i) {
330 syslog(LOG_DEBUG, "PROPFIND enumerated %d messages", i);
331 e = NULL; // EUID gets stored here
335 ctdl_printf(c, "MSG0 %ld|3", msglist[i]);
336 ctdl_readline(c, cbuf, sizeof(cbuf));
338 while (ctdl_readline(c, cbuf, sizeof(cbuf)), strcmp(cbuf, "000")) {
339 if ((enumerate_by_euid) && (!strncasecmp(cbuf, "exti=", 5))) {
340 // e = strdup(&cbuf[5]);
341 int elen = (2 * strlen(&cbuf[5]));
343 urlesc(e, elen, &cbuf[5]);
345 if (!strncasecmp(cbuf, "time=", 5)) {
346 timestamp = atol(&cbuf[5]);
351 sprintf(e, "%ld", msglist[i]);
353 StrBufAppendPrintf(Buf, "<D:response>");
355 // Generate the 'href' tag for this message
356 StrBufAppendPrintf(Buf, "<D:href>");
357 StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
358 StrBufAppendPrintf(Buf, "/ctdl/r/");
359 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
360 StrBufAppendPrintf(Buf, "/");
361 StrBufXMLEscAppend(Buf, NULL, e, strlen(e), 0);
362 StrBufAppendPrintf(Buf, "</D:href>");
363 StrBufAppendPrintf(Buf, "<D:propstat>");
364 StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
365 StrBufAppendPrintf(Buf, "<D:prop>");
367 switch (c->room_default_view) {
369 StrBufAppendPrintf(Buf,
370 "<D:getcontenttype>text/calendar; component=vevent</D:getcontenttype>");
373 StrBufAppendPrintf(Buf,
374 "<D:getcontenttype>text/calendar; component=vtodo</D:getcontenttype>");
376 case VIEW_ADDRESSBOOK:
377 StrBufAppendPrintf(Buf, "<D:getcontenttype>text/x-vcard</D:getcontenttype>");
382 char *datestring = http_datestring(timestamp);
384 StrBufAppendPrintf(Buf, "<D:getlastmodified>");
385 StrBufXMLEscAppend(Buf, NULL, datestring, strlen(datestring), 0);
386 StrBufAppendPrintf(Buf, "</D:getlastmodified>");
389 if (enumerate_by_euid) // FIXME ajc 2017oct30 should this be inside the timestamp conditional?
391 StrBufAppendPrintf(Buf, "<D:getetag>\"%ld\"</D:getetag>", msglist[i]);
394 StrBufAppendPrintf(Buf, "</D:prop></D:propstat></D:response>\n");
402 StrBufAppendPrintf(Buf, "</D:multistatus>\n");
404 add_response_header(h, strdup("Content-type"), strdup("text/xml"));
405 h->response_code = 207;
406 h->response_string = strdup("Multi-Status");
407 h->response_body_length = StrLength(Buf);
408 h->response_body = SmashStrBuf(&Buf);
411 // some good examples here
412 // http://blogs.nologin.es/rickyepoderi/index.php?/archives/14-Introducing-CalDAV-Part-I.html
416 * Called by the_room_itself() when the HTTP method is PROPFIND
418 void get_the_room_itself(struct http_transaction *h, struct ctdlsession *c)
420 JsonValue *j = NewJsonObject(HKEY("gotoroom"));
422 JsonObjectAppend(j, NewJsonPlainString(HKEY("name"), c->room, -1));
423 JsonObjectAppend(j, NewJsonNumber(HKEY("current_view"), c->room_current_view));
424 JsonObjectAppend(j, NewJsonNumber(HKEY("default_view"), c->room_default_view));
425 JsonObjectAppend(j, NewJsonNumber(HKEY("new_messages"), c->new_messages));
426 JsonObjectAppend(j, NewJsonNumber(HKEY("total_messages"), c->total_messages));
427 JsonObjectAppend(j, NewJsonNumber(HKEY("last_seen"), c->last_seen));
429 StrBuf *sj = NewStrBuf();
430 SerializeJson(sj, j, 1); // '1' == free the source array
432 add_response_header(h, strdup("Content-type"), strdup("application/json"));
433 h->response_code = 200;
434 h->response_string = strdup("OK");
435 h->response_body_length = StrLength(sj);
436 h->response_body = SmashStrBuf(&sj);
442 * Handle REST/DAV requests for the room itself (such as /ctdl/r/roomname
443 * or /ctdl/r/roomname/ but *not* specific objects within the room)
445 void the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
447 // OPTIONS method on the room itself usually is a DAV client assessing what's here.
448 if (!strcasecmp(h->method, "OPTIONS")) {
449 options_the_room_itself(h, c);
453 // PROPFIND method on the room itself could be looking for a directory
454 if (!strcasecmp(h->method, "PROPFIND")) {
455 propfind_the_room_itself(h, c);
459 // REPORT method on the room itself is probably the dreaded CalDAV tower-of-crapola
460 if (!strcasecmp(h->method, "REPORT")) {
461 report_the_room_itself(h, c);
465 // GET method on the room itself is an API call, possibly from our JavaScript front end
466 if (!strcasecmp(h->method, "get")) {
467 get_the_room_itself(h, c);
471 // we probably want a "go to this room" for interactive access
477 * Dispatcher for "/ctdl/r" and "/ctdl/r/" for the room list
479 void room_list(struct http_transaction *h, struct ctdlsession *c) {
483 ctdl_printf(c, "LKRA");
484 ctdl_readline(c, buf, sizeof(buf));
490 JsonValue *j = NewJsonArray(HKEY("lkra"));
491 while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
493 // name|QRflags|QRfloor|QRorder|QRflags2|ra|current_view|default_view|mtime
494 JsonValue *jr = NewJsonObject(HKEY("room"));
496 extract_token(roomname, buf, 0, '|', sizeof roomname);
497 JsonObjectAppend(jr, NewJsonPlainString(HKEY("name"), roomname, -1));
499 int ra = extract_int(buf, 5);
500 JsonObjectAppend(jr, NewJsonBool(HKEY("known"), (ra & UA_KNOWN)));
501 JsonObjectAppend(jr, NewJsonBool(HKEY("hasnewmsgs"), (ra & UA_HASNEWMSGS)));
503 int floor = extract_int(buf, 2);
504 JsonObjectAppend(jr, NewJsonNumber(HKEY("floor"), floor));
506 int rorder = extract_int(buf, 3);
507 JsonObjectAppend(jr, NewJsonNumber(HKEY("rorder"), rorder));
509 JsonArrayAppend(j, jr); // add the room to the array
512 StrBuf *sj = NewStrBuf();
513 SerializeJson(sj, j, 1); // '1' == free the source array
515 add_response_header(h, strdup("Content-type"), strdup("application/json"));
516 h->response_code = 200;
517 h->response_string = strdup("OK");
518 h->response_body_length = StrLength(sj);
519 h->response_body = SmashStrBuf(&sj);
524 * Dispatcher for paths starting with /ctdl/r/
526 void ctdl_r(struct http_transaction *h, struct ctdlsession *c) {
527 char requested_roomname[128];
530 // All room-related functions require being "in" the room specified. Are we in that room already?
531 extract_token(requested_roomname, h->uri, 3, '/', sizeof requested_roomname);
532 unescape_input(requested_roomname);
534 if (IsEmptyStr(requested_roomname)) // /ctdl/r/
539 // If not, try to go there.
540 if (strcasecmp(requested_roomname, c->room)) {
541 ctdl_printf(c, "GOTO %s", requested_roomname);
542 ctdl_readline(c, buf, sizeof(buf));
544 // buf[3] will indicate whether any instant messages are waiting
545 extract_token(c->room, &buf[4], 0, '|', sizeof c->room);
546 c->new_messages = extract_int(&buf[4], 1);
547 c->total_messages = extract_int(&buf[4], 2);
548 // 3 (int)info Info flag: set to nonzero if the user needs to read this room's info file
549 // 4 (int)CCC->room.QRflags Various flags associated with this room.
550 // 5 (long)CCC->room.QRhighest The highest message number present in this room
551 c->last_seen = extract_long(&buf[4], 6); // The highest message number the user has read in this room
552 // 7 (int)rmailflag Boolean flag: 1 if this is a Mail> room, 0 otherwise.
553 // 8 (int)raideflag Nonzero if user is either Aide or a Room Aide in this room
554 // 9 (int)newmailcount The number of new Mail messages the user has
555 // 10 (int)CCC->room.QRfloor The floor number this room resides on
556 c->room_current_view = extract_int(&buf[4], 11);
557 c->room_default_view = extract_int(&buf[4], 12);
558 // 13 (int)is_trash Boolean flag: 1 if this is the user's Trash folder, 0 otherwise.
559 // 14 (int)CCC->room.QRflags2 More flags associated with this room
560 // 15 (long)CCC->room.QRmtime Timestamp of the last write activity in this room
566 // At this point our Citadel client session is "in" the specified room.
568 if (num_tokens(h->uri, '/') == 4) // /ctdl/r/roomname
570 the_room_itself(h, c);
574 extract_token(buf, h->uri, 4, '/', sizeof buf);
575 if (num_tokens(h->uri, '/') == 5) {
576 if (IsEmptyStr(buf)) {
577 the_room_itself(h, c); // /ctdl/r/roomname/ ( same as /ctdl/r/roomname )
579 object_in_room(h, c); // /ctdl/r/roomname/object
583 if (num_tokens(h->uri, '/') == 6) {
584 object_in_room(h, c); // /ctdl/r/roomname/object/ or possibly /ctdl/r/roomname/object/component
587 // If we get to this point, the client specified a valid room but requested an action we don't know how to perform.