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.
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];
311 dptr = lowercase_name;
313 eptr = (dptr + (sizeof lowercase_name - 1));
314 while (!IsEmptyStr(sptr) && (dptr < eptr)) {
315 *dptr = tolower(*sptr);
320 memset(qrbuf, 0, sizeof(struct ctdlroom));
322 if (IsEmptyStr(lowercase_name)) {
323 return(1); // empty room name , not valid
326 // First, try the public namespace
327 cdbqr = cdb_fetch(CDB_ROOMS, lowercase_name, strlen(lowercase_name));
329 // If that didn't work, try the user's personal namespace
331 snprintf(personal_lowercase_name, sizeof personal_lowercase_name, "%010ld.%s", CC->user.usernum, lowercase_name);
332 cdbqr = cdb_fetch(CDB_ROOMS, personal_lowercase_name, strlen(personal_lowercase_name));
335 memcpy(qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len));
337 room_sanity_check(qrbuf);
346 // CtdlGetRoomLock() - same as getroom() but locks the record (if supported)
347 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
349 retval = CtdlGetRoom(qrbuf, room_name);
350 if (retval == 0) begin_critical_section(S_ROOMS);
355 // b_putroom() - back end to putroom() and b_deleteroom()
356 // (if the supplied buffer is NULL, delete the room record)
357 void b_putroom(struct ctdlroom *qrbuf, char *room_name) {
358 char lowercase_name[ROOMNAMELEN];
363 bptr = lowercase_name;
364 while (!IsEmptyStr(aptr)) {
365 *bptr = tolower(*aptr);
371 len = bptr - lowercase_name;
373 cdb_delete(CDB_ROOMS, lowercase_name, len);
376 time(&qrbuf->QRmtime);
377 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
382 // CtdlPutRoom() - store room data to disk
383 void CtdlPutRoom(struct ctdlroom *qrbuf) {
384 b_putroom(qrbuf, qrbuf->QRname);
388 // b_deleteroom() - delete a room record from disk
389 void b_deleteroom(char *room_name) {
390 b_putroom(NULL, room_name);
394 // CtdlPutRoomLock() - same as CtdlPutRoom() but unlocks the record (if supported)
395 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
397 end_critical_section(S_ROOMS);
401 // CtdlGetFloorByName() - retrieve the number of the named floor
402 // return < 0 if not found else return floor number
403 int CtdlGetFloorByName(const char *floor_name) {
405 struct floor *flbuf = NULL;
407 for (a = 0; a < MAXFLOORS; ++a) {
408 flbuf = CtdlGetCachedFloor(a);
410 // check to see if it already exists
411 if ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
419 // CtdlGetFloorByNameLock() - retrieve floor number for given floor and lock the floor list.
420 int CtdlGetFloorByNameLock(const char *floor_name) {
421 begin_critical_section(S_FLOORTAB);
422 return CtdlGetFloorByName(floor_name);
426 // CtdlGetAvailableFloor() - Return number of first unused floor
427 // return < 0 if none available
428 int CtdlGetAvailableFloor(void) {
430 struct floor *flbuf = NULL;
432 for (a = 0; a < MAXFLOORS; a++) {
433 flbuf = CtdlGetCachedFloor(a);
435 // check to see if it already exists
436 if ((flbuf->f_flags & F_INUSE) == 0) {
444 // CtdlGetFloor() - retrieve floor data from disk
445 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
446 struct cdbdata *cdbfl;
448 memset(flbuf, 0, sizeof(struct floor));
449 cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
451 memcpy(flbuf, cdbfl->ptr, ((cdbfl->len > sizeof(struct floor)) ? sizeof(struct floor) : cdbfl->len));
455 if (floor_num == 0) {
456 safestrncpy(flbuf->f_name, "Main Floor", sizeof flbuf->f_name);
457 flbuf->f_flags = F_INUSE;
458 flbuf->f_ref_count = 3;
464 // lgetfloor() - same as CtdlGetFloor() but locks the record (if supported)
465 void lgetfloor(struct floor *flbuf, int floor_num) {
466 begin_critical_section(S_FLOORTAB);
467 CtdlGetFloor(flbuf, floor_num);
471 // CtdlGetCachedFloor() - Get floor record from *cache* (loads from disk if needed)
472 // This is strictly a performance hack.
473 struct floor *CtdlGetCachedFloor(int floor_num) {
474 static int initialized = 0;
477 struct floor *fl = NULL;
479 begin_critical_section(S_FLOORCACHE);
480 if (initialized == 0) {
481 for (i=0; i<MAXFLOORS; ++i) {
482 floorcache[floor_num] = NULL;
486 if (floorcache[floor_num] == NULL) {
489 end_critical_section(S_FLOORCACHE);
492 fl = malloc(sizeof(struct floor));
493 CtdlGetFloor(fl, floor_num);
494 begin_critical_section(S_FLOORCACHE);
495 if (floorcache[floor_num] != NULL) {
496 free(floorcache[floor_num]);
498 floorcache[floor_num] = fl;
499 end_critical_section(S_FLOORCACHE);
502 return(floorcache[floor_num]);
506 // CtdlPutFloor() - store floor data on disk
507 void CtdlPutFloor(struct floor *flbuf, int floor_num) {
508 // If we've cached this, clear it out, 'cuz it's WRONG now!
509 begin_critical_section(S_FLOORCACHE);
510 if (floorcache[floor_num] != NULL) {
511 free(floorcache[floor_num]);
512 floorcache[floor_num] = malloc(sizeof(struct floor));
513 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
515 end_critical_section(S_FLOORCACHE);
517 cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
518 flbuf, sizeof(struct floor));
522 // CtdlPutFloorLock() - same as CtdlPutFloor() but unlocks the record (if supported)
523 void CtdlPutFloorLock(struct floor *flbuf, int floor_num) {
524 CtdlPutFloor(flbuf, floor_num);
525 end_critical_section(S_FLOORTAB);
530 // lputfloor() - same as CtdlPutFloor() but unlocks the record (if supported)
531 void lputfloor(struct floor *flbuf, int floor_num) {
532 CtdlPutFloorLock(flbuf, floor_num);
536 // Iterate through the room table, performing a callback for each room.
537 void CtdlForEachRoom(ForEachRoomCallBack callback_func, void *in_data) {
538 struct ctdlroom qrbuf;
539 struct cdbdata *cdbqr;
541 cdb_rewind(CDB_ROOMS);
543 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
544 memset(&qrbuf, 0, sizeof(struct ctdlroom));
545 memcpy(&qrbuf, cdbqr->ptr, ((cdbqr->len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr->len) );
547 room_sanity_check(&qrbuf);
548 if (qrbuf.QRflags & QR_INUSE) {
549 callback_func(&qrbuf, in_data);
555 // delete_msglist() - delete room message pointers
556 void delete_msglist(struct ctdlroom *whichroom) {
557 struct cdbdata *cdbml;
559 // Make sure the msglist we're deleting actually exists, otherwise
560 // libdb will complain when we try to delete an invalid record
561 cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
565 // Go ahead and delete it
566 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
571 // Message pointer compare function for sort_msglist()
572 int sort_msglist_cmp(const void *m1, const void *m2) {
573 if ((*(const long *)m1) > (*(const long *)m2)) return(1);
574 if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
579 // sort message pointers
580 // (returns new msg count)
581 int sort_msglist(long listptrs[], int oldcount) {
586 if (numitems < 2) { // an empty or 1-item list needs no sorting
590 qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp); // do the sort
592 while ((i < numitems) && (listptrs[i] == 0L)) i++; // yank out any nulls
594 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
602 // Determine whether a given room is non-editable.
603 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
605 // The inbox cannot be edited
606 if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
610 // Everything else is editable
615 // Make the specified room the current room for this session. No validation
616 // or access control is done here -- the caller should make sure that the
617 // specified room exists and is ok to access.
618 void CtdlUserGoto(char *where, int display_result, int transiently, int *retmsgs, int *retnew, long *retoldest, long *retnewest) {
620 int new_messages = 0;
621 int old_messages = 0;
622 int total_messages = 0;
623 long oldest_message = 0;
624 long newest_message = 0;
629 char truncated_roomname[ROOMNAMELEN];
630 struct cdbdata *cdbfr;
631 long *msglist = NULL;
633 unsigned int original_v_flags;
636 char setstr[128], lostr[64], histr[64];
640 // If the supplied room name is NULL, the caller wants us to know that
641 // it has already copied the room record into CC->room, so
642 // we can skip the extra database fetch.
644 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
645 CtdlGetRoom(&CC->room, where);
648 // Take care of all the formalities.
650 begin_critical_section(S_USERS);
651 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
652 original_v_flags = vbuf.v_flags;
654 // Know the room ... but not if it's the page log room, or if the
655 // caller specified that we're only entering this room transiently.
656 int add_room_to_known_list = 1;
657 if (transiently == 1) {
658 add_room_to_known_list = 0;
660 char *c_logpages = CtdlGetConfigStr("c_logpages");
661 if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
662 add_room_to_known_list = 0;
664 if (add_room_to_known_list) {
665 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
666 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
669 // Only rewrite the database record if we changed something
670 if (vbuf.v_flags != original_v_flags) {
671 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
673 end_critical_section(S_USERS);
675 // Set info to 1 if the room banner is new since our last visit.
676 // Some clients only want to display it when it changes.
677 if (CC->room.msgnum_info > vbuf.v_lastseen) {
681 cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
683 msglist = (long *) cdbfr->ptr;
684 cdbfr->ptr = NULL; // CtdlUserGoto() now owns this memory
685 num_msgs = cdbfr->len / sizeof(long);
690 for (a=0; a<num_msgs; ++a) {
691 if (msglist[a] > 0L) ++total_messages;
694 if (total_messages > 0) {
695 oldest_message = msglist[0];
696 newest_message = msglist[num_msgs - 1];
699 num_sets = num_tokens(vbuf.v_seen, ',');
700 for (s=0; s<num_sets; ++s) {
701 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
703 extract_token(lostr, setstr, 0, ':', sizeof lostr);
704 if (num_tokens(setstr, ':') >= 2) {
705 extract_token(histr, setstr, 1, ':', sizeof histr);
706 if (!strcmp(histr, "*")) {
707 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
711 strcpy(histr, lostr);
716 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
717 if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
723 new_messages = total_messages - old_messages;
725 if (msglist != NULL) free(msglist);
727 if (CC->room.QRflags & QR_MAILBOX)
732 if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
737 safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
738 if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
739 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
742 if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
746 if (retmsgs != NULL) *retmsgs = total_messages;
747 if (retnew != NULL) *retnew = new_messages;
748 if (retoldest != NULL) *retoldest = oldest_message;
749 if (retnewest != NULL) *retnewest = newest_message;
750 syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
751 CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
754 CC->curr_view = (int)vbuf.v_view;
756 if (display_result) {
757 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
758 CIT_OK, CtdlCheckExpress(),
763 (int)CC->room.QRflags,
764 (long)CC->room.QRhighest,
765 (long)vbuf.v_lastseen,
768 0, // new mail is no longer counted here
769 (int)CC->room.QRfloor,
771 (int)CC->room.QRdefaultview,
773 (int)CC->room.QRflags2,
774 (long)CC->room.QRmtime
780 // Handle some of the macro named rooms
781 void convert_room_name_macros(char *towhere, size_t maxlen) {
782 if (!strcasecmp(towhere, "_BASEROOM_")) {
783 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
785 else if (!strcasecmp(towhere, "_MAIL_")) {
786 safestrncpy(towhere, MAILROOM, maxlen);
788 else if (!strcasecmp(towhere, "_TRASH_")) {
789 safestrncpy(towhere, USERTRASHROOM, maxlen);
791 else if (!strcasecmp(towhere, "_DRAFTS_")) {
792 safestrncpy(towhere, USERDRAFTROOM, maxlen);
794 else if (!strcasecmp(towhere, "_BITBUCKET_")) {
795 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
797 else if (!strcasecmp(towhere, "_CALENDAR_")) {
798 safestrncpy(towhere, USERCALENDARROOM, maxlen);
800 else if (!strcasecmp(towhere, "_TASKS_")) {
801 safestrncpy(towhere, USERTASKSROOM, maxlen);
803 else if (!strcasecmp(towhere, "_CONTACTS_")) {
804 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
806 else if (!strcasecmp(towhere, "_NOTES_")) {
807 safestrncpy(towhere, USERNOTESROOM, maxlen);
812 // Back end function to rename a room.
813 // You can also specify which floor to move the room to, or specify -1 to
814 // keep the room on the same floor it was on.
816 // If you are renaming a mailbox room, you must supply the namespace prefix
817 // in *at least* the old name!
818 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
820 struct ctdlroom qrbuf;
821 struct ctdlroom qrtmp;
826 char actual_old_name[ROOMNAMELEN];
828 syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
830 if (new_floor >= 0) {
831 fl = CtdlGetCachedFloor(new_floor);
832 if ((fl->f_flags & F_INUSE) == 0) {
833 return(crr_invalid_floor);
837 begin_critical_section(S_ROOMS);
839 if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
840 ret = crr_already_exists;
843 else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
844 ret = crr_room_not_found;
847 else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
848 && (CC->user.usernum != qrbuf.QRroomaide)
849 && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) ) {
850 ret = crr_access_denied;
853 else if (CtdlIsNonEditable(&qrbuf)) {
854 ret = crr_noneditable;
859 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
860 if (qrbuf.QRflags & QR_MAILBOX) {
861 owner = atol(qrbuf.QRname);
863 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
864 snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
865 "%010ld.%s", owner, new_name);
868 safestrncpy(qrbuf.QRname, new_name,
869 sizeof(qrbuf.QRname));
872 // Reject change of floor for baseroom/aideroom
873 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
874 !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
879 // Take care of floor stuff
880 old_floor = qrbuf.QRfloor;
882 new_floor = old_floor;
884 qrbuf.QRfloor = new_floor;
887 begin_critical_section(S_CONFIG);
889 // If baseroom/aideroom name changes, update config
890 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
891 CtdlSetConfigStr("c_baseroom", new_name);
893 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
894 CtdlSetConfigStr("c_aideroom", new_name);
897 end_critical_section(S_CONFIG);
899 // If the room name changed, then there are now two room
900 // records, so we have to delete the old one.
901 if (strcasecmp(new_name, old_name)) {
902 b_deleteroom(actual_old_name);
908 end_critical_section(S_ROOMS);
910 // Adjust the floor reference counts if necessary
911 if (new_floor != old_floor) {
912 lgetfloor(&flbuf, old_floor);
914 lputfloor(&flbuf, old_floor);
915 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
916 lgetfloor(&flbuf, new_floor);
918 lputfloor(&flbuf, new_floor);
919 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
922 // ...and everybody say "YATTA!"
927 // Asynchronously schedule a room for deletion. By placing the room into an invalid private namespace,
928 // the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
929 // database operations to complete. Instead, the room gets purged when THE DREADED AUTO-PURGER makes
930 // its next run. Aren't we so clever?!!
931 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
932 char old_name[ROOMNAMELEN];
935 syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
937 safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
938 CtdlGetRoom(qrbuf, qrbuf->QRname);
940 // Move the room into a hidden namespace owned by a non-existent user.
941 // This will make the room invisible to everyone.
942 // It will also qualify it for removal during the next purge cycle.
943 snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
948 qrbuf->QRflags |= QR_MAILBOX;
949 time(&qrbuf->QRgen); // Use a timestamp as the new generation number
951 b_deleteroom(old_name);
955 // Back end processing to delete a room and everything associated with it
956 // (This one is synchronous and should only get called by THE DREADED
957 // AUTO-PURGER in serv_expire.c. All user-facing code should call
958 // the asynchronous schedule_room_for_deletion() instead.)
959 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
961 char configdbkeyname[25];
963 syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
965 // Delete the room's network configdb entry
966 netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
967 CtdlDelConfig(configdbkeyname);
969 // Delete the messages in the room
970 // (Careful: this opens an S_ROOMS critical section!)
971 CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
973 // Flag the room record as not in use
974 CtdlGetRoomLock(qrbuf, qrbuf->QRname);
976 CtdlPutRoomLock(qrbuf);
978 // then decrement the reference count for the floor
979 lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
980 flbuf.f_ref_count = flbuf.f_ref_count - 1;
981 lputfloor(&flbuf, (int) (qrbuf->QRfloor));
983 // Delete the room record from the database!
984 b_deleteroom(qrbuf->QRname);
988 // Check access control for deleting a room
989 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
991 if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
995 if (CtdlIsNonEditable(qr)) {
999 // For mailboxes, check stuff
1000 if (qr->QRflags & QR_MAILBOX) {
1002 if (strlen(qr->QRname) < 12) return(0); // bad name
1004 if (atol(qr->QRname) != CC->user.usernum) {
1005 return(0); // not my room
1008 // Can't delete your own inbox
1009 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1011 // Otherwise it's ok
1015 // For normal rooms, just check for admin or room admin status.
1016 return(is_room_aide());
1020 // Internal code to create a new room (returns room flags)
1022 // Room types: 0=public, 1=hidden, 2=passworded, 3=invitation-only,
1023 // 4=mailbox, 5=mailbox, but caller supplies namespace
1024 unsigned CtdlCreateRoom(char *new_room_name,
1026 char *new_room_pass,
1032 struct ctdlroom qrbuf;
1036 syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1038 if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1039 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1043 memset(&qrbuf, 0, sizeof(struct ctdlroom));
1044 safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1045 qrbuf.QRflags = QR_INUSE;
1046 if (new_room_type > 0)
1047 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1048 if (new_room_type == 1)
1049 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1050 if (new_room_type == 2)
1051 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1052 if ( (new_room_type == 4) || (new_room_type == 5) ) {
1053 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1054 // qrbuf.QRflags2 |= QR2_SUBJECTREQ;
1057 // If the user is requesting a personal room, set up the room
1058 // name accordingly (prepend the user number)
1059 if (new_room_type == 4) {
1060 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1063 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1066 // If the room is private, and the system administrator has elected
1067 // to automatically grant room admin privileges, do so now.
1068 if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1069 qrbuf.QRroomaide = CC->user.usernum;
1072 // Blog owners automatically become room admins of their blogs.
1073 // (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1074 else if (new_room_view == VIEW_BLOG) {
1075 qrbuf.QRroomaide = CC->user.usernum;
1078 // Otherwise, set the room admin to undefined.
1080 qrbuf.QRroomaide = (-1L);
1083 // If the caller is only interested in testing whether this will work,
1084 // return now without creating the room.
1085 if (!really_create) return (qrbuf.QRflags);
1087 qrbuf.QRnumber = get_new_room_number();
1088 qrbuf.QRhighest = 0L; // No messages in this room yet
1089 time(&qrbuf.QRgen); // Use a timestamp as the generation number
1090 qrbuf.QRfloor = new_room_floor;
1091 qrbuf.QRdefaultview = new_room_view;
1093 // save what we just did...
1094 CtdlPutRoom(&qrbuf);
1096 // bump the reference count on whatever floor the room is on
1097 lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1098 flbuf.f_ref_count = flbuf.f_ref_count + 1;
1099 lputfloor(&flbuf, (int) qrbuf.QRfloor);
1101 // Grant the creator access to the room unless the avoid_access
1102 // parameter was specified.
1103 if ( (CC->logged_in) && (avoid_access == 0) ) {
1104 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1105 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1106 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1107 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1110 // resume our happy day
1111 return(qrbuf.QRflags);