1 // Server functions which perform operations on room objects.
3 // Copyright (c) 1987-2022 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.
8 // This program is distributed in the hope that it will be useful,
9 // but WITHOUT ANY WARRANTY; without even the implied warranty of
10 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 // GNU General Public License for more details.
14 #include <libcitadel.h>
16 #include "citserver.h"
17 #include "ctdl_module.h"
23 struct floor *floorcache[MAXFLOORS];
25 // Determine whether the currently logged in session has permission to read
26 // messages in the current room.
27 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void) {
28 if ( (!(CC->logged_in))
29 && (!(CC->internal_pgm))
30 && (!CtdlGetConfigInt("c_guest_logins"))
32 return(om_not_logged_in);
38 // Check to see whether we have permission to post a message in the current
39 // room. Returns a *CITADEL ERROR CODE* and puts a message in errmsgbuf, or
40 // returns 0 on success.
41 int CtdlDoIHavePermissionToPostInThisRoom(
49 if (!(CC->logged_in) && (PostPublic == POST_LOGGED_IN)) {
50 snprintf(errmsgbuf, n, "Not logged in.");
51 return (ERROR + NOT_LOGGED_IN);
53 else if (PostPublic == CHECK_EXIST) {
54 return (0); // evaluate whether a recipient exists
56 else if (!(CC->logged_in)) {
57 if ((CC->room.QRflags & QR_READONLY)) {
58 snprintf(errmsgbuf, n, "Not logged in.");
59 return (ERROR + NOT_LOGGED_IN);
64 if ((CC->user.axlevel < AxProbU) && ((CC->room.QRflags & QR_MAILBOX) == 0)) {
65 snprintf(errmsgbuf, n, "Need to be validated to enter (except in %s> to sysop)", MAILROOM);
66 return (ERROR + HIGHER_ACCESS_REQUIRED);
69 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
71 if (ra & UA_POSTALLOWED) {
72 strcpy(errmsgbuf, "OK to post or reply here");
76 if ( (ra & UA_REPLYALLOWED) && (is_reply) ) {
77 // To be thorough, we ought to check to see if the message they are
78 // replying to is actually a valid one in this room, but unless this
79 // actually becomes a problem we'll go with high performance instead.
80 strcpy(errmsgbuf, "OK to reply here");
84 if ( (ra & UA_REPLYALLOWED) && (!is_reply) ) {
85 // Clarify what happened with a better error message
86 snprintf(errmsgbuf, n, "You may only reply to existing messages here.");
87 return (ERROR + HIGHER_ACCESS_REQUIRED);
90 snprintf(errmsgbuf, n, "Higher access is required to post in this room.");
91 return (ERROR + HIGHER_ACCESS_REQUIRED);
96 // Check whether the current user has permission to delete messages from
97 // the current room (returns 1 for yes, 0 for no)
98 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void) {
100 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
101 if (ra & UA_DELETEALLOWED) return(1);
106 // Retrieve access control information for any user/room pair.
107 // Yes, it has a couple of gotos. If you don't like that, go die in a car fire.
108 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf, int *result, int *view) {
114 if (userbuf == &CC->user) {
118 if ((is_me) && (CtdlGetConfigInt("c_guest_logins")) && (!CC->logged_in)) {
122 // for internal programs, always do everything
123 if (((CC->internal_pgm)) && (roombuf->QRflags & QR_INUSE)) {
124 retval = (UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED);
126 goto SKIP_EVERYTHING;
129 // If guest mode is enabled, always grant access to the Lobby
130 if ((is_guest) && (!strcasecmp(roombuf->QRname, BASEROOM))) {
131 retval = (UA_KNOWN | UA_GOTOALLOWED);
133 goto SKIP_EVERYTHING;
136 // Locate any applicable user/room relationships
138 memset(&vbuf, 0, sizeof vbuf);
141 CtdlGetRelationship(&vbuf, userbuf, roombuf);
144 // Force the properties of the Aide room
145 if (!strcasecmp(roombuf->QRname, CtdlGetConfigStr("c_aideroom"))) {
146 if (userbuf->axlevel >= AxAideU) {
147 retval = UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
154 // If this is a public room, it's accessible...
155 if ( ((roombuf->QRflags & QR_PRIVATE) == 0)
156 && ((roombuf->QRflags & QR_MAILBOX) == 0)
158 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
161 // If this is a preferred users only room, check access level
162 if (roombuf->QRflags & QR_PREFONLY) {
163 if (userbuf->axlevel < AxPrefU) {
164 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED;
168 // For private rooms, check the generation number matchups
169 if ( (roombuf->QRflags & QR_PRIVATE)
170 && ((roombuf->QRflags & QR_MAILBOX) == 0)
173 // An explicit match means the user belongs in this room
174 if (vbuf.v_flags & V_ACCESS) {
175 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
177 // Otherwise, check if this is a guess-name or passworded
178 // room. If it is, a goto may at least be attempted
179 else if ( (roombuf->QRflags & QR_PRIVATE)
180 || (roombuf->QRflags & QR_PASSWORDED)
182 retval = retval & ~UA_KNOWN;
183 retval = retval | UA_GOTOALLOWED;
187 // For mailbox rooms, also check the namespace. Also, mailbox owners can delete their messages
188 if ( (roombuf->QRflags & QR_MAILBOX) && (atol(roombuf->QRname) != 0)) {
189 if (userbuf->usernum == atol(roombuf->QRname)) {
190 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
192 // An explicit match means the user belongs in this room
193 if (vbuf.v_flags & V_ACCESS) {
194 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
198 // For non-mailbox rooms...
200 // User is allowed to post in the room unless:
201 // - User is not validated
202 // - User has no net privileges and it is a shared network room
203 // - It is a read-only room
204 // - It is a blog room (in which case we only allow replies to existing messages)
205 int post_allowed = 1;
206 int reply_allowed = 1;
207 if (userbuf->axlevel < AxProbU) {
211 if ((userbuf->axlevel < AxNetU) && (roombuf->QRflags & QR_NETWORK)) {
215 if (roombuf->QRflags & QR_READONLY) {
219 if (roombuf->QRdefaultview == VIEW_BLOG) {
223 retval = retval | UA_POSTALLOWED | UA_REPLYALLOWED;
226 retval = retval | UA_REPLYALLOWED;
229 // If "collaborative deletion" is active for this room, any user who can post
230 // is also allowed to delete
231 if (roombuf->QRflags2 & QR2_COLLABDEL) {
232 if (retval & UA_POSTALLOWED) {
233 retval = retval | UA_DELETEALLOWED;
239 // Check to see if the user has forgotten this room
240 if (vbuf.v_flags & V_FORGET) {
241 retval = retval & ~UA_KNOWN;
242 if ( ( ((roombuf->QRflags & QR_PRIVATE) == 0)
243 && ((roombuf->QRflags & QR_MAILBOX) == 0)
244 ) || ( (roombuf->QRflags & QR_MAILBOX)
245 && (atol(roombuf->QRname) == CC->user.usernum))
247 retval = retval | UA_ZAPPED;
251 // If user is explicitly locked out of this room, deny everything
252 if (vbuf.v_flags & V_LOCKOUT) {
253 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED & ~UA_POSTALLOWED & ~UA_REPLYALLOWED;
256 // Aides get access to all private rooms
257 if ( (userbuf->axlevel >= AxAideU)
258 && ((roombuf->QRflags & QR_MAILBOX) == 0)
260 if (vbuf.v_flags & V_FORGET) {
261 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
264 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
268 // Aides can gain access to mailboxes as well, but they don't show by default.
269 if ( (userbuf->axlevel >= AxAideU)
270 && (roombuf->QRflags & QR_MAILBOX)
272 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
275 // Aides and Room Aides have admin privileges
276 if ( (userbuf->axlevel >= AxAideU)
277 || (userbuf->usernum == roombuf->QRroomaide)
279 retval = retval | UA_ADMINALLOWED | UA_DELETEALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
282 NEWMSG: // By the way, we also check for the presence of new messages
283 if (is_msg_in_sequence_set(vbuf.v_seen, roombuf->QRhighest) == 0) {
284 retval = retval | UA_HASNEWMSGS;
287 // System rooms never show up in the list.
288 if (roombuf->QRflags2 & QR2_SYSTEM) {
289 retval = retval & ~UA_KNOWN;
293 // Now give the caller the information it wants.
294 if (result != NULL) *result = retval;
295 if (view != NULL) *view = vbuf.v_view;
299 // Self-checking stuff for a room record read into memory
300 void room_sanity_check(struct ctdlroom *qrbuf) {
301 // Mailbox rooms are always on the lowest floor
302 if (qrbuf->QRflags & QR_MAILBOX) {
305 // Listing order of 0 is illegal except for base rooms
306 if (qrbuf->QRorder == 0) {
307 if ( !(qrbuf->QRflags & QR_MAILBOX)
308 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)
309 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)
317 // CtdlGetRoom() - retrieve room data from disk
318 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name) {
319 struct cdbdata *cdbqr;
320 char lowercase_name[ROOMNAMELEN];
321 char personal_lowercase_name[ROOMNAMELEN];
325 dptr = lowercase_name;
327 eptr = (dptr + (sizeof lowercase_name - 1));
328 while (!IsEmptyStr(sptr) && (dptr < eptr)) {
329 *dptr = tolower(*sptr);
334 memset(qrbuf, 0, sizeof(struct ctdlroom));
336 if (IsEmptyStr(lowercase_name)) {
337 return(1); // empty room name , not valid
340 // First, try the public namespace
341 cdbqr = cdb_fetch(CDB_ROOMS, lowercase_name, strlen(lowercase_name));
343 // If that didn't work, try the user's personal namespace
345 snprintf(personal_lowercase_name, sizeof personal_lowercase_name, "%010ld.%s", CC->user.usernum, lowercase_name);
346 cdbqr = cdb_fetch(CDB_ROOMS, personal_lowercase_name, strlen(personal_lowercase_name));
349 memcpy(qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len));
351 room_sanity_check(qrbuf);
360 // CtdlGetRoomLock() - same as getroom() but locks the record (if supported)
361 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
363 retval = CtdlGetRoom(qrbuf, room_name);
364 if (retval == 0) begin_critical_section(S_ROOMS);
369 // b_putroom() - back end to putroom() and b_deleteroom()
370 // (if the supplied buffer is NULL, delete the room record)
371 void b_putroom(struct ctdlroom *qrbuf, char *room_name) {
372 char lowercase_name[ROOMNAMELEN];
377 bptr = lowercase_name;
378 while (!IsEmptyStr(aptr)) {
379 *bptr = tolower(*aptr);
385 len = bptr - lowercase_name;
387 cdb_delete(CDB_ROOMS, lowercase_name, len);
390 time(&qrbuf->QRmtime);
391 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
396 // CtdlPutRoom() - store room data to disk
397 void CtdlPutRoom(struct ctdlroom *qrbuf) {
398 b_putroom(qrbuf, qrbuf->QRname);
402 // b_deleteroom() - delete a room record from disk
403 void b_deleteroom(char *room_name) {
404 b_putroom(NULL, room_name);
408 // CtdlPutRoomLock() - same as CtdlPutRoom() but unlocks the record (if supported)
409 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
411 end_critical_section(S_ROOMS);
415 // CtdlGetFloorByName() - retrieve the number of the named floor
416 // return < 0 if not found else return floor number
417 int CtdlGetFloorByName(const char *floor_name) {
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 ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
433 // CtdlGetFloorByNameLock() - retrieve floor number for given floor and lock the floor list.
434 int CtdlGetFloorByNameLock(const char *floor_name) {
435 begin_critical_section(S_FLOORTAB);
436 return CtdlGetFloorByName(floor_name);
441 * CtdlGetAvailableFloor() - Return number of first unused floor
442 * return < 0 if none available
444 int CtdlGetAvailableFloor(void) {
446 struct floor *flbuf = NULL;
448 for (a = 0; a < MAXFLOORS; a++) {
449 flbuf = CtdlGetCachedFloor(a);
451 /* check to see if it already exists */
452 if ((flbuf->f_flags & F_INUSE) == 0) {
461 * CtdlGetFloor() - retrieve floor data from disk
463 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
464 struct cdbdata *cdbfl;
466 memset(flbuf, 0, sizeof(struct floor));
467 cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
469 memcpy(flbuf, cdbfl->ptr, ((cdbfl->len > sizeof(struct floor)) ? sizeof(struct floor) : cdbfl->len));
472 if (floor_num == 0) {
473 safestrncpy(flbuf->f_name, "Main Floor", sizeof flbuf->f_name);
474 flbuf->f_flags = F_INUSE;
475 flbuf->f_ref_count = 3;
482 * lgetfloor() - same as CtdlGetFloor() but locks the record (if supported)
484 void lgetfloor(struct floor *flbuf, int floor_num) {
485 begin_critical_section(S_FLOORTAB);
486 CtdlGetFloor(flbuf, floor_num);
491 * CtdlGetCachedFloor() - Get floor record from *cache* (loads from disk if needed)
493 * This is strictly a performance hack.
495 struct floor *CtdlGetCachedFloor(int floor_num) {
496 static int initialized = 0;
499 struct floor *fl = NULL;
501 begin_critical_section(S_FLOORCACHE);
502 if (initialized == 0) {
503 for (i=0; i<MAXFLOORS; ++i) {
504 floorcache[floor_num] = NULL;
508 if (floorcache[floor_num] == NULL) {
511 end_critical_section(S_FLOORCACHE);
514 fl = malloc(sizeof(struct floor));
515 CtdlGetFloor(fl, floor_num);
516 begin_critical_section(S_FLOORCACHE);
517 if (floorcache[floor_num] != NULL) {
518 free(floorcache[floor_num]);
520 floorcache[floor_num] = fl;
521 end_critical_section(S_FLOORCACHE);
524 return(floorcache[floor_num]);
529 * CtdlPutFloor() - store floor data on disk
531 void CtdlPutFloor(struct floor *flbuf, int floor_num) {
532 /* If we've cached this, clear it out, 'cuz it's WRONG now! */
533 begin_critical_section(S_FLOORCACHE);
534 if (floorcache[floor_num] != NULL) {
535 free(floorcache[floor_num]);
536 floorcache[floor_num] = malloc(sizeof(struct floor));
537 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
539 end_critical_section(S_FLOORCACHE);
541 cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
542 flbuf, sizeof(struct floor));
547 * CtdlPutFloorLock() - same as CtdlPutFloor() but unlocks the record (if supported)
549 void CtdlPutFloorLock(struct floor *flbuf, int floor_num) {
550 CtdlPutFloor(flbuf, floor_num);
551 end_critical_section(S_FLOORTAB);
557 * lputfloor() - same as CtdlPutFloor() but unlocks the record (if supported)
559 void lputfloor(struct floor *flbuf, int floor_num) {
560 CtdlPutFloorLock(flbuf, floor_num);
565 * Iterate through the room table, performing a callback for each room.
567 void CtdlForEachRoom(ForEachRoomCallBack callback_func, void *in_data) {
568 struct ctdlroom qrbuf;
569 struct cdbdata *cdbqr;
571 cdb_rewind(CDB_ROOMS);
573 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
574 memset(&qrbuf, 0, sizeof(struct ctdlroom));
575 memcpy(&qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len) );
577 room_sanity_check(&qrbuf);
578 if (qrbuf.QRflags & QR_INUSE) {
579 callback_func(&qrbuf, in_data);
586 * delete_msglist() - delete room message pointers
588 void delete_msglist(struct ctdlroom *whichroom) {
589 struct cdbdata *cdbml;
591 /* Make sure the msglist we're deleting actually exists, otherwise
592 * libdb will complain when we try to delete an invalid record
594 cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
598 /* Go ahead and delete it */
599 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
605 * Message pointer compare function for sort_msglist()
607 int sort_msglist_cmp(const void *m1, const void *m2) {
608 if ((*(const long *)m1) > (*(const long *)m2)) return(1);
609 if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
615 * sort message pointers
616 * (returns new msg count)
618 int sort_msglist(long listptrs[], int oldcount) {
628 qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp);
630 /* and yank any nulls */
631 while ((i < numitems) && (listptrs[i] == 0L)) i++;
634 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
643 * Determine whether a given room is non-editable.
645 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
647 /* Mail> rooms are non-editable */
648 if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
652 /* Everything else is editable */
658 * Make the specified room the current room for this session. No validation
659 * or access control is done here -- the caller should make sure that the
660 * specified room exists and is ok to access.
662 void CtdlUserGoto(char *where, int display_result, int transiently,
663 int *retmsgs, int *retnew, long *retoldest, long *retnewest)
666 int new_messages = 0;
667 int old_messages = 0;
668 int total_messages = 0;
669 long oldest_message = 0;
670 long newest_message = 0;
674 int newmailcount = 0;
676 char truncated_roomname[ROOMNAMELEN];
677 struct cdbdata *cdbfr;
678 long *msglist = NULL;
680 unsigned int original_v_flags;
683 char setstr[128], lostr[64], histr[64];
687 /* If the supplied room name is NULL, the caller wants us to know that
688 * it has already copied the room record into CC->room, so
689 * we can skip the extra database fetch.
692 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
693 CtdlGetRoom(&CC->room, where);
696 /* Take care of all the formalities. */
698 begin_critical_section(S_USERS);
699 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
700 original_v_flags = vbuf.v_flags;
702 /* Know the room ... but not if it's the page log room, or if the
703 * caller specified that we're only entering this room transiently.
705 int add_room_to_known_list = 1;
706 if (transiently == 1) {
707 add_room_to_known_list = 0;
709 char *c_logpages = CtdlGetConfigStr("c_logpages");
710 if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
711 add_room_to_known_list = 0;
713 if (add_room_to_known_list) {
714 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
715 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
718 /* Only rewrite the database record if we changed something */
719 if (vbuf.v_flags != original_v_flags) {
720 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
722 end_critical_section(S_USERS);
724 /* Check for new mail */
725 newmailcount = NewMailCount();
727 /* Set info to 1 if the room banner is new since our last visit.
728 * Some clients only want to display it when it changes.
730 if (CC->room.msgnum_info > vbuf.v_lastseen) {
734 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
736 msglist = (long *) cdbfr->ptr;
737 cdbfr->ptr = NULL; /* CtdlUserGoto() now owns this memory */
738 num_msgs = cdbfr->len / sizeof(long);
743 for (a=0; a<num_msgs; ++a) {
744 if (msglist[a] > 0L) ++total_messages;
747 if (total_messages > 0) {
748 oldest_message = msglist[0];
749 newest_message = msglist[num_msgs - 1];
752 num_sets = num_tokens(vbuf.v_seen, ',');
753 for (s=0; s<num_sets; ++s) {
754 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
756 extract_token(lostr, setstr, 0, ':', sizeof lostr);
757 if (num_tokens(setstr, ':') >= 2) {
758 extract_token(histr, setstr, 1, ':', sizeof histr);
759 if (!strcmp(histr, "*")) {
760 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
764 strcpy(histr, lostr);
769 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
770 if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
776 new_messages = total_messages - old_messages;
778 if (msglist != NULL) free(msglist);
780 if (CC->room.QRflags & QR_MAILBOX)
785 if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
790 safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
791 if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
792 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
795 if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
799 if (retmsgs != NULL) *retmsgs = total_messages;
800 if (retnew != NULL) *retnew = new_messages;
801 if (retoldest != NULL) *retoldest = oldest_message;
802 if (retnewest != NULL) *retnewest = newest_message;
803 syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
804 CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
807 CC->curr_view = (int)vbuf.v_view;
809 if (display_result) {
810 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
811 CIT_OK, CtdlCheckExpress(),
816 (int)CC->room.QRflags,
817 (long)CC->room.QRhighest,
818 (long)vbuf.v_lastseen,
822 (int)CC->room.QRfloor,
824 (int)CC->room.QRdefaultview,
826 (int)CC->room.QRflags2,
827 (long)CC->room.QRmtime
834 * Handle some of the macro named rooms
836 void convert_room_name_macros(char *towhere, size_t maxlen) {
837 if (!strcasecmp(towhere, "_BASEROOM_")) {
838 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
840 else if (!strcasecmp(towhere, "_MAIL_")) {
841 safestrncpy(towhere, MAILROOM, maxlen);
843 else if (!strcasecmp(towhere, "_TRASH_")) {
844 safestrncpy(towhere, USERTRASHROOM, maxlen);
846 else if (!strcasecmp(towhere, "_DRAFTS_")) {
847 safestrncpy(towhere, USERDRAFTROOM, maxlen);
849 else if (!strcasecmp(towhere, "_BITBUCKET_")) {
850 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
852 else if (!strcasecmp(towhere, "_CALENDAR_")) {
853 safestrncpy(towhere, USERCALENDARROOM, maxlen);
855 else if (!strcasecmp(towhere, "_TASKS_")) {
856 safestrncpy(towhere, USERTASKSROOM, maxlen);
858 else if (!strcasecmp(towhere, "_CONTACTS_")) {
859 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
861 else if (!strcasecmp(towhere, "_NOTES_")) {
862 safestrncpy(towhere, USERNOTESROOM, maxlen);
868 * Back end function to rename a room.
869 * You can also specify which floor to move the room to, or specify -1 to
870 * keep the room on the same floor it was on.
872 * If you are renaming a mailbox room, you must supply the namespace prefix
873 * in *at least* the old name!
875 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
877 struct ctdlroom qrbuf;
878 struct ctdlroom qrtmp;
883 char actual_old_name[ROOMNAMELEN];
885 syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
887 if (new_floor >= 0) {
888 fl = CtdlGetCachedFloor(new_floor);
889 if ((fl->f_flags & F_INUSE) == 0) {
890 return(crr_invalid_floor);
894 begin_critical_section(S_ROOMS);
896 if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
897 ret = crr_already_exists;
900 else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
901 ret = crr_room_not_found;
904 else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
905 && (CC->user.usernum != qrbuf.QRroomaide)
906 && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) ) {
907 ret = crr_access_denied;
910 else if (CtdlIsNonEditable(&qrbuf)) {
911 ret = crr_noneditable;
916 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
917 if (qrbuf.QRflags & QR_MAILBOX) {
918 owner = atol(qrbuf.QRname);
920 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
921 snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
922 "%010ld.%s", owner, new_name);
925 safestrncpy(qrbuf.QRname, new_name,
926 sizeof(qrbuf.QRname));
929 /* Reject change of floor for baseroom/aideroom */
930 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
931 !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
936 /* Take care of floor stuff */
937 old_floor = qrbuf.QRfloor;
939 new_floor = old_floor;
941 qrbuf.QRfloor = new_floor;
944 begin_critical_section(S_CONFIG);
946 /* If baseroom/aideroom name changes, update config */
947 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
948 CtdlSetConfigStr("c_baseroom", new_name);
950 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
951 CtdlSetConfigStr("c_aideroom", new_name);
954 end_critical_section(S_CONFIG);
956 /* If the room name changed, then there are now two room
957 * records, so we have to delete the old one.
959 if (strcasecmp(new_name, old_name)) {
960 b_deleteroom(actual_old_name);
966 end_critical_section(S_ROOMS);
968 /* Adjust the floor reference counts if necessary */
969 if (new_floor != old_floor) {
970 lgetfloor(&flbuf, old_floor);
972 lputfloor(&flbuf, old_floor);
973 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
974 lgetfloor(&flbuf, new_floor);
976 lputfloor(&flbuf, new_floor);
977 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
980 /* ...and everybody say "YATTA!" */
986 * Asynchronously schedule a room for deletion. By placing the room into an invalid private namespace,
987 * the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
988 * database operations to complete. Instead, the room gets purged when THE DREADED AUTO-PURGER makes
989 * its next run. Aren't we so clever?!!
991 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
992 char old_name[ROOMNAMELEN];
995 syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
997 safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
998 CtdlGetRoom(qrbuf, qrbuf->QRname);
1000 /* Turn the room into a private mailbox owned by a user who doesn't
1001 * exist. This will immediately make the room invisible to everyone,
1002 * and qualify the room for purging.
1004 snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
1009 qrbuf->QRflags |= QR_MAILBOX;
1010 time(&qrbuf->QRgen); /* Use a timestamp as the new generation number */
1012 b_deleteroom(old_name);
1017 * Back end processing to delete a room and everything associated with it
1018 * (This one is synchronous and should only get called by THE DREADED
1019 * AUTO-PURGER in serv_expire.c. All user-facing code should call
1020 * the asynchronous schedule_room_for_deletion() instead.)
1022 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
1024 char configdbkeyname[25];
1026 syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
1028 // Delete the room's network configdb entry
1029 netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
1030 CtdlDelConfig(configdbkeyname);
1032 // Delete the messages in the room
1033 // (Careful: this opens an S_ROOMS critical section!)
1034 CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
1036 // Flag the room record as not in use
1037 CtdlGetRoomLock(qrbuf, qrbuf->QRname);
1039 CtdlPutRoomLock(qrbuf);
1041 // then decrement the reference count for the floor
1042 lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
1043 flbuf.f_ref_count = flbuf.f_ref_count - 1;
1044 lputfloor(&flbuf, (int) (qrbuf->QRfloor));
1046 // Delete the room record from the database!
1047 b_deleteroom(qrbuf->QRname);
1052 * Check access control for deleting a room
1054 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
1056 if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
1060 if (CtdlIsNonEditable(qr)) {
1065 * For mailboxes, check stuff
1067 if (qr->QRflags & QR_MAILBOX) {
1069 if (strlen(qr->QRname) < 12) return(0); /* bad name */
1071 if (atol(qr->QRname) != CC->user.usernum) {
1072 return(0); /* not my room */
1075 /* Can't delete your Mail> room */
1076 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1078 /* Otherwise it's ok */
1083 * For normal rooms, just check for admin or room admin status.
1085 return(is_room_aide());
1090 * Internal code to create a new room (returns room flags)
1092 * Room types: 0=public, 1=hidden, 2=passworded, 3=invitation-only,
1093 * 4=mailbox, 5=mailbox, but caller supplies namespace
1095 unsigned CtdlCreateRoom(char *new_room_name,
1097 char *new_room_pass,
1103 struct ctdlroom qrbuf;
1107 syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1109 if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1110 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1114 memset(&qrbuf, 0, sizeof(struct ctdlroom));
1115 safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1116 qrbuf.QRflags = QR_INUSE;
1117 if (new_room_type > 0)
1118 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1119 if (new_room_type == 1)
1120 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1121 if (new_room_type == 2)
1122 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1123 if ( (new_room_type == 4) || (new_room_type == 5) ) {
1124 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1125 /* qrbuf.QRflags2 |= QR2_SUBJECTREQ; */
1128 /* If the user is requesting a personal room, set up the room
1129 * name accordingly (prepend the user number)
1131 if (new_room_type == 4) {
1132 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1135 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1138 /* If the room is private, and the system administrator has elected
1139 * to automatically grant room admin privileges, do so now.
1141 if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1142 qrbuf.QRroomaide = CC->user.usernum;
1144 /* Blog owners automatically become room admins of their blogs.
1145 * (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1147 else if (new_room_view == VIEW_BLOG) {
1148 qrbuf.QRroomaide = CC->user.usernum;
1150 /* Otherwise, set the room admin to undefined.
1153 qrbuf.QRroomaide = (-1L);
1157 * If the caller is only interested in testing whether this will work,
1158 * return now without creating the room.
1160 if (!really_create) return (qrbuf.QRflags);
1162 qrbuf.QRnumber = get_new_room_number();
1163 qrbuf.QRhighest = 0L; /* No messages in this room yet */
1164 time(&qrbuf.QRgen); /* Use a timestamp as the generation number */
1165 qrbuf.QRfloor = new_room_floor;
1166 qrbuf.QRdefaultview = new_room_view;
1168 /* save what we just did... */
1169 CtdlPutRoom(&qrbuf);
1171 /* bump the reference count on whatever floor the room is on */
1172 lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1173 flbuf.f_ref_count = flbuf.f_ref_count + 1;
1174 lputfloor(&flbuf, (int) qrbuf.QRfloor);
1176 /* Grant the creator access to the room unless the avoid_access
1177 * parameter was specified.
1179 if ( (CC->logged_in) && (avoid_access == 0) ) {
1180 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1181 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1182 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1183 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1186 /* resume our happy day */
1187 return (qrbuf.QRflags);