stable now but there are GIANT PIECES MISSING
[citadel.git] / citadel / room_ops.c
1 /* 
2  * Server functions which perform operations on room objects.
3  *
4  * Copyright (c) 1987-2021 by the citadel.org team
5  *
6  * This program is open source software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License, version 3.
8  *
9  * This program is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  * GNU General Public License for more details.
13  */
14
15 #include <stdio.h>
16 #include <libcitadel.h>
17
18 #include "citserver.h"
19 #include "ctdl_module.h"
20 #include "config.h"
21 #include "control.h"
22 #include "user_ops.h"
23 #include "room_ops.h"
24
25 struct floor *floorcache[MAXFLOORS];
26
27 /* 
28  * Determine whether the currently logged in session has permission to read
29  * messages in the current room.
30  */
31 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void) {
32         if (    (!(CC->logged_in))
33                 && (!(CC->internal_pgm))
34                 && (!CtdlGetConfigInt("c_guest_logins"))
35         ) {
36                 return(om_not_logged_in);
37         }
38         return(om_ok);
39 }
40
41
42 /*
43  * Check to see whether we have permission to post a message in the current
44  * room.  Returns a *CITADEL ERROR CODE* and puts a message in errmsgbuf, or
45  * returns 0 on success.
46  */
47 int CtdlDoIHavePermissionToPostInThisRoom(
48         char *errmsgbuf, 
49         size_t n, 
50         const char* RemoteIdentifier,
51         PostType PostPublic,
52         int is_reply
53 ) {
54         int ra;
55
56         if (!(CC->logged_in) && (PostPublic == POST_LOGGED_IN)) {
57                 snprintf(errmsgbuf, n, "Not logged in.");
58                 return (ERROR + NOT_LOGGED_IN);
59         }
60         else if (PostPublic == CHECK_EXISTANCE) {
61                 return (0);                                     // evaluate whether a recipient exists
62         }
63         else if (!(CC->logged_in)) {
64                 if ((CC->room.QRflags & QR_READONLY)) {
65                         snprintf(errmsgbuf, n, "Not logged in.");
66                         return (ERROR + NOT_LOGGED_IN);
67                 }
68                 if (CC->room.QRflags2 & QR2_MODERATED) {
69                         snprintf(errmsgbuf, n, "Not logged in Moderation feature not yet implemented!");
70                         return (ERROR + NOT_LOGGED_IN);
71                 }
72                 // FIXME what was this?  AJC 2021
73                 //if ((PostPublic != POST_LMTP) && (CC->room.QRflags2 & QR2_SMTP_PUBLIC) == 0) {
74                         //return CtdlNetconfigCheckRoomaccess(errmsgbuf, n, RemoteIdentifier);
75                 //}
76                 return (0);
77         }
78
79         if ((CC->user.axlevel < AxProbU) && ((CC->room.QRflags & QR_MAILBOX) == 0)) {
80                 snprintf(errmsgbuf, n, "Need to be validated to enter (except in %s> to sysop)", MAILROOM);
81                 return (ERROR + HIGHER_ACCESS_REQUIRED);
82         }
83
84         CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
85
86         if (ra & UA_POSTALLOWED) {
87                 strcpy(errmsgbuf, "OK to post or reply here");
88                 return(0);
89         }
90
91         if ( (ra & UA_REPLYALLOWED) && (is_reply) ) {
92                 /*
93                  * To be thorough, we ought to check to see if the message they are
94                  * replying to is actually a valid one in this room, but unless this
95                  * actually becomes a problem we'll go with high performance instead.
96                  */
97                 strcpy(errmsgbuf, "OK to reply here");
98                 return(0);
99         }
100
101         if ( (ra & UA_REPLYALLOWED) && (!is_reply) ) {
102                 /* Clarify what happened with a better error message */
103                 snprintf(errmsgbuf, n, "You may only reply to existing messages here.");
104                 return (ERROR + HIGHER_ACCESS_REQUIRED);
105         }
106
107         snprintf(errmsgbuf, n, "Higher access is required to post in this room.");
108         return (ERROR + HIGHER_ACCESS_REQUIRED);
109
110 }
111
112
113 /*
114  * Check whether the current user has permission to delete messages from
115  * the current room (returns 1 for yes, 0 for no)
116  */
117 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void) {
118         int ra;
119         CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
120         if (ra & UA_DELETEALLOWED) return(1);
121         return(0);
122 }
123
124
125 /*
126  * Retrieve access control information for any user/room pair.
127  * Yes, it has a couple of gotos.  If you don't like that, go die in a car fire.
128  */
129 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view) {
130         int retval = 0;
131         visit vbuf;
132         int is_me = 0;
133         int is_guest = 0;
134
135         if (userbuf == &CC->user) {
136                 is_me = 1;
137         }
138
139         if ((is_me) && (CtdlGetConfigInt("c_guest_logins")) && (!CC->logged_in)) {
140                 is_guest = 1;
141         }
142
143         /* for internal programs, always do everything */
144         if (((CC->internal_pgm)) && (roombuf->QRflags & QR_INUSE)) {
145                 retval = (UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED);
146                 vbuf.v_view = 0;
147                 goto SKIP_EVERYTHING;
148         }
149
150         /* If guest mode is enabled, always grant access to the Lobby */
151         if ((is_guest) && (!strcasecmp(roombuf->QRname, BASEROOM))) {
152                 retval = (UA_KNOWN | UA_GOTOALLOWED);
153                 vbuf.v_view = 0;
154                 goto SKIP_EVERYTHING;
155         }
156
157         /* Locate any applicable user/room relationships */
158         if (is_guest) {
159                 memset(&vbuf, 0, sizeof vbuf);
160         }
161         else {
162                 CtdlGetRelationship(&vbuf, userbuf, roombuf);
163         }
164
165         /* Force the properties of the Aide room */
166         if (!strcasecmp(roombuf->QRname, CtdlGetConfigStr("c_aideroom"))) {
167                 if (userbuf->axlevel >= AxAideU) {
168                         retval = UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
169                 } else {
170                         retval = 0;
171                 }
172                 goto NEWMSG;
173         }
174
175         /* If this is a public room, it's accessible... */
176         if (    ((roombuf->QRflags & QR_PRIVATE) == 0) 
177                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
178         ) {
179                 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
180         }
181
182         /* If this is a preferred users only room, check access level */
183         if (roombuf->QRflags & QR_PREFONLY) {
184                 if (userbuf->axlevel < AxPrefU) {
185                         retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED;
186                 }
187         }
188
189         /* For private rooms, check the generation number matchups */
190         if (    (roombuf->QRflags & QR_PRIVATE) 
191                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
192         ) {
193
194                 /* An explicit match means the user belongs in this room */
195                 if (vbuf.v_flags & V_ACCESS) {
196                         retval = retval | UA_KNOWN | UA_GOTOALLOWED;
197                 }
198                 /* Otherwise, check if this is a guess-name or passworded
199                  * room.  If it is, a goto may at least be attempted
200                  */
201                 else if (       (roombuf->QRflags & QR_PRIVATE)
202                                 || (roombuf->QRflags & QR_PASSWORDED)
203                 ) {
204                         retval = retval & ~UA_KNOWN;
205                         retval = retval | UA_GOTOALLOWED;
206                 }
207         }
208
209         /* For mailbox rooms, also check the namespace */
210         /* Also, mailbox owners can delete their messages */
211         if ( (roombuf->QRflags & QR_MAILBOX) && (atol(roombuf->QRname) != 0)) {
212                 if (userbuf->usernum == atol(roombuf->QRname)) {
213                         retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
214                 }
215                 /* An explicit match means the user belongs in this room */
216                 if (vbuf.v_flags & V_ACCESS) {
217                         retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
218                 }
219         }
220
221         /* For non-mailbox rooms... */
222         else {
223
224                 /* User is allowed to post in the room unless:
225                  * - User is not validated
226                  * - User has no net privileges and it is a shared network room
227                  * - It is a read-only room
228                  * - It is a blog room (in which case we only allow replies to existing messages)
229                  */
230                 int post_allowed = 1;
231                 int reply_allowed = 1;
232                 if (userbuf->axlevel < AxProbU) {
233                         post_allowed = 0;
234                         reply_allowed = 0;
235                 }
236                 if ((userbuf->axlevel < AxNetU) && (roombuf->QRflags & QR_NETWORK)) {
237                         post_allowed = 0;
238                         reply_allowed = 0;
239                 }
240                 if (roombuf->QRflags & QR_READONLY) {
241                         post_allowed = 0;
242                         reply_allowed = 0;
243                 }
244                 if (roombuf->QRdefaultview == VIEW_BLOG) {
245                         post_allowed = 0;
246                 }
247                 if (post_allowed) {
248                         retval = retval | UA_POSTALLOWED | UA_REPLYALLOWED;
249                 }
250                 if (reply_allowed) {
251                         retval = retval | UA_REPLYALLOWED;
252                 }
253
254                 /* If "collaborative deletion" is active for this room, any user who can post
255                  * is also allowed to delete
256                  */
257                 if (roombuf->QRflags2 & QR2_COLLABDEL) {
258                         if (retval & UA_POSTALLOWED) {
259                                 retval = retval | UA_DELETEALLOWED;
260                         }
261                 }
262
263         }
264
265         /* Check to see if the user has forgotten this room */
266         if (vbuf.v_flags & V_FORGET) {
267                 retval = retval & ~UA_KNOWN;
268                 if (    ( ((roombuf->QRflags & QR_PRIVATE) == 0) 
269                         && ((roombuf->QRflags & QR_MAILBOX) == 0)
270                 ) || (  (roombuf->QRflags & QR_MAILBOX) 
271                         && (atol(roombuf->QRname) == CC->user.usernum))
272                 ) {
273                         retval = retval | UA_ZAPPED;
274                 }
275         }
276
277         /* If user is explicitly locked out of this room, deny everything */
278         if (vbuf.v_flags & V_LOCKOUT) {
279                 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED & ~UA_POSTALLOWED & ~UA_REPLYALLOWED;
280         }
281
282         /* Aides get access to all private rooms */
283         if (    (userbuf->axlevel >= AxAideU)
284                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
285         ) {
286                 if (vbuf.v_flags & V_FORGET) {
287                         retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
288                 }
289                 else {
290                         retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
291                 }
292         }
293
294         /* Aides can gain access to mailboxes as well, but they don't show
295          * by default.
296          */
297         if (    (userbuf->axlevel >= AxAideU)
298                 && (roombuf->QRflags & QR_MAILBOX)
299         ) {
300                 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
301         }
302
303         /* Aides and Room Aides have admin privileges */
304         if (    (userbuf->axlevel >= AxAideU)
305                 || (userbuf->usernum == roombuf->QRroomaide)
306         ) {
307                 retval = retval | UA_ADMINALLOWED | UA_DELETEALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
308         }
309
310 NEWMSG: /* By the way, we also check for the presence of new messages */
311         if (is_msg_in_sequence_set(vbuf.v_seen, roombuf->QRhighest) == 0) {
312                 retval = retval | UA_HASNEWMSGS;
313         }
314
315         /* System rooms never show up in the list. */
316         if (roombuf->QRflags2 & QR2_SYSTEM) {
317                 retval = retval & ~UA_KNOWN;
318         }
319
320 SKIP_EVERYTHING:
321         /* Now give the caller the information it wants. */
322         if (result != NULL) *result = retval;
323         if (view != NULL) *view = vbuf.v_view;
324 }
325
326
327 /*
328  * Self-checking stuff for a room record read into memory
329  */
330 void room_sanity_check(struct ctdlroom *qrbuf) {
331         /* Mailbox rooms are always on the lowest floor */
332         if (qrbuf->QRflags & QR_MAILBOX) {
333                 qrbuf->QRfloor = 0;
334         }
335         /* Listing order of 0 is illegal except for base rooms */
336         if (qrbuf->QRorder == 0)
337                 if (    !(qrbuf->QRflags & QR_MAILBOX)
338                         && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)
339                         && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)
340                 ) {
341                         qrbuf->QRorder = 64;
342                 }
343 }
344
345
346 /*
347  * CtdlGetRoom()  -  retrieve room data from disk
348  */
349 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name) {
350         struct cdbdata *cdbqr;
351         char lowercase_name[ROOMNAMELEN];
352         char personal_lowercase_name[ROOMNAMELEN];
353         const char *sptr;
354         char *dptr, *eptr;
355
356         dptr = lowercase_name;
357         sptr = room_name;
358         eptr = (dptr + (sizeof lowercase_name - 1));
359         while (!IsEmptyStr(sptr) && (dptr < eptr)) {
360                 *dptr = tolower(*sptr);
361                 sptr++; dptr++;
362         }
363         *dptr = '\0';
364
365         memset(qrbuf, 0, sizeof(struct ctdlroom));
366
367         /* First, try the public namespace */
368         cdbqr = cdb_fetch(CDB_ROOMS, lowercase_name, strlen(lowercase_name));
369
370         /* If that didn't work, try the user's personal namespace */
371         if (cdbqr == NULL) {
372                 snprintf(personal_lowercase_name, sizeof personal_lowercase_name, "%010ld.%s", CC->user.usernum, lowercase_name);
373                 cdbqr = cdb_fetch(CDB_ROOMS, personal_lowercase_name, strlen(personal_lowercase_name));
374         }
375         if (cdbqr != NULL) {
376                 memcpy(qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ?  sizeof(struct ctdlroom) : cdbqr->len));
377                 cdb_free(cdbqr);
378                 room_sanity_check(qrbuf);
379                 return (0);
380         }
381         else {
382                 return (1);
383         }
384 }
385
386
387 /*
388  * CtdlGetRoomLock()  -  same as getroom() but locks the record (if supported)
389  */
390 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
391         register int retval;
392         retval = CtdlGetRoom(qrbuf, room_name);
393         if (retval == 0) begin_critical_section(S_ROOMS);
394         return(retval);
395 }
396
397
398 /*
399  * b_putroom()  -  back end to putroom() and b_deleteroom()
400  *              (if the supplied buffer is NULL, delete the room record)
401  */
402 void b_putroom(struct ctdlroom *qrbuf, char *room_name)
403 {
404         char lowercase_name[ROOMNAMELEN];
405         char *aptr, *bptr;
406         long len;
407
408         aptr = room_name;
409         bptr = lowercase_name;
410         while (!IsEmptyStr(aptr)) {
411                 *bptr = tolower(*aptr);
412                 aptr++;
413                 bptr++;
414         }
415         *bptr='\0';
416
417         len = bptr - lowercase_name;
418         if (qrbuf == NULL) {
419                 cdb_delete(CDB_ROOMS, lowercase_name, len);
420         }
421         else {
422                 time(&qrbuf->QRmtime);
423                 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
424         }
425 }
426
427
428 /* 
429  * CtdlPutRoom()  -  store room data to disk
430  */
431 void CtdlPutRoom(struct ctdlroom *qrbuf) {
432         b_putroom(qrbuf, qrbuf->QRname);
433 }
434
435
436 /*
437  * b_deleteroom()  -  delete a room record from disk
438  */
439 void b_deleteroom(char *room_name) {
440         b_putroom(NULL, room_name);
441 }
442
443
444 /*
445  * CtdlPutRoomLock()  -  same as CtdlPutRoom() but unlocks the record (if supported)
446  */
447 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
448         CtdlPutRoom(qrbuf);
449         end_critical_section(S_ROOMS);
450 }
451
452
453 /*
454  * CtdlGetFloorByName()  -  retrieve the number of the named floor
455  * return < 0 if not found else return floor number
456  */
457 int CtdlGetFloorByName(const char *floor_name) {
458         int a;
459         struct floor *flbuf = NULL;
460
461         for (a = 0; a < MAXFLOORS; ++a) {
462                 flbuf = CtdlGetCachedFloor(a);
463
464                 /* check to see if it already exists */
465                 if ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
466                         return a;
467                 }
468         }
469         return -1;
470 }
471
472
473 /*
474  * CtdlGetFloorByNameLock()  -  retrieve floor number for given floor and lock the floor list.
475  */
476 int CtdlGetFloorByNameLock(const char *floor_name)
477 {
478         begin_critical_section(S_FLOORTAB);
479         return CtdlGetFloorByName(floor_name);
480 }
481
482
483 /*
484  * CtdlGetAvailableFloor()  -  Return number of first unused floor
485  * return < 0 if none available
486  */
487 int CtdlGetAvailableFloor(void) {
488         int a;
489         struct floor *flbuf = NULL;
490
491         for (a = 0; a < MAXFLOORS; a++) {
492                 flbuf = CtdlGetCachedFloor(a);
493
494                 /* check to see if it already exists */
495                 if ((flbuf->f_flags & F_INUSE) == 0) {
496                         return a;
497                 }
498         }
499         return -1;
500 }
501
502
503 /*
504  * CtdlGetFloor()  -  retrieve floor data from disk
505  */
506 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
507         struct cdbdata *cdbfl;
508
509         memset(flbuf, 0, sizeof(struct floor));
510         cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
511         if (cdbfl != NULL) {
512                 memcpy(flbuf, cdbfl->ptr, ((cdbfl->len > sizeof(struct floor)) ?  sizeof(struct floor) : cdbfl->len));
513                 cdb_free(cdbfl);
514         } else {
515                 if (floor_num == 0) {
516                         safestrncpy(flbuf->f_name, "Main Floor", sizeof flbuf->f_name);
517                         flbuf->f_flags = F_INUSE;
518                         flbuf->f_ref_count = 3;
519                 }
520         }
521 }
522
523
524 /*
525  * lgetfloor()  -  same as CtdlGetFloor() but locks the record (if supported)
526  */
527 void lgetfloor(struct floor *flbuf, int floor_num) {
528         begin_critical_section(S_FLOORTAB);
529         CtdlGetFloor(flbuf, floor_num);
530 }
531
532
533 /*
534  * CtdlGetCachedFloor()  -  Get floor record from *cache* (loads from disk if needed)
535  *    
536  * This is strictly a performance hack.
537  */
538 struct floor *CtdlGetCachedFloor(int floor_num) {
539         static int initialized = 0;
540         int i;
541         int fetch_new = 0;
542         struct floor *fl = NULL;
543
544         begin_critical_section(S_FLOORCACHE);
545         if (initialized == 0) {
546                 for (i=0; i<MAXFLOORS; ++i) {
547                         floorcache[floor_num] = NULL;
548                 }
549         initialized = 1;
550         }
551         if (floorcache[floor_num] == NULL) {
552                 fetch_new = 1;
553         }
554         end_critical_section(S_FLOORCACHE);
555
556         if (fetch_new) {
557                 fl = malloc(sizeof(struct floor));
558                 CtdlGetFloor(fl, floor_num);
559                 begin_critical_section(S_FLOORCACHE);
560                 if (floorcache[floor_num] != NULL) {
561                         free(floorcache[floor_num]);
562                 }
563                 floorcache[floor_num] = fl;
564                 end_critical_section(S_FLOORCACHE);
565         }
566
567         return(floorcache[floor_num]);
568 }
569
570
571 /*
572  * CtdlPutFloor()  -  store floor data on disk
573  */
574 void CtdlPutFloor(struct floor *flbuf, int floor_num) {
575         /* If we've cached this, clear it out, 'cuz it's WRONG now! */
576         begin_critical_section(S_FLOORCACHE);
577         if (floorcache[floor_num] != NULL) {
578                 free(floorcache[floor_num]);
579                 floorcache[floor_num] = malloc(sizeof(struct floor));
580                 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
581         }
582         end_critical_section(S_FLOORCACHE);
583
584         cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
585                   flbuf, sizeof(struct floor));
586 }
587
588
589 /*
590  * CtdlPutFloorLock()  -  same as CtdlPutFloor() but unlocks the record (if supported)
591  */
592 void CtdlPutFloorLock(struct floor *flbuf, int floor_num) {
593         CtdlPutFloor(flbuf, floor_num);
594         end_critical_section(S_FLOORTAB);
595
596 }
597
598
599 /*
600  * lputfloor()  -  same as CtdlPutFloor() but unlocks the record (if supported)
601  */
602 void lputfloor(struct floor *flbuf, int floor_num) {
603         CtdlPutFloorLock(flbuf, floor_num);
604 }
605
606 /* 
607  * Iterate through the room table, performing a callback for each room.
608  */
609 void CtdlForEachRoom(ForEachRoomCallBack callback_func, void *in_data) {
610         struct ctdlroom qrbuf;
611         struct cdbdata *cdbqr;
612
613         cdb_rewind(CDB_ROOMS);
614
615         while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
616                 memset(&qrbuf, 0, sizeof(struct ctdlroom));
617                 memcpy(&qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ?  sizeof(struct ctdlroom) : cdbqr->len) );
618                 cdb_free(cdbqr);
619                 room_sanity_check(&qrbuf);
620                 if (qrbuf.QRflags & QR_INUSE) {
621                         callback_func(&qrbuf, in_data);
622                 }
623         }
624 }
625
626
627 /*
628  * delete_msglist()  -  delete room message pointers
629  */
630 void delete_msglist(struct ctdlroom *whichroom) {
631         struct cdbdata *cdbml;
632
633         /* Make sure the msglist we're deleting actually exists, otherwise
634          * libdb will complain when we try to delete an invalid record
635          */
636         cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
637         if (cdbml != NULL) {
638                 cdb_free(cdbml);
639
640                 /* Go ahead and delete it */
641                 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
642         }
643 }
644
645
646 /*
647  * Message pointer compare function for sort_msglist()
648  */
649 int sort_msglist_cmp(const void *m1, const void *m2) {
650         if ((*(const long *)m1) > (*(const long *)m2)) return(1);
651         if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
652         return(0);
653 }
654
655
656 /*
657  * sort message pointers
658  * (returns new msg count)
659  */
660 int sort_msglist(long listptrs[], int oldcount) {
661         int numitems;
662         int i = 0;
663
664         numitems = oldcount;
665         if (numitems < 2) {
666                 return (oldcount);
667         }
668
669         /* do the sort */
670         qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp);
671
672         /* and yank any nulls */
673         while ((i < numitems) && (listptrs[i] == 0L)) i++;
674
675         if (i > 0) {
676                 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
677                 numitems-=i;
678         }
679
680         return (numitems);
681 }
682
683
684 /*
685  * Determine whether a given room is non-editable.
686  */
687 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
688
689         /* Mail> rooms are non-editable */
690         if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
691                 return (1);
692         }
693
694         /* Everything else is editable */
695         return (0);
696 }
697
698
699
700 /*
701  * Make the specified room the current room for this session.  No validation
702  * or access control is done here -- the caller should make sure that the
703  * specified room exists and is ok to access.
704  */
705 void CtdlUserGoto(char *where, int display_result, int transiently,
706                 int *retmsgs, int *retnew, long *retoldest, long *retnewest)
707 {
708         int a;
709         int new_messages = 0;
710         int old_messages = 0;
711         int total_messages = 0;
712         long oldest_message = 0;
713         long newest_message = 0;
714         int info = 0;
715         int rmailflag;
716         int raideflag;
717         int newmailcount = 0;
718         visit vbuf;
719         char truncated_roomname[ROOMNAMELEN];
720         struct cdbdata *cdbfr;
721         long *msglist = NULL;
722         int num_msgs = 0;
723         unsigned int original_v_flags;
724         int num_sets;
725         int s;
726         char setstr[128], lostr[64], histr[64];
727         long lo, hi;
728         int is_trash = 0;
729
730         /* If the supplied room name is NULL, the caller wants us to know that
731          * it has already copied the room record into CC->room, so
732          * we can skip the extra database fetch.
733          */
734         if (where != NULL) {
735                 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
736                 CtdlGetRoom(&CC->room, where);
737         }
738
739         /* Take care of all the formalities. */
740
741         begin_critical_section(S_USERS);
742         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
743         original_v_flags = vbuf.v_flags;
744
745         /* Know the room ... but not if it's the page log room, or if the
746          * caller specified that we're only entering this room transiently.
747          */
748         int add_room_to_known_list = 1;
749         if (transiently == 1) {
750                 add_room_to_known_list = 0;
751         }
752         char *c_logpages = CtdlGetConfigStr("c_logpages");
753         if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
754                 add_room_to_known_list = 0;
755         }
756         if (add_room_to_known_list) {
757                 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
758                 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
759         }
760         
761         /* Only rewrite the database record if we changed something */
762         if (vbuf.v_flags != original_v_flags) {
763                 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
764         }
765         end_critical_section(S_USERS);
766
767         /* Check for new mail */
768         newmailcount = NewMailCount();
769
770         /* Set info to 1 if the room banner is new since our last visit.
771          * Some clients only want to display it when it changes.
772          */
773         if (CC->room.msgnum_info > vbuf.v_lastseen) {
774                 info = 1;
775         }
776
777         cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
778         if (cdbfr != NULL) {
779                 msglist = (long *) cdbfr->ptr;
780                 cdbfr->ptr = NULL;      /* CtdlUserGoto() now owns this memory */
781                 num_msgs = cdbfr->len / sizeof(long);
782                 cdb_free(cdbfr);
783         }
784
785         total_messages = 0;
786         for (a=0; a<num_msgs; ++a) {
787                 if (msglist[a] > 0L) ++total_messages;
788         }
789
790         if (total_messages > 0) {
791                 oldest_message = msglist[0];
792                 newest_message = msglist[num_msgs - 1];
793         }
794
795         num_sets = num_tokens(vbuf.v_seen, ',');
796         for (s=0; s<num_sets; ++s) {
797                 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
798
799                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
800                 if (num_tokens(setstr, ':') >= 2) {
801                         extract_token(histr, setstr, 1, ':', sizeof histr);
802                         if (!strcmp(histr, "*")) {
803                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
804                         }
805                 } 
806                 else {
807                         strcpy(histr, lostr);
808                 }
809                 lo = atol(lostr);
810                 hi = atol(histr);
811
812                 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
813                         if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
814                                 ++old_messages;
815                                 msglist[a] = 0L;
816                         }
817                 }
818         }
819         new_messages = total_messages - old_messages;
820
821         if (msglist != NULL) free(msglist);
822
823         if (CC->room.QRflags & QR_MAILBOX)
824                 rmailflag = 1;
825         else
826                 rmailflag = 0;
827
828         if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
829                 raideflag = 1;
830         else
831                 raideflag = 0;
832
833         safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
834         if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
835                 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
836         }
837
838         if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
839                 is_trash = 1;
840         }
841
842         if (retmsgs != NULL) *retmsgs = total_messages;
843         if (retnew != NULL) *retnew = new_messages;
844         if (retoldest != NULL) *retoldest = oldest_message;
845         if (retnewest != NULL) *retnewest = newest_message;
846         syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
847                    CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
848         );
849
850         CC->curr_view = (int)vbuf.v_view;
851
852         if (display_result) {
853                 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
854                         CIT_OK, CtdlCheckExpress(),
855                         truncated_roomname,
856                         (int)new_messages,
857                         (int)total_messages,
858                         (int)info,
859                         (int)CC->room.QRflags,
860                         (long)CC->room.QRhighest,
861                         (long)vbuf.v_lastseen,
862                         (int)rmailflag,
863                         (int)raideflag,
864                         (int)newmailcount,
865                         (int)CC->room.QRfloor,
866                         (int)vbuf.v_view,
867                         (int)CC->room.QRdefaultview,
868                         (int)is_trash,
869                         (int)CC->room.QRflags2,
870                         (long)CC->room.QRmtime
871                 );
872         }
873 }
874
875
876 /*
877  * Handle some of the macro named rooms
878  */
879 void convert_room_name_macros(char *towhere, size_t maxlen) {
880         if (!strcasecmp(towhere, "_BASEROOM_")) {
881                 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
882         }
883         else if (!strcasecmp(towhere, "_MAIL_")) {
884                 safestrncpy(towhere, MAILROOM, maxlen);
885         }
886         else if (!strcasecmp(towhere, "_TRASH_")) {
887                 safestrncpy(towhere, USERTRASHROOM, maxlen);
888         }
889         else if (!strcasecmp(towhere, "_DRAFTS_")) {
890                 safestrncpy(towhere, USERDRAFTROOM, maxlen);
891         }
892         else if (!strcasecmp(towhere, "_BITBUCKET_")) {
893                 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
894         }
895         else if (!strcasecmp(towhere, "_CALENDAR_")) {
896                 safestrncpy(towhere, USERCALENDARROOM, maxlen);
897         }
898         else if (!strcasecmp(towhere, "_TASKS_")) {
899                 safestrncpy(towhere, USERTASKSROOM, maxlen);
900         }
901         else if (!strcasecmp(towhere, "_CONTACTS_")) {
902                 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
903         }
904         else if (!strcasecmp(towhere, "_NOTES_")) {
905                 safestrncpy(towhere, USERNOTESROOM, maxlen);
906         }
907 }
908
909
910 /*
911  * Back end function to rename a room.
912  * You can also specify which floor to move the room to, or specify -1 to
913  * keep the room on the same floor it was on.
914  *
915  * If you are renaming a mailbox room, you must supply the namespace prefix
916  * in *at least* the old name!
917  */
918 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
919         int old_floor = 0;
920         struct ctdlroom qrbuf;
921         struct ctdlroom qrtmp;
922         int ret = 0;
923         struct floor *fl;
924         struct floor flbuf;
925         long owner = 0L;
926         char actual_old_name[ROOMNAMELEN];
927
928         syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
929
930         if (new_floor >= 0) {
931                 fl = CtdlGetCachedFloor(new_floor);
932                 if ((fl->f_flags & F_INUSE) == 0) {
933                         return(crr_invalid_floor);
934                 }
935         }
936
937         begin_critical_section(S_ROOMS);
938
939         if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
940                 ret = crr_already_exists;
941         }
942
943         else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
944                 ret = crr_room_not_found;
945         }
946
947         else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
948                   && (CC->user.usernum != qrbuf.QRroomaide)
949                   && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) )  {
950                 ret = crr_access_denied;
951         }
952
953         else if (CtdlIsNonEditable(&qrbuf)) {
954                 ret = crr_noneditable;
955         }
956
957         else {
958                 /* Rename it */
959                 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
960                 if (qrbuf.QRflags & QR_MAILBOX) {
961                         owner = atol(qrbuf.QRname);
962                 }
963                 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
964                         snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
965                                         "%010ld.%s", owner, new_name);
966                 }
967                 else {
968                         safestrncpy(qrbuf.QRname, new_name,
969                                                 sizeof(qrbuf.QRname));
970                 }
971
972                 /* Reject change of floor for baseroom/aideroom */
973                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
974                     !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
975                 {
976                         new_floor = 0;
977                 }
978
979                 /* Take care of floor stuff */
980                 old_floor = qrbuf.QRfloor;
981                 if (new_floor < 0) {
982                         new_floor = old_floor;
983                 }
984                 qrbuf.QRfloor = new_floor;
985                 CtdlPutRoom(&qrbuf);
986
987                 begin_critical_section(S_CONFIG);
988         
989                 /* If baseroom/aideroom name changes, update config */
990                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
991                         CtdlSetConfigStr("c_baseroom", new_name);
992                 }
993                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
994                         CtdlSetConfigStr("c_aideroom", new_name);
995                 }
996         
997                 end_critical_section(S_CONFIG);
998         
999                 /* If the room name changed, then there are now two room
1000                  * records, so we have to delete the old one.
1001                  */
1002                 if (strcasecmp(new_name, old_name)) {
1003                         b_deleteroom(actual_old_name);
1004                 }
1005
1006                 ret = crr_ok;
1007         }
1008
1009         end_critical_section(S_ROOMS);
1010
1011         /* Adjust the floor reference counts if necessary */
1012         if (new_floor != old_floor) {
1013                 lgetfloor(&flbuf, old_floor);
1014                 --flbuf.f_ref_count;
1015                 lputfloor(&flbuf, old_floor);
1016                 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
1017                 lgetfloor(&flbuf, new_floor);
1018                 ++flbuf.f_ref_count;
1019                 lputfloor(&flbuf, new_floor);
1020                 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
1021         }
1022
1023         /* ...and everybody say "YATTA!" */     
1024         return(ret);
1025 }
1026
1027
1028 /*
1029  * Asynchronously schedule a room for deletion.  By placing the room into an invalid private namespace,
1030  * the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
1031  * database operations to complete.  Instead, the room gets purged when THE DREADED AUTO-PURGER makes
1032  * its next run.  Aren't we so clever?!!
1033  */
1034 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
1035         char old_name[ROOMNAMELEN];
1036         static int seq = 0;
1037
1038         syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
1039
1040         safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
1041         CtdlGetRoom(qrbuf, qrbuf->QRname);
1042
1043         /* Turn the room into a private mailbox owned by a user who doesn't
1044          * exist.  This will immediately make the room invisible to everyone,
1045          * and qualify the room for purging.
1046          */
1047         snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
1048                 time(NULL),
1049                 ++seq,
1050                 old_name
1051         );
1052         qrbuf->QRflags |= QR_MAILBOX;
1053         time(&qrbuf->QRgen);    /* Use a timestamp as the new generation number  */
1054         CtdlPutRoom(qrbuf);
1055         b_deleteroom(old_name);
1056 }
1057
1058
1059 /*
1060  * Back end processing to delete a room and everything associated with it
1061  * (This one is synchronous and should only get called by THE DREADED
1062  * AUTO-PURGER in serv_expire.c.  All user-facing code should call
1063  * the asynchronous schedule_room_for_deletion() instead.)
1064  */
1065 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
1066         struct floor flbuf;
1067         char configdbkeyname[25];
1068
1069         syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
1070
1071         /* Delete the room's network configdb entry */
1072         netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
1073         CtdlDelConfig(configdbkeyname);
1074
1075         /* Delete the messages in the room
1076          * (Careful: this opens an S_ROOMS critical section!)
1077          */
1078         CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
1079
1080         /* Flag the room record as not in use */
1081         CtdlGetRoomLock(qrbuf, qrbuf->QRname);
1082         qrbuf->QRflags = 0;
1083         CtdlPutRoomLock(qrbuf);
1084
1085         /* then decrement the reference count for the floor */
1086         lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
1087         flbuf.f_ref_count = flbuf.f_ref_count - 1;
1088         lputfloor(&flbuf, (int) (qrbuf->QRfloor));
1089
1090         /* Delete the room record from the database! */
1091         b_deleteroom(qrbuf->QRname);
1092 }
1093
1094
1095 /*
1096  * Check access control for deleting a room
1097  */
1098 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
1099
1100         if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
1101                 return(0);
1102         }
1103
1104         if (CtdlIsNonEditable(qr)) {
1105                 return(0);
1106         }
1107
1108         /*
1109          * For mailboxes, check stuff
1110          */
1111         if (qr->QRflags & QR_MAILBOX) {
1112
1113                 if (strlen(qr->QRname) < 12) return(0); /* bad name */
1114
1115                 if (atol(qr->QRname) != CC->user.usernum) {
1116                         return(0);      /* not my room */
1117                 }
1118
1119                 /* Can't delete your Mail> room */
1120                 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1121
1122                 /* Otherwise it's ok */
1123                 return(1);
1124         }
1125
1126         /*
1127          * For normal rooms, just check for admin or room admin status.
1128          */
1129         return(is_room_aide());
1130 }
1131
1132
1133 /*
1134  * Internal code to create a new room (returns room flags)
1135  *
1136  * Room types:  0=public, 1=hidden, 2=passworded, 3=invitation-only,
1137  *              4=mailbox, 5=mailbox, but caller supplies namespace
1138  */
1139 unsigned CtdlCreateRoom(char *new_room_name,
1140                      int new_room_type,
1141                      char *new_room_pass,
1142                      int new_room_floor,
1143                      int really_create,
1144                      int avoid_access,
1145                      int new_room_view)
1146 {
1147         struct ctdlroom qrbuf;
1148         struct floor flbuf;
1149         visit vbuf;
1150
1151         syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1152
1153         if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1154                 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1155                 return(0);
1156         }
1157
1158         memset(&qrbuf, 0, sizeof(struct ctdlroom));
1159         safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1160         qrbuf.QRflags = QR_INUSE;
1161         if (new_room_type > 0)
1162                 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1163         if (new_room_type == 1)
1164                 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1165         if (new_room_type == 2)
1166                 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1167         if ( (new_room_type == 4) || (new_room_type == 5) ) {
1168                 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1169                 /* qrbuf.QRflags2 |= QR2_SUBJECTREQ; */
1170         }
1171
1172         /* If the user is requesting a personal room, set up the room
1173          * name accordingly (prepend the user number)
1174          */
1175         if (new_room_type == 4) {
1176                 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1177         }
1178         else {
1179                 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1180         }
1181
1182         /* If the room is private, and the system administrator has elected
1183          * to automatically grant room admin privileges, do so now.
1184          */
1185         if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1186                 qrbuf.QRroomaide = CC->user.usernum;
1187         }
1188         /* Blog owners automatically become room admins of their blogs.
1189          * (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1190          */
1191         else if (new_room_view == VIEW_BLOG) {
1192                 qrbuf.QRroomaide = CC->user.usernum;
1193         }
1194         /* Otherwise, set the room admin to undefined.
1195          */
1196         else {
1197                 qrbuf.QRroomaide = (-1L);
1198         }
1199
1200         /* 
1201          * If the caller is only interested in testing whether this will work,
1202          * return now without creating the room.
1203          */
1204         if (!really_create) return (qrbuf.QRflags);
1205
1206         qrbuf.QRnumber = get_new_room_number();
1207         qrbuf.QRhighest = 0L;   /* No messages in this room yet */
1208         time(&qrbuf.QRgen);     /* Use a timestamp as the generation number */
1209         qrbuf.QRfloor = new_room_floor;
1210         qrbuf.QRdefaultview = new_room_view;
1211
1212         /* save what we just did... */
1213         CtdlPutRoom(&qrbuf);
1214
1215         /* bump the reference count on whatever floor the room is on */
1216         lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1217         flbuf.f_ref_count = flbuf.f_ref_count + 1;
1218         lputfloor(&flbuf, (int) qrbuf.QRfloor);
1219
1220         /* Grant the creator access to the room unless the avoid_access
1221          * parameter was specified.
1222          */
1223         if ( (CC->logged_in) && (avoid_access == 0) ) {
1224                 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1225                 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1226                 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1227                 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1228         }
1229
1230         /* resume our happy day */
1231         return (qrbuf.QRflags);
1232 }