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
325 if (cdbqr.ptr == NULL) {
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));
329 if (cdbqr.ptr != NULL) {
330 memcpy(qrbuf, cdbqr.ptr, ((cdbqr.len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr.len));
331 room_sanity_check(qrbuf);
340 // CtdlGetRoomLock() - same as getroom() but locks the record (if supported)
341 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
343 retval = CtdlGetRoom(qrbuf, room_name);
344 if (retval == 0) begin_critical_section(S_ROOMS);
349 // b_putroom() - back end to putroom() and b_deleteroom()
350 // (if the supplied buffer is NULL, delete the room record)
351 void b_putroom(struct ctdlroom *qrbuf, char *room_name) {
352 char lowercase_name[ROOMNAMELEN];
355 len = strlen(room_name);
356 for (int i=0; i<=len; ++i) {
357 lowercase_name[i] = tolower(room_name[i]);
361 cdb_delete(CDB_ROOMS, lowercase_name, len);
364 time(&qrbuf->QRmtime);
365 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
370 // CtdlPutRoom() - store room data to disk
371 void CtdlPutRoom(struct ctdlroom *qrbuf) {
372 b_putroom(qrbuf, qrbuf->QRname);
376 // b_deleteroom() - delete a room record from disk
377 void b_deleteroom(char *room_name) {
378 b_putroom(NULL, room_name);
382 // CtdlPutRoomLock() - same as CtdlPutRoom() but unlocks the record (if supported)
383 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
385 end_critical_section(S_ROOMS);
389 // CtdlGetFloorByName() - retrieve the number of the named floor
390 // return < 0 if not found else return floor number
391 int CtdlGetFloorByName(const char *floor_name) {
393 struct floor *flbuf = NULL;
395 for (a = 0; a < MAXFLOORS; ++a) {
396 flbuf = CtdlGetCachedFloor(a);
398 // check to see if it already exists
399 if ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
407 // CtdlGetFloorByNameLock() - retrieve floor number for given floor and lock the floor list.
408 int CtdlGetFloorByNameLock(const char *floor_name) {
409 begin_critical_section(S_FLOORTAB);
410 return CtdlGetFloorByName(floor_name);
414 // CtdlGetAvailableFloor() - Return number of first unused floor
415 // return < 0 if none available
416 int CtdlGetAvailableFloor(void) {
418 struct floor *flbuf = NULL;
420 for (a = 0; a < MAXFLOORS; a++) {
421 flbuf = CtdlGetCachedFloor(a);
423 // check to see if it already exists
424 if ((flbuf->f_flags & F_INUSE) == 0) {
432 // CtdlGetFloor() - retrieve floor data from disk
433 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
434 struct cdbdata cdbfl;
436 memset(flbuf, 0, sizeof(struct floor));
437 cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
438 if (cdbfl.ptr != NULL) {
439 memcpy(flbuf, cdbfl.ptr, ((cdbfl.len > sizeof(struct floor)) ? sizeof(struct floor) : cdbfl.len));
442 if (floor_num == 0) {
443 safestrncpy(flbuf->f_name, "Main Floor", sizeof flbuf->f_name);
444 flbuf->f_flags = F_INUSE;
445 flbuf->f_ref_count = 3;
451 // lgetfloor() - same as CtdlGetFloor() but locks the record (if supported)
452 void lgetfloor(struct floor *flbuf, int floor_num) {
453 begin_critical_section(S_FLOORTAB);
454 CtdlGetFloor(flbuf, floor_num);
458 // CtdlGetCachedFloor() - Get floor record from *cache* (loads from disk if needed)
459 // This is strictly a performance hack.
460 struct floor *CtdlGetCachedFloor(int floor_num) {
461 static int initialized = 0;
464 struct floor *fl = NULL;
466 begin_critical_section(S_FLOORCACHE);
467 if (initialized == 0) {
468 for (i=0; i<MAXFLOORS; ++i) {
469 floorcache[floor_num] = NULL;
473 if (floorcache[floor_num] == NULL) {
476 end_critical_section(S_FLOORCACHE);
479 fl = malloc(sizeof(struct floor));
480 CtdlGetFloor(fl, floor_num);
481 begin_critical_section(S_FLOORCACHE);
482 if (floorcache[floor_num] != NULL) {
483 free(floorcache[floor_num]);
485 floorcache[floor_num] = fl;
486 end_critical_section(S_FLOORCACHE);
489 return(floorcache[floor_num]);
493 // CtdlPutFloor() - store floor data on disk
494 void CtdlPutFloor(struct floor *flbuf, int floor_num) {
495 // If we've cached this, clear it out, 'cuz it's WRONG now!
496 begin_critical_section(S_FLOORCACHE);
497 if (floorcache[floor_num] != NULL) {
498 free(floorcache[floor_num]);
499 floorcache[floor_num] = malloc(sizeof(struct floor));
500 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
502 end_critical_section(S_FLOORCACHE);
504 cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
505 flbuf, sizeof(struct floor));
509 // CtdlPutFloorLock() - same as CtdlPutFloor() but unlocks the record (if supported)
510 void CtdlPutFloorLock(struct floor *flbuf, int floor_num) {
511 CtdlPutFloor(flbuf, floor_num);
512 end_critical_section(S_FLOORTAB);
517 // lputfloor() - same as CtdlPutFloor() but unlocks the record (if supported)
518 void lputfloor(struct floor *flbuf, int floor_num) {
519 CtdlPutFloorLock(flbuf, floor_num);
523 // Iterate through the room table, performing a callback for each room.
524 void CtdlForEachRoom(ForEachRoomCallBack callback_func, void *in_data) {
525 struct ctdlroom qrbuf;
526 struct cdbkeyval cdbqr;
528 cdb_rewind(CDB_ROOMS);
529 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr.val.ptr!=NULL) { // always read through to the end
530 memset(&qrbuf, 0, sizeof(struct ctdlroom));
531 memcpy(&qrbuf, cdbqr.val.ptr, ((cdbqr.val.len > sizeof(struct ctdlroom)) ? sizeof(struct ctdlroom) : cdbqr.val.len) );
532 room_sanity_check(&qrbuf);
533 if (qrbuf.QRflags & QR_INUSE) {
534 callback_func(&qrbuf, in_data);
540 // delete_msglist() - delete room message pointers
541 void delete_msglist(struct ctdlroom *whichroom) {
542 struct cdbdata cdbml;
544 // Make sure the msglist we're deleting actually exists; don't try to delete an invalid record
545 cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
546 if (cdbml.ptr != NULL) {
547 // ok it exists, go ahead and delete it
548 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
553 // Message pointer compare function for sort_msglist()
554 int sort_msglist_cmp(const void *m1, const void *m2) {
555 if ((*(const long *)m1) > (*(const long *)m2)) return(1);
556 if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
561 // sort message pointers
562 // (returns new msg count)
563 int sort_msglist(long listptrs[], int oldcount) {
568 if (numitems < 2) { // an empty or 1-item list needs no sorting
572 qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp); // do the sort
574 while ((i < numitems) && (listptrs[i] == 0L)) i++; // yank out any nulls
576 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
584 // Determine whether a given room is non-editable.
585 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
587 // The inbox cannot be edited
588 if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
592 // Everything else is editable
597 // Retrieve a list of all messages (message numbers) in the specified room.
598 // Returns the number of messages in the room, allocates a pointer to the array and stuffs it in the supplied location.
599 // Caller must free that memory.
600 // If no messages in room, returns 0 and msgs is set to NULL.
601 int CtdlFetchMsgList(long roomnum, long **msgs) {
603 struct cdbdata cdbfr;
605 cdbfr = cdb_fetch(CDB_MSGLISTS, &roomnum, sizeof(long));
606 if (cdbfr.ptr == NULL) {
607 *msgs = malloc(sizeof(long)); // dummy buffer
612 num_msgs = cdbfr.len / sizeof(long);
614 *msgs = malloc(cdbfr.len);
615 memcpy(*msgs, cdbfr.ptr, cdbfr.len);
624 // Make the specified room the current room for this session. No validation
625 // or access control is done here -- the caller should make sure that the
626 // specified room exists and is ok to access.
627 void CtdlUserGoto(char *where, int display_result, int transiently, int *retmsgs, int *retnew, long *retoldest, long *retnewest) {
629 int new_messages = 0;
630 int old_messages = 0;
631 int total_messages = 0;
632 long oldest_message = 0;
633 long newest_message = 0;
638 char truncated_roomname[ROOMNAMELEN];
639 long *msglist = NULL;
641 unsigned int original_v_flags;
644 char setstr[128], lostr[64], histr[64];
648 // If the supplied room name is NULL, the caller wants us to know that
649 // it has already copied the room record into CC->room, so
650 // we can skip the extra database fetch.
652 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
653 CtdlGetRoom(&CC->room, where);
656 // Take care of all the formalities.
658 begin_critical_section(S_USERS);
659 CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
660 original_v_flags = vbuf.v_flags;
662 // Know the room ... but not if it's the page log room, or if the
663 // caller specified that we're only entering this room transiently.
664 int add_room_to_known_list = 1;
665 if (transiently == 1) {
666 add_room_to_known_list = 0;
668 char *c_logpages = CtdlGetConfigStr("c_logpages");
669 if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
670 add_room_to_known_list = 0;
672 if (add_room_to_known_list) {
673 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
674 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
677 // Only rewrite the database record if we changed something
678 if (vbuf.v_flags != original_v_flags) {
679 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
681 end_critical_section(S_USERS);
683 // Set info to 1 if the room banner is new since our last visit.
684 // Some clients only want to display it when it changes.
685 if (CC->room.msgnum_info > vbuf.v_lastseen) {
689 num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
692 for (a=0; a<num_msgs; ++a) {
693 if (msglist[a] > 0L) ++total_messages;
696 if (total_messages > 0) {
697 oldest_message = msglist[0];
698 newest_message = msglist[num_msgs - 1];
701 num_sets = num_tokens(vbuf.v_seen, ',');
702 for (s=0; s<num_sets; ++s) {
703 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
705 extract_token(lostr, setstr, 0, ':', sizeof lostr);
706 if (num_tokens(setstr, ':') >= 2) {
707 extract_token(histr, setstr, 1, ':', sizeof histr);
708 if (!strcmp(histr, "*")) {
709 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
713 strcpy(histr, lostr);
718 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
719 if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
725 new_messages = total_messages - old_messages;
727 if (msglist != NULL) free(msglist);
729 if (CC->room.QRflags & QR_MAILBOX)
734 if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
739 safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
740 if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
741 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
744 if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
748 if (retmsgs != NULL) *retmsgs = total_messages;
749 if (retnew != NULL) *retnew = new_messages;
750 if (retoldest != NULL) *retoldest = oldest_message;
751 if (retnewest != NULL) *retnewest = newest_message;
752 syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
753 CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
756 CC->curr_view = (int)vbuf.v_view;
758 if (display_result) {
759 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
760 CIT_OK, CtdlCheckExpress(),
765 (int)CC->room.QRflags,
766 (long)CC->room.QRhighest,
767 (long)vbuf.v_lastseen,
770 0, // new mail is no longer counted here
771 (int)CC->room.QRfloor,
773 (int)CC->room.QRdefaultview,
775 (int)CC->room.QRflags2,
776 (long)CC->room.QRmtime
782 // Handle some of the macro named rooms
783 void convert_room_name_macros(char *towhere, size_t maxlen) {
784 if (!strcasecmp(towhere, "_BASEROOM_")) {
785 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
787 else if (!strcasecmp(towhere, "_MAIL_")) {
788 safestrncpy(towhere, MAILROOM, maxlen);
790 else if (!strcasecmp(towhere, "_TRASH_")) {
791 safestrncpy(towhere, USERTRASHROOM, maxlen);
793 else if (!strcasecmp(towhere, "_DRAFTS_")) {
794 safestrncpy(towhere, USERDRAFTROOM, maxlen);
796 else if (!strcasecmp(towhere, "_BITBUCKET_")) {
797 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
799 else if (!strcasecmp(towhere, "_CALENDAR_")) {
800 safestrncpy(towhere, USERCALENDARROOM, maxlen);
802 else if (!strcasecmp(towhere, "_TASKS_")) {
803 safestrncpy(towhere, USERTASKSROOM, maxlen);
805 else if (!strcasecmp(towhere, "_CONTACTS_")) {
806 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
808 else if (!strcasecmp(towhere, "_NOTES_")) {
809 safestrncpy(towhere, USERNOTESROOM, maxlen);
814 // Back end function to rename a room.
815 // You can also specify which floor to move the room to, or specify -1 to
816 // keep the room on the same floor it was on.
818 // If you are renaming a mailbox room, you must supply the namespace prefix
819 // in *at least* the old name!
820 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
822 struct ctdlroom qrbuf;
823 struct ctdlroom qrtmp;
828 char actual_old_name[ROOMNAMELEN];
830 syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
832 if (new_floor >= 0) {
833 fl = CtdlGetCachedFloor(new_floor);
834 if ((fl->f_flags & F_INUSE) == 0) {
835 return(crr_invalid_floor);
839 begin_critical_section(S_ROOMS);
841 if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
842 ret = crr_already_exists;
845 else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
846 ret = crr_room_not_found;
849 else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
850 && (CC->user.usernum != qrbuf.QRroomaide)
851 && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) ) {
852 ret = crr_access_denied;
855 else if (CtdlIsNonEditable(&qrbuf)) {
856 ret = crr_noneditable;
861 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
862 if (qrbuf.QRflags & QR_MAILBOX) {
863 owner = atol(qrbuf.QRname);
865 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
866 snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
867 "%010ld.%s", owner, new_name);
870 safestrncpy(qrbuf.QRname, new_name,
871 sizeof(qrbuf.QRname));
874 // Reject change of floor for baseroom/aideroom
875 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
876 !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
881 // Take care of floor stuff
882 old_floor = qrbuf.QRfloor;
884 new_floor = old_floor;
886 qrbuf.QRfloor = new_floor;
890 // If the room name changed, then there are now two room
891 // records, so we have to delete the old one.
892 if (strcasecmp(new_name, old_name)) {
893 b_deleteroom(actual_old_name);
899 end_critical_section(S_ROOMS);
901 // If baseroom/aideroom name changes, update config
902 begin_critical_section(S_CONFIG);
903 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
904 CtdlSetConfigStr("c_baseroom", new_name);
906 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
907 CtdlSetConfigStr("c_aideroom", new_name);
909 end_critical_section(S_CONFIG);
911 // Adjust the floor reference counts if necessary
912 if (new_floor != old_floor) {
913 lgetfloor(&flbuf, old_floor);
915 lputfloor(&flbuf, old_floor);
916 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
917 lgetfloor(&flbuf, new_floor);
919 lputfloor(&flbuf, new_floor);
920 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
923 // ...and everybody say "YATTA!"
928 // Asynchronously schedule a room for deletion. By placing the room into an invalid private namespace,
929 // the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
930 // database operations to complete. Instead, the room gets purged when THE DREADED AUTO-PURGER makes
931 // its next run. Aren't we so clever?!!
932 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
933 char old_name[ROOMNAMELEN];
936 syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
938 safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
939 CtdlGetRoom(qrbuf, qrbuf->QRname);
941 // Move the room into a hidden namespace owned by a non-existent user.
942 // This will make the room invisible to everyone.
943 // It will also qualify it for removal during the next purge cycle.
944 snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
949 qrbuf->QRflags |= QR_MAILBOX;
950 time(&qrbuf->QRgen); // Use a timestamp as the new generation number
952 b_deleteroom(old_name);
956 // Back end processing to delete a room and everything associated with it
957 // (This one is synchronous and should only get called by THE DREADED
958 // AUTO-PURGER in serv_expire.c. All user-facing code should call
959 // the asynchronous schedule_room_for_deletion() instead.)
960 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
962 char configdbkeyname[25];
964 syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
966 // Delete the room's network configdb entry
967 netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
968 CtdlDelConfig(configdbkeyname);
970 // Delete the messages in the room
971 // (Careful: this opens an S_ROOMS critical section!)
972 CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
974 // Flag the room record as not in use
975 CtdlGetRoomLock(qrbuf, qrbuf->QRname);
977 CtdlPutRoomLock(qrbuf);
979 // then decrement the reference count for the floor
980 lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
981 flbuf.f_ref_count = flbuf.f_ref_count - 1;
982 lputfloor(&flbuf, (int) (qrbuf->QRfloor));
984 // Delete the room record from the database!
985 b_deleteroom(qrbuf->QRname);
989 // Check access control for deleting a room
990 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
992 if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
996 if (CtdlIsNonEditable(qr)) {
1000 // For mailboxes, check stuff
1001 if (qr->QRflags & QR_MAILBOX) {
1003 if (strlen(qr->QRname) < 12) return(0); // bad name
1005 if (atol(qr->QRname) != CC->user.usernum) {
1006 return(0); // not my room
1009 // Can't delete your own inbox
1010 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1012 // Otherwise it's ok
1016 // For normal rooms, just check for admin or room admin status.
1017 return(is_room_aide());
1021 // Internal code to create a new room (returns room flags)
1023 // Room types: 0=public, 1=hidden, 2=passworded, 3=invitation-only,
1024 // 4=mailbox, 5=mailbox, but caller supplies namespace
1025 unsigned CtdlCreateRoom(char *new_room_name,
1027 char *new_room_pass,
1033 struct ctdlroom qrbuf;
1037 syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1039 if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1040 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1044 memset(&qrbuf, 0, sizeof(struct ctdlroom));
1045 safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1046 qrbuf.QRflags = QR_INUSE;
1047 if (new_room_type > 0)
1048 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1049 if (new_room_type == 1)
1050 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1051 if (new_room_type == 2)
1052 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1053 if ( (new_room_type == 4) || (new_room_type == 5) ) {
1054 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1055 // qrbuf.QRflags2 |= QR2_SUBJECTREQ;
1058 // If the user is requesting a personal room, set up the room
1059 // name accordingly (prepend the user number)
1060 if (new_room_type == 4) {
1061 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1064 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1067 // If the room is private, and the system administrator has elected
1068 // to automatically grant room admin privileges, do so now.
1069 if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1070 qrbuf.QRroomaide = CC->user.usernum;
1073 // Blog owners automatically become room admins of their blogs.
1074 // (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1075 else if (new_room_view == VIEW_BLOG) {
1076 qrbuf.QRroomaide = CC->user.usernum;
1079 // Otherwise, set the room admin to undefined.
1081 qrbuf.QRroomaide = (-1L);
1084 // If the caller is only interested in testing whether this will work,
1085 // return now without creating the room.
1086 if (!really_create) return (qrbuf.QRflags);
1088 qrbuf.QRnumber = get_new_room_number();
1089 qrbuf.QRhighest = 0L; // No messages in this room yet
1090 time(&qrbuf.QRgen); // Use a timestamp as the generation number
1091 qrbuf.QRfloor = new_room_floor;
1092 qrbuf.QRdefaultview = new_room_view;
1094 // save what we just did...
1095 CtdlPutRoom(&qrbuf);
1097 // bump the reference count on whatever floor the room is on
1098 lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1099 flbuf.f_ref_count = flbuf.f_ref_count + 1;
1100 lputfloor(&flbuf, (int) qrbuf.QRfloor);
1102 // Grant the creator access to the room unless the avoid_access
1103 // parameter was specified.
1104 if ( (CC->logged_in) && (avoid_access == 0) ) {
1105 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1106 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1107 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1108 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1111 // resume our happy day
1112 return(qrbuf.QRflags);