]> code.citadel.org Git - citadel.git/blobdiff - citadel/serv_expire.c
* Add specific error codes for every command on the wire protocol, so that
[citadel.git] / citadel / serv_expire.c
index 76ccd8e6b21848744edf8401e729089eb3300697..f3de34e25b1b7d8299e3cd61b36d4bb6328ebe89 100644 (file)
@@ -14,8 +14,8 @@
  * 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.
@@ -51,7 +51,6 @@
 #include <limits.h>
 #include "citadel.h"
 #include "server.h"
-#include <syslog.h>
 #include "sysdep_decls.h"
 #include "citserver.h"
 #include "support.h"
@@ -91,8 +90,8 @@ struct ValidUser {
 };
 
 
-struct roomref {
-       struct roomref *next;
+struct ctdlroomref {
+       struct ctdlroomref *next;
        long msgnum;
 };
 
@@ -108,7 +107,7 @@ struct ValidRoom *ValidRoomList = NULL;
 struct ValidUser *ValidUserList = NULL;
 int messages_purged;
 
-struct roomref *rr = NULL;
+struct ctdlroomref *rr = NULL;
 
 extern struct CitContext *ContextList;
 
@@ -117,7 +116,7 @@ extern struct CitContext *ContextList;
  * First phase of message purge -- gather the locations of messages which
  * qualify for purging and write them to a temp file.
  */
-void GatherPurgeMessages(struct room *qrbuf, void *data) {
+void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
        struct ExpirePolicy epbuf;
        long delnum;
        time_t xtime, now;
@@ -233,7 +232,7 @@ void PurgeMessages(void) {
 }
 
 
-void AddValidUser(struct user *usbuf, void *data) {
+void AddValidUser(struct ctdluser *usbuf, void *data) {
        struct ValidUser *vuptr;
 
        vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
@@ -242,7 +241,7 @@ void AddValidUser(struct user *usbuf, void *data) {
        ValidUserList = vuptr;
 }
 
-void AddValidRoom(struct room *qrbuf, void *data) {
+void AddValidRoom(struct ctdlroom *qrbuf, void *data) {
        struct ValidRoom *vrptr;
 
        vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
@@ -252,7 +251,7 @@ void AddValidRoom(struct room *qrbuf, void *data) {
        ValidRoomList = vrptr;
 }
 
-void DoPurgeRooms(struct room *qrbuf, void *data) {
+void DoPurgeRooms(struct ctdlroom *qrbuf, void *data) {
        time_t age, purge_secs;
        struct PurgeList *pptr;
        struct ValidUser *vuptr;
@@ -307,7 +306,7 @@ void DoPurgeRooms(struct room *qrbuf, void *data) {
 int PurgeRooms(void) {
        struct PurgeList *pptr;
        int num_rooms_purged = 0;
-       struct room qrbuf;
+       struct ctdlroom qrbuf;
        struct ValidUser *vuptr;
        char *transcript = NULL;
 
@@ -353,7 +352,7 @@ int PurgeRooms(void) {
 }
 
 
-void do_user_purge(struct user *us, void *data) {
+void do_user_purge(struct ctdluser *us, void *data) {
        int purge;
        time_t now;
        time_t purge_time;
@@ -361,7 +360,7 @@ void do_user_purge(struct user *us, void *data) {
 
        /* stupid recovery routine to re-create missing mailboxen.
         * don't enable this.
-       struct room qrbuf;
+       struct ctdlroom qrbuf;
        char mailboxname[ROOMNAMELEN];
        MailboxName(mailboxname, us, MAILROOM);
        create_room(mailboxname, 4, "", 0, 1, 1);
@@ -595,60 +594,56 @@ int PurgeUseTable(void) {
 }
 
 
-void cmd_expi(char *argbuf) {
-       char cmd[SIZ];
+void purge_databases(void) {
        int retval;
+       static time_t last_purge = 0;
+       time_t now;
+       struct tm tm;
 
-       if (CtdlAccessCheck(ac_aide)) return;
+       /* 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);
+       memcpy(&tm, localtime(&now), sizeof(struct tm));
+       if (tm.tm_hour != config.c_purge_hour) return;
+       if ((now - last_purge) < 43200) return;
 
-       extract(cmd, argbuf, 0);
-       if (!strcasecmp(cmd, "users")) {
-               retval = PurgeUsers();
-               cprintf("%d Purged %d users.\n", CIT_OK, retval);
-               return;
-       }
-       else if (!strcasecmp(cmd, "messages")) {
-               PurgeMessages();
-               cprintf("%d Expired %d messages.\n", CIT_OK, messages_purged);
-               return;
-       }
-       else if (!strcasecmp(cmd, "rooms")) {
-               retval = PurgeRooms();
-               cprintf("%d Expired %d rooms.\n", CIT_OK, retval);
-               return;
-       }
-       else if (!strcasecmp(cmd, "visits")) {
-               retval = PurgeVisits();
-               cprintf("%d Purged %d visits.\n", CIT_OK, retval);
-       }
-       else if (!strcasecmp(cmd, "usetable")) {
-               retval = PurgeUseTable();
-               cprintf("%d Purged %d entries from the use table.\n",
-                       CIT_OK, retval);
-       }
-       else if (!strcasecmp(cmd, "defrag")) {
-               defrag_databases();
-               cprintf("%d Defragmented the databases.\n", CIT_OK);
-       }
-       else {
-               cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
-               return;
-       }
+       lprintf(3, "Auto-purger: starting.\n");
+
+       retval = PurgeUsers();
+       lprintf(3, "Purged %d users.\n", retval);
+
+       PurgeMessages();
+       lprintf(3, "Expired %d messages.\n", messages_purged);
+
+       retval = PurgeRooms();
+       lprintf(3, "Expired %d rooms.\n", retval);
+
+       retval = PurgeVisits();
+       lprintf(3, "Purged %d visits.\n", retval);
+
+       retval = PurgeUseTable();
+       lprintf(3, "Purged %d entries from the use table.\n", retval);
+
+       lprintf(3, "Auto-purger: finished.\n");
+
+       last_purge = now;       /* So we don't do it again soon */
 }
 
 /*****************************************************************************/
 
 
 void do_fsck_msg(long msgnum, void *userdata) {
-       struct roomref *ptr;
+       struct ctdlroomref *ptr;
 
-       ptr = (struct roomref *)mallok(sizeof(struct roomref));
+       ptr = (struct ctdlroomref *)mallok(sizeof(struct ctdlroomref));
        ptr->next = rr;
        ptr->msgnum = msgnum;
        rr = ptr;
 }
 
-void do_fsck_room(struct room *qrbuf, void *data)
+void do_fsck_room(struct ctdlroom *qrbuf, void *data)
 {
        getroom(&CC->room, qrbuf->QRname);
        CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, do_fsck_msg, NULL);
@@ -661,14 +656,14 @@ void cmd_fsck(char *argbuf) {
        long msgnum;
        struct cdbdata *cdbmsg;
        struct MetaData smi;
-       struct roomref *ptr;
+       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);
+               cprintf("%d Another FSCK is already running.\n", ERROR + RESOURCE_BUSY);
                return;
        }
 
@@ -726,7 +721,7 @@ void cmd_fsck(char *argbuf) {
 
 char *serv_expire_init(void)
 {
-       CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
+       CtdlRegisterSessionHook(purge_databases, EVT_TIMER);
        CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
        return "$Id$";
 }