citadel/server/room_ops.c

   1 // Server functions which perform operations on room objects.
   2 //
   3 // Copyright (c) 1987-2023 by the citadel.org team
   4 //
   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.
   7
   8 #include <stdio.h>
   9 #include <libcitadel.h>
  10
  11 #include "citserver.h"
  12 #include "ctdl_module.h"
  13 #include "config.h"
  14 #include "control.h"
  15 #include "user_ops.h"
  16 #include "room_ops.h"
  17
  18 struct floor *floorcache[MAXFLOORS];
  19
  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"))
  26         ) {
  27                 return(om_not_logged_in);
  28         }
  29         return(om_ok);
  30 }
  31
  32
  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) {
  37         int ra;
  38
  39         if (!(CC->logged_in) && (PostPublic == POST_LOGGED_IN)) {
  40                 snprintf(errmsgbuf, n, "Not logged in.");
  41                 return (ERROR + NOT_LOGGED_IN);
  42         }
  43         else if (PostPublic == CHECK_EXIST) {
  44                 return (0);                                     // evaluate whether a recipient exists
  45         }
  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);
  50                 }
  51                 return (0);
  52         }
  53
  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);
  57         }
  58
  59         CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
  60
  61         if (ra & UA_POSTALLOWED) {
  62                 strcpy(errmsgbuf, "OK to post or reply here");
  63                 return(0);
  64         }
  65
  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");
  71                 return(0);
  72         }
  73
  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);
  78         }
  79
  80         snprintf(errmsgbuf, n, "Higher access is required to post in this room.");
  81         return (ERROR + HIGHER_ACCESS_REQUIRED);
  82
  83 }
  84
  85
  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) {
  89         int ra;
  90         CtdlRoomAccess(&CC->room, &CC->user, &ra, NULL);
  91         if (ra & UA_DELETEALLOWED) return(1);
  92         return(0);
  93 }
  94
  95
  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) {
  99         int retval = 0;
 100         struct visit vbuf;
 101         int is_me = 0;
 102         int is_guest = 0;
 103
 104         if (userbuf == &CC->user) {
 105                 is_me = 1;
 106         }
 107
 108         if ((is_me) && (CtdlGetConfigInt("c_guest_logins")) && (!CC->logged_in)) {
 109                 is_guest = 1;
 110         }
 111
 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);
 115                 vbuf.v_view = 0;
 116                 goto SKIP_EVERYTHING;
 117         }
 118
 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);
 122                 vbuf.v_view = 0;
 123                 goto SKIP_EVERYTHING;
 124         }
 125
 126         // Locate any applicable user/room relationships
 127         if (is_guest) {
 128                 memset(&vbuf, 0, sizeof vbuf);
 129         }
 130         else {
 131                 CtdlGetRelationship(&vbuf, userbuf, roombuf);
 132         }
 133
 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;
 138                 }
 139                 else {
 140                         retval = 0;
 141                 }
 142                 goto NEWMSG;
 143         }
 144
 145         // If this is a public room, it's accessible...
 146         if (    ((roombuf->QRflags & QR_PRIVATE) == 0)
 147                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
 148         ) {
 149                 retval = retval | UA_KNOWN | UA_GOTOALLOWED;
 150         }
 151
 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;
 156                 }
 157         }
 158
 159         // For private rooms, check the generation number matchups
 160         if (    (roombuf->QRflags & QR_PRIVATE)
 161                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
 162         ) {
 163
 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;
 167                 }
 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)
 172                 ) {
 173                         retval = retval & ~UA_KNOWN;
 174                         retval = retval | UA_GOTOALLOWED;
 175                 }
 176         }
 177
 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;
 182                 }
 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;
 186                 }
 187         }
 188
 189         // For non-mailbox rooms...
 190         else {
 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) {
 198                         post_allowed = 0;
 199                         reply_allowed = 0;
 200                 }
 201                 if (roombuf->QRflags & QR_READONLY) {
 202                         post_allowed = 0;
 203                         reply_allowed = 0;
 204                 }
 205                 if (roombuf->QRdefaultview == VIEW_BLOG) {
 206                         post_allowed = 0;
 207                 }
 208                 if (post_allowed) {
 209                         retval = retval | UA_POSTALLOWED | UA_REPLYALLOWED;
 210                 }
 211                 if (reply_allowed) {
 212                         retval = retval | UA_REPLYALLOWED;
 213                 }
 214
 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;
 220                         }
 221                 }
 222
 223         }
 224
 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))
 232                 ) {
 233                         retval = retval | UA_ZAPPED;
 234                 }
 235         }
 236
 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;
 240         }
 241
 242         // Aides get access to all private rooms
 243         if (    (userbuf->axlevel >= AxAideU)
 244                 && ((roombuf->QRflags & QR_MAILBOX) == 0)
 245         ) {
 246                 if (vbuf.v_flags & V_FORGET) {
 247                         retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
 248                 }
 249                 else {
 250                         retval = retval | UA_KNOWN | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
 251                 }
 252         }
 253
 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)
 257         ) {
 258                 retval = retval | UA_GOTOALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
 259         }
 260
 261         // Aides and Room Aides have admin privileges
 262         if (    (userbuf->axlevel >= AxAideU)
 263                 || (userbuf->usernum == roombuf->QRroomaide)
 264         ) {
 265                 retval = retval | UA_ADMINALLOWED | UA_DELETEALLOWED | UA_POSTALLOWED | UA_REPLYALLOWED;
 266         }
 267
 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;
 271         }
 272
 273         // System rooms never show up in the list.
 274         if (roombuf->QRflags2 & QR2_SYSTEM) {
 275                 retval = retval & ~UA_KNOWN;
 276         }
 277
 278 SKIP_EVERYTHING:
 279         // Now give the caller the information it wants.
 280         if (result != NULL) *result = retval;
 281         if (view != NULL) *view = vbuf.v_view;
 282 }
 283
 284
 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) {
 289                 qrbuf->QRfloor = 0;
 290         }
 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)
 296                 ) {
 297                         qrbuf->QRorder = 64;
 298                 }
 299         }
 300 }
 301
 302
 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];
 308         long len;
 309
 310         len = strlen(room_name);
 311         for (int i=0; i<=len; ++i) {
 312                 lowercase_name[i] = tolower(room_name[i]);
 313         }
 314
 315         memset(qrbuf, 0, sizeof(struct ctdlroom));
 316
 317         if (IsEmptyStr(lowercase_name)) {
 318                 return(1);                      // empty room name , not valid
 319         }
 320
 321         // First, try the public namespace
 322         cdbqr = cdb_fetch(CDB_ROOMS, lowercase_name, strlen(lowercase_name));
 323
 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));
 328         }
 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);
 332                 return (0);
 333         }
 334         else {
 335                 return (1);
 336         }
 337 }
 338
 339
 340 // CtdlGetRoomLock()  -  same as getroom() but locks the record (if supported)
 341 int CtdlGetRoomLock(struct ctdlroom *qrbuf, const char *room_name) {
 342         register int retval;
 343         retval = CtdlGetRoom(qrbuf, room_name);
 344         if (retval == 0) begin_critical_section(S_ROOMS);
 345         return(retval);
 346 }
 347
 348
 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];
 353         long len;
 354
 355         len = strlen(room_name);
 356         for (int i=0; i<=len; ++i) {
 357                 lowercase_name[i] = tolower(room_name[i]);
 358         }
 359
 360         if (qrbuf == NULL) {
 361                 cdb_delete(CDB_ROOMS, lowercase_name, len);
 362         }
 363         else {
 364                 time(&qrbuf->QRmtime);
 365                 cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
 366         }
 367 }
 368
 369
 370 // CtdlPutRoom()  -  store room data to disk
 371 void CtdlPutRoom(struct ctdlroom *qrbuf) {
 372         b_putroom(qrbuf, qrbuf->QRname);
 373 }
 374
 375
 376 // b_deleteroom()  -  delete a room record from disk
 377 void b_deleteroom(char *room_name) {
 378         b_putroom(NULL, room_name);
 379 }
 380
 381
 382 // CtdlPutRoomLock()  -  same as CtdlPutRoom() but unlocks the record (if supported)
 383 void CtdlPutRoomLock(struct ctdlroom *qrbuf) {
 384         CtdlPutRoom(qrbuf);
 385         end_critical_section(S_ROOMS);
 386 }
 387
 388
 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) {
 392         int a;
 393         struct floor *flbuf = NULL;
 394
 395         for (a = 0; a < MAXFLOORS; ++a) {
 396                 flbuf = CtdlGetCachedFloor(a);
 397
 398                 // check to see if it already exists
 399                 if ((!strcasecmp(flbuf->f_name, floor_name)) && (flbuf->f_flags & F_INUSE)) {
 400                         return a;
 401                 }
 402         }
 403         return -1;
 404 }
 405
 406
 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);
 411 }
 412
 413
 414 // CtdlGetAvailableFloor()  -  Return number of first unused floor
 415 // return < 0 if none available
 416 int CtdlGetAvailableFloor(void) {
 417         int a;
 418         struct floor *flbuf = NULL;
 419
 420         for (a = 0; a < MAXFLOORS; a++) {
 421                 flbuf = CtdlGetCachedFloor(a);
 422
 423                 // check to see if it already exists
 424                 if ((flbuf->f_flags & F_INUSE) == 0) {
 425                         return a;
 426                 }
 427         }
 428         return -1;
 429 }
 430
 431
 432 // CtdlGetFloor()  -  retrieve floor data from disk
 433 void CtdlGetFloor(struct floor *flbuf, int floor_num) {
 434         struct cdbdata cdbfl;
 435
 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));
 440         }
 441         else {
 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;
 446                 }
 447         }
 448 }
 449
 450
 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);
 455 }
 456
 457
 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;
 462         int i;
 463         int fetch_new = 0;
 464         struct floor *fl = NULL;
 465
 466         begin_critical_section(S_FLOORCACHE);
 467         if (initialized == 0) {
 468                 for (i=0; i<MAXFLOORS; ++i) {
 469                         floorcache[floor_num] = NULL;
 470                 }
 471         initialized = 1;
 472         }
 473         if (floorcache[floor_num] == NULL) {
 474                 fetch_new = 1;
 475         }
 476         end_critical_section(S_FLOORCACHE);
 477
 478         if (fetch_new) {
 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]);
 484                 }
 485                 floorcache[floor_num] = fl;
 486                 end_critical_section(S_FLOORCACHE);
 487         }
 488
 489         return(floorcache[floor_num]);
 490 }
 491
 492
 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));
 501         }
 502         end_critical_section(S_FLOORCACHE);
 503
 504         cdb_store(CDB_FLOORTAB, &floor_num, sizeof(int),
 505                   flbuf, sizeof(struct floor));
 506 }
 507
 508
 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);
 513
 514 }
 515
 516
 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);
 520 }
 521
 522
 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;
 527
 528         cdb_rewind(CDB_ROOMS);
 529
 530         while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr.val.ptr!=NULL) {
 531                 memset(&qrbuf, 0, sizeof(struct ctdlroom));
 532                 memcpy(&qrbuf, cdbqr.val.ptr, ((cdbqr.val.len > sizeof(struct ctdlroom)) ?  sizeof(struct ctdlroom) : cdbqr.val.len) );
 533                 room_sanity_check(&qrbuf);
 534                 if (qrbuf.QRflags & QR_INUSE) {
 535                         callback_func(&qrbuf, in_data);
 536                 }
 537         }
 538 }
 539
 540
 541 // delete_msglist()  -  delete room message pointers
 542 void delete_msglist(struct ctdlroom *whichroom) {
 543         struct cdbdata cdbml;
 544
 545         // Make sure the msglist we're deleting actually exists; don't try to delete an invalid record
 546         cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
 547         if (cdbml.ptr != NULL) {
 548                 // ok it exists, go ahead and delete it
 549                 cdb_delete(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
 550         }
 551 }
 552
 553
 554 // Message pointer compare function for sort_msglist()
 555 int sort_msglist_cmp(const void *m1, const void *m2) {
 556         if ((*(const long *)m1) > (*(const long *)m2)) return(1);
 557         if ((*(const long *)m1) < (*(const long *)m2)) return(-1);
 558         return(0);
 559 }
 560
 561
 562 // sort message pointers
 563 // (returns new msg count)
 564 int sort_msglist(long listptrs[], int oldcount) {
 565         int numitems;
 566         int i = 0;
 567
 568         numitems = oldcount;
 569         if (numitems < 2) {                                                     // an empty or 1-item list needs no sorting
 570                 return (oldcount);
 571         }
 572
 573         qsort(listptrs, numitems, sizeof(long), sort_msglist_cmp);              // do the sort
 574
 575         while ((i < numitems) && (listptrs[i] == 0L)) i++;                      // yank out any nulls
 576         if (i > 0) {
 577                 memmove(&listptrs[0], &listptrs[i], (sizeof(long) * (numitems - i)));
 578                 numitems-=i;
 579         }
 580
 581         return (numitems);
 582 }
 583
 584
 585 // Determine whether a given room is non-editable.
 586 int CtdlIsNonEditable(struct ctdlroom *qrbuf) {
 587
 588         // The inbox cannot be edited
 589         if ( (qrbuf->QRflags & QR_MAILBOX) && (!strcasecmp(&qrbuf->QRname[11], MAILROOM)) ) {
 590                 return (1);
 591         }
 592
 593         // Everything else is editable
 594         return (0);
 595 }
 596
 597
 598 // Retrieve a list of all messages (message numbers) in the specified room.
 599 // Returns the number of messages in the room, allocates a pointer to the array and stuffs it in the supplied location.
 600 // Caller must free that memory.
 601 // If no messages in room, returns 0 and msgs is set to NULL.
 602 int CtdlFetchMsgList(long roomnum, long **msgs) {
 603         int num_msgs = 0;
 604         struct cdbdata cdbfr;
 605
 606         cdbfr = cdb_fetch(CDB_MSGLISTS, &roomnum, sizeof(long));
 607         if (cdbfr.ptr == NULL) {
 608                 syslog(LOG_ERR, "room_ops: no msglist for room %ld", roomnum);
 609                 *msgs = malloc(sizeof(long));   // dummy buffer
 610                 *msgs[0] = 0;
 611                 return (0);
 612         }
 613
 614         num_msgs = cdbfr.len / sizeof(long);
 615         if (num_msgs > 0) {
 616                 *msgs = malloc(cdbfr.len);
 617                 memcpy(*msgs, cdbfr.ptr, cdbfr.len);
 618         }
 619         else {
 620                 *msgs = NULL;
 621         }
 622         return(num_msgs);
 623 }
 624
 625
 626 // Make the specified room the current room for this session.  No validation
 627 // or access control is done here -- the caller should make sure that the
 628 // specified room exists and is ok to access.
 629 void CtdlUserGoto(char *where, int display_result, int transiently, int *retmsgs, int *retnew, long *retoldest, long *retnewest) {
 630         int a;
 631         int new_messages = 0;
 632         int old_messages = 0;
 633         int total_messages = 0;
 634         long oldest_message = 0;
 635         long newest_message = 0;
 636         int info = 0;
 637         int rmailflag;
 638         int raideflag;
 639         struct visit vbuf;
 640         char truncated_roomname[ROOMNAMELEN];
 641         long *msglist = NULL;
 642         int num_msgs = 0;
 643         unsigned int original_v_flags;
 644         int num_sets;
 645         int s;
 646         char setstr[128], lostr[64], histr[64];
 647         long lo, hi;
 648         int is_trash = 0;
 649
 650         // If the supplied room name is NULL, the caller wants us to know that
 651         // it has already copied the room record into CC->room, so
 652         // we can skip the extra database fetch.
 653         if (where != NULL) {
 654                 safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
 655                 CtdlGetRoom(&CC->room, where);
 656         }
 657
 658         // Take care of all the formalities.
 659
 660         begin_critical_section(S_USERS);
 661         CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
 662         original_v_flags = vbuf.v_flags;
 663
 664         // Know the room ... but not if it's the page log room, or if the
 665         // caller specified that we're only entering this room transiently.
 666         int add_room_to_known_list = 1;
 667         if (transiently == 1) {
 668                 add_room_to_known_list = 0;
 669         }
 670         char *c_logpages = CtdlGetConfigStr("c_logpages");
 671         if ( (c_logpages != NULL) && (!strcasecmp(CC->room.QRname, c_logpages)) ) {
 672                 add_room_to_known_list = 0;
 673         }
 674         if (add_room_to_known_list) {
 675                 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
 676                 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
 677         }
 678
 679         // Only rewrite the database record if we changed something
 680         if (vbuf.v_flags != original_v_flags) {
 681                 CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
 682         }
 683         end_critical_section(S_USERS);
 684
 685         // Set info to 1 if the room banner is new since our last visit.
 686         // Some clients only want to display it when it changes.
 687         if (CC->room.msgnum_info > vbuf.v_lastseen) {
 688                 info = 1;
 689         }
 690
 691         num_msgs = CtdlFetchMsgList(CC->room.QRnumber, &msglist);
 692
 693         total_messages = 0;
 694         for (a=0; a<num_msgs; ++a) {
 695                 if (msglist[a] > 0L) ++total_messages;
 696         }
 697
 698         if (total_messages > 0) {
 699                 oldest_message = msglist[0];
 700                 newest_message = msglist[num_msgs - 1];
 701         }
 702
 703         num_sets = num_tokens(vbuf.v_seen, ',');
 704         for (s=0; s<num_sets; ++s) {
 705                 extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
 706
 707                 extract_token(lostr, setstr, 0, ':', sizeof lostr);
 708                 if (num_tokens(setstr, ':') >= 2) {
 709                         extract_token(histr, setstr, 1, ':', sizeof histr);
 710                         if (!strcmp(histr, "*")) {
 711                                 snprintf(histr, sizeof histr, "%ld", LONG_MAX);
 712                         }
 713                 }
 714                 else {
 715                         strcpy(histr, lostr);
 716                 }
 717                 lo = atol(lostr);
 718                 hi = atol(histr);
 719
 720                 for (a=0; a<num_msgs; ++a) if (msglist[a] > 0L) {
 721                         if ((msglist[a] >= lo) && (msglist[a] <= hi)) {
 722                                 ++old_messages;
 723                                 msglist[a] = 0L;
 724                         }
 725                 }
 726         }
 727         new_messages = total_messages - old_messages;
 728
 729         if (msglist != NULL) free(msglist);
 730
 731         if (CC->room.QRflags & QR_MAILBOX)
 732                 rmailflag = 1;
 733         else
 734                 rmailflag = 0;
 735
 736         if ((CC->room.QRroomaide == CC->user.usernum) || (CC->user.axlevel >= AxAideU))
 737                 raideflag = 1;
 738         else
 739                 raideflag = 0;
 740
 741         safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
 742         if ( (CC->room.QRflags & QR_MAILBOX) && (atol(CC->room.QRname) == CC->user.usernum) ) {
 743                 safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
 744         }
 745
 746         if (!strcasecmp(truncated_roomname, USERTRASHROOM)) {
 747                 is_trash = 1;
 748         }
 749
 750         if (retmsgs != NULL) *retmsgs = total_messages;
 751         if (retnew != NULL) *retnew = new_messages;
 752         if (retoldest != NULL) *retoldest = oldest_message;
 753         if (retnewest != NULL) *retnewest = newest_message;
 754         syslog(LOG_DEBUG, "room_ops: %s : %d new of %d total messages, oldest=%ld, newest=%ld",
 755                    CC->room.QRname, new_messages, total_messages, oldest_message, newest_message
 756         );
 757
 758         CC->curr_view = (int)vbuf.v_view;
 759
 760         if (display_result) {
 761                 cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
 762                         CIT_OK, CtdlCheckExpress(),
 763                         truncated_roomname,
 764                         (int)new_messages,
 765                         (int)total_messages,
 766                         (int)info,
 767                         (int)CC->room.QRflags,
 768                         (long)CC->room.QRhighest,
 769                         (long)vbuf.v_lastseen,
 770                         (int)rmailflag,
 771                         (int)raideflag,
 772                         0,                                      // new mail is no longer counted here
 773                         (int)CC->room.QRfloor,
 774                         (int)vbuf.v_view,
 775                         (int)CC->room.QRdefaultview,
 776                         (int)is_trash,
 777                         (int)CC->room.QRflags2,
 778                         (long)CC->room.QRmtime
 779                 );
 780         }
 781 }
 782
 783
 784 // Handle some of the macro named rooms
 785 void convert_room_name_macros(char *towhere, size_t maxlen) {
 786         if (!strcasecmp(towhere, "_BASEROOM_")) {
 787                 safestrncpy(towhere, CtdlGetConfigStr("c_baseroom"), maxlen);
 788         }
 789         else if (!strcasecmp(towhere, "_MAIL_")) {
 790                 safestrncpy(towhere, MAILROOM, maxlen);
 791         }
 792         else if (!strcasecmp(towhere, "_TRASH_")) {
 793                 safestrncpy(towhere, USERTRASHROOM, maxlen);
 794         }
 795         else if (!strcasecmp(towhere, "_DRAFTS_")) {
 796                 safestrncpy(towhere, USERDRAFTROOM, maxlen);
 797         }
 798         else if (!strcasecmp(towhere, "_BITBUCKET_")) {
 799                 safestrncpy(towhere, CtdlGetConfigStr("c_twitroom"), maxlen);
 800         }
 801         else if (!strcasecmp(towhere, "_CALENDAR_")) {
 802                 safestrncpy(towhere, USERCALENDARROOM, maxlen);
 803         }
 804         else if (!strcasecmp(towhere, "_TASKS_")) {
 805                 safestrncpy(towhere, USERTASKSROOM, maxlen);
 806         }
 807         else if (!strcasecmp(towhere, "_CONTACTS_")) {
 808                 safestrncpy(towhere, USERCONTACTSROOM, maxlen);
 809         }
 810         else if (!strcasecmp(towhere, "_NOTES_")) {
 811                 safestrncpy(towhere, USERNOTESROOM, maxlen);
 812         }
 813 }
 814
 815
 816 // Back end function to rename a room.
 817 // You can also specify which floor to move the room to, or specify -1 to
 818 // keep the room on the same floor it was on.
 819 //
 820 // If you are renaming a mailbox room, you must supply the namespace prefix
 821 // in *at least* the old name!
 822 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
 823         int old_floor = 0;
 824         struct ctdlroom qrbuf;
 825         struct ctdlroom qrtmp;
 826         int ret = 0;
 827         struct floor *fl;
 828         struct floor flbuf;
 829         long owner = 0L;
 830         char actual_old_name[ROOMNAMELEN];
 831
 832         syslog(LOG_DEBUG, "room_ops: CtdlRenameRoom(%s, %s, %d)", old_name, new_name, new_floor);
 833
 834         if (new_floor >= 0) {
 835                 fl = CtdlGetCachedFloor(new_floor);
 836                 if ((fl->f_flags & F_INUSE) == 0) {
 837                         return(crr_invalid_floor);
 838                 }
 839         }
 840
 841         begin_critical_section(S_ROOMS);
 842
 843         if ( (CtdlGetRoom(&qrtmp, new_name) == 0) && (strcasecmp(new_name, old_name)) ) {
 844                 ret = crr_already_exists;
 845         }
 846
 847         else if (CtdlGetRoom(&qrbuf, old_name) != 0) {
 848                 ret = crr_room_not_found;
 849         }
 850
 851         else if ( (CC->user.axlevel < AxAideU) && (!CC->internal_pgm)
 852                   && (CC->user.usernum != qrbuf.QRroomaide)
 853                   && ( (((qrbuf.QRflags & QR_MAILBOX) == 0) || (atol(qrbuf.QRname) != CC->user.usernum))) )  {
 854                 ret = crr_access_denied;
 855         }
 856
 857         else if (CtdlIsNonEditable(&qrbuf)) {
 858                 ret = crr_noneditable;
 859         }
 860
 861         else {
 862                 // Rename it
 863                 safestrncpy(actual_old_name, qrbuf.QRname, sizeof actual_old_name);
 864                 if (qrbuf.QRflags & QR_MAILBOX) {
 865                         owner = atol(qrbuf.QRname);
 866                 }
 867                 if ( (owner > 0L) && (atol(new_name) == 0L) ) {
 868                         snprintf(qrbuf.QRname, sizeof(qrbuf.QRname),
 869                                         "%010ld.%s", owner, new_name);
 870                 }
 871                 else {
 872                         safestrncpy(qrbuf.QRname, new_name,
 873                                                 sizeof(qrbuf.QRname));
 874                 }
 875
 876                 // Reject change of floor for baseroom/aideroom
 877                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN) ||
 878                     !strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN))
 879                 {
 880                         new_floor = 0;
 881                 }
 882
 883                 // Take care of floor stuff
 884                 old_floor = qrbuf.QRfloor;
 885                 if (new_floor < 0) {
 886                         new_floor = old_floor;
 887                 }
 888                 qrbuf.QRfloor = new_floor;
 889                 CtdlPutRoom(&qrbuf);
 890
 891                 begin_critical_section(S_CONFIG);
 892
 893                 // If baseroom/aideroom name changes, update config
 894                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_baseroom"), ROOMNAMELEN)) {
 895                         CtdlSetConfigStr("c_baseroom", new_name);
 896                 }
 897                 if (!strncasecmp(old_name, CtdlGetConfigStr("c_aideroom"), ROOMNAMELEN)) {
 898                         CtdlSetConfigStr("c_aideroom", new_name);
 899                 }
 900
 901                 end_critical_section(S_CONFIG);
 902
 903                 // If the room name changed, then there are now two room
 904                 // records, so we have to delete the old one.
 905                 if (strcasecmp(new_name, old_name)) {
 906                         b_deleteroom(actual_old_name);
 907                 }
 908
 909                 ret = crr_ok;
 910         }
 911
 912         end_critical_section(S_ROOMS);
 913
 914         // Adjust the floor reference counts if necessary
 915         if (new_floor != old_floor) {
 916                 lgetfloor(&flbuf, old_floor);
 917                 --flbuf.f_ref_count;
 918                 lputfloor(&flbuf, old_floor);
 919                 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", old_floor, flbuf.f_ref_count);
 920                 lgetfloor(&flbuf, new_floor);
 921                 ++flbuf.f_ref_count;
 922                 lputfloor(&flbuf, new_floor);
 923                 syslog(LOG_DEBUG, "room_ops: reference count for floor %d is now %d", new_floor, flbuf.f_ref_count);
 924         }
 925
 926         // ...and everybody say "YATTA!"
 927         return(ret);
 928 }
 929
 930
 931 // Asynchronously schedule a room for deletion.  By placing the room into an invalid private namespace,
 932 // the room will appear deleted to the user(s), but the session doesn't need to block while waiting for
 933 // database operations to complete.  Instead, the room gets purged when THE DREADED AUTO-PURGER makes
 934 // its next run.  Aren't we so clever?!!
 935 void CtdlScheduleRoomForDeletion(struct ctdlroom *qrbuf) {
 936         char old_name[ROOMNAMELEN];
 937         static int seq = 0;
 938
 939         syslog(LOG_NOTICE, "room_ops: scheduling room <%s> for deletion", qrbuf->QRname);
 940
 941         safestrncpy(old_name, qrbuf->QRname, sizeof old_name);
 942         CtdlGetRoom(qrbuf, qrbuf->QRname);
 943
 944         // Move the room into a hidden namespace owned by a non-existent user.
 945         // This will make the room invisible to everyone.
 946         // It will also qualify it for removal during the next purge cycle.
 947         snprintf(qrbuf->QRname, sizeof qrbuf->QRname, "9999999999.%08lx.%04d.%s",
 948                 time(NULL),
 949                 ++seq,
 950                 old_name
 951         );
 952         qrbuf->QRflags |= QR_MAILBOX;
 953         time(&qrbuf->QRgen);    // Use a timestamp as the new generation number
 954         CtdlPutRoom(qrbuf);
 955         b_deleteroom(old_name);
 956 }
 957
 958
 959 // Back end processing to delete a room and everything associated with it
 960 // (This one is synchronous and should only get called by THE DREADED
 961 // AUTO-PURGER in serv_expire.c.  All user-facing code should call
 962 // the asynchronous schedule_room_for_deletion() instead.)
 963 void CtdlDeleteRoom(struct ctdlroom *qrbuf) {
 964         struct floor flbuf;
 965         char configdbkeyname[25];
 966
 967         syslog(LOG_NOTICE, "room_ops: deleting room <%s>", qrbuf->QRname);
 968
 969         // Delete the room's network configdb entry
 970         netcfg_keyname(configdbkeyname, qrbuf->QRnumber);
 971         CtdlDelConfig(configdbkeyname);
 972
 973         // Delete the messages in the room
 974         // (Careful: this opens an S_ROOMS critical section!)
 975         CtdlDeleteMessages(qrbuf->QRname, NULL, 0, "");
 976
 977         // Flag the room record as not in use
 978         CtdlGetRoomLock(qrbuf, qrbuf->QRname);
 979         qrbuf->QRflags = 0;
 980         CtdlPutRoomLock(qrbuf);
 981
 982         // then decrement the reference count for the floor
 983         lgetfloor(&flbuf, (int) (qrbuf->QRfloor));
 984         flbuf.f_ref_count = flbuf.f_ref_count - 1;
 985         lputfloor(&flbuf, (int) (qrbuf->QRfloor));
 986
 987         // Delete the room record from the database!
 988         b_deleteroom(qrbuf->QRname);
 989 }
 990
 991
 992 // Check access control for deleting a room
 993 int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
 994
 995         if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
 996                 return(0);
 997         }
 998
 999         if (CtdlIsNonEditable(qr)) {
1000                 return(0);
1001         }
1002
1003         // For mailboxes, check stuff
1004         if (qr->QRflags & QR_MAILBOX) {
1005
1006                 if (strlen(qr->QRname) < 12) return(0); // bad name
1007
1008                 if (atol(qr->QRname) != CC->user.usernum) {
1009                         return(0);                      // not my room
1010                 }
1011
1012                 // Can't delete your own inbox
1013                 if (!strcasecmp(&qr->QRname[11], MAILROOM)) return(0);
1014
1015                 // Otherwise it's ok
1016                 return(1);
1017         }
1018
1019         // For normal rooms, just check for admin or room admin status.
1020         return(is_room_aide());
1021 }
1022
1023
1024 // Internal code to create a new room (returns room flags)
1025 //
1026 // Room types:  0=public, 1=hidden, 2=passworded, 3=invitation-only,
1027 //              4=mailbox, 5=mailbox, but caller supplies namespace
1028 unsigned CtdlCreateRoom(char *new_room_name,
1029                      int new_room_type,
1030                      char *new_room_pass,
1031                      int new_room_floor,
1032                      int really_create,
1033                      int avoid_access,
1034                      int new_room_view)
1035 {
1036         struct ctdlroom qrbuf;
1037         struct floor flbuf;
1038         struct visit vbuf;
1039
1040         syslog(LOG_DEBUG, "room_ops: CtdlCreateRoom(name=%s, type=%d, view=%d)", new_room_name, new_room_type, new_room_view);
1041
1042         if (CtdlGetRoom(&qrbuf, new_room_name) == 0) {
1043                 syslog(LOG_DEBUG, "room_ops: cannot create room <%s> - already exists", new_room_name);
1044                 return(0);
1045         }
1046
1047         memset(&qrbuf, 0, sizeof(struct ctdlroom));
1048         safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
1049         qrbuf.QRflags = QR_INUSE;
1050         if (new_room_type > 0)
1051                 qrbuf.QRflags = (qrbuf.QRflags | QR_PRIVATE);
1052         if (new_room_type == 1)
1053                 qrbuf.QRflags = (qrbuf.QRflags | QR_GUESSNAME);
1054         if (new_room_type == 2)
1055                 qrbuf.QRflags = (qrbuf.QRflags | QR_PASSWORDED);
1056         if ( (new_room_type == 4) || (new_room_type == 5) ) {
1057                 qrbuf.QRflags = (qrbuf.QRflags | QR_MAILBOX);
1058                 // qrbuf.QRflags2 |= QR2_SUBJECTREQ;
1059         }
1060
1061         // If the user is requesting a personal room, set up the room
1062         // name accordingly (prepend the user number)
1063         if (new_room_type == 4) {
1064                 CtdlMailboxName(qrbuf.QRname, sizeof qrbuf.QRname, &CC->user, new_room_name);
1065         }
1066         else {
1067                 safestrncpy(qrbuf.QRname, new_room_name, sizeof qrbuf.QRname);
1068         }
1069
1070         // If the room is private, and the system administrator has elected
1071         // to automatically grant room admin privileges, do so now.
1072         if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
1073                 qrbuf.QRroomaide = CC->user.usernum;
1074         }
1075
1076         // Blog owners automatically become room admins of their blogs.
1077         // (In the future we will offer a site-wide configuration setting to suppress this behavior.)
1078         else if (new_room_view == VIEW_BLOG) {
1079                 qrbuf.QRroomaide = CC->user.usernum;
1080         }
1081
1082         // Otherwise, set the room admin to undefined.
1083         else {
1084                 qrbuf.QRroomaide = (-1L);
1085         }
1086
1087         // If the caller is only interested in testing whether this will work,
1088         // return now without creating the room.
1089         if (!really_create) return (qrbuf.QRflags);
1090
1091         qrbuf.QRnumber = get_new_room_number();
1092         qrbuf.QRhighest = 0L;                   // No messages in this room yet
1093         time(&qrbuf.QRgen);                     // Use a timestamp as the generation number
1094         qrbuf.QRfloor = new_room_floor;
1095         qrbuf.QRdefaultview = new_room_view;
1096
1097         // save what we just did...
1098         CtdlPutRoom(&qrbuf);
1099
1100         // bump the reference count on whatever floor the room is on
1101         lgetfloor(&flbuf, (int) qrbuf.QRfloor);
1102         flbuf.f_ref_count = flbuf.f_ref_count + 1;
1103         lputfloor(&flbuf, (int) qrbuf.QRfloor);
1104
1105         // Grant the creator access to the room unless the avoid_access
1106         // parameter was specified.
1107         if ( (CC->logged_in) && (avoid_access == 0) ) {
1108                 CtdlGetRelationship(&vbuf, &CC->user, &qrbuf);
1109                 vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
1110                 vbuf.v_flags = vbuf.v_flags | V_ACCESS;
1111                 CtdlSetRelationship(&vbuf, &CC->user, &qrbuf);
1112         }
1113
1114         // resume our happy day
1115         return(qrbuf.QRflags);
1116 }