Changing the name of the 'Aide' access level to 'Admin'
[citadel.git] / citadel / room_ops.c
index fbea0f27083633cd8218e0bc82835ef3df8b5f94..1e4209bdc6867bccc3a8b9e10ed9b1d15d2bb99b 100644 (file)
@@ -1,21 +1,15 @@
 /* 
  * Server functions which perform operations on room objects.
  *
- * Copyright (c) 1987-2011 by the citadel.org team
+ * Copyright (c) 1987-2012 by the citadel.org team
  *
  * This program is open source software; you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation; either version 3 of the License, or
- * (at your option) any later version.
+ * it under the terms of the GNU General Public License, version 3.
  *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  */
 
 #include "sysdep.h"
@@ -261,6 +255,7 @@ SKIP_EVERYTHING:
        if (view != NULL) *view = vbuf.v_view;
 }
 
+
 /*
  * Self-checking stuff for a room record read into memory
  */
@@ -362,13 +357,10 @@ void b_putroom(struct ctdlroom *qrbuf, char *room_name)
 
        len = bptr - lowercase_name;
        if (qrbuf == NULL) {
-               cdb_delete(CDB_ROOMS,
-                          lowercase_name, len);
+               cdb_delete(CDB_ROOMS, lowercase_name, len);
        } else {
                time(&qrbuf->QRmtime);
-               cdb_store(CDB_ROOMS,
-                         lowercase_name, len,
-                         qrbuf, sizeof(struct ctdlroom));
+               cdb_store(CDB_ROOMS, lowercase_name, len, qrbuf, sizeof(struct ctdlroom));
        }
 }
 
@@ -389,7 +381,6 @@ void b_deleteroom(char *room_name) {
 }
 
 
-
 /*
  * CtdlPutRoomLock()  -  same as CtdlPutRoom() but unlocks the record (if supported)
  */
@@ -401,8 +392,6 @@ void CtdlPutRoomLock(struct ctdlroom *qrbuf)
 
 }
 
-/****************************************************************************/
-
 
 /*
  * CtdlGetFloorByName()  -  retrieve the number of the named floor
@@ -426,7 +415,6 @@ int CtdlGetFloorByName(const char *floor_name)
 }
 
 
-
 /*
  * CtdlGetFloorByNameLock()  -  retrieve floor number for given floor and lock the floor list.
  */
@@ -484,6 +472,7 @@ void CtdlGetFloor(struct floor *flbuf, int floor_num)
 
 }
 
+
 /*
  * lgetfloor()  -  same as CtdlGetFloor() but locks the record (if supported)
  */
@@ -533,7 +522,6 @@ struct floor *CtdlGetCachedFloor(int floor_num) {
 }
 
 
-
 /*
  * CtdlPutFloor()  -  store floor data on disk
  */
@@ -553,7 +541,6 @@ void CtdlPutFloor(struct floor *flbuf, int floor_num)
 }
 
 
-
 /*
  * CtdlPutFloorLock()  -  same as CtdlPutFloor() but unlocks the record (if supported)
  */
@@ -566,7 +553,6 @@ void CtdlPutFloorLock(struct floor *flbuf, int floor_num)
 }
 
 
-
 /*
  * lputfloor()  -  same as CtdlPutFloor() but unlocks the record (if supported)
  */
@@ -591,11 +577,13 @@ void CtdlForEachRoom(void (*CallBack) (struct ctdlroom *EachRoom, void *out_data
                memset(&qrbuf, 0, sizeof(struct ctdlroom));
                memcpy(&qrbuf, cdbqr->ptr,
                       ((cdbqr->len > sizeof(struct ctdlroom)) ?
-                       sizeof(struct ctdlroom) : cdbqr->len));
+                       sizeof(struct ctdlroom) : cdbqr->len)
+               );
                cdb_free(cdbqr);
                room_sanity_check(&qrbuf);
-               if (qrbuf.QRflags & QR_INUSE)
+               if (qrbuf.QRflags & QR_INUSE) {
                        (*CallBack)(&qrbuf, in_data);
+               }
        }
 }
 
@@ -608,7 +596,7 @@ void delete_msglist(struct ctdlroom *whichroom)
         struct cdbdata *cdbml;
 
        /* Make sure the msglist we're deleting actually exists, otherwise
-        * gdbm will complain when we try to delete an invalid record
+        * libdb will complain when we try to delete an invalid record
         */
         cdbml = cdb_fetch(CDB_MSGLISTS, &whichroom->QRnumber, sizeof(long));
         if (cdbml != NULL) {
@@ -620,7 +608,6 @@ void delete_msglist(struct ctdlroom *whichroom)
 }
 
 
-
 /*
  * Message pointer compare function for sort_msglist()
  */
@@ -649,8 +636,7 @@ int sort_msglist(long listptrs[], int oldcount)
 
        /* and yank any nulls */
        while ((numitems > 0) && (listptrs[0] == 0L)) {
-               memmove(&listptrs[0], &listptrs[1],
-                      (sizeof(long) * (numitems - 1)));
+               memmove(&listptrs[0], &listptrs[1], (sizeof(long) * (numitems - 1)));
                --numitems;
        }
 
@@ -674,7 +660,6 @@ int CtdlIsNonEditable(struct ctdlroom *qrbuf)
 }
 
 
-
 /*
  * Back-back-end for all room listing commands
  */
@@ -923,6 +908,7 @@ void cmd_lzrm(char *argbuf)
 void CtdlUserGoto(char *where, int display_result, int transiently,
                int *retmsgs, int *retnew)
 {
+       struct CitContext *CCC = CC;
        int a;
        int new_messages = 0;
        int old_messages = 0;
@@ -948,20 +934,20 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
         * we can skip the extra database fetch.
         */
        if (where != NULL) {
-               safestrncpy(CC->room.QRname, where, sizeof CC->room.QRname);
-               CtdlGetRoom(&CC->room, where);
+               safestrncpy(CCC->room.QRname, where, sizeof CCC->room.QRname);
+               CtdlGetRoom(&CCC->room, where);
        }
 
        /* Take care of all the formalities. */
 
        begin_critical_section(S_USERS);
-       CtdlGetRelationship(&vbuf, &CC->user, &CC->room);
+       CtdlGetRelationship(&vbuf, &CCC->user, &CCC->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.
         */
-       if ((strcasecmp(CC->room.QRname, config.c_logpages))
+       if ((strcasecmp(CCC->room.QRname, config.c_logpages))
           && (transiently == 0) ) {
                vbuf.v_flags = vbuf.v_flags & ~V_FORGET & ~V_LOCKOUT;
                vbuf.v_flags = vbuf.v_flags | V_ACCESS;
@@ -969,7 +955,7 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
        
        /* Only rewrite the database record if we changed something */
        if (vbuf.v_flags != original_v_flags) {
-               CtdlSetRelationship(&vbuf, &CC->user, &CC->room);
+               CtdlSetRelationship(&vbuf, &CCC->user, &CCC->room);
        }
        end_critical_section(S_USERS);
 
@@ -977,11 +963,11 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
        newmailcount = NewMailCount();
 
        /* set info to 1 if the user needs to read the room's info file */
-       if (CC->room.QRinfo > vbuf.v_lastseen) {
+       if (CCC->room.QRinfo > vbuf.v_lastseen) {
                info = 1;
        }
 
-        cdbfr = cdb_fetch(CDB_MSGLISTS, &CC->room.QRnumber, sizeof(long));
+        cdbfr = cdb_fetch(CDB_MSGLISTS, &CCC->room.QRnumber, sizeof(long));
         if (cdbfr != NULL) {
                msglist = (long *) cdbfr->ptr;
                cdbfr->ptr = NULL;      /* CtdlUserGoto() now owns this memory */
@@ -993,7 +979,7 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
        for (a=0; a<num_msgs; ++a) {
                if (msglist[a] > 0L) ++total_messages;
        }
-       new_messages = num_msgs;
+
        num_sets = num_tokens(vbuf.v_seen, ',');
        for (s=0; s<num_sets; ++s) {
                extract_token(setstr, vbuf.v_seen, s, ',', sizeof setstr);
@@ -1022,20 +1008,20 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
 
        if (msglist != NULL) free(msglist);
 
-       if (CC->room.QRflags & QR_MAILBOX)
+       if (CCC->room.QRflags & QR_MAILBOX)
                rmailflag = 1;
        else
                rmailflag = 0;
 
-       if ((CC->room.QRroomaide == CC->user.usernum)
-           || (CC->user.axlevel >= AxAideU))
+       if ((CCC->room.QRroomaide == CCC->user.usernum)
+           || (CCC->user.axlevel >= AxAideU))
                raideflag = 1;
        else
                raideflag = 0;
 
-       safestrncpy(truncated_roomname, CC->room.QRname, sizeof truncated_roomname);
-       if ( (CC->room.QRflags & QR_MAILBOX)
-          && (atol(CC->room.QRname) == CC->user.usernum) ) {
+       safestrncpy(truncated_roomname, CCC->room.QRname, sizeof truncated_roomname);
+       if ( (CCC->room.QRflags & QR_MAILBOX)
+          && (atol(CCC->room.QRname) == CCC->user.usernum) ) {
                safestrncpy(truncated_roomname, &truncated_roomname[11], sizeof truncated_roomname);
        }
 
@@ -1045,31 +1031,32 @@ void CtdlUserGoto(char *where, int display_result, int transiently,
 
        if (retmsgs != NULL) *retmsgs = total_messages;
        if (retnew != NULL) *retnew = new_messages;
-       syslog(LOG_DEBUG, "<%s> %d new of %d total messages\n",
-               CC->room.QRname,
-               new_messages, total_messages
-       );
+       MSG_syslog(LOG_INFO, "<%s> %d new of %d total messages\n",
+                  CCC->room.QRname,
+                  new_messages, total_messages
+               );
 
-       CC->curr_view = (int)vbuf.v_view;
+       CCC->curr_view = (int)vbuf.v_view;
 
        if (display_result) {
-               cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|\n",
+               cprintf("%d%c%s|%d|%d|%d|%d|%ld|%ld|%d|%d|%d|%d|%d|%d|%d|%d|%ld|\n",
                        CIT_OK, CtdlCheckExpress(),
                        truncated_roomname,
                        (int)new_messages,
                        (int)total_messages,
                        (int)info,
-                       (int)CC->room.QRflags,
-                       (long)CC->room.QRhighest,
+                       (int)CCC->room.QRflags,
+                       (long)CCC->room.QRhighest,
                        (long)vbuf.v_lastseen,
                        (int)rmailflag,
                        (int)raideflag,
                        (int)newmailcount,
-                       (int)CC->room.QRfloor,
+                       (int)CCC->room.QRfloor,
                        (int)vbuf.v_view,
-                       (int)CC->room.QRdefaultview,
+                       (int)CCC->room.QRdefaultview,
                        (int)is_trash,
-                       (int)CC->room.QRflags2
+                       (int)CCC->room.QRflags2,
+                       (long)CCC->room.QRmtime
                );
        }
 }
@@ -1320,7 +1307,7 @@ void cmd_rdir(char *cmdbuf)
 }
 
 /*
- * get room parameters (aide or room aide command)
+ * get room parameters (admin or room admin command)
  */
 void cmd_getr(char *cmdbuf)
 {
@@ -1472,7 +1459,7 @@ int CtdlRenameRoom(char *old_name, char *new_name, int new_floor) {
 
 
 /*
- * set room parameters (aide or room aide command)
+ * set room parameters (admin or room admin command)
  */
 void cmd_setr(char *args)
 {
@@ -1608,7 +1595,9 @@ void cmd_setr(char *args)
                mkdir(buf, 0755);
        }
        snprintf(buf, sizeof buf, "The room \"%s\" has been edited by %s.\n",
-               CC->room.QRname, CC->curr_user);
+               CC->room.QRname,
+               (CC->logged_in ? CC->curr_user : "an administrator")
+       );
        CtdlAideMessage(buf, "Room modification Message");
        cprintf("%d Ok\n", CIT_OK);
 }
@@ -1616,7 +1605,7 @@ void cmd_setr(char *args)
 
 
 /* 
- * get the name of the room aide for this room
+ * get the name of the room admin for this room
  */
 void cmd_geta(char *cmdbuf)
 {
@@ -1633,7 +1622,7 @@ void cmd_geta(char *cmdbuf)
 
 
 /* 
- * set the room aide for this room
+ * set the room admin for this room
  */
 void cmd_seta(char *new_ra)
 {
@@ -1665,13 +1654,13 @@ void cmd_seta(char *new_ra)
        if (post_notice == 1) {
                if (!IsEmptyStr(usbuf.fullname))
                        snprintf(buf, sizeof buf,
-                               "%s is now the room aide for \"%s\".\n",
+                               "%s is now the room admin for \"%s\".\n",
                                usbuf.fullname, CC->room.QRname);
                else
                        snprintf(buf, sizeof buf,
-                               "There is now no room aide for \"%s\".\n",
+                               "There is now no room admin for \"%s\".\n",
                                CC->room.QRname);
-               CtdlAideMessage(buf, "Aide Room Modification");
+               CtdlAideMessage(buf, "Admin Room Modification");
        }
        cprintf("%d Ok\n", CIT_OK);
 }
@@ -1817,13 +1806,13 @@ int CtdlDoIHavePermissionToDeleteThisRoom(struct ctdlroom *qr) {
        }
 
        /*
-        * For normal rooms, just check for aide or room aide status.
+        * For normal rooms, just check for admin or room admin status.
         */
        return(is_room_aide());
 }
 
 /*
- * aide command: kill the current room
+ * admin command: kill the current room
  */
 void cmd_kill(char *argbuf)
 {
@@ -1853,7 +1842,9 @@ void cmd_kill(char *argbuf)
 
                /* tell the world what we did */
                snprintf(msg, sizeof msg, "The room \"%s\" has been deleted by %s.\n",
-                        deleted_room_name, CC->curr_user);
+                        deleted_room_name,
+                       (CC->logged_in ? CC->curr_user : "an administrator")
+               );
                CtdlAideMessage(msg, "Room Purger Message");
                cprintf("%d '%s' deleted.\n", CIT_OK, deleted_room_name);
        } else {
@@ -1914,12 +1905,20 @@ unsigned CtdlCreateRoom(char *new_room_name,
        }
 
        /* If the room is private, and the system administrator has elected
-        * to automatically grant room aide privileges, do so now; otherwise,
-        * set the room aide to undefined.
+        * to automatically grant room admin privileges, do so now.
         */
        if ((qrbuf.QRflags & QR_PRIVATE) && (CREATAIDE == 1)) {
                qrbuf.QRroomaide = CC->user.usernum;
-       } else {
+       }
+       /* Blog owners automatically become room admins of their blogs.
+        * (In the future we will offer a site-wide configuration setting to suppress this behavior.)
+        */
+       else if (new_room_view == VIEW_BLOG) {
+               qrbuf.QRroomaide = CC->user.usernum;
+       }
+       /* Otherwise, set the room admin to undefined.
+        */
+       else {
                qrbuf.QRroomaide = (-1L);
        }
 
@@ -2063,7 +2062,7 @@ void cmd_cre8(char *args)
        snprintf(notification_message, 1024,
                "A new room called \"%s\" has been created by %s%s%s%s%s%s\n",
                new_room_name,
-               CC->user.fullname,
+               (CC->logged_in ? CC->curr_user : "an administrator"),
                ((newflags & QR_MAILBOX) ? " [personal]" : ""),
                ((newflags & QR_PRIVATE) ? " [private]" : ""),
                ((newflags & QR_GUESSNAME) ? " [hidden]" : ""),
@@ -2279,6 +2278,19 @@ void cmd_eflr(char *argbuf)
 }
 
 
+
+/* 
+ * cmd_stat()  -  return the modification time of the current room (maybe other things in the future)
+ */
+void cmd_stat(char *gargs)
+{
+       if (CtdlAccessCheck(ac_logged_in_or_guest)) return;
+       CtdlGetRoom(&CC->room, CC->room.QRname);
+       cprintf("%d %s|%ld|\n", CIT_OK, CC->room.QRname, CC->room.QRmtime);
+}
+
+
+
 /*****************************************************************************/
 /*                      MODULE INITIALIZATION STUFF                          */
 /*****************************************************************************/
@@ -2293,12 +2305,13 @@ CTDL_MODULE_INIT(room_ops)
                CtdlRegisterProtoHook(cmd_lzrm, "LZRM", "List zapped rooms");
                CtdlRegisterProtoHook(cmd_lprm, "LPRM", "List public rooms");
                CtdlRegisterProtoHook(cmd_goto, "GOTO", "Goto a named room");
+               CtdlRegisterProtoHook(cmd_stat, "STAT", "Get mtime of the current room");
                CtdlRegisterProtoHook(cmd_whok, "WHOK", "List users who know this room");
                CtdlRegisterProtoHook(cmd_rdir, "RDIR", "List files in room directory");
                CtdlRegisterProtoHook(cmd_getr, "GETR", "Get room parameters");
                CtdlRegisterProtoHook(cmd_setr, "SETR", "Set room parameters");
-               CtdlRegisterProtoHook(cmd_geta, "GETA", "Get the room aide name");
-               CtdlRegisterProtoHook(cmd_seta, "SETA", "Set the room aide for this room");
+               CtdlRegisterProtoHook(cmd_geta, "GETA", "Get the room admin name");
+               CtdlRegisterProtoHook(cmd_seta, "SETA", "Set the room admin for this room");
                CtdlRegisterProtoHook(cmd_rinf, "RINF", "Fetch room info file");
                CtdlRegisterProtoHook(cmd_kill, "KILL", "Kill (delete) the current room");
                CtdlRegisterProtoHook(cmd_cre8, "CRE8", "Create a new room");