]> code.citadel.org Git - citadel.git/blobdiff - citadel/serv_expire.c
* Replaced most of the very repetitive and very redundant access level checks
[citadel.git] / citadel / serv_expire.c
index 5bfb0be56970b1cda60cc934ce1ed052c4bbf9c3..f8f2366e182d96b36a96d42ec14c0159ffc780a6 100644 (file)
@@ -3,8 +3,8 @@
  *
  * This module handles the expiry of old messages and the purging of old users.
  *
+ * $Id$
  */
-/* $Id$ */
 
 
 /*
@@ -36,9 +36,6 @@
 #include <sys/wait.h>
 #include <string.h>
 #include <limits.h>
-#ifdef HAVE_PTHREAD_H
-#include <pthread.h>
-#endif
 #include "citadel.h"
 #include "server.h"
 #include <syslog.h>
@@ -62,30 +59,37 @@ struct oldvisit {
        long v_generation;
        long v_lastseen;
        unsigned int v_flags;
-       };
+};
 
 struct PurgeList {
        struct PurgeList *next;
        char name[ROOMNAMELEN]; /* use the larger of username or roomname */
-       };
+};
 
 struct VPurgeList {
        struct VPurgeList *next;
        long vp_roomnum;
        long vp_roomgen;
        long vp_usernum;
-       };
+};
 
 struct ValidRoom {
        struct ValidRoom *next;
        long vr_roomnum;
        long vr_roomgen;
-       };
+};
 
 struct ValidUser {
        struct ValidUser *next;
        long vu_usernum;
-       };
+};
+
+
+struct roomref {
+       struct roomref *next;
+       long msgnum;
+};
+
 
 struct PurgeList *UserPurgeList = NULL;
 struct PurgeList *RoomPurgeList = NULL;
@@ -93,27 +97,15 @@ struct ValidRoom *ValidRoomList = NULL;
 struct ValidUser *ValidUserList = NULL;
 int messages_purged;
 
+struct roomref *rr = NULL;
+
 extern struct CitContext *ContextList;
 
-#define MODULE_NAME    "Expire old messages, users, rooms"
-#define MODULE_AUTHOR  "Art Cancro"
-#define MODULE_EMAIL   "ajc@uncnsrd.mt-kisco.ny.us"
-#define MAJOR_VERSION  1
-#define MINOR_VERSION  0
-
-static struct DLModule_Info info = {
-       MODULE_NAME,
-       MODULE_AUTHOR,
-       MODULE_EMAIL,
-       MAJOR_VERSION,
-       MINOR_VERSION
-       };
-
-void DoPurgeMessages(struct quickroom *qrbuf) {
+void DoPurgeMessages(struct quickroom *qrbuf, void *data) {
        struct ExpirePolicy epbuf;
        long delnum;
        time_t xtime, now;
-       char msgid[64];
+       struct CtdlMessage *msg;
        int a;
         struct cdbdata *cdbfr;
        long *msglist = NULL;
@@ -122,11 +114,6 @@ void DoPurgeMessages(struct quickroom *qrbuf) {
        time(&now);
        GetExpirePolicy(&epbuf, qrbuf);
        
-       /*
-       lprintf(9, "ExpirePolicy for <%s> is <%d> <%d>\n",
-               qrbuf->QRname, epbuf.expire_mode, epbuf.expire_value);
-       */
-
        /* If the room is set to never expire messages ... do nothing */
        if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
        if (epbuf.expire_mode == EXPIRE_MANUAL) return;
@@ -145,7 +132,7 @@ void DoPurgeMessages(struct quickroom *qrbuf) {
        if (num_msgs == 0) {
                end_critical_section(S_QUICKROOM);
                return;
-               }
+       }
 
        /* If the room is set to expire by count, do that */
        if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
@@ -157,15 +144,21 @@ void DoPurgeMessages(struct quickroom *qrbuf) {
                                (sizeof(long)*(num_msgs - 1)));
                        --num_msgs;
                        ++messages_purged;
-                       }
                }
+       }
 
        /* If the room is set to expire by age... */
        if (epbuf.expire_mode == EXPIRE_AGE) {
                for (a=0; a<num_msgs; ++a) {
                        delnum = msglist[a];
-                       sprintf(msgid, "%ld", delnum);
-                       xtime = output_message(msgid, MT_DATE, 0);
+
+                       msg = CtdlFetchMessage(delnum);
+                       if (msg != NULL) {
+                               xtime = atol(msg->cm_fields['T']);
+                               CtdlFreeMessage(msg);
+                       } else {
+                               xtime = 0L;
+                       }
 
                        if ((xtime > 0L)
                           && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
@@ -173,9 +166,9 @@ void DoPurgeMessages(struct quickroom *qrbuf) {
                                AdjRefCount(delnum, -1); 
                                msglist[a] = 0L;
                                ++messages_purged;
-                               }
                        }
                }
+       }
 
        if (num_msgs > 0) {
                num_msgs = sort_msglist(msglist, num_msgs);
@@ -187,25 +180,25 @@ void DoPurgeMessages(struct quickroom *qrbuf) {
        if (msglist != NULL) phree(msglist);
 
        end_critical_section(S_QUICKROOM);
-       }
+}
 
 void PurgeMessages(void) {
        lprintf(5, "PurgeMessages() called\n");
        messages_purged = 0;
-       ForEachRoom(DoPurgeMessages);
+       ForEachRoom(DoPurgeMessages, NULL);
 }
 
 
-void AddValidUser(struct usersupp *usbuf) {
+void AddValidUser(struct usersupp *usbuf, void *data) {
        struct ValidUser *vuptr;
 
        vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
        vuptr->next = ValidUserList;
        vuptr->vu_usernum = usbuf->usernum;
        ValidUserList = vuptr;
-       }
+}
 
-void AddValidRoom(struct quickroom *qrbuf) {
+void AddValidRoom(struct quickroom *qrbuf, void *data) {
        struct ValidRoom *vrptr;
 
        vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
@@ -213,9 +206,9 @@ void AddValidRoom(struct quickroom *qrbuf) {
        vrptr->vr_roomnum = qrbuf->QRnumber;
        vrptr->vr_roomgen = qrbuf->QRgen;
        ValidRoomList = vrptr;
-       }
+}
 
-void DoPurgeRooms(struct quickroom *qrbuf) {
+void DoPurgeRooms(struct quickroom *qrbuf, void *data) {
        time_t age, purge_secs;
        struct PurgeList *pptr;
        struct ValidUser *vuptr;
@@ -241,6 +234,7 @@ void DoPurgeRooms(struct quickroom *qrbuf) {
        if (qrbuf->QRflags & QR_PERMANENT) return;
        if (qrbuf->QRflags & QR_DIRECTORY) return;
        if (qrbuf->QRflags & QR_NETWORK) return;
+       if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
        if (is_noneditable(qrbuf)) return;
 
        /* If we don't know the modification date, be safe and don't purge */
@@ -279,17 +273,17 @@ int PurgeRooms(void) {
 
        /* Load up a table full of valid user numbers so we can delete
         * user-owned rooms for users who no longer exist */
-       ForEachUser(AddValidUser);
+       ForEachUser(AddValidUser, NULL);
 
        /* Then cycle through the room file */
-       ForEachRoom(DoPurgeRooms);
+       ForEachRoom(DoPurgeRooms, NULL);
 
        /* Free the valid user list */
        while (ValidUserList != NULL) {
                vuptr = ValidUserList->next;
                phree(ValidUserList);
                ValidUserList = vuptr;
-               }
+       }
 
 
        transcript = mallok(256);
@@ -301,22 +295,22 @@ int PurgeRooms(void) {
                        sprintf(&transcript[strlen(transcript)], " %s\n",
                                qrbuf.QRname);
                        delete_room(&qrbuf);
-                       }
+               }
                pptr = RoomPurgeList->next;
                phree(RoomPurgeList);
                RoomPurgeList = pptr;
                ++num_rooms_purged;
-               }
+       }
 
        if (num_rooms_purged > 0) aide_message(transcript);
        phree(transcript);
 
        lprintf(5, "Purged %d rooms.\n", num_rooms_purged);
        return(num_rooms_purged);
-       }
+}
 
 
-void do_user_purge(struct usersupp *us) {
+void do_user_purge(struct usersupp *us, void *data) {
        int purge;
        time_t now;
        time_t purge_time;
@@ -325,10 +319,10 @@ void do_user_purge(struct usersupp *us) {
        /* Set purge time; if the user overrides the system default, use it */
        if (us->USuserpurge > 0) {
                purge_time = ((time_t)us->USuserpurge) * 86400L;
-               }
+       }
        else {
                purge_time = ((time_t)config.c_userpurge) * 86400L;
-               }
+       }
 
        /* The default rule is to not purge. */
        purge = 0;
@@ -364,10 +358,10 @@ void do_user_purge(struct usersupp *us) {
                pptr->next = UserPurgeList;
                strcpy(pptr->name, us->fullname);
                UserPurgeList = pptr;
-               }
-
        }
 
+}
+
 
 
 int PurgeUsers(void) {
@@ -377,8 +371,8 @@ int PurgeUsers(void) {
 
        lprintf(5, "PurgeUsers() called\n");
        if (config.c_userpurge > 0) {
-               ForEachUser(do_user_purge);
-               }
+               ForEachUser(do_user_purge, NULL);
+       }
 
        transcript = mallok(256);
        strcpy(transcript, "The following users have been auto-purged:\n");
@@ -392,14 +386,14 @@ int PurgeUsers(void) {
                phree(UserPurgeList);
                UserPurgeList = pptr;
                ++num_users_purged;
-               }
+       }
 
        if (num_users_purged > 0) aide_message(transcript);
        phree(transcript);
 
        lprintf(5, "Purged %d users.\n", num_users_purged);
        return(num_users_purged);
-       }
+}
 
 
 /*
@@ -427,10 +421,10 @@ int PurgeVisits(void) {
        int RoomIsValid, UserIsValid;
 
        /* First, load up a table full of valid room/gen combinations */
-       ForEachRoom(AddValidRoom);
+       ForEachRoom(AddValidRoom, NULL);
 
        /* Then load up a table full of valid user numbers */
-       ForEachUser(AddValidUser);
+       ForEachUser(AddValidUser, NULL);
 
        /* Now traverse through the visits, purging irrelevant records... */
        cdb_rewind(CDB_VISIT);
@@ -449,13 +443,13 @@ int PurgeVisits(void) {
                        if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
                             && (vrptr->vr_roomgen==vbuf.v_roomgen))
                                RoomIsValid = 1;
-                       }
+               }
 
                /* Check to see if the user exists */
                for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
                        if (vuptr->vu_usernum == vbuf.v_usernum)
                                UserIsValid = 1;
-                       }
+               }
 
                /* Put the record on the purge list if it's dead */
                if ((RoomIsValid==0) || (UserIsValid==0)) {
@@ -466,23 +460,23 @@ int PurgeVisits(void) {
                        vptr->vp_roomgen = vbuf.v_roomgen;
                        vptr->vp_usernum = vbuf.v_usernum;
                        VisitPurgeList = vptr;
-                       }
-
                }
 
+       }
+
        /* Free the valid room/gen combination list */
        while (ValidRoomList != NULL) {
                vrptr = ValidRoomList->next;
                phree(ValidRoomList);
                ValidRoomList = vrptr;
-               }
+       }
 
        /* Free the valid user list */
        while (ValidUserList != NULL) {
                vuptr = ValidUserList->next;
                phree(ValidUserList);
                ValidUserList = vuptr;
-               }
+       }
 
        /* Now delete every visit on the purged list */
        while (VisitPurgeList != NULL) {
@@ -495,62 +489,139 @@ int PurgeVisits(void) {
                phree(VisitPurgeList);
                VisitPurgeList = vptr;
                ++purged;
-               }
+       }
        
        return(purged);
-       }
+}
 
 
 void cmd_expi(char *argbuf) {
        char cmd[256];
        int retval;
 
-
-       if ((!(CC->logged_in))&&(!(CC->internal_pgm))) {
-               cprintf("%d Not logged in.\n",ERROR+NOT_LOGGED_IN);
-               return;
-               }
-
-       if ((!is_room_aide()) && (!(CC->internal_pgm)) ) {
-               cprintf("%d Higher access required.\n",
-                       ERROR+HIGHER_ACCESS_REQUIRED);
-               return;
-               }
+       if (CtdlAccessCheck(ac_aide)) return;
 
        extract(cmd, argbuf, 0);
        if (!strcasecmp(cmd, "users")) {
                retval = PurgeUsers();
                cprintf("%d Purged %d users.\n", OK, retval);
                return;
-               }
+       }
        else if (!strcasecmp(cmd, "messages")) {
                PurgeMessages();
                cprintf("%d Expired %d messages.\n", OK, messages_purged);
                return;
-               }
+       }
        else if (!strcasecmp(cmd, "rooms")) {
                retval = PurgeRooms();
                cprintf("%d Expired %d rooms.\n", OK, retval);
                return;
-               }
+       }
        else if (!strcasecmp(cmd, "visits")) {
                retval = PurgeVisits();
                cprintf("%d Purged %d visits.\n", OK, retval);
-               }
+       }
        else if (!strcasecmp(cmd, "defrag")) {
                defrag_databases();
                cprintf("%d Defragmented the databases.\n", OK);
-               }
+       }
        else {
                cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
                return;
+       }
+}
+
+/*****************************************************************************/
+
+
+void do_fsck_msg(long msgnum) {
+       struct roomref *ptr;
+
+       ptr = (struct roomref *)mallok(sizeof(struct roomref));
+       ptr->next = rr;
+       ptr->msgnum = msgnum;
+       rr = ptr;
+}
+
+void do_fsck_room(struct quickroom *qrbuf, void *data)
+{
+       getroom(&CC->quickroom, qrbuf->QRname);
+       CtdlForEachMessage(MSGS_ALL, 0L, (-127), NULL, NULL, do_fsck_msg);
+}
+
+/*
+ * Check message reference counts
+ */
+void cmd_fsck(char *argbuf) {
+       long msgnum;
+       struct cdbdata *cdbmsg;
+       struct SuppMsgInfo smi;
+       struct roomref *ptr;
+       int realcount;
+
+       if (CtdlAccessCheck(ac_aide)) return;
+
+       /* Lame way of checking whether anyone else is doing this now */
+       if (rr != NULL) {
+               cprintf("%d Another FSCK is already running.\n", ERROR);
+               return;
+       }
+
+       cprintf("%d Checking message reference counts\n", LISTING_FOLLOWS);
+
+       cprintf("\nThis could take a while.  Please be patient!\n\n");
+       cprintf("Gathering pointers...\n");
+       ForEachRoom(do_fsck_room, NULL);
+
+       get_control();
+       cprintf("Checking message base...\n");
+       for (msgnum = 0L; msgnum <= CitControl.MMhighest; ++msgnum) {
+
+               cdbmsg = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
+               if (cdbmsg != NULL) {
+                       cdb_free(cdbmsg);
+                       cprintf("Message %7ld    ", msgnum);
+
+                       GetSuppMsgInfo(&smi, msgnum);
+                       cprintf("refcount=%-2d   ", smi.smi_refcount);
+
+                       realcount = 0;
+                       for (ptr = rr; ptr != NULL; ptr = ptr->next) {
+                               if (ptr->msgnum == msgnum) ++realcount;
+                       }
+                       cprintf("realcount=%-2d\n", realcount);
+
+                       if ( (smi.smi_refcount != realcount)
+                          || (realcount == 0) ) {
+                               smi.smi_refcount = realcount;
+                               PutSuppMsgInfo(&smi);
+                               AdjRefCount(msgnum, 0); /* deletes if needed */
+                       }
+
                }
+
        }
 
+       cprintf("Freeing memory...\n");
+       while (rr != NULL) {
+               ptr = rr->next;
+               phree(rr);
+               rr = ptr;
+       }
+
+       cprintf("Done!\n");
+       cprintf("000\n");
+
+}
+
+
+
 
+/*****************************************************************************/
 
-struct DLModule_Info *Dynamic_Module_Init(void)
+char *Dynamic_Module_Init(void)
 {
-   CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
-   return &info;
+       CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
+       CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
+       return "$Id$";
 }