Moved to new module init structure.
[citadel.git] / citadel / serv_expire.c
index 2ee22eae2899edae45be8d16776928702b81b2ff..66b46570d54153bd0b202af2b454ca053ceb2b94 100644 (file)
 #include <limits.h>
 #include "citadel.h"
 #include "server.h"
-#include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
 #include "config.h"
-#include "serv_extensions.h"
 #include "room_ops.h"
 #include "policy.h"
 #include "database.h"
@@ -66,6 +64,9 @@
 #include "tools.h"
 
 
+#include "ctdl_module.h"
+
+
 struct PurgeList {
        struct PurgeList *next;
        char name[ROOMNAMELEN]; /* use the larger of username or roomname */
@@ -97,7 +98,13 @@ struct ctdlroomref {
 
 struct UPurgeList {
        struct UPurgeList *next;
-       char up_key[SIZ];
+       char up_key[256];
+};
+
+struct EPurgeList {
+       struct EPurgeList *next;
+       int ep_keylen;
+       char *ep_key;
 };
 
 
@@ -106,6 +113,7 @@ struct PurgeList *RoomPurgeList = NULL;
 struct ValidRoom *ValidRoomList = NULL;
 struct ValidUser *ValidUserList = NULL;
 int messages_purged;
+int users_not_purged;
 
 struct ctdlroomref *rr = NULL;
 
@@ -120,7 +128,7 @@ void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
        struct ExpirePolicy epbuf;
        long delnum;
        time_t xtime, now;
-       struct CtdlMessage *msg;
+       struct CtdlMessage *msg = NULL;
        int a;
         struct cdbdata *cdbfr;
        long *msglist = NULL;
@@ -206,7 +214,7 @@ void DoPurgeMessages(FILE *purgelist) {
                if (!strncasecmp(buf, "m=", 2)) {
                        msgnum = atol(&buf[2]);
                        if (msgnum > 0L) {
-                               CtdlDeleteMessages(roomname, msgnum, "");
+                               CtdlDeleteMessages(roomname, &msgnum, 1, "");
                        }
                }
        }
@@ -344,7 +352,7 @@ int PurgeRooms(void) {
                ++num_rooms_purged;
        }
 
-       if (num_rooms_purged > 0) aide_message(transcript);
+       if (num_rooms_purged > 0) aide_message(transcript, "Room Autopurger Message");
        free(transcript);
 
        lprintf(CTDL_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
@@ -354,13 +362,12 @@ int PurgeRooms(void) {
 
 /*
  * Back end function to check user accounts for associated Unix accounts
- * which no longer exist.
+ * which no longer exist.  (Only relevant for host auth mode.)
  */
 void do_uid_user_purge(struct ctdluser *us, void *data) {
-#ifdef ENABLE_AUTOLOGIN
        struct PurgeList *pptr;
 
-       if ((us->uid != (-1)) && (us->uid != BBSUID)) {
+       if ((us->uid != (-1)) && (us->uid != CTDLUID)) {
                if (getpwuid(us->uid) == NULL) {
                        pptr = (struct PurgeList *)
                                malloc(sizeof(struct PurgeList));
@@ -369,8 +376,9 @@ void do_uid_user_purge(struct ctdluser *us, void *data) {
                        UserPurgeList = pptr;
                }
        }
-
-#endif /* ENABLE_AUTOLOGIN */
+       else {
+               ++users_not_purged;
+       }
 }
 
 
@@ -384,17 +392,6 @@ void do_user_purge(struct ctdluser *us, void *data) {
        time_t purge_time;
        struct PurgeList *pptr;
 
-       /* stupid recovery routine to re-create missing mailboxen.
-        * don't enable this.
-       struct ctdlroom qrbuf;
-       char mailboxname[ROOMNAMELEN];
-       MailboxName(mailboxname, us, MAILROOM);
-       create_room(mailboxname, 4, "", 0, 1, 1, VIEW_BBS);
-       if (getroom(&qrbuf, mailboxname) != 0) return;
-       lprintf(CTDL_DEBUG, "Got %s\n", qrbuf.QRname);
-        */
-
-
        /* Set purge time; if the user overrides the system default, use it */
        if (us->USuserpurge > 0) {
                purge_time = ((time_t)us->USuserpurge) * 86400L;
@@ -421,6 +418,10 @@ void do_user_purge(struct ctdluser *us, void *data) {
         */
        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.
@@ -432,12 +433,20 @@ void do_user_purge(struct ctdluser *us, void *data) {
         */
        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 *) malloc(sizeof(struct PurgeList));
                pptr->next = UserPurgeList;
                strcpy(pptr->name, us->fullname);
                UserPurgeList = pptr;
        }
+       else {
+               ++users_not_purged;
+       }
 
 }
 
@@ -449,26 +458,49 @@ int PurgeUsers(void) {
        char *transcript = NULL;
 
        lprintf(CTDL_DEBUG, "PurgeUsers() called\n");
-       if (config.c_userpurge > 0) {
-               ForEachUser(do_user_purge, NULL);
+       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);
+               }
        }
-       ForEachUser(do_uid_user_purge, NULL);
 
        transcript = malloc(SIZ);
-       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 (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;
+               }
+       }
+
+       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);
+       if (num_users_purged > 0) aide_message(transcript, "User Purge Message");
        free(transcript);
 
        lprintf(CTDL_DEBUG, "Purged %d users.\n", num_users_purged);
@@ -599,7 +631,7 @@ int PurgeUseTable(void) {
                        uptr = (struct UPurgeList *) malloc(sizeof(struct UPurgeList));
                        if (uptr != NULL) {
                                uptr->next = ul;
-                               safestrncpy(uptr->up_key, ut.ut_msgid, SIZ);
+                               safestrncpy(uptr->up_key, ut.ut_msgid, sizeof uptr->up_key);
                                ul = uptr;
                        }
                        ++purged;
@@ -621,6 +653,61 @@ int PurgeUseTable(void) {
 }
 
 
+
+/*
+ * 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 purge_databases(void) {
        int retval;
        static time_t last_purge = 0;
@@ -653,6 +740,12 @@ void purge_databases(void) {
        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 */
@@ -673,7 +766,7 @@ void do_fsck_msg(long msgnum, void *userdata) {
 void do_fsck_room(struct ctdlroom *qrbuf, void *data)
 {
        getroom(&CC->room, qrbuf->QRname);
-       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, do_fsck_msg, NULL);
+       CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, do_fsck_msg, NULL);
 }
 
 /*
@@ -720,9 +813,7 @@ void cmd_fsck(char *argbuf) {
 
                        if ( (smi.meta_refcount != realcount)
                           || (realcount == 0) ) {
-                               smi.meta_refcount = realcount;
-                               PutMetaData(&smi);
-                               AdjRefCount(msgnum, 0); /* deletes if needed */
+                               AdjRefCount(msgnum, (smi.meta_refcount - realcount));
                        }
 
                }
@@ -746,9 +837,11 @@ void cmd_fsck(char *argbuf) {
 
 /*****************************************************************************/
 
-char *serv_expire_init(void)
+CTDL_MODULE_INIT(expire)
 {
        CtdlRegisterSessionHook(purge_databases, EVT_TIMER);
        CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
+
+       /* return our Subversion id for the Log */
        return "$Id$";
 }