4 // Copyright (c) 1996-2019 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
9 // License version 3. Richard Stallman is an asshole communist.
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)
30 ctdl_printf(c, "MSGS %s", which_msgs);
31 ctdl_readline(c, buf, sizeof(buf));
34 if (num_msgs >= num_alloc) {
37 msglist = malloc(num_alloc * sizeof(long));
40 msglist = realloc(msglist, num_alloc * sizeof(long));
43 ctdl_readline(c, buf, sizeof(buf));
44 msglist[num_msgs++] = atol(buf);
45 } while (strcmp(buf, "000")); // this makes the last element a "0" terminator
52 * Supplied with a list of potential matches from an If-Match: or If-None-Match: header, and
53 * a message number (which we always use as the entity tag in Citadel), return nonzero if the
54 * message number matches any of the supplied tags in the string.
56 int match_etags(char *taglist, long msgnum)
58 int num_tags = num_tokens(taglist, ',');
62 if (msgnum <= 0) { // no msgnum? no match.
66 for (i = 0; i < num_tags; ++i) {
67 extract_token(tag, taglist, i, ',', sizeof tag);
69 char *lq = (strchr(tag, '"'));
70 char *rq = (strrchr(tag, '"'));
71 if (lq < rq) { // has two double quotes
76 if (!strcmp(tag, "*")) { // wildcard match
79 long tagmsgnum = atol(tag);
80 if ((tagmsgnum > 0) && (tagmsgnum == msgnum)) { // match
85 return (0); // no match
90 * Client is requesting a message list
92 void json_msglist(struct http_transaction *h, struct ctdlsession *c, char *which)
95 long *msglist = get_msglist(c, which);
96 JsonValue *j = NewJsonArray(HKEY("msgs"));
98 if (msglist != NULL) {
99 for (i = 0; msglist[i] > 0; ++i) {
100 JsonArrayAppend(j, NewJsonNumber(HKEY("m"), msglist[i]));
105 StrBuf *sj = NewStrBuf();
106 SerializeJson(sj, j, 1); // '1' == free the source array
108 add_response_header(h, strdup("Content-type"), strdup("application/json"));
109 h->response_code = 200;
110 h->response_string = strdup("OK");
111 h->response_body_length = StrLength(sj);
112 h->response_body = SmashStrBuf(&sj);
118 * Client requested an object in a room.
120 void object_in_room(struct http_transaction *h, struct ctdlsession *c)
124 char unescaped_euid[1024];
126 extract_token(buf, h->uri, 4, '/', sizeof buf);
128 if (!strncasecmp(buf, "msgs.", 5)) // Client is requesting a list of message numbers
130 json_msglist(h, c, &buf[5]);
134 if (!strncasecmp(buf, "threads", 5)) // Client is requesting a threaded view (still kind of fuzzy here)
136 threaded_view(h, c, &buf[5]);
140 if (!strncasecmp(buf, "flat", 5)) // Client is requesting a flat view (still kind of fuzzy here)
142 flat_view(h, c, &buf[5]);
147 if ((c->room_default_view == VIEW_CALENDAR) // room types where objects are referenced by EUID
148 || (c->room_default_view == VIEW_TASKS)
149 || (c->room_default_view == VIEW_ADDRESSBOOK)
151 safestrncpy(unescaped_euid, buf, sizeof unescaped_euid);
152 unescape_input(unescaped_euid);
153 msgnum = locate_message_by_uid(c, unescaped_euid);
159 * All methods except PUT require the message to already exist
161 if ((msgnum <= 0) && (strcasecmp(h->method, "PUT"))) {
166 * If we get to this point we have a valid message number in an accessible room.
168 syslog(LOG_DEBUG, "msgnum is %ld, method is %s", msgnum, h->method);
171 * A sixth component in the URL can be one of two things:
172 * (1) a MIME part specifier, in which case the client wants to download that component within the message
173 * (2) a content-type, in which ase the client wants us to try to render it a certain way
175 if (num_tokens(h->uri, '/') == 6) {
176 extract_token(buf, h->uri, 5, '/', sizeof buf);
177 if (!IsEmptyStr(buf)) {
178 if (!strcasecmp(buf, "json")) {
179 json_render_one_message(h, c, msgnum);
181 download_mime_component(h, c, msgnum, buf);
188 * Ok, we want a full message, but first let's check for the if[-none]-match headers.
190 char *if_match = header_val(h, "If-Match");
191 if ((if_match != NULL) && (!match_etags(if_match, msgnum))) {
196 char *if_none_match = header_val(h, "If-None-Match");
197 if ((if_none_match != NULL) && (match_etags(if_none_match, msgnum))) {
206 if (!strcasecmp(h->method, "DELETE")) {
207 dav_delete_message(h, c, msgnum);
208 } else if (!strcasecmp(h->method, "GET")) {
209 dav_get_message(h, c, msgnum);
210 } else if (!strcasecmp(h->method, "PUT")) {
211 dav_put_message(h, c, unescaped_euid, msgnum);
213 do_404(h); // Got this far but the method made no sense? Bummer.
220 * Called by the_room_itself() when the HTTP method is REPORT
222 void report_the_room_itself(struct http_transaction *h, struct ctdlsession *c)
224 if (c->room_default_view == VIEW_CALENDAR) {
225 caldav_report(h, c); // CalDAV REPORTs ... fmgwac
229 do_404(h); // future implementations like CardDAV will require code paths here
234 * Called by the_room_itself() when the HTTP method is OPTIONS
236 void options_the_room_itself(struct http_transaction *h, struct ctdlsession *c)
238 h->response_code = 200;
239 h->response_string = strdup("OK");
240 if (c->room_default_view == VIEW_CALENDAR) {
241 add_response_header(h, strdup("DAV"), strdup("1, calendar-access")); // offer CalDAV
242 } else if (c->room_default_view == VIEW_ADDRESSBOOK) {
243 add_response_header(h, strdup("DAV"), strdup("1, addressbook")); // offer CardDAV
245 add_response_header(h, strdup("DAV"), strdup("1")); // ordinary WebDAV for all other room types
247 add_response_header(h, strdup("Allow"), strdup("OPTIONS, PROPFIND, GET, PUT, REPORT, DELETE"));
252 * Called by the_room_itself() when the HTTP method is PROPFIND
254 void propfind_the_room_itself(struct http_transaction *h, struct ctdlsession *c)
258 int dav_depth = (header_val(h, "Depth") ? atoi(header_val(h, "Depth")) : INT_MAX);
259 syslog(LOG_DEBUG, "Client PROPFIND requested depth: %d", dav_depth);
260 StrBuf *Buf = NewStrBuf();
262 StrBufAppendPrintf(Buf, "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
263 "<D:multistatus " "xmlns:D=\"DAV:\" " "xmlns:C=\"urn:ietf:params:xml:ns:caldav\"" ">");
265 /* Transmit the collection resource */
266 StrBufAppendPrintf(Buf, "<D:response>");
267 StrBufAppendPrintf(Buf, "<D:href>");
268 StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
269 StrBufAppendPrintf(Buf, "/ctdl/r/");
270 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
271 StrBufAppendPrintf(Buf, "</D:href>");
273 StrBufAppendPrintf(Buf, "<D:propstat>");
274 StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
275 StrBufAppendPrintf(Buf, "<D:prop>");
276 StrBufAppendPrintf(Buf, "<D:displayname>");
277 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
278 StrBufAppendPrintf(Buf, "</D:displayname>");
280 StrBufAppendPrintf(Buf, "<D:owner />"); // empty owner ought to be legal; see rfc3744 section 5.1
282 StrBufAppendPrintf(Buf, "<D:resourcetype><D:collection />");
283 switch (c->room_default_view) {
285 StrBufAppendPrintf(Buf, "<C:calendar />"); // RFC4791 section 4.2
288 StrBufAppendPrintf(Buf, "</D:resourcetype>");
290 int enumerate_by_euid = 0; // nonzero if messages will be retrieved by euid instead of msgnum
291 switch (c->room_default_view) {
292 case VIEW_CALENDAR: // RFC4791 section 5.2
293 StrBufAppendPrintf(Buf,
294 "<C:supported-calendar-component-set><C:comp name=\"VEVENT\"/></C:supported-calendar-component-set>");
295 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
296 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
297 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
298 enumerate_by_euid = 1;
300 case VIEW_TASKS: // RFC4791 section 5.2
301 StrBufAppendPrintf(Buf,
302 "<C:supported-calendar-component-set><C:comp name=\"VTODO\"/></C:supported-calendar-component-set>");
303 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
304 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
305 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
306 enumerate_by_euid = 1;
308 case VIEW_ADDRESSBOOK: // FIXME put some sort of CardDAV crapola here when we implement it
309 enumerate_by_euid = 1;
311 case VIEW_WIKI: // FIXME invent "WikiDAV" ?
312 enumerate_by_euid = 1;
317 /* FIXME get the mtime
318 StrBufAppendPrintf(Buf, "<D:getlastmodified>");
320 StrBufAppendPrintf(Buf, "</D:getlastmodified>");
323 StrBufAppendPrintf(Buf, "</D:prop>");
324 StrBufAppendPrintf(Buf, "</D:propstat>");
325 StrBufAppendPrintf(Buf, "</D:response>\n");
327 // If a depth greater than zero was specified, transmit the collection listing
330 long *msglist = get_msglist(c, "ALL");
333 for (i = 0; (msglist[i] > 0); ++i) {
335 syslog(LOG_DEBUG, "PROPFIND enumerated %d messages", i);
336 e = NULL; // EUID gets stored here
340 ctdl_printf(c, "MSG0 %ld|3", msglist[i]);
341 ctdl_readline(c, cbuf, sizeof(cbuf));
343 while (ctdl_readline(c, cbuf, sizeof(cbuf)), strcmp(cbuf, "000")) {
344 if ((enumerate_by_euid) && (!strncasecmp(cbuf, "exti=", 5))) {
345 // e = strdup(&cbuf[5]);
346 int elen = (2 * strlen(&cbuf[5]));
348 urlesc(e, elen, &cbuf[5]);
350 if (!strncasecmp(cbuf, "time=", 5)) {
351 timestamp = atol(&cbuf[5]);
356 sprintf(e, "%ld", msglist[i]);
358 StrBufAppendPrintf(Buf, "<D:response>");
360 // Generate the 'href' tag for this message
361 StrBufAppendPrintf(Buf, "<D:href>");
362 StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
363 StrBufAppendPrintf(Buf, "/ctdl/r/");
364 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
365 StrBufAppendPrintf(Buf, "/");
366 StrBufXMLEscAppend(Buf, NULL, e, strlen(e), 0);
367 StrBufAppendPrintf(Buf, "</D:href>");
368 StrBufAppendPrintf(Buf, "<D:propstat>");
369 StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
370 StrBufAppendPrintf(Buf, "<D:prop>");
372 switch (c->room_default_view) {
374 StrBufAppendPrintf(Buf,
375 "<D:getcontenttype>text/calendar; component=vevent</D:getcontenttype>");
378 StrBufAppendPrintf(Buf,
379 "<D:getcontenttype>text/calendar; component=vtodo</D:getcontenttype>");
381 case VIEW_ADDRESSBOOK:
382 StrBufAppendPrintf(Buf, "<D:getcontenttype>text/x-vcard</D:getcontenttype>");
387 char *datestring = http_datestring(timestamp);
389 StrBufAppendPrintf(Buf, "<D:getlastmodified>");
390 StrBufXMLEscAppend(Buf, NULL, datestring, strlen(datestring), 0);
391 StrBufAppendPrintf(Buf, "</D:getlastmodified>");
394 if (enumerate_by_euid) // FIXME ajc 2017oct30 should this be inside the timestamp conditional?
396 StrBufAppendPrintf(Buf, "<D:getetag>\"%ld\"</D:getetag>", msglist[i]);
399 StrBufAppendPrintf(Buf, "</D:prop></D:propstat></D:response>\n");
407 StrBufAppendPrintf(Buf, "</D:multistatus>\n");
409 add_response_header(h, strdup("Content-type"), strdup("text/xml"));
410 h->response_code = 207;
411 h->response_string = strdup("Multi-Status");
412 h->response_body_length = StrLength(Buf);
413 h->response_body = SmashStrBuf(&Buf);
416 // some good examples here
417 // http://blogs.nologin.es/rickyepoderi/index.php?/archives/14-Introducing-CalDAV-Part-I.html
421 * Called by the_room_itself() when the HTTP method is PROPFIND
423 void get_the_room_itself(struct http_transaction *h, struct ctdlsession *c)
425 JsonValue *j = NewJsonObject(HKEY("gotoroom"));
427 JsonObjectAppend(j, NewJsonPlainString(HKEY("name"), c->room, -1));
428 JsonObjectAppend(j, NewJsonNumber(HKEY("current_view"), c->room_current_view));
429 JsonObjectAppend(j, NewJsonNumber(HKEY("default_view"), c->room_default_view));
430 JsonObjectAppend(j, NewJsonNumber(HKEY("new_messages"), c->new_messages));
431 JsonObjectAppend(j, NewJsonNumber(HKEY("total_messages"), c->total_messages));
432 JsonObjectAppend(j, NewJsonNumber(HKEY("last_seen"), c->last_seen));
434 StrBuf *sj = NewStrBuf();
435 SerializeJson(sj, j, 1); // '1' == free the source array
437 add_response_header(h, strdup("Content-type"), strdup("application/json"));
438 h->response_code = 200;
439 h->response_string = strdup("OK");
440 h->response_body_length = StrLength(sj);
441 h->response_body = SmashStrBuf(&sj);
447 * Handle REST/DAV requests for the room itself (such as /ctdl/r/roomname
448 * or /ctdl/r/roomname/ but *not* specific objects within the room)
450 void the_room_itself(struct http_transaction *h, struct ctdlsession *c)
452 // OPTIONS method on the room itself usually is a DAV client assessing what's here.
454 if (!strcasecmp(h->method, "OPTIONS")) {
455 options_the_room_itself(h, c);
458 // PROPFIND method on the room itself could be looking for a directory
460 if (!strcasecmp(h->method, "PROPFIND")) {
461 propfind_the_room_itself(h, c);
464 // REPORT method on the room itself is probably the dreaded CalDAV tower-of-crapola
466 if (!strcasecmp(h->method, "REPORT")) {
467 report_the_room_itself(h, c);
470 // GET method on the room itself is an API call, possibly from our JavaScript front end
472 if (!strcasecmp(h->method, "get")) {
473 get_the_room_itself(h, c);
476 // we probably want a "go to this room" for interactive access
482 * Dispatcher for "/ctdl/r" and "/ctdl/r/" for the room list
484 void room_list(struct http_transaction *h, struct ctdlsession *c)
489 ctdl_printf(c, "LKRA");
490 ctdl_readline(c, buf, sizeof(buf));
496 JsonValue *j = NewJsonArray(HKEY("lkra"));
497 while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
499 // name|QRflags|QRfloor|QRorder|QRflags2|ra|current_view|default_view|mtime
500 JsonValue *jr = NewJsonObject(HKEY("room"));
502 extract_token(roomname, buf, 0, '|', sizeof roomname);
503 JsonObjectAppend(jr, NewJsonPlainString(HKEY("name"), roomname, -1));
505 int ra = extract_int(buf, 5);
506 JsonObjectAppend(jr, NewJsonBool(HKEY("known"), (ra & UA_KNOWN)));
507 JsonObjectAppend(jr, NewJsonBool(HKEY("hasnewmsgs"), (ra & UA_HASNEWMSGS)));
509 int floor = extract_int(buf, 2);
510 JsonObjectAppend(jr, NewJsonNumber(HKEY("floor"), floor));
512 int rorder = extract_int(buf, 3);
513 JsonObjectAppend(jr, NewJsonNumber(HKEY("rorder"), rorder));
515 JsonArrayAppend(j, jr); // add the room to the array
518 StrBuf *sj = NewStrBuf();
519 SerializeJson(sj, j, 1); // '1' == free the source array
521 add_response_header(h, strdup("Content-type"), strdup("application/json"));
522 h->response_code = 200;
523 h->response_string = strdup("OK");
524 h->response_body_length = StrLength(sj);
525 h->response_body = SmashStrBuf(&sj);
530 * Dispatcher for paths starting with /ctdl/r/
532 void ctdl_r(struct http_transaction *h, struct ctdlsession *c)
534 char requested_roomname[128];
537 // All room-related functions require being "in" the room specified. Are we in that room already?
538 extract_token(requested_roomname, h->uri, 3, '/', sizeof requested_roomname);
539 unescape_input(requested_roomname);
541 if (IsEmptyStr(requested_roomname)) // /ctdl/r/
546 // If not, try to go there.
547 if (strcasecmp(requested_roomname, c->room)) {
548 ctdl_printf(c, "GOTO %s", requested_roomname);
549 ctdl_readline(c, buf, sizeof(buf));
551 // buf[3] will indicate whether any instant messages are waiting
552 extract_token(c->room, &buf[4], 0, '|', sizeof c->room);
553 c->new_messages = extract_int(&buf[4], 1);
554 c->total_messages = extract_int(&buf[4], 2);
555 // 3 (int)info Info flag: set to nonzero if the user needs to read this room's info file
556 // 4 (int)CCC->room.QRflags Various flags associated with this room.
557 // 5 (long)CCC->room.QRhighest The highest message number present in this room
558 c->last_seen = extract_long(&buf[4], 6); // The highest message number the user has read in this room
559 // 7 (int)rmailflag Boolean flag: 1 if this is a Mail> room, 0 otherwise.
560 // 8 (int)raideflag Nonzero if user is either Aide or a Room Aide in this room
561 // 9 (int)newmailcount The number of new Mail messages the user has
562 // 10 (int)CCC->room.QRfloor The floor number this room resides on
563 c->room_current_view = extract_int(&buf[4], 11);
564 c->room_default_view = extract_int(&buf[4], 12);
565 // 13 (int)is_trash Boolean flag: 1 if this is the user's Trash folder, 0 otherwise.
566 // 14 (int)CCC->room.QRflags2 More flags associated with this room
567 // 15 (long)CCC->room.QRmtime Timestamp of the last write activity in this room
573 // At this point our Citadel client session is "in" the specified room.
575 if (num_tokens(h->uri, '/') == 4) // /ctdl/r/roomname
577 the_room_itself(h, c);
581 extract_token(buf, h->uri, 4, '/', sizeof buf);
582 if (num_tokens(h->uri, '/') == 5) {
583 if (IsEmptyStr(buf)) {
584 the_room_itself(h, c); // /ctdl/r/roomname/ ( same as /ctdl/r/roomname )
586 object_in_room(h, c); // /ctdl/r/roomname/object
590 if (num_tokens(h->uri, '/') == 6) {
591 object_in_room(h, c); // /ctdl/r/roomname/object/ or possibly /ctdl/r/roomname/object/component
594 // If we get to this point, the client specified a valid room but requested an action we don't know how to perform.