Moved to new module init structure.
[citadel.git] / citadel / serv_expire.c
index 5bfb0be56970b1cda60cc934ce1ed052c4bbf9c3..66b46570d54153bd0b202af2b454ca053ceb2b94 100644 (file)
@@ -1,10 +1,9 @@
 /*
- * serv_expire.c
+ * $Id$
  *
  * This module handles the expiry of old messages and the purging of old users.
  *
  */
-/* $Id$ */
 
 
 /*
  * then the second stage deletes all listed objects from the database.
  *
  * At first glance this may seem cumbersome and unnecessary.  The reason it is
- * implemented in this way is because GDBM (and perhaps some other backends we
- * may hook into in the future) explicitly do _not_ support the deletion of
+ * implemented in this way is because Berkeley DB, and possibly other backends
+ * we may hook into in the future, explicitly do _not_ support the deletion of
  * records from a file while the file is being traversed.  The delete operation
  * will succeed, but the traversal is not guaranteed to visit every object if
  * this is done.  Therefore we utilize the two-stage purge.
+ *
+ * When using Berkeley DB, there's another reason for the two-phase purge: we
+ * don't want the entire thing being done as one huge transaction.
  */
 
 
 #include <pwd.h>
 #include <errno.h>
 #include <sys/types.h>
-#include <sys/time.h>
+
+#if TIME_WITH_SYS_TIME
+# include <sys/time.h>
+# include <time.h>
+#else
+# if HAVE_SYS_TIME_H
+#  include <sys/time.h>
+# else
+#  include <time.h>
+# endif
+#endif
+
 #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>
-#include <time.h>
-#include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
 #include "config.h"
-#include "dynloader.h"
 #include "room_ops.h"
 #include "policy.h"
 #include "database.h"
 #include "msgbase.h"
 #include "user_ops.h"
 #include "control.h"
+#include "serv_network.h"
 #include "tools.h"
 
 
-struct oldvisit {
-       char v_roomname[ROOMNAMELEN];
-       long v_generation;
-       long v_lastseen;
-       unsigned int v_flags;
-       };
+#include "ctdl_module.h"
+
 
 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 ctdlroomref {
+       struct ctdlroomref *next;
+       long msgnum;
+};
+
+struct UPurgeList {
+       struct UPurgeList *next;
+       char up_key[256];
+};
+
+struct EPurgeList {
+       struct EPurgeList *next;
+       int ep_keylen;
+       char *ep_key;
+};
+
 
 struct PurgeList *UserPurgeList = NULL;
 struct PurgeList *RoomPurgeList = NULL;
 struct ValidRoom *ValidRoomList = NULL;
 struct ValidUser *ValidUserList = NULL;
 int messages_purged;
+int users_not_purged;
+
+struct ctdlroomref *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) {
+
+/*
+ * First phase of message purge -- gather the locations of messages which
+ * qualify for purging and write them to a temp file.
+ */
+void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
        struct ExpirePolicy epbuf;
        long delnum;
        time_t xtime, now;
-       char msgid[64];
+       struct CtdlMessage *msg = NULL;
        int a;
         struct cdbdata *cdbfr;
        long *msglist = NULL;
        int num_msgs = 0;
+       FILE *purgelist;
+
+       purgelist = (FILE *)data;
+       fprintf(purgelist, "r=%s\n", qrbuf->QRname);
 
        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;
 
-       begin_critical_section(S_QUICKROOM);
         cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
 
         if (cdbfr != NULL) {
-               msglist = mallok(cdbfr->len);
+               msglist = malloc(cdbfr->len);
                memcpy(msglist, cdbfr->ptr, cdbfr->len);
                num_msgs = cdbfr->len / sizeof(long);
                cdb_free(cdbfr);
        }
-       
+
        /* Nothing to do if there aren't any messages */
        if (num_msgs == 0) {
-               end_critical_section(S_QUICKROOM);
+               if (msglist != NULL) free(msglist);
                return;
-               }
+       }
 
        /* If the room is set to expire by count, do that */
        if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
-               while (num_msgs > epbuf.expire_value) {
-                       delnum = msglist[0];
-                       lprintf(5, "Expiring message %ld\n", delnum);
-                       AdjRefCount(delnum, -1); 
-                       memcpy(&msglist[0], &msglist[1],
-                               (sizeof(long)*(num_msgs - 1)));
-                       --num_msgs;
-                       ++messages_purged;
+               if (num_msgs > epbuf.expire_value) {
+                       for (a=0; a<(num_msgs - epbuf.expire_value); ++a) {
+                               fprintf(purgelist, "m=%ld\n", msglist[a]);
+                               ++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, 0); /* dont need body */
+                       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))) {
-                               lprintf(5, "Expiring message %ld\n", delnum);
-                               AdjRefCount(delnum, -1); 
-                               msglist[a] = 0L;
+                               fprintf(purgelist, "m=%ld\n", delnum);
                                ++messages_purged;
-                               }
                        }
                }
-
-       if (num_msgs > 0) {
-               num_msgs = sort_msglist(msglist, num_msgs);
        }
-       
-       cdb_store(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long),
-               msglist, (num_msgs * sizeof(long)) );
 
-       if (msglist != NULL) phree(msglist);
+       if (msglist != NULL) free(msglist);
+}
 
-       end_critical_section(S_QUICKROOM);
+
+/*
+ * Second phase of message purge -- read list of msgs from temp file and
+ * delete them.
+ */
+void DoPurgeMessages(FILE *purgelist) {
+       char roomname[ROOMNAMELEN];
+       long msgnum;
+       char buf[SIZ];
+
+       rewind(purgelist);
+       strcpy(roomname, "nonexistent room ___ ___");
+       while (fgets(buf, sizeof buf, purgelist) != NULL) {
+               buf[strlen(buf)-1]=0;
+               if (!strncasecmp(buf, "r=", 2)) {
+                       strcpy(roomname, &buf[2]);
+               }
+               if (!strncasecmp(buf, "m=", 2)) {
+                       msgnum = atol(&buf[2]);
+                       if (msgnum > 0L) {
+                               CtdlDeleteMessages(roomname, &msgnum, 1, "");
+                       }
+               }
        }
+}
+
 
 void PurgeMessages(void) {
-       lprintf(5, "PurgeMessages() called\n");
+       FILE *purgelist;
+
+       lprintf(CTDL_DEBUG, "PurgeMessages() called\n");
        messages_purged = 0;
-       ForEachRoom(DoPurgeMessages);
+
+       purgelist = tmpfile();
+       if (purgelist == NULL) {
+               lprintf(CTDL_CRIT, "Can't create purgelist temp file: %s\n",
+                       strerror(errno));
+               return;
+       }
+
+       ForEachRoom(GatherPurgeMessages, (void *)purgelist );
+       DoPurgeMessages(purgelist);
+       fclose(purgelist);
 }
 
 
-void AddValidUser(struct usersupp *usbuf) {
+void AddValidUser(struct ctdluser *usbuf, void *data) {
        struct ValidUser *vuptr;
 
-       vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
+       vuptr = (struct ValidUser *)malloc(sizeof(struct ValidUser));
        vuptr->next = ValidUserList;
        vuptr->vu_usernum = usbuf->usernum;
        ValidUserList = vuptr;
-       }
+}
 
-void AddValidRoom(struct quickroom *qrbuf) {
+void AddValidRoom(struct ctdlroom *qrbuf, void *data) {
        struct ValidRoom *vrptr;
 
-       vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
+       vrptr = (struct ValidRoom *)malloc(sizeof(struct ValidRoom));
        vrptr->next = ValidRoomList;
        vrptr->vr_roomnum = qrbuf->QRnumber;
        vrptr->vr_roomgen = qrbuf->QRgen;
        ValidRoomList = vrptr;
-       }
+}
 
-void DoPurgeRooms(struct quickroom *qrbuf) {
+void DoPurgeRooms(struct ctdlroom *qrbuf, void *data) {
        time_t age, purge_secs;
        struct PurgeList *pptr;
        struct ValidUser *vuptr;
@@ -226,97 +270,123 @@ void DoPurgeRooms(struct quickroom *qrbuf) {
         * it.  Bypass any other rules.
         */
        if (qrbuf->QRflags & QR_MAILBOX) {
+               /* if user not found, do_purge will be 1 */
+               do_purge = 1;
                for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
                        if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
                                do_purge = 0;
-                               goto BYPASS;
                        }
                }
-               /* user not found */
-               do_purge = 1;
-               goto BYPASS;
        }
-
-       /* Any of these attributes render a room non-purgable */
-       if (qrbuf->QRflags & QR_PERMANENT) return;
-       if (qrbuf->QRflags & QR_DIRECTORY) return;
-       if (qrbuf->QRflags & QR_NETWORK) return;
-       if (is_noneditable(qrbuf)) return;
-
-       /* If we don't know the modification date, be safe and don't purge */
-       if (qrbuf->QRmtime <= (time_t)0) return;
-
-       /* If no room purge time is set, be safe and don't purge */
-       if (config.c_roompurge < 0) return;
-
-       /* Otherwise, check the date of last modification */
-       age = time(NULL) - (qrbuf->QRmtime);
-       purge_secs = (time_t)config.c_roompurge * (time_t)86400;
-       if (purge_secs <= (time_t)0) return;
-       lprintf(9, "<%s> is <%ld> seconds old\n", qrbuf->QRname, age);
-       if (age > purge_secs) do_purge = 1;
-
-BYPASS:        if (do_purge) {
-               pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
+       else {
+               /* Any of these attributes render a room non-purgable */
+               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 */
+               if (qrbuf->QRmtime <= (time_t)0) return;
+
+               /* If no room purge time is set, be safe and don't purge */
+               if (config.c_roompurge < 0) return;
+
+               /* Otherwise, check the date of last modification */
+               age = time(NULL) - (qrbuf->QRmtime);
+               purge_secs = (time_t)config.c_roompurge * (time_t)86400;
+               if (purge_secs <= (time_t)0) return;
+               lprintf(CTDL_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
+               if (age > purge_secs) do_purge = 1;
+       } /* !QR_MAILBOX */
+
+       if (do_purge) {
+               pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
                pptr->next = RoomPurgeList;
                strcpy(pptr->name, qrbuf->QRname);
                RoomPurgeList = pptr;
        }
 
 }
-       
+
 
 
 int PurgeRooms(void) {
        struct PurgeList *pptr;
        int num_rooms_purged = 0;
-       struct quickroom qrbuf;
+       struct ctdlroom qrbuf;
        struct ValidUser *vuptr;
        char *transcript = NULL;
 
-       lprintf(5, "PurgeRooms() called\n");
+       lprintf(CTDL_DEBUG, "PurgeRooms() called\n");
 
 
        /* 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);
+               free(ValidUserList);
                ValidUserList = vuptr;
-               }
+       }
 
 
-       transcript = mallok(256);
+       transcript = malloc(SIZ);
        strcpy(transcript, "The following rooms have been auto-purged:\n");
 
        while (RoomPurgeList != NULL) {
                if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
-                       transcript=reallok(transcript, strlen(transcript)+256);
-                       sprintf(&transcript[strlen(transcript)], " %s\n",
+                       transcript=realloc(transcript, strlen(transcript)+SIZ);
+                       snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
                                qrbuf.QRname);
                        delete_room(&qrbuf);
-                       }
+               }
                pptr = RoomPurgeList->next;
-               phree(RoomPurgeList);
+               free(RoomPurgeList);
                RoomPurgeList = pptr;
                ++num_rooms_purged;
-               }
+       }
 
-       if (num_rooms_purged > 0) aide_message(transcript);
-       phree(transcript);
+       if (num_rooms_purged > 0) aide_message(transcript, "Room Autopurger Message");
+       free(transcript);
 
-       lprintf(5, "Purged %d rooms.\n", num_rooms_purged);
+       lprintf(CTDL_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
        return(num_rooms_purged);
+}
+
+
+/*
+ * Back end function to check user accounts for associated Unix accounts
+ * which no longer exist.  (Only relevant for host auth mode.)
+ */
+void do_uid_user_purge(struct ctdluser *us, void *data) {
+       struct PurgeList *pptr;
+
+       if ((us->uid != (-1)) && (us->uid != CTDLUID)) {
+               if (getpwuid(us->uid) == NULL) {
+                       pptr = (struct PurgeList *)
+                               malloc(sizeof(struct PurgeList));
+                       pptr->next = UserPurgeList;
+                       strcpy(pptr->name, us->fullname);
+                       UserPurgeList = pptr;
+               }
        }
+       else {
+               ++users_not_purged;
+       }
+}
 
 
-void do_user_purge(struct usersupp *us) {
+
+/*
+ * Back end function to check user accounts for expiration.
+ */
+void do_user_purge(struct ctdluser *us, void *data) {
        int purge;
        time_t now;
        time_t purge_time;
@@ -325,10 +395,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;
@@ -348,6 +418,10 @@ void do_user_purge(struct usersupp *us) {
         */
        if (us->flags & US_PERM) purge = 0;
 
+       /* If the user is an Aide, don't purge him/her/it.
+        */
+       if (us->axlevel == 6) purge = 0;
+
        /* If the access level is 0, the record should already have been
         * deleted, but maybe the user was logged in at the time or something.
         * Delete the record now.
@@ -359,15 +433,23 @@ void do_user_purge(struct usersupp *us) {
         */
        if (us->timescalled == 0) purge = 1;
 
+       /* User number 0, as well as any negative user number, is
+        * also impossible.
+        */
+       if (us->usernum < 1L) purge = 1;
+
        if (purge == 1) {
-               pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
+               pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
                pptr->next = UserPurgeList;
                strcpy(pptr->name, us->fullname);
                UserPurgeList = pptr;
-               }
-
+       }
+       else {
+               ++users_not_purged;
        }
 
+}
+
 
 
 int PurgeUsers(void) {
@@ -375,31 +457,55 @@ int PurgeUsers(void) {
        int num_users_purged = 0;
        char *transcript = NULL;
 
-       lprintf(5, "PurgeUsers() called\n");
-       if (config.c_userpurge > 0) {
-               ForEachUser(do_user_purge);
+       lprintf(CTDL_DEBUG, "PurgeUsers() called\n");
+       users_not_purged = 0;
+
+       if (config.c_auth_mode == 1) {
+               /* host auth mode */
+               ForEachUser(do_uid_user_purge, NULL);
+       }
+       else {
+               /* native auth mode */
+               if (config.c_userpurge > 0) {
+                       ForEachUser(do_user_purge, NULL);
                }
+       }
 
-       transcript = mallok(256);
-       strcpy(transcript, "The following users have been auto-purged:\n");
+       transcript = malloc(SIZ);
+
+       if (users_not_purged == 0) {
+               strcpy(transcript, "The auto-purger was told to purge every user.  It is\n"
+                               "refusing to do this because it usually indicates a problem\n"
+                               "such as an inability to communicate with a name service.\n"
+               );
+               while (UserPurgeList != NULL) {
+                       pptr = UserPurgeList->next;
+                       free(UserPurgeList);
+                       UserPurgeList = pptr;
+                       ++num_users_purged;
+               }
+       }
 
-       while (UserPurgeList != NULL) {
-               transcript=reallok(transcript, strlen(transcript)+256);
-               sprintf(&transcript[strlen(transcript)], " %s\n",
-                       UserPurgeList->name);
-               purge_user(UserPurgeList->name);
-               pptr = UserPurgeList->next;
-               phree(UserPurgeList);
-               UserPurgeList = pptr;
-               ++num_users_purged;
+       else {
+               strcpy(transcript, "The following users have been auto-purged:\n");
+               while (UserPurgeList != NULL) {
+                       transcript=realloc(transcript, strlen(transcript)+SIZ);
+                       snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
+                               UserPurgeList->name);
+                       purge_user(UserPurgeList->name);
+                       pptr = UserPurgeList->next;
+                       free(UserPurgeList);
+                       UserPurgeList = pptr;
+                       ++num_users_purged;
                }
+       }
 
-       if (num_users_purged > 0) aide_message(transcript);
-       phree(transcript);
+       if (num_users_purged > 0) aide_message(transcript, "User Purge Message");
+       free(transcript);
 
-       lprintf(5, "Purged %d users.\n", num_users_purged);
+       lprintf(CTDL_DEBUG, "Purged %d users.\n", num_users_purged);
        return(num_users_purged);
-       }
+}
 
 
 /*
@@ -427,10 +533,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,40 +555,40 @@ 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)) {
                        vptr = (struct VPurgeList *)
-                               mallok(sizeof(struct VPurgeList));
+                               malloc(sizeof(struct VPurgeList));
                        vptr->next = VisitPurgeList;
                        vptr->vp_roomnum = vbuf.v_roomnum;
                        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);
+               free(ValidRoomList);
                ValidRoomList = vrptr;
-               }
+       }
 
        /* Free the valid user list */
        while (ValidUserList != NULL) {
                vuptr = ValidUserList->next;
-               phree(ValidUserList);
+               free(ValidUserList);
                ValidUserList = vuptr;
-               }
+       }
 
        /* Now delete every visit on the purged list */
        while (VisitPurgeList != NULL) {
@@ -492,65 +598,250 @@ int PurgeVisits(void) {
                                VisitPurgeList->vp_usernum);
                cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
                vptr = VisitPurgeList->next;
-               phree(VisitPurgeList);
+               free(VisitPurgeList);
                VisitPurgeList = vptr;
                ++purged;
+       }
+
+       return(purged);
+}
+
+/*
+ * Purge the use table of old entries.
+ *
+ */
+int PurgeUseTable(void) {
+       int purged = 0;
+       struct cdbdata *cdbut;
+       struct UseTable ut;
+       struct UPurgeList *ul = NULL;
+       struct UPurgeList *uptr; 
+
+       /* Phase 1: traverse through the table, discovering old records... */
+       lprintf(CTDL_DEBUG, "Purge use table: phase 1\n");
+       cdb_rewind(CDB_USETABLE);
+       while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL) {
+
+                memcpy(&ut, cdbut->ptr,
+                       ((cdbut->len > sizeof(struct UseTable)) ?
+                        sizeof(struct UseTable) : cdbut->len));
+                cdb_free(cdbut);
+
+               if ( (time(NULL) - ut.ut_timestamp) > USETABLE_RETAIN ) {
+                       uptr = (struct UPurgeList *) malloc(sizeof(struct UPurgeList));
+                       if (uptr != NULL) {
+                               uptr->next = ul;
+                               safestrncpy(uptr->up_key, ut.ut_msgid, sizeof uptr->up_key);
+                               ul = uptr;
+                       }
+                       ++purged;
                }
-       
+
+       }
+
+       /* Phase 2: delete the records */
+       lprintf(CTDL_DEBUG, "Purge use table: phase 2\n");
+       while (ul != NULL) {
+               cdb_delete(CDB_USETABLE, ul->up_key, strlen(ul->up_key));
+               uptr = ul->next;
+               free(ul);
+               ul = uptr;
+       }
+
+       lprintf(CTDL_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
        return(purged);
+}
+
+
+
+/*
+ * Purge the EUID Index of old records.
+ *
+ */
+int PurgeEuidIndexTable(void) {
+       int purged = 0;
+       struct cdbdata *cdbei;
+       struct EPurgeList *el = NULL;
+       struct EPurgeList *eptr; 
+       long msgnum;
+       struct CtdlMessage *msg = NULL;
+
+       /* Phase 1: traverse through the table, discovering old records... */
+       lprintf(CTDL_DEBUG, "Purge EUID index: phase 1\n");
+       cdb_rewind(CDB_EUIDINDEX);
+       while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei != NULL) {
+
+               memcpy(&msgnum, cdbei->ptr, sizeof(long));
+
+               msg = CtdlFetchMessage(msgnum, 0);
+               if (msg != NULL) {
+                       CtdlFreeMessage(msg);   /* it still exists, so do nothing */
+               }
+               else {
+                       eptr = (struct EPurgeList *) malloc(sizeof(struct EPurgeList));
+                       if (eptr != NULL) {
+                               eptr->next = el;
+                               eptr->ep_keylen = cdbei->len - sizeof(long);
+                               eptr->ep_key = malloc(cdbei->len);
+                               memcpy(eptr->ep_key, &cdbei->ptr[sizeof(long)], eptr->ep_keylen);
+                               el = eptr;
+                       }
+                       ++purged;
+               }
+
+                cdb_free(cdbei);
+
+       }
+
+       /* Phase 2: delete the records */
+       lprintf(CTDL_DEBUG, "Purge euid index: phase 2\n");
+       while (el != NULL) {
+               cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
+               free(el->ep_key);
+               eptr = el->next;
+               free(el);
+               el = eptr;
        }
 
+       lprintf(CTDL_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
+       return(purged);
+}
+
 
-void cmd_expi(char *argbuf) {
-       char cmd[256];
+void purge_databases(void) {
        int retval;
+       static time_t last_purge = 0;
+       time_t now;
+       struct tm tm;
 
+       /* Do the auto-purge if the current hour equals the purge hour,
+        * but not if the operation has already been performed in the
+        * last twelve hours.  This is usually enough granularity.
+        */
+       now = time(NULL);
+       localtime_r(&now, &tm);
+       if (tm.tm_hour != config.c_purge_hour) return;
+       if ((now - last_purge) < 43200) return;
 
-       if ((!(CC->logged_in))&&(!(CC->internal_pgm))) {
-               cprintf("%d Not logged in.\n",ERROR+NOT_LOGGED_IN);
-               return;
-               }
+       lprintf(CTDL_INFO, "Auto-purger: starting.\n");
 
-       if ((!is_room_aide()) && (!(CC->internal_pgm)) ) {
-               cprintf("%d Higher access required.\n",
-                       ERROR+HIGHER_ACCESS_REQUIRED);
-               return;
-               }
+       retval = PurgeUsers();
+       lprintf(CTDL_NOTICE, "Purged %d users.\n", retval);
 
-       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);
+       PurgeMessages();
+       lprintf(CTDL_NOTICE, "Expired %d messages.\n", messages_purged);
+
+       retval = PurgeRooms();
+       lprintf(CTDL_NOTICE, "Expired %d rooms.\n", retval);
+
+       retval = PurgeVisits();
+       lprintf(CTDL_NOTICE, "Purged %d visits.\n", retval);
+
+       retval = PurgeUseTable();
+       lprintf(CTDL_NOTICE, "Purged %d entries from the use table.\n", retval);
+
+       retval = PurgeEuidIndexTable();
+       lprintf(CTDL_NOTICE, "Purged %d entries from the EUID index.\n", retval);
+
+       retval = TDAP_ProcessAdjRefCountQueue();
+       lprintf(CTDL_NOTICE, "Processed %d message reference count adjustments.\n", retval);
+
+       lprintf(CTDL_INFO, "Auto-purger: finished.\n");
+
+       last_purge = now;       /* So we don't do it again soon */
+}
+
+/*****************************************************************************/
+
+
+void do_fsck_msg(long msgnum, void *userdata) {
+       struct ctdlroomref *ptr;
+
+       ptr = (struct ctdlroomref *)malloc(sizeof(struct ctdlroomref));
+       ptr->next = rr;
+       ptr->msgnum = msgnum;
+       rr = ptr;
+}
+
+void do_fsck_room(struct ctdlroom *qrbuf, void *data)
+{
+       getroom(&CC->room, qrbuf->QRname);
+       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, do_fsck_msg, NULL);
+}
+
+/*
+ * Check message reference counts
+ */
+void cmd_fsck(char *argbuf) {
+       long msgnum;
+       struct cdbdata *cdbmsg;
+       struct MetaData smi;
+       struct ctdlroomref *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 + RESOURCE_BUSY);
                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);
+
+                       GetMetaData(&smi, msgnum);
+                       cprintf("refcount=%-2d   ", smi.meta_refcount);
+
+                       realcount = 0;
+                       for (ptr = rr; ptr != NULL; ptr = ptr->next) {
+                               if (ptr->msgnum == msgnum) ++realcount;
+                       }
+                       cprintf("realcount=%-2d\n", realcount);
+
+                       if ( (smi.meta_refcount != realcount)
+                          || (realcount == 0) ) {
+                               AdjRefCount(msgnum, (smi.meta_refcount - realcount));
+                       }
+
                }
+
+       }
+
+       cprintf("Freeing memory...\n");
+       while (rr != NULL) {
+               ptr = rr->next;
+               free(rr);
+               rr = ptr;
        }
 
+       cprintf("Done!\n");
+       cprintf("000\n");
+
+}
+
 
 
-struct DLModule_Info *Dynamic_Module_Init(void)
+
+/*****************************************************************************/
+
+CTDL_MODULE_INIT(expire)
 {
-   CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
-   return &info;
+       CtdlRegisterSessionHook(purge_databases, EVT_TIMER);
+       CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
+
+       /* return our Subversion id for the Log */
+       return "$Id$";
 }