]> code.citadel.org Git - citadel.git/blobdiff - citadel/room_ops.c
* Add specific error codes for every command on the wire protocol, so that
[citadel.git] / citadel / room_ops.c
index 99c0432f1208a9ba940bdbe17f6b5de0afed18ad..e4a66b7e9e4a806f7e62e60ec5fe179546f7796a 100644 (file)
@@ -49,7 +49,7 @@ struct floor *floorcache[MAXFLOORS];
 /*
  * Generic routine for determining user access to rooms
  */
-int CtdlRoomAccess(struct room *roombuf, struct user *userbuf)
+int CtdlRoomAccess(struct ctdlroom *roombuf, struct ctdluser *userbuf)
 {
        int retval = 0;
        struct visit vbuf;
@@ -162,7 +162,7 @@ NEWMSG:     /* By the way, we also check for the presence of new messages */
 /*
  * Self-checking stuff for a room record read into memory
  */
-void room_sanity_check(struct room *qrbuf)
+void room_sanity_check(struct ctdlroom *qrbuf)
 {
        /* Mailbox rooms are always on the lowest floor */
        if (qrbuf->QRflags & QR_MAILBOX) {
@@ -181,7 +181,7 @@ void room_sanity_check(struct room *qrbuf)
 /*
  * getroom()  -  retrieve room data from disk
  */
-int getroom(struct room *qrbuf, char *room_name)
+int getroom(struct ctdlroom *qrbuf, char *room_name)
 {
        struct cdbdata *cdbqr;
        char lowercase_name[ROOMNAMELEN];
@@ -193,10 +193,10 @@ int getroom(struct room *qrbuf, char *room_name)
        }
        lowercase_name[a] = 0;
 
-       memset(qrbuf, 0, sizeof(struct room));
+       memset(qrbuf, 0, sizeof(struct ctdlroom));
 
        /* First, try the public namespace */
-       cdbqr = cdb_fetch(CDB_QUICKROOM,
+       cdbqr = cdb_fetch(CDB_ROOMS,
                          lowercase_name, strlen(lowercase_name));
 
        /* If that didn't work, try the user's personal namespace */
@@ -204,14 +204,14 @@ int getroom(struct room *qrbuf, char *room_name)
                snprintf(personal_lowercase_name,
                         sizeof personal_lowercase_name, "%010ld.%s",
                         CC->user.usernum, lowercase_name);
-               cdbqr = cdb_fetch(CDB_QUICKROOM,
+               cdbqr = cdb_fetch(CDB_ROOMS,
                                  personal_lowercase_name,
                                  strlen(personal_lowercase_name));
        }
        if (cdbqr != NULL) {
                memcpy(qrbuf, cdbqr->ptr,
-                      ((cdbqr->len > sizeof(struct room)) ?
-                       sizeof(struct room) : cdbqr->len));
+                      ((cdbqr->len > sizeof(struct ctdlroom)) ?
+                       sizeof(struct ctdlroom) : cdbqr->len));
                cdb_free(cdbqr);
 
                room_sanity_check(qrbuf);
@@ -225,11 +225,11 @@ int getroom(struct room *qrbuf, char *room_name)
 /*
  * lgetroom()  -  same as getroom() but locks the record (if supported)
  */
-int lgetroom(struct room *qrbuf, char *room_name)
+int lgetroom(struct ctdlroom *qrbuf, char *room_name)
 {
        register int retval;
        retval = getroom(qrbuf, room_name);
-       if (retval == 0) begin_critical_section(S_QUICKROOM);
+       if (retval == 0) begin_critical_section(S_ROOMS);
        return(retval);
 }
 
@@ -238,7 +238,7 @@ int lgetroom(struct room *qrbuf, char *room_name)
  * b_putroom()  -  back end to putroom() and b_deleteroom()
  *              (if the supplied buffer is NULL, delete the room record)
  */
-void b_putroom(struct room *qrbuf, char *room_name)
+void b_putroom(struct ctdlroom *qrbuf, char *room_name)
 {
        char lowercase_name[ROOMNAMELEN];
        int a;
@@ -248,13 +248,13 @@ void b_putroom(struct room *qrbuf, char *room_name)
        }
 
        if (qrbuf == NULL) {
-               cdb_delete(CDB_QUICKROOM,
+               cdb_delete(CDB_ROOMS,
                           lowercase_name, strlen(lowercase_name));
        } else {
                time(&qrbuf->QRmtime);
-               cdb_store(CDB_QUICKROOM,
+               cdb_store(CDB_ROOMS,
                          lowercase_name, strlen(lowercase_name),
-                         qrbuf, sizeof(struct room));
+                         qrbuf, sizeof(struct ctdlroom));
        }
 }
 
@@ -262,7 +262,7 @@ void b_putroom(struct room *qrbuf, char *room_name)
 /* 
  * putroom()  -  store room data to disk
  */
-void putroom(struct room *qrbuf) {
+void putroom(struct ctdlroom *qrbuf) {
        b_putroom(qrbuf, qrbuf->QRname);
 }
 
@@ -279,11 +279,11 @@ void b_deleteroom(char *room_name) {
 /*
  * lputroom()  -  same as putroom() but unlocks the record (if supported)
  */
-void lputroom(struct room *qrbuf)
+void lputroom(struct ctdlroom *qrbuf)
 {
 
        putroom(qrbuf);
-       end_critical_section(S_QUICKROOM);
+       end_critical_section(S_ROOMS);
 
 }
 
@@ -305,7 +305,8 @@ void getfloor(struct floor *flbuf, int floor_num)
                cdb_free(cdbfl);
        } else {
                if (floor_num == 0) {
-                       strcpy(flbuf->f_name, "Main Floor");
+                       safestrncpy(flbuf->f_name, "Main Floor", 
+                               sizeof flbuf->f_name);
                        flbuf->f_flags = F_INUSE;
                        flbuf->f_ref_count = 3;
                }
@@ -381,19 +382,19 @@ void lputfloor(struct floor *flbuf, int floor_num)
 /* 
  *  Traverse the room file...
  */
-void ForEachRoom(void (*CallBack) (struct room *EachRoom, void *out_data),
+void ForEachRoom(void (*CallBack) (struct ctdlroom *EachRoom, void *out_data),
                void *in_data)
 {
-       struct room qrbuf;
+       struct ctdlroom qrbuf;
        struct cdbdata *cdbqr;
 
-       cdb_rewind(CDB_QUICKROOM);
+       cdb_rewind(CDB_ROOMS);
 
-       while (cdbqr = cdb_next_item(CDB_QUICKROOM), cdbqr != NULL) {
-               memset(&qrbuf, 0, sizeof(struct room));
+       while (cdbqr = cdb_next_item(CDB_ROOMS), cdbqr != NULL) {
+               memset(&qrbuf, 0, sizeof(struct ctdlroom));
                memcpy(&qrbuf, cdbqr->ptr,
-                      ((cdbqr->len > sizeof(struct room)) ?
-                       sizeof(struct room) : cdbqr->len));
+                      ((cdbqr->len > sizeof(struct ctdlroom)) ?
+                       sizeof(struct ctdlroom) : cdbqr->len));
                cdb_free(cdbqr);
                room_sanity_check(&qrbuf);
                if (qrbuf.QRflags & QR_INUSE)
@@ -405,7 +406,7 @@ void ForEachRoom(void (*CallBack) (struct room *EachRoom, void *out_data),
 /*
  * delete_msglist()  -  delete room message pointers
  */
-void delete_msglist(struct room *whichroom)
+void delete_msglist(struct ctdlroom *whichroom)
 {
         struct cdbdata *cdbml;
 
@@ -464,7 +465,7 @@ int sort_msglist(long listptrs[], int oldcount)
 /*
  * Determine whether a given room is non-editable.
  */
-int is_noneditable(struct room *qrbuf)
+int is_noneditable(struct ctdlroom *qrbuf)
 {
 
        /* Mail> rooms are non-editable */
@@ -481,7 +482,7 @@ int is_noneditable(struct room *qrbuf)
 /*
  * Back-back-end for all room listing commands
  */
-void list_roomname(struct room *qrbuf, int ra)
+void list_roomname(struct ctdlroom *qrbuf, int ra)
 {
        char truncated_roomname[ROOMNAMELEN];
 
@@ -511,7 +512,7 @@ void list_roomname(struct room *qrbuf, int ra)
 /* 
  * cmd_lrms()   -  List all accessible rooms, known or forgotten
  */
-void cmd_lrms_backend(struct room *qrbuf, void *data)
+void cmd_lrms_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
        int ra;
@@ -548,7 +549,7 @@ void cmd_lrms(char *argbuf)
 /* 
  * cmd_lkra()   -  List all known rooms
  */
-void cmd_lkra_backend(struct room *qrbuf, void *data)
+void cmd_lkra_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
        int ra;
@@ -582,7 +583,7 @@ void cmd_lkra(char *argbuf)
 
 
 
-void cmd_lprm_backend(struct room *qrbuf, void *data)
+void cmd_lprm_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
        int ra;
@@ -614,7 +615,7 @@ void cmd_lprm(char *argbuf)
 /* 
  * cmd_lkrn()   -  List all known rooms with new messages
  */
-void cmd_lkrn_backend(struct room *qrbuf, void *data)
+void cmd_lkrn_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
        int ra;
@@ -652,7 +653,7 @@ void cmd_lkrn(char *argbuf)
 /* 
  * cmd_lkro()   -  List all known rooms
  */
-void cmd_lkro_backend(struct room *qrbuf, void *data)
+void cmd_lkro_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
        int ra;
@@ -690,7 +691,7 @@ void cmd_lkro(char *argbuf)
 /* 
  * cmd_lzrm()   -  List all forgotten rooms
  */
-void cmd_lzrm_backend(struct room *qrbuf, void *data)
+void cmd_lzrm_backend(struct ctdlroom *qrbuf, void *data)
 {
        int FloorBeingSearched = (-1);
 
@@ -744,20 +745,22 @@ void usergoto(char *where, int display_result, int transiently,
         struct cdbdata *cdbfr;
        long *msglist = NULL;
        int num_msgs = 0;
+       unsigned int original_v_flags;
 
        /* If the supplied room name is NULL, the caller wants us to know that
         * it has already copied the room record into CC->room, so
         * we can skip the extra database fetch.
         */
        if (where != NULL) {
-               strcpy(CC->room.QRname, where);
+               safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
                getroom(&CC->room, where);
        }
 
        /* Take care of all the formalities. */
 
-       begin_critical_section(S_USERSUPP);
+       begin_critical_section(S_USERS);
        CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
+       original_v_flags = vbuf.v_flags;
 
        /* Know the room ... but not if it's the page log room, or if the
         * caller specified that we're only entering this room transiently.
@@ -767,8 +770,12 @@ void usergoto(char *where, int display_result, int transiently,
                vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
                vbuf.v_flags = vbuf.v_flags | V_ACCESS;
        }
-       CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
-       end_critical_section(S_USERSUPP);
+       
+       /* Only rewrite the database record if we changed something */
+       if (vbuf.v_flags != original_v_flags) {
+               CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
+       }
+       end_critical_section(S_USERS);
 
        /* Check for new mail */
        newmailcount = NewMailCount();
@@ -848,7 +855,7 @@ void usergoto(char *where, int display_result, int transiently,
  */
 void cmd_goto(char *gargs)
 {
-       struct room QRscratch;
+       struct ctdlroom QRscratch;
        int c;
        int ok = 0;
        int ra;
@@ -893,7 +900,7 @@ void cmd_goto(char *gargs)
                /* Let internal programs go directly to any room. */
                if (CC->internal_pgm) {
                        memcpy(&CC->room, &QRscratch,
-                               sizeof(struct room));
+                               sizeof(struct ctdlroom));
                        usergoto(NULL, 1, transiently, NULL, NULL);
                        return;
                }
@@ -910,7 +917,7 @@ void cmd_goto(char *gargs)
                        if ((QRscratch.QRflags & QR_MAILBOX) &&
                            ((ra & UA_GOTOALLOWED))) {
                                memcpy(&CC->room, &QRscratch,
-                                       sizeof(struct room));
+                                       sizeof(struct ctdlroom));
                                usergoto(NULL, 1, transiently, NULL, NULL);
                                return;
                        } else if ((QRscratch.QRflags & QR_PASSWORDED) &&
@@ -928,23 +935,22 @@ void cmd_goto(char *gargs)
                                   (CC->user.axlevel < 6)
                                   ) {
                                lprintf(9, "Failed to acquire private room\n");
-                               goto NOPE;
                        } else {
                                memcpy(&CC->room, &QRscratch,
-                                       sizeof(struct room));
+                                       sizeof(struct ctdlroom));
                                usergoto(NULL, 1, transiently, NULL, NULL);
                                return;
                        }
                }
        }
 
-NOPE:  cprintf("%d room '%s' not found\n", ERROR + ROOM_NOT_FOUND, towhere);
+       cprintf("%d room '%s' not found\n", ERROR + ROOM_NOT_FOUND, towhere);
 }
 
 
 void cmd_whok(void)
 {
-       struct user temp;
+       struct ctdluser temp;
        struct cdbdata *cdbus;
 
        getuser(&CC->user, CC->curr_user);
@@ -965,8 +971,8 @@ void cmd_whok(void)
         }
 
        cprintf("%d Who knows room:\n", LISTING_FOLLOWS);
-       cdb_rewind(CDB_USERSUPP);
-       while (cdbus = cdb_next_item(CDB_USERSUPP), cdbus != NULL) {
+       cdb_rewind(CDB_USERS);
+       while (cdbus = cdb_next_item(CDB_USERS), cdbus != NULL) {
                memset(&temp, 0, sizeof temp);
                memcpy(&temp, cdbus->ptr, sizeof temp);
                cdb_free(cdbus);
@@ -1087,8 +1093,8 @@ void cmd_getr(void)
  */
 int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
        int old_floor = 0;
-       struct room qrbuf;
-       struct room qrtmp;
+       struct ctdlroom qrbuf;
+       struct ctdlroom qrtmp;
        int ret = 0;
        struct floor *fl;
        struct floor flbuf;
@@ -1105,7 +1111,7 @@ int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
                }
        }
 
-       begin_critical_section(S_QUICKROOM);
+       begin_critical_section(S_ROOMS);
 
        if ( (getroom(&qrtmp, new_name) == 0) 
           && (strcasecmp(new_name, old_name)) ) {
@@ -1179,16 +1185,18 @@ int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
                ret = crr_ok;
        }
 
-       end_critical_section(S_QUICKROOM);
+       end_critical_section(S_ROOMS);
 
        /* Adjust the floor reference counts if necessary */
        if (new_floor != old_floor) {
                lgetfloor(&flbuf, old_floor);
                --flbuf.f_ref_count;
                lputfloor(&flbuf, old_floor);
-               lgetfloor(&flbuf, CC->room.QRfloor);
+               lprintf(9, "Reference count for floor %d is now %d\n", old_floor, flbuf.f_ref_count);
+               lgetfloor(&flbuf, new_floor);
                ++flbuf.f_ref_count;
-               lputfloor(&flbuf, CC->room.QRfloor);
+               lputfloor(&flbuf, new_floor);
+               lprintf(9, "Reference count for floor %d is now %d\n", new_floor, flbuf.f_ref_count);
        }
 
        /* ...and everybody say "YATTA!" */     
@@ -1228,12 +1236,12 @@ void cmd_setr(char *args)
        r = CtdlRenameRoom(CC->room.QRname, new_name, new_floor);
 
        if (r == crr_room_not_found) {
-               cprintf("%d Internal error - room not found?\n", ERROR);
+               cprintf("%d Internal error - room not found?\n", ERROR + INTERNAL_ERROR);
        } else if (r == crr_already_exists) {
                cprintf("%d '%s' already exists.\n",
                        ERROR + ALREADY_EXISTS, new_name);
        } else if (r == crr_noneditable) {
-               cprintf("%d Cannot edit this room.\n", ERROR);
+               cprintf("%d Cannot edit this room.\n", ERROR + NOT_HERE);
        } else if (r == crr_invalid_floor) {
                cprintf("%d Target floor does not exist.\n",
                        ERROR + INVALID_FLOOR_OPERATION);
@@ -1243,7 +1251,7 @@ void cmd_setr(char *args)
                        CC->room.QRname);
        } else if (r != crr_ok) {
                cprintf("%d Error: CtdlRenameRoom() returned %d\n",
-                       ERROR, r);
+                       ERROR + INTERNAL_ERROR, r);
        }
 
        if (r != crr_ok) {
@@ -1343,7 +1351,7 @@ void cmd_setr(char *args)
  */
 void cmd_geta(void)
 {
-       struct user usbuf;
+       struct ctdluser usbuf;
 
        if (CtdlAccessCheck(ac_logged_in)) return;
 
@@ -1360,7 +1368,7 @@ void cmd_geta(void)
  */
 void cmd_seta(char *new_ra)
 {
-       struct user usbuf;
+       struct ctdluser usbuf;
        long newu;
        char buf[SIZ];
        int post_notice;
@@ -1403,7 +1411,7 @@ void cmd_seta(char *new_ra)
  * Generate an associated file name for a room
  */
 void assoc_file_name(char *buf, size_t n,
-                    struct room *qrbuf, const char *prefix)
+                    struct ctdlroom *qrbuf, const char *prefix)
 {
        snprintf(buf, n, "./%s/%ld", prefix, qrbuf->QRnumber);
 }
@@ -1421,7 +1429,7 @@ void cmd_rinf(void)
        info_fp = fopen(filename, "r");
 
        if (info_fp == NULL) {
-               cprintf("%d No info file.\n", ERROR);
+               cprintf("%d No info file.\n", ERROR + FILE_NOT_FOUND);
                return;
        }
        cprintf("%d Info:\n", LISTING_FOLLOWS);
@@ -1437,7 +1445,7 @@ void cmd_rinf(void)
 /*
  * Back end processing to delete a room and everything associated with it
  */
-void delete_room(struct room *qrbuf)
+void delete_room(struct ctdlroom *qrbuf)
 {
        struct floor flbuf;
        char filename[100];
@@ -1457,7 +1465,7 @@ void delete_room(struct room *qrbuf)
        unlink(filename);
 
        /* Delete the messages in the room
-        * (Careful: this opens an S_QUICKROOM critical section!)
+        * (Careful: this opens an S_ROOMS critical section!)
         */
        CtdlDeleteMessages(qrbuf->QRname, 0L, "");
 
@@ -1480,7 +1488,7 @@ void delete_room(struct room *qrbuf)
 /*
  * Check access control for deleting a room
  */
-int CtdlDoIHavePermissionToDeleteThisRoom(struct room *qr) {
+int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
 
        if ((!(CC->logged_in)) && (!(CC->internal_pgm))) {
                return(0);
@@ -1568,7 +1576,7 @@ unsigned create_room(char *new_room_name,
                     int avoid_access)
 {
 
-       struct room qrbuf;
+       struct ctdlroom qrbuf;
        struct floor flbuf;
        struct visit vbuf;
 
@@ -1579,7 +1587,7 @@ unsigned create_room(char *new_room_name,
        }
 
 
-       memset(&qrbuf, 0, sizeof(struct room));
+       memset(&qrbuf, 0, sizeof(struct ctdlroom));
        safestrncpy(qrbuf.QRpasswd, new_room_pass, sizeof qrbuf.QRpasswd);
        qrbuf.QRflags = QR_INUSE;
        if (new_room_type > 0)
@@ -1672,7 +1680,7 @@ void cmd_cre8(char *args)
        new_room_floor = 0;
 
        if ((strlen(new_room_name) == 0) && (cre8_ok == 1)) {
-               cprintf("%d Invalid room name.\n", ERROR);
+               cprintf("%d Invalid room name.\n", ERROR + ILLEGAL_VALUE);
                return;
        }
 
@@ -1707,7 +1715,7 @@ void cmd_cre8(char *args)
        }
 
        if ((new_room_type < 0) || (new_room_type > 5)) {
-               cprintf("%d Invalid room type.\n", ERROR);
+               cprintf("%d Invalid room type.\n", ERROR + ILLEGAL_VALUE);
                return;
        }
 
@@ -1715,7 +1723,7 @@ void cmd_cre8(char *args)
                if ((config.c_aide_mailboxes == 0)
                   || (CC->user.axlevel < 6)) {
                        cprintf("%d Higher access required\n", 
-                               ERROR+HIGHER_ACCESS_REQUIRED);
+                               ERROR + HIGHER_ACCESS_REQUIRED);
                        return;
                }
        }
@@ -1843,7 +1851,7 @@ void cmd_cflr(char *argbuf)
 
        if (strlen(new_floor_name) == 0) {
                cprintf("%d Blank floor name not allowed.\n",
-                       ERROR+ILLEGAL_VALUE);
+                       ERROR + ILLEGAL_VALUE);
                return;
        }
 
@@ -1939,7 +1947,7 @@ void cmd_eflr(char *argbuf)
 
        np = num_parms(argbuf);
        if (np < 1) {
-               cprintf("%d Usage error.\n", ERROR);
+               cprintf("%d Usage error.\n", ERROR + ILLEGAL_VALUE);
                return;
        }