67b3e9082943ca78a952b0048e00c6d8fa9a3ff5
[citadel.git] / webcit-ng / server / room_functions.c
1 // Room functions
2 //
3 // Copyright (c) 1996-2022 by the citadel.org team
4 //
5 // This program is open source software.  Use, duplication, or
6 // disclosure are subject to the GNU General Public License v3.
7
8 #include "webcit.h"
9
10
11 // Return a "zero-terminated" array of message numbers in the current room.
12 // Caller owns the memory and must free it.  Returns NULL if any problems.
13 long *get_msglist(struct ctdlsession *c, char *which_msgs) {
14         char buf[1024];
15         long *msglist = NULL;
16         int num_msgs = 0;
17         int num_alloc = 0;
18
19         ctdl_printf(c, "MSGS %s", which_msgs);
20         ctdl_readline(c, buf, sizeof(buf));
21         if (buf[0] == '1') {
22                 do {
23                         if (num_msgs >= num_alloc) {
24                                 if (num_alloc == 0) {
25                                         num_alloc = 1024;
26                                         msglist = malloc(num_alloc * sizeof(long));
27                                 }
28                                 else {
29                                         num_alloc *= 2;
30                                         msglist = realloc(msglist, num_alloc * sizeof(long));
31                                 }
32                         }
33                         ctdl_readline(c, buf, sizeof(buf));
34                         msglist[num_msgs++] = atol(buf);
35                 } while (strcmp(buf, "000"));   // this makes the last element a "0" terminator
36         }
37         return msglist;
38 }
39
40
41 // Supplied with a list of potential matches from an If-Match: or If-None-Match: header, and
42 // a message number (which we always use as the entity tag in Citadel), return nonzero if the
43 // message number matches any of the supplied tags in the string.
44 int match_etags(char *taglist, long msgnum) {
45         int num_tags = num_tokens(taglist, ',');
46         int i = 0;
47         char tag[1024];
48
49         if (msgnum <= 0) {                                      // no msgnum?  no match.
50                 return (0);
51         }
52
53         for (i = 0; i < num_tags; ++i) {
54                 extract_token(tag, taglist, i, ',', sizeof tag);
55                 striplt(tag);
56                 char *lq = (strchr(tag, '"'));
57                 char *rq = (strrchr(tag, '"'));
58                 if (lq < rq) {                                  // has two double quotes
59                         strcpy(rq, "");
60                         strcpy(tag, ++lq);
61                 }
62                 striplt(tag);
63                 if (!strcmp(tag, "*")) {                        // wildcard match
64                         return (1);
65                 }
66                 long tagmsgnum = atol(tag);
67                 if ((tagmsgnum > 0) && (tagmsgnum == msgnum)) { // match
68                         return (1);
69                 }
70         }
71
72         return (0);                                             // no match
73 }
74
75
76 // Client is requesting a STAT (name and modification time) of the current room
77 void json_stat(struct http_transaction *h, struct ctdlsession *c) {
78         char buf[1024];
79         char field[1024];
80
81         ctdl_printf(c, "STAT");
82         ctdl_readline(c, buf, sizeof(buf));
83         if (buf[0] == '2') {
84                 JsonValue *j = NewJsonObject(HKEY("stat"));
85                 extract_token(field, &buf[4], 0, '|', sizeof field);
86                 JsonObjectAppend(j, NewJsonPlainString(HKEY("name"), field, -1));
87                 JsonObjectAppend(j, NewJsonNumber(HKEY("room_mtime"), extract_long(&buf[4], 1)));
88
89                 StrBuf *sj = NewStrBuf();
90                 SerializeJson(sj, j, 1);                                // '1' == free the source array
91                 add_response_header(h, strdup("Content-type"), strdup("application/json"));
92                 h->response_code = 200;
93                 h->response_string = strdup("OK");
94                 h->response_body_length = StrLength(sj);
95                 h->response_body = SmashStrBuf(&sj);
96         }
97         else {
98                 do_404(h);
99         }
100         return;
101 }
102
103
104 // Client is requesting a mailbox summary of the current room
105 void json_mailbox(struct http_transaction *h, struct ctdlsession *c) {
106         char buf[1024];
107         char field[1024];
108         JsonValue *j = NewJsonArray(HKEY("msgs"));
109
110         ctdl_printf(c, "MSGS ALL|||9");                         // "9" as the fourth parameter delivers a mailbox summary
111         ctdl_readline(c, buf, sizeof(buf));
112         if (buf[0] == '1') {
113                 while (ctdl_readline(c, buf, sizeof(buf)), (strcmp(buf, "000"))) {
114                         utf8ify_rfc822_string(buf);
115                         JsonValue *jmsg = NewJsonObject(HKEY("message"));
116                         JsonObjectAppend(jmsg, NewJsonNumber(HKEY("msgnum"), extract_long(buf, 0)));
117                         JsonObjectAppend(jmsg, NewJsonNumber(HKEY("time"), extract_long(buf, 1)));
118                         extract_token(field, buf, 2, '|', sizeof field);
119                         JsonObjectAppend(jmsg, NewJsonPlainString(HKEY("author"), field, -1));
120                         extract_token(field, buf, 4, '|', sizeof field);
121                         JsonObjectAppend(jmsg, NewJsonPlainString(HKEY("addr"), field, -1));
122                         extract_token(field, buf, 5, '|', sizeof field);
123                         JsonObjectAppend(jmsg, NewJsonPlainString(HKEY("subject"), field, -1));
124                         JsonObjectAppend(jmsg, NewJsonNumber(HKEY("msgidhash"), extract_long(buf, 6)));
125                         extract_token(field, buf, 7, '|', sizeof field);
126                         JsonObjectAppend(jmsg, NewJsonPlainString(HKEY("references"), field, -1));
127                         JsonArrayAppend(j, jmsg);               // add the message to the array
128                 }
129         }
130
131         StrBuf *sj = NewStrBuf();
132         SerializeJson(sj, j, 1);                                // '1' == free the source array
133
134         add_response_header(h, strdup("Content-type"), strdup("application/json"));
135         h->response_code = 200;
136         h->response_string = strdup("OK");
137         h->response_body_length = StrLength(sj);
138         h->response_body = SmashStrBuf(&sj);
139         return;
140 }
141
142
143 // Client is requesting a message list
144 void json_msglist(struct http_transaction *h, struct ctdlsession *c, char *which) {
145         int i = 0;
146         long *msglist = get_msglist(c, which);
147         JsonValue *j = NewJsonArray(HKEY("msgs"));
148
149         if (msglist != NULL) {
150                 for (i = 0; msglist[i] > 0; ++i) {
151                         JsonArrayAppend(j, NewJsonNumber(HKEY("m"), msglist[i]));
152                 }
153                 free(msglist);
154         }
155
156         StrBuf *sj = NewStrBuf();
157         SerializeJson(sj, j, 1);                                // '1' == free the source array
158
159         add_response_header(h, strdup("Content-type"), strdup("application/json"));
160         h->response_code = 200;
161         h->response_string = strdup("OK");
162         h->response_body_length = StrLength(sj);
163         h->response_body = SmashStrBuf(&sj);
164         return;
165 }
166
167
168 // Client is requesting the room info banner
169 void read_room_info_banner(struct http_transaction *h, struct ctdlsession *c) {
170         char buf[1024];
171
172         ctdl_printf(c, "RINF");
173         ctdl_readline(c, buf, sizeof(buf));
174         if (buf[0] == '1') {
175                 StrBuf *info = NewStrBuf();
176                 while (ctdl_readline(c, buf, sizeof(buf)), (strcmp(buf, "000"))){
177                         StrBufAppendPrintf(info, "%s\n", buf);
178                 }
179                 add_response_header(h, strdup("Content-type"), strdup("text/plain"));
180                 h->response_code = 200;
181                 h->response_string = strdup("OK");
182                 h->response_body_length = StrLength(info);
183                 h->response_body = SmashStrBuf(&info);
184                 return;
185         }
186         else {
187                 do_404(h);
188         }
189 }
190
191
192 // Client is setting the "Last Read Pointer" (marking all messages as "seen" up to this message)
193 void set_last_read_pointer(struct http_transaction *h, struct ctdlsession *c) {
194         char cbuf[1024];
195         ctdl_printf(c, "SLRP %d", atoi(get_url_param(h, "last")));
196         ctdl_readline(c, cbuf, sizeof(cbuf));
197         if (cbuf[0] == '2') {
198                 do_204(h);
199         }
200         else {
201                 do_404(h);
202         }
203 }
204
205
206 // Client requested an object in a room.
207 void object_in_room(struct http_transaction *h, struct ctdlsession *c) {
208         char buf[1024];
209         long msgnum = (-1);
210         char unescaped_euid[1024];
211
212         extract_token(buf, h->url, 4, '/', sizeof buf);
213
214         if (!strcasecmp(buf, "mailbox")) {              // Client is requesting a mailbox summary
215                 json_mailbox(h, c);
216                 return;
217         }
218
219         if (!strcasecmp(buf, "stat")) {                 // Client is requesting a stat command (name and modification time)
220                 json_stat(h, c);
221                 return;
222         }
223
224         if (!strncasecmp(buf, "msgs.", 5)) {            // Client is requesting a list of message numbers
225                 unescape_input(&buf[5]);
226                 json_msglist(h, c, &buf[5]);
227                 return;
228         }
229
230         if (!strcasecmp(buf, "info.txt")) {             // Client is requesting the room info banner
231                 read_room_info_banner(h, c);
232                 return;
233         }
234
235         if (!strcasecmp(buf, "slrp")) {                 // Set the Last Read Pointer
236                 set_last_read_pointer(h, c);
237                 return;
238         }
239
240         // If we get to this point, the client is requesting a specific object *in* the room.
241
242         if ((c->room_default_view == VIEW_CALENDAR)     // room types where objects are referenced by EUID
243            || (c->room_default_view == VIEW_TASKS)
244            || (c->room_default_view == VIEW_ADDRESSBOOK)
245            ) {
246                 safestrncpy(unescaped_euid, buf, sizeof unescaped_euid);
247                 unescape_input(unescaped_euid);
248                 msgnum = locate_message_by_uid(c, unescaped_euid);
249         }
250         else {                                          // otherwise the object is being referenced by message number
251                 msgnum = atol(buf);
252         }
253
254         // All methods except PUT require the message to already exist
255         if ((msgnum <= 0) && (strcasecmp(h->method, "PUT"))) {
256                 do_404(h);
257         }
258
259         // If we get to this point we have a valid message number in an accessible room.
260         syslog(LOG_DEBUG, "msgnum is %ld, method is %s", msgnum, h->method);
261
262         // A sixth component in the URL can be one of two things:
263         // (1) a MIME part specifier, in which case the client wants to download that component within the message
264         // (2) a content-type, in which ase the client wants us to try to render it a certain way
265         if (num_tokens(h->url, '/') == 6) {
266                 extract_token(buf, h->url, 5, '/', sizeof buf);
267                 if (!IsEmptyStr(buf)) {
268                         if (!strcasecmp(buf, "json")) {
269                                 json_render_one_message(h, c, msgnum);
270                         }
271                         else {
272                                 download_mime_component(h, c, msgnum, buf);
273                         }
274                         return;
275                 }
276         }
277
278         // Ok, we want a full message, but first let's check for the if[-none]-match headers.
279         char *if_match = header_val(h, "If-Match");
280         if ((if_match != NULL) && (!match_etags(if_match, msgnum))) {
281                 do_412(h);
282                 return;
283         }
284
285         char *if_none_match = header_val(h, "If-None-Match");
286         if ((if_none_match != NULL) && (match_etags(if_none_match, msgnum))) {
287                 do_412(h);
288                 return;
289         }
290
291         // DOOOOOO ITTTTT!!!
292
293         if (!strcasecmp(h->method, "DELETE")) {
294                 dav_delete_message(h, c, msgnum);
295         }
296         else if (!strcasecmp(h->method, "GET")) {
297                 dav_get_message(h, c, msgnum);
298         }
299         else if (!strcasecmp(h->method, "PUT")) {
300                 dav_put_message(h, c, unescaped_euid, msgnum);
301         }
302         else {
303                 do_404(h);      // Got this far but the method made no sense?  Bummer.
304         }
305
306 }
307
308
309 // Called by the_room_itself() when the HTTP method is REPORT
310 void report_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
311         if (c->room_default_view == VIEW_CALENDAR) {
312                 caldav_report(h, c);    // CalDAV REPORTs ... fmgwac
313                 return;
314         }
315
316         do_404(h);              // future implementations like CardDAV will require code paths here
317 }
318
319
320 // Called by the_room_itself() when the HTTP method is OPTIONS
321 void options_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
322         h->response_code = 200;
323         h->response_string = strdup("OK");
324         if (c->room_default_view == VIEW_CALENDAR) {
325                 add_response_header(h, strdup("DAV"), strdup("1, calendar-access"));    // offer CalDAV
326         }
327         else if (c->room_default_view == VIEW_ADDRESSBOOK) {
328                 add_response_header(h, strdup("DAV"), strdup("1, addressbook"));        // offer CardDAV
329         }
330         else {
331                 add_response_header(h, strdup("DAV"), strdup("1"));     // ordinary WebDAV for all other room types
332         }
333         add_response_header(h, strdup("Allow"), strdup("OPTIONS, PROPFIND, GET, PUT, REPORT, DELETE"));
334 }
335
336
337 // Called by the_room_itself() when the HTTP method is PROPFIND
338 void propfind_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
339         char *e;
340         long timestamp;
341         int dav_depth = (header_val(h, "Depth") ? atoi(header_val(h, "Depth")) : INT_MAX);
342         syslog(LOG_DEBUG, "Client PROPFIND requested depth: %d", dav_depth);
343         StrBuf *Buf = NewStrBuf();
344
345         StrBufAppendPrintf(Buf, "<?xml version=\"1.0\" encoding=\"utf-8\"?>"
346                            "<D:multistatus " "xmlns:D=\"DAV:\" " "xmlns:C=\"urn:ietf:params:xml:ns:caldav\"" ">");
347
348         // Transmit the collection resource
349         StrBufAppendPrintf(Buf, "<D:response>");
350         StrBufAppendPrintf(Buf, "<D:href>");
351         StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
352         StrBufAppendPrintf(Buf, "/ctdl/r/");
353         StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
354         StrBufAppendPrintf(Buf, "</D:href>");
355
356         StrBufAppendPrintf(Buf, "<D:propstat>");
357         StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
358         StrBufAppendPrintf(Buf, "<D:prop>");
359         StrBufAppendPrintf(Buf, "<D:displayname>");
360         StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
361         StrBufAppendPrintf(Buf, "</D:displayname>");
362
363         StrBufAppendPrintf(Buf, "<D:owner />"); // empty owner ought to be legal; see rfc3744 section 5.1
364
365         StrBufAppendPrintf(Buf, "<D:resourcetype><D:collection />");
366         switch (c->room_default_view) {
367         case VIEW_CALENDAR:
368                 StrBufAppendPrintf(Buf, "<C:calendar />");      // RFC4791 section 4.2
369                 break;
370         }
371         StrBufAppendPrintf(Buf, "</D:resourcetype>");
372
373         int enumerate_by_euid = 0;      // nonzero if messages will be retrieved by euid instead of msgnum
374         switch (c->room_default_view) {
375         case VIEW_CALENDAR:             // RFC4791 section 5.2
376                 StrBufAppendPrintf(Buf, "<C:supported-calendar-component-set><C:comp name=\"VEVENT\"/></C:supported-calendar-component-set>");
377                 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
378                 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
379                 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
380                 enumerate_by_euid = 1;
381                 break;
382         case VIEW_TASKS:                // RFC4791 section 5.2
383                 StrBufAppendPrintf(Buf, "<C:supported-calendar-component-set><C:comp name=\"VTODO\"/></C:supported-calendar-component-set>");
384                 StrBufAppendPrintf(Buf, "<C:supported-calendar-data>");
385                 StrBufAppendPrintf(Buf, "<C:calendar-data content-type=\"text/calendar\" version=\"2.0\"/>");
386                 StrBufAppendPrintf(Buf, "</C:supported-calendar-data>");
387                 enumerate_by_euid = 1;
388                 break;
389         case VIEW_ADDRESSBOOK:          // FIXME put some sort of CardDAV crapola here when we implement it
390                 enumerate_by_euid = 1;
391                 break;
392         case VIEW_WIKI:                 // FIXME invent "WikiDAV" ?  The versioning stuff in DAV could be useful.
393                 enumerate_by_euid = 1;
394                 break;
395         }
396
397         // FIXME get the mtime
398         // StrBufAppendPrintf(Buf, "<D:getlastmodified>");
399         // escputs(datestring);
400         // StrBufAppendPrintf(Buf, "</D:getlastmodified>");
401
402         StrBufAppendPrintf(Buf, "</D:prop>");
403         StrBufAppendPrintf(Buf, "</D:propstat>");
404         StrBufAppendPrintf(Buf, "</D:response>\n");
405
406         // If a depth greater than zero was specified, transmit the collection listing
407         // BEGIN COLLECTION
408         if (dav_depth > 0) {
409                 long *msglist = get_msglist(c, "ALL");
410                 if (msglist) {
411                         int i;
412                         for (i = 0; (msglist[i] > 0); ++i) {
413                                 if ((i % 10) == 0)
414                                         syslog(LOG_DEBUG, "PROPFIND enumerated %d messages", i);
415                                 e = NULL;       // EUID gets stored here
416                                 timestamp = 0;
417
418                                 char cbuf[1024];
419                                 ctdl_printf(c, "MSG0 %ld|3", msglist[i]);
420                                 ctdl_readline(c, cbuf, sizeof(cbuf));
421                                 if (cbuf[0] == '1')
422                                         while (ctdl_readline(c, cbuf, sizeof(cbuf)), strcmp(cbuf, "000")) {
423                                                 if ((enumerate_by_euid) && (!strncasecmp(cbuf, "exti=", 5))) {
424                                                         // e = strdup(&cbuf[5]);
425                                                         int elen = (2 * strlen(&cbuf[5]));
426                                                         e = malloc(elen);
427                                                         urlesc(e, elen, &cbuf[5]);
428                                                 }
429                                                 if (!strncasecmp(cbuf, "time=", 5)) {
430                                                         timestamp = atol(&cbuf[5]);
431                                                 }
432                                         }
433                                 if (e == NULL) {
434                                         e = malloc(20);
435                                         sprintf(e, "%ld", msglist[i]);
436                                 }
437                                 StrBufAppendPrintf(Buf, "<D:response>");
438
439                                 // Generate the 'href' tag for this message
440                                 StrBufAppendPrintf(Buf, "<D:href>");
441                                 StrBufXMLEscAppend(Buf, NULL, h->site_prefix, strlen(h->site_prefix), 0);
442                                 StrBufAppendPrintf(Buf, "/ctdl/r/");
443                                 StrBufXMLEscAppend(Buf, NULL, c->room, strlen(c->room), 0);
444                                 StrBufAppendPrintf(Buf, "/");
445                                 StrBufXMLEscAppend(Buf, NULL, e, strlen(e), 0);
446                                 StrBufAppendPrintf(Buf, "</D:href>");
447                                 StrBufAppendPrintf(Buf, "<D:propstat>");
448                                 StrBufAppendPrintf(Buf, "<D:status>HTTP/1.1 200 OK</D:status>");
449                                 StrBufAppendPrintf(Buf, "<D:prop>");
450
451                                 switch (c->room_default_view) {
452                                 case VIEW_CALENDAR:
453                                         StrBufAppendPrintf(Buf,
454                                                            "<D:getcontenttype>text/calendar; component=vevent</D:getcontenttype>");
455                                         break;
456                                 case VIEW_TASKS:
457                                         StrBufAppendPrintf(Buf,
458                                                            "<D:getcontenttype>text/calendar; component=vtodo</D:getcontenttype>");
459                                         break;
460                                 case VIEW_ADDRESSBOOK:
461                                         StrBufAppendPrintf(Buf, "<D:getcontenttype>text/x-vcard</D:getcontenttype>");
462                                         break;
463                                 }
464
465                                 if (timestamp > 0) {
466                                         char *datestring = http_datestring(timestamp);
467                                         if (datestring) {
468                                                 StrBufAppendPrintf(Buf, "<D:getlastmodified>");
469                                                 StrBufXMLEscAppend(Buf, NULL, datestring, strlen(datestring), 0);
470                                                 StrBufAppendPrintf(Buf, "</D:getlastmodified>");
471                                                 free(datestring);
472                                         }
473                                         if (enumerate_by_euid) {        // FIXME ajc 2017oct30 should this be inside the timestamp conditional?
474                                                 StrBufAppendPrintf(Buf, "<D:getetag>\"%ld\"</D:getetag>", msglist[i]);
475                                         }
476                                 }
477                                 StrBufAppendPrintf(Buf, "</D:prop></D:propstat></D:response>\n");
478                                 free(e);
479                         }
480                         free(msglist);
481                 };
482         }
483         // END COLLECTION
484
485         StrBufAppendPrintf(Buf, "</D:multistatus>\n");
486
487         add_response_header(h, strdup("Content-type"), strdup("text/xml"));
488         h->response_code = 207;
489         h->response_string = strdup("Multi-Status");
490         h->response_body_length = StrLength(Buf);
491         h->response_body = SmashStrBuf(&Buf);
492 }
493
494 // some good examples here
495 // http://blogs.nologin.es/rickyepoderi/index.php?/archives/14-Introducing-CalDAV-Part-I.html
496
497
498 // Called by the_room_itself() when the HTTP method is PROPFIND
499 void get_the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
500         JsonValue *j = NewJsonObject(HKEY("gotoroom"));
501
502         JsonObjectAppend(j, NewJsonPlainString(HKEY("name"), c->room, -1));
503         JsonObjectAppend(j, NewJsonNumber(HKEY("current_view"), c->room_current_view));
504         JsonObjectAppend(j, NewJsonNumber(HKEY("default_view"), c->room_default_view));
505         JsonObjectAppend(j, NewJsonNumber(HKEY("is_room_aide"), c->is_room_aide));
506         JsonObjectAppend(j, NewJsonNumber(HKEY("can_delete_messages"), c->can_delete_messages));
507         JsonObjectAppend(j, NewJsonNumber(HKEY("new_messages"), c->new_messages));
508         JsonObjectAppend(j, NewJsonNumber(HKEY("total_messages"), c->total_messages));
509         JsonObjectAppend(j, NewJsonNumber(HKEY("last_seen"), c->last_seen));
510         JsonObjectAppend(j, NewJsonNumber(HKEY("room_mtime"), c->room_mtime));
511         JsonObjectAppend(j, NewJsonNumber(HKEY("new_mail"), c->new_mail));
512
513         StrBuf *sj = NewStrBuf();
514         SerializeJson(sj, j, 1);        // '1' == free the source array
515
516         add_response_header(h, strdup("Content-type"), strdup("application/json"));
517         h->response_code = 200;
518         h->response_string = strdup("OK");
519         h->response_body_length = StrLength(sj);
520         h->response_body = SmashStrBuf(&sj);
521         return;
522 }
523
524
525 // Handle REST/DAV requests for the room itself (such as /ctdl/r/roomname
526 // or /ctdl/r/roomname/ but *not* specific objects within the room)
527 void the_room_itself(struct http_transaction *h, struct ctdlsession *c) {
528
529         // OPTIONS method on the room itself usually is a DAV client assessing what's here.
530         if (!strcasecmp(h->method, "OPTIONS")) {
531                 options_the_room_itself(h, c);
532                 return;
533         }
534
535         // PROPFIND method on the room itself could be looking for a directory
536         if (!strcasecmp(h->method, "PROPFIND")) {
537                 propfind_the_room_itself(h, c);
538                 return;
539         }
540
541         // REPORT method on the room itself is probably the dreaded CalDAV tower-of-crapola
542         if (!strcasecmp(h->method, "REPORT")) {
543                 report_the_room_itself(h, c);
544                 return;
545         }
546
547         // GET method on the room itself is an API call, possibly from our JavaScript front end
548         if (!strcasecmp(h->method, "get")) {
549                 get_the_room_itself(h, c);
550                 return;
551         }
552
553         // we probably want a "go to this room" for interactive access
554         do_404(h);
555 }
556
557
558 // Dispatcher for "/ctdl/r" and "/ctdl/r/" for the room list
559 void room_list(struct http_transaction *h, struct ctdlsession *c) {
560         char buf[1024];
561         char roomname[1024];
562
563         ctdl_printf(c, "LKRA");
564         ctdl_readline(c, buf, sizeof(buf));
565         if (buf[0] != '1') {
566                 do_502(h);
567                 return;
568         }
569
570         JsonValue *j = NewJsonArray(HKEY("lkra"));
571         while (ctdl_readline(c, buf, sizeof(buf)), strcmp(buf, "000")) {
572
573                 // 0   |1      |2      |3      |4       |5 |6           |7           |8
574                 // name|QRflags|QRfloor|QRorder|QRflags2|ra|current_view|default_view|mtime
575                 JsonValue *jr = NewJsonObject(HKEY("room"));
576
577                 extract_token(roomname, buf, 0, '|', sizeof roomname);
578                 JsonObjectAppend(jr, NewJsonPlainString(HKEY("name"), roomname, -1));
579
580                 JsonObjectAppend(jr, NewJsonNumber(HKEY("floor"), extract_int(buf, 2)));
581                 JsonObjectAppend(jr, NewJsonNumber(HKEY("rorder"), extract_int(buf, 3)));
582
583                 int ra = extract_int(buf, 5);
584                 JsonObjectAppend(jr, NewJsonBool(HKEY("known"), (ra & UA_KNOWN)));
585                 JsonObjectAppend(jr, NewJsonBool(HKEY("hasnewmsgs"), (ra & UA_HASNEWMSGS)));
586
587                 JsonObjectAppend(jr, NewJsonNumber(HKEY("current_view"), extract_int(buf, 6)));
588                 JsonObjectAppend(jr, NewJsonNumber(HKEY("default_view"), extract_int(buf, 7)));
589                 JsonObjectAppend(jr, NewJsonNumber(HKEY("mtime"), extract_int(buf, 8)));
590
591                 JsonArrayAppend(j, jr); // add the room to the array
592         }
593
594         StrBuf *sj = NewStrBuf();
595         SerializeJson(sj, j, 1);        // '1' == free the source array
596
597         add_response_header(h, strdup("Content-type"), strdup("application/json"));
598         h->response_code = 200;
599         h->response_string = strdup("OK");
600         h->response_body_length = StrLength(sj);
601         h->response_body = SmashStrBuf(&sj);
602 }
603
604
605 // Dispatcher for paths starting with /ctdl/r/
606 void ctdl_r(struct http_transaction *h, struct ctdlsession *c) {
607         char requested_roomname[128];
608         char buf[1024];
609         long room_flags = 0;
610         long room_flags2 = 0;
611
612         // All room-related functions require being "in" the room specified.  Are we in that room already?
613         extract_token(requested_roomname, h->url, 3, '/', sizeof requested_roomname);
614         unescape_input(requested_roomname);
615
616         if (IsEmptyStr(requested_roomname)) {   //      /ctdl/r/
617                 room_list(h, c);
618                 return;
619         }
620         // If not, try to go there.
621         if (strcasecmp(requested_roomname, c->room)) {
622                 ctdl_printf(c, "GOTO %s", requested_roomname);
623                 ctdl_readline(c, buf, sizeof(buf));
624                 if (buf[0] == '2') {
625                         // buf[3] will indicate whether any instant messages are waiting
626                         extract_token(c->room, &buf[4], 0, '|', sizeof c->room);
627                         c->new_messages = extract_int(&buf[4], 1);
628                         c->total_messages = extract_int(&buf[4], 2);
629                         //      3       (int)info                       Info flag: set to nonzero if the user needs to read this room's info file
630                         room_flags = extract_long(&buf[4], 3);          // Various flags associated with this room.
631                         //      5       (long)CC->room.QRhighest        The highest message number present in this room
632                         c->last_seen = extract_long(&buf[4], 6);        // The highest message number the user has read in this room
633                         //      7       (int)rmailflag                  Boolean flag: 1 if this is a Mail> room, 0 otherwise.
634                         c->is_room_aide = extract_int(&buf[4], 8);
635                         c->new_mail = extract_int(&buf[4], 9);          // the number of new messages in the user's INBOX
636                         //      10      (int)CC->room.QRfloor           The floor number this room resides on
637                         c->room_current_view = extract_int(&buf[4], 11);
638                         c->room_default_view = extract_int(&buf[4], 12);
639                         //      13      (int)is_trash                   Boolean flag: 1 if this is the user's Trash folder, 0 otherwise.
640                         room_flags2 = extract_long(&buf[4], 14);        // More flags associated with this room.
641                         c->room_mtime = extract_long(&buf[4], 15);      // Timestamp of the last write activity in this room
642
643                         // If any of these three conditions are met, let the client know it has permission to delete messages.
644                         if ((c->is_room_aide) || (room_flags & QR_MAILBOX) || (room_flags2 & QR2_COLLABDEL)) {
645                                 c->can_delete_messages = 1;
646                         }
647                         else {
648                                 c->can_delete_messages = 0;
649                         }
650                 }
651                 else {
652                         do_404(h);
653                         return;
654                 }
655         }
656         // At this point our Citadel client session is "in" the specified room.
657
658         if (num_tokens(h->url, '/') == 4) {     //      /ctdl/r/roomname
659                 the_room_itself(h, c);
660                 return;
661         }
662
663         extract_token(buf, h->url, 4, '/', sizeof buf);
664         if (num_tokens(h->url, '/') == 5) {
665                 if (IsEmptyStr(buf)) {
666                         the_room_itself(h, c);  //      /ctdl/r/roomname/       ( same as /ctdl/r/roomname )
667                 }
668                 else {
669                         object_in_room(h, c);   //      /ctdl/r/roomname/object
670                 }
671                 return;
672         }
673         if (num_tokens(h->url, '/') == 6) {
674                 object_in_room(h, c);   //      /ctdl/r/roomname/object/ or possibly /ctdl/r/roomname/object/component
675                 return;
676         }
677         // If we get to this point, the client specified a valid room but requested an action we don't know how to perform.
678         do_404(h);
679 }