1 // Server functions which perform operations on room objects.
3 // Copyright (c) 1987-2023 by the citadel.org team
5 // This program is open source software; you can redistribute it and/or modify
6 // it under the terms of the GNU General Public License, version 3.
9 #include <libcitadel.h>
11 #include "citserver.h"
12 #include "ctdl_module.h"
18 struct floor *floorcache[MAXFLOORS];
20 // Determine whether the currently logged in session has permission to read
21 // messages in the current room.
22 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void) {
23 if ( (!(CC->logged_in))
24 && (!(CC->internal_pgm))
25 && (!CtdlGetConfigInt("c_guest_logins"))
27 return(om_not_logged_in);
33 // Check to see whether we have permission to post a message in the current
34 // room. Returns a *CITADEL ERROR CODE* and puts a message in errmsgbuf, or
35 // returns 0 on success.
36 int CtdlDoIHavePermissionToPostInThisRoom(char *errmsgbuf, size_t n, PostType PostPublic, int is_reply) {
39 if (!(CC->logged_in) && (PostPublic == POST_LOGGED_IN)) {
40 snprintf(errmsgbuf, n, "Not logged in.");
41 return (ERROR + NOT_LOGGED_IN);
43 else if (PostPublic == CHECK_EXIST) {
44 return (0); // evaluate whether a recipient exists
46 else if (!(CC->logged_in)) {
47 if ((CC->room.QRflags & QR_READONLY)) {
48 snprintf(errmsgbuf, n, "Not logged in.");
49 return (ERROR + NOT_LOGGED_IN);
54 if ((CC->user.axlevel < AxProbU) && ((CC->room.QRflags & QR_MAILBOX) == 0)) {
55 snprintf(errmsgbuf, n, "Need to be validated to enter (except in %s> to sysop)", MAILROOM);
56 return (ERROR + HIGHER_ACCESS_REQUIRED);
59 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
61 if (ra & UA_POSTALLOWED) {
62 strcpy(errmsgbuf, "OK to post or reply here");
66 if ( (ra & UA_REPLYALLOWED) && (is_reply) ) {
67 // To be thorough, we ought to check to see if the message they are
68 // replying to is actually a valid one in this room, but unless this
69 // actually becomes a problem we'll go with high performance instead.
70 strcpy(errmsgbuf, "OK to reply here");
74 if ( (ra & UA_REPLYALLOWED) && (!is_reply) ) {
75 // Clarify what happened with a better error message
76 snprintf(errmsgbuf, n, "You may only reply to existing messages here.");
77 return (ERROR + HIGHER_ACCESS_REQUIRED);
80 snprintf(errmsgbuf, n, "Higher access is required to post in this room.");
81 return (ERROR + HIGHER_ACCESS_REQUIRED);
86 // Check whether the current user has permission to delete messages from
87 // the current room (returns 1 for yes, 0 for no)
88 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void) {
90 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
91 if (ra & UA_DELETEALLOWED) return(1);
96 // This is the main access control function for any user/room pair.
97 // Yes, it has a couple of gotos. If you don't like that, go die in a car fire.
98 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view) {
104 if (userbuf == &CC->user) {
108 if ((is_me) && (CtdlGetConfigInt("c_guest_logins")) && (!CC->logged_in)) {
112 // for internal programs, always do everything
113 if (((CC->internal_pgm)) && (roombuf->QRflags & QR_INUSE)) {
114 retval = (UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED);
116 goto SKIP_EVERYTHING;
119 // If guest mode is enabled, always grant access to the Lobby
120 if ((is_guest) && (!strcasecmp(roombuf->QRname, BASEROOM))) {
121 retval = (UA_KNOWN | UA_GOTOALLOWED);
123 goto SKIP_EVERYTHING;
126 // Locate any applicable user/room relationships
128 memset(&vbuf, 0, sizeof vbuf);
131 CtdlGetRelationship(&vbuf, userbuf, roombuf);
134 // Force the properties of the Aide room
135 if (!strcasecmp(roombuf->QRname, CtdlGetConfigStr("c_aideroom"))) {
136 if (userbuf->axlevel >= AxAideU) {
137 retval = UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
145 // If this is a public room, it's accessible...
146 if ( ((roombuf->QRflags & QR_PRIVATE) == 0)
147 && ((roombuf->QRflags & QR_MAILBOX) == 0)
149 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
152 // If this is a preferred users only room, check access level
153 if (roombuf->QRflags & QR_PREFONLY) {
154 if (userbuf->axlevel < AxPrefU) {
155 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED;
159 // For private rooms, check the generation number matchups
160 if ( (roombuf->QRflags & QR_PRIVATE)
161 && ((roombuf->QRflags & QR_MAILBOX) == 0)
164 // An explicit match means the user belongs in this room
165 if (vbuf.v_flags & V_ACCESS) {
166 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
168 // Otherwise, check if this is a guess-name or passworded
169 // room. If it is, a goto may at least be attempted
170 else if ( (roombuf->QRflags & QR_PRIVATE)
171 || (roombuf->QRflags & QR_PASSWORDED)
173 retval = retval & ~UA_KNOWN;
174 retval = retval | UA_GOTOALLOWED;
178 // For mailbox rooms, also check the namespace. Also, mailbox owners can delete their messages
179 if ( (roombuf->QRflags & QR_MAILBOX) && (atol(roombuf->QRname) != 0)) {
180 if (userbuf->usernum == atol(roombuf->QRname)) {
181 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
183 // An explicit match means the user belongs in this room
184 if (vbuf.v_flags & V_ACCESS) {
185 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
189 // For non-mailbox rooms...
191 // User is allowed to post in the room unless:
192 // - User is not validated
193 // - It is a read-only room
194 // - It is a blog room (in which case we only allow replies to existing messages)
195 int post_allowed = 1;
196 int reply_allowed = 1;
197 if (userbuf->axlevel < AxProbU) {
201 if (roombuf->QRflags & QR_READONLY) {
205 if (roombuf->QRdefaultview == VIEW_BLOG) {
209 retval = retval | UA_POSTALLOWED | UA_REPLYALLOWED;
212 retval = retval | UA_REPLYALLOWED;
215 // If "collaborative deletion" is active for this room, any user who can post
216 // is also allowed to delete
217 if (roombuf->QRflags2 & QR2_COLLABDEL) {
218 if (retval & UA_POSTALLOWED) {
219 retval = retval | UA_DELETEALLOWED;
225 // Check to see if the user has forgotten this room
226 if (vbuf.v_flags & V_FORGET) {
227 retval = retval & ~UA_KNOWN;
228 if ( ( ((roombuf->QRflags & QR_PRIVATE) == 0)
229 && ((roombuf->QRflags & QR_MAILBOX) == 0)
230 ) || ( (roombuf->QRflags & QR_MAILBOX)
231 && (atol(roombuf->QRname) == CC->user.usernum))
233 retval = retval | UA_ZAPPED;
237 // If user is explicitly locked out of this room, deny everything
238 if (vbuf.v_flags & V_LOCKOUT) {
239 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED & ~UA_POSTALLOWED & ~UA_REPLYALLOWED;
242 // Aides get access to all private rooms
243 if ( (userbuf->axlevel >= AxAideU)
244 && ((roombuf->QRflags & QR_MAILBOX) == 0)
246 if (vbuf.v_flags & V_FORGET) {
247 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
250 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
254 // Aides can gain access to mailboxes as well, but they don't show by default.
255 if ( (userbuf->axlevel >= AxAideU)
256 && (roombuf->QRflags & QR_MAILBOX)
258 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
261 // Aides and Room Aides have admin privileges
262 if ( (userbuf->axlevel >= AxAideU)
263 || (userbuf->usernum == roombuf->QRroomaide)
265 retval = retval | UA_ADMINALLOWED | UA_DELETEALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
268 NEWMSG: // By the way, we also check for the presence of new messages
269 if (is_msg_in_sequence_set(vbuf.v_seen, roombuf->QRhighest) == 0) {
270 retval = retval | UA_HASNEWMSGS;
273 // System rooms never show up in the list.
274 if (roombuf->QRflags2 & QR2_SYSTEM) {
275 retval = retval & ~UA_KNOWN;
279 // Now give the caller the information it wants.
280 if (result != NULL) *result = retval;
281 if (view != NULL) *view = vbuf.v_view;
285 // Self-checking stuff for a room record read into memory
286 void room_sanity_check(struct ctdlroom *qrbuf) {
287 // Mailbox rooms are always on the lowest floor
288 if (qrbuf->QRflags & QR_MAILBOX) {
291 // Listing order of 0 is illegal except for base rooms
292 if (qrbuf->QRorder == 0) {
293 if ( !(qrbuf->QRflags & QR_MAILBOX)
294 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)
295 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)
303 // CtdlGetRoom() - retrieve room data from disk
304 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name) {
305 struct cdbdata *cdbqr;
306 char lowercase_name[ROOMNAMELEN];
307 char personal_lowercase_name[ROOMNAMELEN];
310 len = strlen(room_name);
311 for (int i=0; i<=len; ++i) {
312 lowercase_name[i] = tolower(room_name[i]);
315 memset(qrbuf, 0, sizeof(struct ctdlroom));
317 if (IsEmptyStr(lowercase_name)) {
318 return(1); // empty room name , not valid
321 // First, try the public namespace
322 cdbqr = cdb_fetch(CDB_ROOMS, lowercase_name, strlen(lowercase_name));
324 // If that didn't work, try the user's personal namespace
326 snprintf(personal_lowercase_name, sizeof personal_lowercase_name, "%010ld.%s", CC->user.usernum, lowercase_name);
327 cdbqr = cdb_fetch(CDB_ROOMS, personal_lowercase_name, strlen(personal_lowercase_name));
330 memcpy(qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len));
332 room_sanity_check(qrbuf);
341 // CtdlGetRoomLock() - same as getroom() but locks the record (if supported)
342 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
344 retval = CtdlGetRoom(qrbuf, room_name);
345 if (retval == 0) begin_critical_section(S_ROOMS);
350 // b_putroom() - back end to putroom() and b_deleteroom()
351 // (if the supplied buffer is NULL, delete the room record)
352 void b_putroom(struct ctdlroom *qrbuf, char *room_name) {
353 char lowercase_name[ROOMNAMELEN];
356 len = strlen(room_name);
357 for (int i=0; i<=len; ++i) {
358 lowercase_name[i] = tolower(room_name[i]);
362 cdb_delete(CDB_ROOMS, lowercase_name, len);
365 time(&qrbuf->QRmtime);
366 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
371 // CtdlPutRoom() - store room data to disk
372 void CtdlPutRoom(struct ctdlroom *qrbuf) {
373 b_putroom(qrbuf, qrbuf->QRname);
377 // b_deleteroom() - delete a room record from disk
378 void b_deleteroom(char *room_name) {
379 b_putroom(NULL, room_name);
383 // CtdlPutRoomLock() - same as CtdlPutRoom() but unlocks the record (if supported)
384 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
386 end_critical_section(S_ROOMS);
390 // CtdlGetFloorByName() - retrieve the number of the named floor
391 // return < 0 if not found else return floor number
392 int CtdlGetFloorByName(const char *floor_name) {
394 struct floor *flbuf = NULL;
396 for (a = 0; a < MAXFLOORS; ++a) {
397 flbuf = CtdlGetCachedFloor(a);
399 // check to see if it already exists
400 if ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
408 // CtdlGetFloorByNameLock() - retrieve floor number for given floor and lock the floor list.
409 int CtdlGetFloorByNameLock(const char *floor_name) {
410 begin_critical_section(S_FLOORTAB);
411 return CtdlGetFloorByName(floor_name);
415 // CtdlGetAvailableFloor() - Return number of first unused floor
416 // return < 0 if none available
417 int CtdlGetAvailableFloor(void) {
419 struct floor *flbuf = NULL;
421 for (a = 0; a < MAXFLOORS; a++) {
422 flbuf = CtdlGetCachedFloor(a);
424 // check to see if it already exists
425 if ((flbuf->f_flags & F_INUSE) == 0) {
433 // CtdlGetFloor() - retrieve floor data from disk
434 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
435 struct cdbdata *cdbfl;
437 memset(flbuf, 0, sizeof(struct floor));
438 cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
440 memcpy(flbuf, cdbfl->ptr, ((cdbfl->len > sizeof(struct floor)) ? sizeof(struct floor) : cdbfl->len));
444 if (floor_num == 0) {
445 safestrncpy(flbuf->f_name, "Main Floor", sizeof flbuf->f_name);
446 flbuf->f_flags = F_INUSE;
447 flbuf->f_ref_count = 3;
453 // lgetfloor() - same as CtdlGetFloor() but locks the record (if supported)
454 void lgetfloor(struct floor *flbuf, int floor_num) {
455 begin_critical_section(S_FLOORTAB);
456 CtdlGetFloor(flbuf, floor_num);
460 // CtdlGetCachedFloor() - Get floor record from *cache* (loads from disk if needed)
461 // This is strictly a performance hack.
462 struct floor *CtdlGetCachedFloor(int floor_num) {
463 static int initialized = 0;
466 struct floor *fl = NULL;
468 begin_critical_section(S_FLOORCACHE);
469 if (initialized == 0) {
470 for (i=0; i<MAXFLOORS; ++i) {
471 floorcache[floor_num] = NULL;
475 if (floorcache[floor_num] == NULL) {
478 end_critical_section(S_FLOORCACHE);
481 fl = malloc(sizeof(struct floor));
482 CtdlGetFloor(fl, floor_num);
483 begin_critical_section(S_FLOORCACHE);
484 if (floorcache[floor_num] != NULL) {
485 free(floorcache[floor_num]);
487 floorcache[floor_num] = fl;
488 end_critical_section(S_FLOORCACHE);
491 return(floorcache[floor_num]);
495 // CtdlPutFloor() - store floor data on disk
496 void CtdlPutFloor(struct floor *flbuf, int floor_num) {
497 // If we've cached this, clear it out, 'cuz it's WRONG now!
498 begin_critical_section(S_FLOORCACHE);
499 if (floorcache[floor_num] != NULL) {
500 free(floorcache[floor_num]);
501 floorcache[floor_num] = malloc(sizeof(struct floor));
502 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
504 end_critical_section(S_FLOORCACHE);
506 cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
507 flbuf, sizeof(struct floor));
511 // CtdlPutFloorLock() - same as CtdlPutFloor() but unlocks the record (if supported)
512 void CtdlPutFloorLock(struct floor *flbuf, int floor_num) {
513 CtdlPutFloor(flbuf, floor_num);
514 end_critical_section(S_FLOORTAB);
519 // lputfloor() - same as CtdlPutFloor() but unlocks the record (if supported)
520 void lputfloor(struct floor *flbuf, int floor_num) {
521 CtdlPutFloorLock(flbuf, floor_num);
525 // Iterate through the room table, performing a callback for each room.
526 void CtdlForEachRoom(ForEachRoomCallBack callback_func, void *in_data) {
527 struct ctdlroom qrbuf;
528 struct cdbdata *cdbqr;
530 cdb_rewind(CDB_ROOMS);
532 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
533 memset(&qrbuf, 0, sizeof(struct ctdlroom));
534 memcpy(&qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len) );
536 room_sanity_check(&qrbuf);
537 if (qrbuf.QRflags & QR_INUSE) {
538 callback_func(&qrbuf, in_data);
544 // delete_msglist() - delete room message pointers
545 void delete_msglist(struct ctdlroom *whichroom) {
546 struct cdbdata *cdbml;
548 // Make sure the msglist we're deleting actually exists, otherwise
549 // libdb will complain when we try to delete an invalid record
550 cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
554 // Go ahead and delete it
555 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
560 // Message pointer compare function for sort_msglist()
561 int sort_msglist_cmp(const void *m1, const void *m2) {
562 if ((*(const long *)m1) > (*(const long *)m2)) return(1);
563 if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
568 // sort message pointers
569 // (returns new msg count)
570 int sort_msglist(long listptrs[], int oldcount) {
575 if (numitems < 2) { // an empty or 1-item list needs no sorting
579 qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp); // do the sort
581 while ((i < numitems) && (listptrs[i] == 0L)) i++; // yank out any nulls
583 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
591 // Determine whether a given room is non-editable.
592 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
594 // The inbox cannot be edited
595 if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
599 // Everything else is editable
604 // Make the specified room the current room for this session. No validation
605 // or access control is done here -- the caller should make sure that the
606 // specified room exists and is ok to access.
607 void CtdlUserGoto(char *where, int display_result, int transiently, int *retmsgs, int *retnew, long *retoldest, long *retnewest) {
609 int new_messages = 0;
610 int old_messages = 0;
611 int total_messages = 0;
612 long oldest_message = 0;
613 long newest_message = 0;
618 char truncated_roomname[ROOMNAMELEN];
619 struct cdbdata *cdbfr;
620 long *msglist = NULL;
622 unsigned int original_v_flags;
625 char setstr[128], lostr[64], histr[64];
629 // If the supplied room name is NULL, the caller wants us to know that
630 // it has already copied the room record into CC->room, so
631 // we can skip the extra database fetch.
633 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
634 CtdlGetRoom(&CC->room, where);
637 // Take care of all the formalities.
639 begin_critical_section(S_USERS);
640 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
641 original_v_flags = vbuf.v_flags;
643 // Know the room ... but not if it's the page log room, or if the
644 // caller specified that we're only entering this room transiently.
645 int add_room_to_known_list = 1;
646 if (transiently == 1) {
647 add_room_to_known_list = 0;
649 char *c_logpages = CtdlGetConfigStr("c_logpages");
650 if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
651 add_room_to_known_list = 0;
653 if (add_room_to_known_list) {
654 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
655 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
658 // Only rewrite the database record if we changed something
659 if (vbuf.v_flags != original_v_flags) {
660 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
662 end_critical_section(S_USERS);
664 // Set info to 1 if the room banner is new since our last visit.
665 // Some clients only want to display it when it changes.
666 if (CC->room.msgnum_info > vbuf.v_lastseen) {
670 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
672 msglist = (long *) cdbfr->ptr;
673 cdbfr->ptr = NULL; // CtdlUserGoto() now owns this memory (this requires attention if we move to LMDB)
674 num_msgs = cdbfr->len / sizeof(long);
679 for (a=0; a<num_msgs; ++a) {
680 if (msglist[a] > 0L) ++total_messages;
683 if (total_messages > 0) {
684 oldest_message = msglist[0];
685 newest_message = msglist[num_msgs - 1];
688 num_sets = num_tokens(vbuf.v_seen, ',');
689 for (s=0; s<num_sets; ++s) {
690 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
692 extract_token(lostr, setstr, 0, ':', sizeof lostr);
693 if (num_tokens(setstr, ':') >= 2) {
694 extract_token(histr, setstr, 1, ':', sizeof histr);
695 if (!strcmp(histr, "*")) {
696 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
700 strcpy(histr, lostr);
705 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
706 if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
712 new_messages = total_messages - old_messages;
714 if (msglist != NULL) free(msglist);
716 if (CC->room.QRflags & QR_MAILBOX)
721 if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
726 safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
727 if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
728 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
731 if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
735 if (retmsgs != NULL) *retmsgs = total_messages;
736 if (retnew != NULL) *retnew = new_messages;
737 if (retoldest != NULL) *retoldest = oldest_message;
738 if (retnewest != NULL) *retnewest = newest_message;
739 syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
740 CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
743 CC->curr_view = (int)vbuf.v_view;
745 if (display_result) {
746 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
747 CIT_OK, CtdlCheckExpress(),
752 (int)CC->room.QRflags,
753 (long)CC->room.QRhighest,
754 (long)vbuf.v_lastseen,
757 0, // new mail is no longer counted here
758 (int)CC->room.QRfloor,
760 (int)CC->room.QRdefaultview,
762 (int)CC->room.QRflags2,
763 (long)CC->room.QRmtime
769 // Handle some of the macro named rooms
770 void convert_room_name_macros(char *towhere, size_t maxlen) {
771 if (!strcasecmp(towhere, "_BASEROOM_")) {
772 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
774 else if (!strcasecmp(towhere, "_MAIL_")) {
775 safestrncpy(towhere, MAILROOM, maxlen);
777 else if (!strcasecmp(towhere, "_TRASH_")) {
778 safestrncpy(towhere, USERTRASHROOM, maxlen);
780 else if (!strcasecmp(towhere, "_DRAFTS_")) {
781 safestrncpy(towhere, USERDRAFTROOM, maxlen);
783 else if (!strcasecmp(towhere, "_BITBUCKET_")) {
784 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
786 else if (!strcasecmp(towhere, "_CALENDAR_")) {
787 safestrncpy(towhere, USERCALENDARROOM, maxlen);
789 else if (!strcasecmp(towhere, "_TASKS_")) {
790 safestrncpy(towhere, USERTASKSROOM, maxlen);
792 else if (!strcasecmp(towhere, "_CONTACTS_")) {
793 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
795 else if (!strcasecmp(towhere, "_NOTES_")) {
796 safestrncpy(towhere, USERNOTESROOM, maxlen);
801 // Back end function to rename a room.
802 // You can also specify which floor to move the room to, or specify -1 to
803 // keep the room on the same floor it was on.
805 // If you are renaming a mailbox room, you must supply the namespace prefix
806 // in *at least* the old name!
807 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
809 struct ctdlroom qrbuf;
810 struct ctdlroom qrtmp;
815 char actual_old_name[ROOMNAMELEN];
817 syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
819 if (new_floor >= 0) {
820 fl = CtdlGetCachedFloor(new_floor);
821 if ((fl->f_flags & F_INUSE) == 0) {
822 return(crr_invalid_floor);
826 begin_critical_section(S_ROOMS);
828 if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
829 ret = crr_already_exists;
832 else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
833 ret = crr_room_not_found;
836 else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
837 && (CC->user.usernum != qrbuf.QRroomaide)
838 && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) ) {
839 ret = crr_access_denied;
842 else if (CtdlIsNonEditable(&qrbuf)) {
843 ret = crr_noneditable;
848 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
849 if (qrbuf.QRflags & QR_MAILBOX) {
850 owner = atol(qrbuf.QRname);
852 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
853 snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
854 "%010ld.%s", owner, new_name);
857 safestrncpy(qrbuf.QRname, new_name,
858 sizeof(qrbuf.QRname));
861 // Reject change of floor for baseroom/aideroom
862 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
863 !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
868 // Take care of floor stuff
869 old_floor = qrbuf.QRfloor;
871 new_floor = old_floor;
873 qrbuf.QRfloor = new_floor;
876 begin_critical_section(S_CONFIG);
878 // If baseroom/aideroom name changes, update config
879 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
880 CtdlSetConfigStr("c_baseroom", new_name);
882 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
883 CtdlSetConfigStr("c_aideroom", new_name);
886 end_critical_section(S_CONFIG);
888 // If the room name changed, then there are now two room
889 // records, so we have to delete the old one.
890 if (strcasecmp(new_name, old_name)) {
891 b_deleteroom(actual_old_name);
897 end_critical_section(S_ROOMS);
899 // Adjust the floor reference counts if necessary
900 if (new_floor != old_floor) {
901 lgetfloor(&flbuf, old_floor);
903 lputfloor(&flbuf, old_floor);
904 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
905 lgetfloor(&flbuf, new_floor);
907 lputfloor(&flbuf, new_floor);
908 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
911 // ...and everybody say "YATTA!"
916 // Asynchronously schedule a room for deletion. By placing the room into an invalid private namespace,
917 // the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
918 // database operations to complete. Instead, the room gets purged when THE DREADED AUTO-PURGER makes
919 // its next run. Aren't we so clever?!!
920 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
921 char old_name[ROOMNAMELEN];
924 syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
926 safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
927 CtdlGetRoom(qrbuf, qrbuf->QRname);
929 // Move the room into a hidden namespace owned by a non-existent user.
930 // This will make the room invisible to everyone.
931 // It will also qualify it for removal during the next purge cycle.
932 snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
937 qrbuf->QRflags |= QR_MAILBOX;
938 time(&qrbuf->QRgen); // Use a timestamp as the new generation number
940 b_deleteroom(old_name);
944 // Back end processing to delete a room and everything associated with it
945 // (This one is synchronous and should only get called by THE DREADED
946 // AUTO-PURGER in serv_expire.c. All user-facing code should call
947 // the asynchronous schedule_room_for_deletion() instead.)
948 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
950 char configdbkeyname[25];
952 syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
954 // Delete the room's network configdb entry
955 netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
956 CtdlDelConfig(configdbkeyname);
958 // Delete the messages in the room
959 // (Careful: this opens an S_ROOMS critical section!)
960 CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
962 // Flag the room record as not in use
963 CtdlGetRoomLock(qrbuf, qrbuf->QRname);
965 CtdlPutRoomLock(qrbuf);
967 // then decrement the reference count for the floor
968 lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
969 flbuf.f_ref_count = flbuf.f_ref_count - 1;
970 lputfloor(&flbuf, (int) (qrbuf->QRfloor));
972 // Delete the room record from the database!
973 b_deleteroom(qrbuf->QRname);
977 // Check access control for deleting a room
978 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
980 if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
984 if (CtdlIsNonEditable(qr)) {
988 // For mailboxes, check stuff
989 if (qr->QRflags & QR_MAILBOX) {
991 if (strlen(qr->QRname) < 12) return(0); // bad name
993 if (atol(qr->QRname) != CC->user.usernum) {
994 return(0); // not my room
997 // Can't delete your own inbox
998 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1000 // Otherwise it's ok
1004 // For normal rooms, just check for admin or room admin status.
1005 return(is_room_aide());
1009 // Internal code to create a new room (returns room flags)
1011 // Room types: 0=public, 1=hidden, 2=passworded, 3=invitation-only,
1012 // 4=mailbox, 5=mailbox, but caller supplies namespace
1013 unsigned CtdlCreateRoom(char *new_room_name,
1015 char *new_room_pass,
1021 struct ctdlroom qrbuf;
1025 syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1027 if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1028 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1032 memset(&qrbuf, 0, sizeof(struct ctdlroom));
1033 safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1034 qrbuf.QRflags = QR_INUSE;
1035 if (new_room_type > 0)
1036 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1037 if (new_room_type == 1)
1038 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1039 if (new_room_type == 2)
1040 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1041 if ( (new_room_type == 4) || (new_room_type == 5) ) {
1042 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1043 // qrbuf.QRflags2 |= QR2_SUBJECTREQ;
1046 // If the user is requesting a personal room, set up the room
1047 // name accordingly (prepend the user number)
1048 if (new_room_type == 4) {
1049 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1052 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1055 // If the room is private, and the system administrator has elected
1056 // to automatically grant room admin privileges, do so now.
1057 if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1058 qrbuf.QRroomaide = CC->user.usernum;
1061 // Blog owners automatically become room admins of their blogs.
1062 // (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1063 else if (new_room_view == VIEW_BLOG) {
1064 qrbuf.QRroomaide = CC->user.usernum;
1067 // Otherwise, set the room admin to undefined.
1069 qrbuf.QRroomaide = (-1L);
1072 // If the caller is only interested in testing whether this will work,
1073 // return now without creating the room.
1074 if (!really_create) return (qrbuf.QRflags);
1076 qrbuf.QRnumber = get_new_room_number();
1077 qrbuf.QRhighest = 0L; // No messages in this room yet
1078 time(&qrbuf.QRgen); // Use a timestamp as the generation number
1079 qrbuf.QRfloor = new_room_floor;
1080 qrbuf.QRdefaultview = new_room_view;
1082 // save what we just did...
1083 CtdlPutRoom(&qrbuf);
1085 // bump the reference count on whatever floor the room is on
1086 lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1087 flbuf.f_ref_count = flbuf.f_ref_count + 1;
1088 lputfloor(&flbuf, (int) qrbuf.QRfloor);
1090 // Grant the creator access to the room unless the avoid_access
1091 // parameter was specified.
1092 if ( (CC->logged_in) && (avoid_access == 0) ) {
1093 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1094 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1095 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1096 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1099 // resume our happy day
1100 return(qrbuf.QRflags);