2 * Server functions which perform operations on room objects.
4 * Copyright (c) 1987-2016 by the citadel.org team
6 * This program is open source software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License, version 3.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
16 #include <libcitadel.h>
18 #include "citserver.h"
19 #include "ctdl_module.h"
25 struct floor *floorcache[MAXFLOORS];
28 * Determine whether the currently logged in session has permission to read
29 * messages in the current room.
31 int CtdlDoIHavePermissionToReadMessagesInThisRoom(void) {
32 if ( (!(CC->logged_in))
33 && (!(CC->internal_pgm))
34 && (!CtdlGetConfigInt("c_guest_logins"))
36 return(om_not_logged_in);
42 * Check to see whether we have permission to post a message in the current
43 * room. Returns a *CITADEL ERROR CODE* and puts a message in errmsgbuf, or
44 * returns 0 on success.
46 int CtdlDoIHavePermissionToPostInThisRoom(
49 const char* RemoteIdentifier,
55 if (!(CC->logged_in) &&
56 (PostPublic == POST_LOGGED_IN)) {
57 snprintf(errmsgbuf, n, "Not logged in.");
58 return (ERROR + NOT_LOGGED_IN);
60 else if (PostPublic == CHECK_EXISTANCE) {
61 return (0); // We're Evaling whether a recipient exists
63 else if (!(CC->logged_in)) {
65 if ((CC->room.QRflags & QR_READONLY)) {
66 snprintf(errmsgbuf, n, "Not logged in.");
67 return (ERROR + NOT_LOGGED_IN);
69 if (CC->room.QRflags2 & QR2_MODERATED) {
70 snprintf(errmsgbuf, n, "Not logged in Moderation feature not yet implemented!");
71 return (ERROR + NOT_LOGGED_IN);
73 if ((PostPublic!=POST_LMTP) &&(CC->room.QRflags2 & QR2_SMTP_PUBLIC) == 0) {
75 return CtdlNetconfigCheckRoomaccess(errmsgbuf, n, RemoteIdentifier);
81 if ((CC->user.axlevel < AxProbU) && ((CC->room.QRflags & QR_MAILBOX) == 0))
83 snprintf(errmsgbuf, n, "Need to be validated to enter (except in %s> to sysop)", MAILROOM);
84 return (ERROR + HIGHER_ACCESS_REQUIRED);
87 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
89 if (ra & UA_POSTALLOWED) {
90 strcpy(errmsgbuf, "OK to post or reply here");
94 if ( (ra & UA_REPLYALLOWED) && (is_reply) ) {
96 * To be thorough, we ought to check to see if the message they are
97 * replying to is actually a valid one in this room, but unless this
98 * actually becomes a problem we'll go with high performance instead.
100 strcpy(errmsgbuf, "OK to reply here");
104 if ( (ra & UA_REPLYALLOWED) && (!is_reply) ) {
105 /* Clarify what happened with a better error message */
106 snprintf(errmsgbuf, n, "You may only reply to existing messages here.");
107 return (ERROR + HIGHER_ACCESS_REQUIRED);
110 snprintf(errmsgbuf, n, "Higher access is required to post in this room.");
111 return (ERROR + HIGHER_ACCESS_REQUIRED);
116 * Check whether the current user has permission to delete messages from
117 * the current room (returns 1 for yes, 0 for no)
119 int CtdlDoIHavePermissionToDeleteMessagesFromThisRoom(void) {
121 CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
122 if (ra & UA_DELETEALLOWED) return(1);
127 * Retrieve access control information for any user/room pair.
128 * Yes, it has a couple of gotos. If you don't like that, go die in a car fire.
130 void CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf,
131 int *result, int *view)
138 if (userbuf == &CC->user) {
142 if ((is_me) && (CtdlGetConfigInt("c_guest_logins")) && (!CC->logged_in)) {
146 /* for internal programs, always do everything */
147 if (((CC->internal_pgm)) && (roombuf->QRflags & QR_INUSE)) {
148 retval = (UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED);
150 goto SKIP_EVERYTHING;
153 /* If guest mode is enabled, always grant access to the Lobby */
154 if ((is_guest) && (!strcasecmp(roombuf->QRname, BASEROOM))) {
155 retval = (UA_KNOWN | UA_GOTOALLOWED);
157 goto SKIP_EVERYTHING;
160 /* Locate any applicable user/room relationships */
162 memset(&vbuf, 0, sizeof vbuf);
165 CtdlGetRelationship(&vbuf, userbuf, roombuf);
168 /* Force the properties of the Aide room */
169 if (!strcasecmp(roombuf->QRname, CtdlGetConfigStr("c_aideroom"))) {
170 if (userbuf->axlevel >= AxAideU) {
171 retval = UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
178 /* If this is a public room, it's accessible... */
179 if ( ((roombuf->QRflags & QR_PRIVATE) == 0)
180 && ((roombuf->QRflags & QR_MAILBOX) == 0)
182 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
185 /* If this is a preferred users only room, check access level */
186 if (roombuf->QRflags & QR_PREFONLY) {
187 if (userbuf->axlevel < AxPrefU) {
188 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED;
192 /* For private rooms, check the generation number matchups */
193 if ( (roombuf->QRflags & QR_PRIVATE)
194 && ((roombuf->QRflags & QR_MAILBOX) == 0)
197 /* An explicit match means the user belongs in this room */
198 if (vbuf.v_flags & V_ACCESS) {
199 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
201 /* Otherwise, check if this is a guess-name or passworded
202 * room. If it is, a goto may at least be attempted
204 else if ( (roombuf->QRflags & QR_PRIVATE)
205 || (roombuf->QRflags & QR_PASSWORDED)
207 retval = retval & ~UA_KNOWN;
208 retval = retval | UA_GOTOALLOWED;
212 /* For mailbox rooms, also check the namespace */
213 /* Also, mailbox owners can delete their messages */
214 if ( (roombuf->QRflags & QR_MAILBOX) && (atol(roombuf->QRname) != 0)) {
215 if (userbuf->usernum == atol(roombuf->QRname)) {
216 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
218 /* An explicit match means the user belongs in this room */
219 if (vbuf.v_flags & V_ACCESS) {
220 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_DELETEALLOWED | UA_REPLYALLOWED;
224 /* For non-mailbox rooms... */
227 /* User is allowed to post in the room unless:
228 * - User is not validated
229 * - User has no net privileges and it is a shared network room
230 * - It is a read-only room
231 * - It is a blog room (in which case we only allow replies to existing messages)
233 int post_allowed = 1;
234 int reply_allowed = 1;
235 if (userbuf->axlevel < AxProbU) {
239 if ((userbuf->axlevel < AxNetU) && (roombuf->QRflags & QR_NETWORK)) {
243 if (roombuf->QRflags & QR_READONLY) {
247 if (roombuf->QRdefaultview == VIEW_BLOG) {
251 retval = retval | UA_POSTALLOWED | UA_REPLYALLOWED;
254 retval = retval | UA_REPLYALLOWED;
257 /* If "collaborative deletion" is active for this room, any user who can post
258 * is also allowed to delete
260 if (roombuf->QRflags2 & QR2_COLLABDEL) {
261 if (retval & UA_POSTALLOWED) {
262 retval = retval | UA_DELETEALLOWED;
268 /* Check to see if the user has forgotten this room */
269 if (vbuf.v_flags & V_FORGET) {
270 retval = retval & ~UA_KNOWN;
271 if ( ( ((roombuf->QRflags & QR_PRIVATE) == 0)
272 && ((roombuf->QRflags & QR_MAILBOX) == 0)
273 ) || ( (roombuf->QRflags & QR_MAILBOX)
274 && (atol(roombuf->QRname) == CC->user.usernum))
276 retval = retval | UA_ZAPPED;
280 /* If user is explicitly locked out of this room, deny everything */
281 if (vbuf.v_flags & V_LOCKOUT) {
282 retval = retval & ~UA_KNOWN & ~UA_GOTOALLOWED & ~UA_POSTALLOWED & ~UA_REPLYALLOWED;
285 /* Aides get access to all private rooms */
286 if ( (userbuf->axlevel >= AxAideU)
287 && ((roombuf->QRflags & QR_MAILBOX) == 0)
289 if (vbuf.v_flags & V_FORGET) {
290 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
293 retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
297 /* Aides can gain access to mailboxes as well, but they don't show
300 if ( (userbuf->axlevel >= AxAideU)
301 && (roombuf->QRflags & QR_MAILBOX)
303 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
306 /* Aides and Room Aides have admin privileges */
307 if ( (userbuf->axlevel >= AxAideU)
308 || (userbuf->usernum == roombuf->QRroomaide)
310 retval = retval | UA_ADMINALLOWED | UA_DELETEALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
313 NEWMSG: /* By the way, we also check for the presence of new messages */
314 if (is_msg_in_sequence_set(vbuf.v_seen, roombuf->QRhighest) == 0) {
315 retval = retval | UA_HASNEWMSGS;
318 /* System rooms never show up in the list. */
319 if (roombuf->QRflags2 & QR2_SYSTEM) {
320 retval = retval & ~UA_KNOWN;
324 /* Now give the caller the information it wants. */
325 if (result != NULL) *result = retval;
326 if (view != NULL) *view = vbuf.v_view;
331 * Self-checking stuff for a room record read into memory
333 void room_sanity_check(struct ctdlroom *qrbuf)
335 /* Mailbox rooms are always on the lowest floor */
336 if (qrbuf->QRflags & QR_MAILBOX) {
339 /* Listing order of 0 is illegal except for base rooms */
340 if (qrbuf->QRorder == 0)
341 if ( !(qrbuf->QRflags & QR_MAILBOX)
342 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)
343 && strncasecmp(qrbuf->QRname, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)
351 * CtdlGetRoom() - retrieve room data from disk
353 int CtdlGetRoom(struct ctdlroom *qrbuf, const char *room_name)
355 struct cdbdata *cdbqr;
356 char lowercase_name[ROOMNAMELEN];
357 char personal_lowercase_name[ROOMNAMELEN];
361 dptr = lowercase_name;
363 eptr = (dptr + (sizeof lowercase_name - 1));
364 while (!IsEmptyStr(sptr) && (dptr < eptr)){
365 *dptr = tolower(*sptr);
370 memset(qrbuf, 0, sizeof(struct ctdlroom));
372 /* First, try the public namespace */
373 cdbqr = cdb_fetch(CDB_ROOMS,
374 lowercase_name, strlen(lowercase_name));
376 /* If that didn't work, try the user's personal namespace */
378 snprintf(personal_lowercase_name,
379 sizeof personal_lowercase_name, "%010ld.%s",
380 CC->user.usernum, lowercase_name);
381 cdbqr = cdb_fetch(CDB_ROOMS,
382 personal_lowercase_name,
383 strlen(personal_lowercase_name));
386 memcpy(qrbuf, cdbqr->ptr,
387 ((cdbqr->len > sizeof(struct ctdlroom)) ?
388 sizeof(struct ctdlroom) : cdbqr->len));
391 room_sanity_check(qrbuf);
401 * CtdlGetRoomLock() - same as getroom() but locks the record (if supported)
403 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name)
406 retval = CtdlGetRoom(qrbuf, room_name);
407 if (retval == 0) begin_critical_section(S_ROOMS);
413 * b_putroom() - back end to putroom() and b_deleteroom()
414 * (if the supplied buffer is NULL, delete the room record)
416 void b_putroom(struct ctdlroom *qrbuf, char *room_name)
418 char lowercase_name[ROOMNAMELEN];
423 bptr = lowercase_name;
424 while (!IsEmptyStr(aptr))
426 *bptr = tolower(*aptr);
432 len = bptr - lowercase_name;
434 cdb_delete(CDB_ROOMS, lowercase_name, len);
436 time(&qrbuf->QRmtime);
437 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
443 * CtdlPutRoom() - store room data to disk
445 void CtdlPutRoom(struct ctdlroom *qrbuf) {
446 b_putroom(qrbuf, qrbuf->QRname);
451 * b_deleteroom() - delete a room record from disk
453 void b_deleteroom(char *room_name) {
454 b_putroom(NULL, room_name);
459 * CtdlPutRoomLock() - same as CtdlPutRoom() but unlocks the record (if supported)
461 void CtdlPutRoomLock(struct ctdlroom *qrbuf)
464 end_critical_section(S_ROOMS);
469 * CtdlGetFloorByName() - retrieve the number of the named floor
470 * return < 0 if not found else return floor number
472 int CtdlGetFloorByName(const char *floor_name)
475 struct floor *flbuf = NULL;
477 for (a = 0; a < MAXFLOORS; ++a) {
478 flbuf = CtdlGetCachedFloor(a);
480 /* check to see if it already exists */
481 if ((!strcasecmp(flbuf->f_name, floor_name))
482 && (flbuf->f_flags & F_INUSE)) {
491 * CtdlGetFloorByNameLock() - retrieve floor number for given floor and lock the floor list.
493 int CtdlGetFloorByNameLock(const char *floor_name)
495 begin_critical_section(S_FLOORTAB);
496 return CtdlGetFloorByName(floor_name);
502 * CtdlGetAvailableFloor() - Return number of first unused floor
503 * return < 0 if none available
505 int CtdlGetAvailableFloor(void)
508 struct floor *flbuf = NULL;
510 for (a = 0; a < MAXFLOORS; a++) {
511 flbuf = CtdlGetCachedFloor(a);
513 /* check to see if it already exists */
514 if ((flbuf->f_flags & F_INUSE) == 0) {
523 * CtdlGetFloor() - retrieve floor data from disk
525 void CtdlGetFloor(struct floor *flbuf, int floor_num)
527 struct cdbdata *cdbfl;
529 memset(flbuf, 0, sizeof(struct floor));
530 cdbfl = cdb_fetch(CDB_FLOORTAB, &floor_num, sizeof(int));
532 memcpy(flbuf, cdbfl->ptr,
533 ((cdbfl->len > sizeof(struct floor)) ?
534 sizeof(struct floor) : cdbfl->len));
537 if (floor_num == 0) {
538 safestrncpy(flbuf->f_name, "Main Floor",
539 sizeof flbuf->f_name);
540 flbuf->f_flags = F_INUSE;
541 flbuf->f_ref_count = 3;
549 * lgetfloor() - same as CtdlGetFloor() but locks the record (if supported)
551 void lgetfloor(struct floor *flbuf, int floor_num)
553 begin_critical_section(S_FLOORTAB);
554 CtdlGetFloor(flbuf, floor_num);
559 * CtdlGetCachedFloor() - Get floor record from *cache* (loads from disk if needed)
561 * This is strictly a performance hack.
563 struct floor *CtdlGetCachedFloor(int floor_num) {
564 static int initialized = 0;
567 struct floor *fl = NULL;
569 begin_critical_section(S_FLOORCACHE);
570 if (initialized == 0) {
571 for (i=0; i<MAXFLOORS; ++i) {
572 floorcache[floor_num] = NULL;
576 if (floorcache[floor_num] == NULL) {
579 end_critical_section(S_FLOORCACHE);
582 fl = malloc(sizeof(struct floor));
583 CtdlGetFloor(fl, floor_num);
584 begin_critical_section(S_FLOORCACHE);
585 if (floorcache[floor_num] != NULL) {
586 free(floorcache[floor_num]);
588 floorcache[floor_num] = fl;
589 end_critical_section(S_FLOORCACHE);
592 return(floorcache[floor_num]);
597 * CtdlPutFloor() - store floor data on disk
599 void CtdlPutFloor(struct floor *flbuf, int floor_num)
601 /* If we've cached this, clear it out, 'cuz it's WRONG now! */
602 begin_critical_section(S_FLOORCACHE);
603 if (floorcache[floor_num] != NULL) {
604 free(floorcache[floor_num]);
605 floorcache[floor_num] = malloc(sizeof(struct floor));
606 memcpy(floorcache[floor_num], flbuf, sizeof(struct floor));
608 end_critical_section(S_FLOORCACHE);
610 cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
611 flbuf, sizeof(struct floor));
616 * CtdlPutFloorLock() - same as CtdlPutFloor() but unlocks the record (if supported)
618 void CtdlPutFloorLock(struct floor *flbuf, int floor_num)
620 CtdlPutFloor(flbuf, floor_num);
621 end_critical_section(S_FLOORTAB);
627 * lputfloor() - same as CtdlPutFloor() but unlocks the record (if supported)
629 void lputfloor(struct floor *flbuf, int floor_num)
631 CtdlPutFloorLock(flbuf, floor_num);
636 * Iterate through the room table, performing a callback for each room.
638 void CtdlForEachRoom(ForEachRoomCallBack CB, void *in_data)
640 struct ctdlroom qrbuf;
641 struct cdbdata *cdbqr;
643 cdb_rewind(CDB_ROOMS);
645 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
646 memset(&qrbuf, 0, sizeof(struct ctdlroom));
647 memcpy(&qrbuf, cdbqr->ptr,
648 ((cdbqr->len > sizeof(struct ctdlroom)) ?
649 sizeof(struct ctdlroom) : cdbqr->len)
652 room_sanity_check(&qrbuf);
653 if (qrbuf.QRflags & QR_INUSE) {
660 * Iterate through the room table, performing a callback for each room that has a netconfig entry.
662 void CtdlForEachNetCfgRoom(ForEachRoomNetCfgCallBack CB, void *in_data, RoomNetCfg filter)
664 struct ctdlroom qrbuf;
665 struct cdbdata *cdbqr;
667 cdb_rewind(CDB_ROOMS);
669 while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
670 memset(&qrbuf, 0, sizeof(struct ctdlroom));
671 memcpy(&qrbuf, cdbqr->ptr,
672 ((cdbqr->len > sizeof(struct ctdlroom)) ?
673 sizeof(struct ctdlroom) : cdbqr->len)
676 room_sanity_check(&qrbuf);
677 if (qrbuf.QRflags & QR_INUSE)
679 OneRoomNetCfg *RNCfg;
680 RNCfg = CtdlGetNetCfgForRoom(qrbuf.QRnumber);
681 if ((RNCfg != NULL) && ((filter == maxRoomNetCfg) || (RNCfg->NetConfigs[filter] != NULL)))
683 CB(&qrbuf, in_data, RNCfg);
684 FreeRoomNetworkStruct(&RNCfg);
692 * delete_msglist() - delete room message pointers
694 void delete_msglist(struct ctdlroom *whichroom)
696 struct cdbdata *cdbml;
698 /* Make sure the msglist we're deleting actually exists, otherwise
699 * libdb will complain when we try to delete an invalid record
701 cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
705 /* Go ahead and delete it */
706 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
712 * Message pointer compare function for sort_msglist()
714 int sort_msglist_cmp(const void *m1, const void *m2) {
715 if ((*(const long *)m1) > (*(const long *)m2)) return(1);
716 if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
722 * sort message pointers
723 * (returns new msg count)
725 int sort_msglist(long listptrs[], int oldcount)
736 qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp);
738 /* and yank any nulls */
739 while ((i < numitems) && (listptrs[i] == 0L)) i++;
743 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
752 * Determine whether a given room is non-editable.
754 int CtdlIsNonEditable(struct ctdlroom *qrbuf)
757 /* Mail> rooms are non-editable */
758 if ( (qrbuf->QRflags & QR_MAILBOX)
759 && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) )
762 /* Everything else is editable */
769 * Make the specified room the current room for this session. No validation
770 * or access control is done here -- the caller should make sure that the
771 * specified room exists and is ok to access.
773 void CtdlUserGoto(char *where, int display_result, int transiently,
774 int *retmsgs, int *retnew, long *retoldest, long *retnewest)
776 struct CitContext *CCC = CC;
778 int new_messages = 0;
779 int old_messages = 0;
780 int total_messages = 0;
781 long oldest_message = 0;
782 long newest_message = 0;
786 int newmailcount = 0;
788 char truncated_roomname[ROOMNAMELEN];
789 struct cdbdata *cdbfr;
790 long *msglist = NULL;
792 unsigned int original_v_flags;
795 char setstr[128], lostr[64], histr[64];
799 /* If the supplied room name is NULL, the caller wants us to know that
800 * it has already copied the room record into CC->room, so
801 * we can skip the extra database fetch.
804 safestrncpy(CCC->room.QRname, where, sizeof CCC->room.QRname);
805 CtdlGetRoom(&CCC->room, where);
808 /* Take care of all the formalities. */
810 begin_critical_section(S_USERS);
811 CtdlGetRelationship(&vbuf, &CCC->user, &CCC->room);
812 original_v_flags = vbuf.v_flags;
814 /* Know the room ... but not if it's the page log room, or if the
815 * caller specified that we're only entering this room transiently.
817 if ((strcasecmp(CCC->room.QRname, CtdlGetConfigStr("c_logpages"))) && (transiently == 0))
819 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
820 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
823 /* Only rewrite the database record if we changed something */
824 if (vbuf.v_flags != original_v_flags) {
825 CtdlSetRelationship(&vbuf, &CCC->user, &CCC->room);
827 end_critical_section(S_USERS);
829 /* Check for new mail */
830 newmailcount = NewMailCount();
832 /* set info to 1 if the user needs to read the room's info file */
833 if (CCC->room.QRinfo > vbuf.v_lastseen) {
837 cdbfr = cdb_fetch(CDB_MSGLISTS, &CCC->room.QRnumber, sizeof(long));
839 msglist = (long *) cdbfr->ptr;
840 cdbfr->ptr = NULL; /* CtdlUserGoto() now owns this memory */
841 num_msgs = cdbfr->len / sizeof(long);
846 for (a=0; a<num_msgs; ++a) {
847 if (msglist[a] > 0L) ++total_messages;
850 if (total_messages > 0) {
851 oldest_message = msglist[0];
852 newest_message = msglist[num_msgs - 1];
855 num_sets = num_tokens(vbuf.v_seen, ',');
856 for (s=0; s<num_sets; ++s) {
857 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
859 extract_token(lostr, setstr, 0, ':', sizeof lostr);
860 if (num_tokens(setstr, ':') >= 2) {
861 extract_token(histr, setstr, 1, ':', sizeof histr);
862 if (!strcmp(histr, "*")) {
863 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
867 strcpy(histr, lostr);
872 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
873 if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
879 new_messages = total_messages - old_messages;
881 if (msglist != NULL) free(msglist);
883 if (CCC->room.QRflags & QR_MAILBOX)
888 if ((CCC->room.QRroomaide == CCC->user.usernum)
889 || (CCC->user.axlevel >= AxAideU))
894 safestrncpy(truncated_roomname, CCC->room.QRname, sizeof truncated_roomname);
895 if ( (CCC->room.QRflags & QR_MAILBOX)
896 && (atol(CCC->room.QRname) == CCC->user.usernum) ) {
897 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
900 if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
904 if (retmsgs != NULL) *retmsgs = total_messages;
905 if (retnew != NULL) *retnew = new_messages;
906 if (retoldest != NULL) *retoldest = oldest_message;
907 if (retnewest != NULL) *retnewest = newest_message;
908 MSG_syslog(LOG_DEBUG, "<%s> %d new of %d total messages, oldest=%ld, newest=%ld",
909 CCC->room.QRname, new_messages, total_messages, oldest_message, newest_message
912 CCC->curr_view = (int)vbuf.v_view;
914 if (display_result) {
915 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
916 CIT_OK, CtdlCheckExpress(),
921 (int)CCC->room.QRflags,
922 (long)CCC->room.QRhighest,
923 (long)vbuf.v_lastseen,
927 (int)CCC->room.QRfloor,
929 (int)CCC->room.QRdefaultview,
931 (int)CCC->room.QRflags2,
932 (long)CCC->room.QRmtime
939 * Handle some of the macro named rooms
941 void convert_room_name_macros(char *towhere, size_t maxlen) {
942 if (!strcasecmp(towhere, "_BASEROOM_")) {
943 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
945 else if (!strcasecmp(towhere, "_MAIL_")) {
946 safestrncpy(towhere, MAILROOM, maxlen);
948 else if (!strcasecmp(towhere, "_TRASH_")) {
949 safestrncpy(towhere, USERTRASHROOM, maxlen);
951 else if (!strcasecmp(towhere, "_DRAFTS_")) {
952 safestrncpy(towhere, USERDRAFTROOM, maxlen);
954 else if (!strcasecmp(towhere, "_BITBUCKET_")) {
955 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
957 else if (!strcasecmp(towhere, "_CALENDAR_")) {
958 safestrncpy(towhere, USERCALENDARROOM, maxlen);
960 else if (!strcasecmp(towhere, "_TASKS_")) {
961 safestrncpy(towhere, USERTASKSROOM, maxlen);
963 else if (!strcasecmp(towhere, "_CONTACTS_")) {
964 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
966 else if (!strcasecmp(towhere, "_NOTES_")) {
967 safestrncpy(towhere, USERNOTESROOM, maxlen);
973 * Back end function to rename a room.
974 * You can also specify which floor to move the room to, or specify -1 to
975 * keep the room on the same floor it was on.
977 * If you are renaming a mailbox room, you must supply the namespace prefix
978 * in *at least* the old name!
980 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
982 struct ctdlroom qrbuf;
983 struct ctdlroom qrtmp;
988 char actual_old_name[ROOMNAMELEN];
990 syslog(LOG_DEBUG, "CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
992 if (new_floor >= 0) {
993 fl = CtdlGetCachedFloor(new_floor);
994 if ((fl->f_flags & F_INUSE) == 0) {
995 return(crr_invalid_floor);
999 begin_critical_section(S_ROOMS);
1001 if ( (CtdlGetRoom(&qrtmp, new_name) == 0)
1002 && (strcasecmp(new_name, old_name)) ) {
1003 ret = crr_already_exists;
1006 else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
1007 ret = crr_room_not_found;
1010 else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
1011 && (CC->user.usernum != qrbuf.QRroomaide)
1012 && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) ) {
1013 ret = crr_access_denied;
1016 else if (CtdlIsNonEditable(&qrbuf)) {
1017 ret = crr_noneditable;
1022 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
1023 if (qrbuf.QRflags & QR_MAILBOX) {
1024 owner = atol(qrbuf.QRname);
1026 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
1027 snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
1028 "%010ld.%s", owner, new_name);
1031 safestrncpy(qrbuf.QRname, new_name,
1032 sizeof(qrbuf.QRname));
1035 /* Reject change of floor for baseroom/aideroom */
1036 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
1037 !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
1042 /* Take care of floor stuff */
1043 old_floor = qrbuf.QRfloor;
1044 if (new_floor < 0) {
1045 new_floor = old_floor;
1047 qrbuf.QRfloor = new_floor;
1048 CtdlPutRoom(&qrbuf);
1050 begin_critical_section(S_CONFIG);
1052 /* If baseroom/aideroom name changes, update config */
1053 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
1054 CtdlSetConfigStr("c_baseroom", new_name);
1056 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
1057 CtdlSetConfigStr("c_aideroom", new_name);
1060 end_critical_section(S_CONFIG);
1062 /* If the room name changed, then there are now two room
1063 * records, so we have to delete the old one.
1065 if (strcasecmp(new_name, old_name)) {
1066 b_deleteroom(actual_old_name);
1072 end_critical_section(S_ROOMS);
1074 /* Adjust the floor reference counts if necessary */
1075 if (new_floor != old_floor) {
1076 lgetfloor(&flbuf, old_floor);
1077 --flbuf.f_ref_count;
1078 lputfloor(&flbuf, old_floor);
1079 syslog(LOG_DEBUG, "Reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
1080 lgetfloor(&flbuf, new_floor);
1081 ++flbuf.f_ref_count;
1082 lputfloor(&flbuf, new_floor);
1083 syslog(LOG_DEBUG, "Reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
1086 /* ...and everybody say "YATTA!" */
1092 * Asynchronously schedule a room for deletion. By placing the room into an invalid private namespace,
1093 * the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
1094 * database operations to complete. Instead, the room gets purged when THE DREADED AUTO-PURGER makes
1095 * its next run. Aren't we so clever?!!
1097 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf)
1099 char old_name[ROOMNAMELEN];
1102 syslog(LOG_NOTICE, "Scheduling room <%s> for deletion", qrbuf->QRname);
1104 safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
1105 CtdlGetRoom(qrbuf, qrbuf->QRname);
1107 /* Turn the room into a private mailbox owned by a user who doesn't
1108 * exist. This will immediately make the room invisible to everyone,
1109 * and qualify the room for purging.
1111 snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
1116 qrbuf->QRflags |= QR_MAILBOX;
1117 time(&qrbuf->QRgen); /* Use a timestamp as the new generation number */
1119 b_deleteroom(old_name);
1125 * Back end processing to delete a room and everything associated with it
1126 * (This one is synchronous and should only get called by THE DREADED
1127 * AUTO-PURGER in serv_expire.c. All user-facing code should call
1128 * the asynchronous schedule_room_for_deletion() instead.)
1130 void CtdlDeleteRoom(struct ctdlroom *qrbuf)
1133 char filename[PATH_MAX];
1134 char configdbkeyname[25];
1136 syslog(LOG_NOTICE, "Deleting room <%s>", qrbuf->QRname);
1138 /* Delete the info file */
1139 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_info_dir);
1142 /* Delete the image file */
1143 assoc_file_name(filename, sizeof filename, qrbuf, ctdl_image_dir);
1146 /* Delete the room's network configdb entry */
1147 netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
1148 CtdlDelConfig(configdbkeyname);
1150 /* Delete the messages in the room
1151 * (Careful: this opens an S_ROOMS critical section!)
1153 CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
1155 /* Flag the room record as not in use */
1156 CtdlGetRoomLock(qrbuf, qrbuf->QRname);
1158 CtdlPutRoomLock(qrbuf);
1160 /* then decrement the reference count for the floor */
1161 lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
1162 flbuf.f_ref_count = flbuf.f_ref_count - 1;
1163 lputfloor(&flbuf, (int) (qrbuf->QRfloor));
1165 /* Delete the room record from the database! */
1166 b_deleteroom(qrbuf->QRname);
1171 * Check access control for deleting a room
1173 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
1175 if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
1179 if (CtdlIsNonEditable(qr)) {
1184 * For mailboxes, check stuff
1186 if (qr->QRflags & QR_MAILBOX) {
1188 if (strlen(qr->QRname) < 12) return(0); /* bad name */
1190 if (atol(qr->QRname) != CC->user.usernum) {
1191 return(0); /* not my room */
1194 /* Can't delete your Mail> room */
1195 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1197 /* Otherwise it's ok */
1202 * For normal rooms, just check for admin or room admin status.
1204 return(is_room_aide());
1210 * Internal code to create a new room (returns room flags)
1212 * Room types: 0=public, 1=hidden, 2=passworded, 3=invitation-only,
1213 * 4=mailbox, 5=mailbox, but caller supplies namespace
1215 unsigned CtdlCreateRoom(char *new_room_name,
1217 char *new_room_pass,
1224 struct ctdlroom qrbuf;
1228 MARK_syslog(LOG_DEBUG, "CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1230 if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1231 MARK_syslog(LOG_DEBUG, "Cannot create room <%s> - already exists", new_room_name);
1235 memset(&qrbuf, 0, sizeof(struct ctdlroom));
1236 safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1237 qrbuf.QRflags = QR_INUSE;
1238 if (new_room_type > 0)
1239 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1240 if (new_room_type == 1)
1241 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1242 if (new_room_type == 2)
1243 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1244 if ( (new_room_type == 4) || (new_room_type == 5) ) {
1245 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1246 /* qrbuf.QRflags2 |= QR2_SUBJECTREQ; */
1249 /* If the user is requesting a personal room, set up the room
1250 * name accordingly (prepend the user number)
1252 if (new_room_type == 4) {
1253 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1256 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1259 /* If the room is private, and the system administrator has elected
1260 * to automatically grant room admin privileges, do so now.
1262 if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1263 qrbuf.QRroomaide = CC->user.usernum;
1265 /* Blog owners automatically become room admins of their blogs.
1266 * (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1268 else if (new_room_view == VIEW_BLOG) {
1269 qrbuf.QRroomaide = CC->user.usernum;
1271 /* Otherwise, set the room admin to undefined.
1274 qrbuf.QRroomaide = (-1L);
1278 * If the caller is only interested in testing whether this will work,
1279 * return now without creating the room.
1281 if (!really_create) return (qrbuf.QRflags);
1283 qrbuf.QRnumber = get_new_room_number();
1284 qrbuf.QRhighest = 0L; /* No messages in this room yet */
1285 time(&qrbuf.QRgen); /* Use a timestamp as the generation number */
1286 qrbuf.QRfloor = new_room_floor;
1287 qrbuf.QRdefaultview = new_room_view;
1289 /* save what we just did... */
1290 CtdlPutRoom(&qrbuf);
1292 /* bump the reference count on whatever floor the room is on */
1293 lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1294 flbuf.f_ref_count = flbuf.f_ref_count + 1;
1295 lputfloor(&flbuf, (int) qrbuf.QRfloor);
1297 /* Grant the creator access to the room unless the avoid_access
1298 * parameter was specified.
1300 if ( (CC->logged_in) && (avoid_access == 0) ) {
1301 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1302 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1303 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1304 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1307 /* resume our happy day */
1308 return (qrbuf.QRflags);