/*
- * serv_expire.c
+ * $Id$
*
* This module handles the expiry of old messages and the purging of old users.
*
*/
-/* $Id$ */
/*
* 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 "tools.h"
-struct oldvisit {
- char v_roomname[ROOMNAMELEN];
- 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;
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) {
+
+/*
+ * First phase of message purge -- gather the locations of messages which
+ * qualify for purging and write them to a temp file.
+ */
+void GatherPurgeMessages(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;
+ 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);
- get_msglist(qrbuf);
-
+ cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
+
+ if (cdbfr != NULL) {
+ msglist = mallok(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 (CC->num_msgs == 0) {
- end_critical_section(S_QUICKROOM);
+ if (num_msgs == 0) {
+ if (msglist != NULL) phree(msglist);
return;
- }
+ }
/* If the room is set to expire by count, do that */
if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
- while (CC->num_msgs > epbuf.expire_value) {
- delnum = MessageFromList(0);
- lprintf(5, "Expiring message %ld\n", delnum);
- cdb_delete(CDB_MSGMAIN, &delnum, sizeof(long));
- memcpy(&CC->msglist[0], &CC->msglist[1],
- (sizeof(long)*(CC->num_msgs - 1)));
- CC->num_msgs = CC->num_msgs - 1;
- ++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<(CC->num_msgs); ++a) {
- delnum = MessageFromList(a);
- sprintf(msgid, "%ld", delnum);
- xtime = output_message(msgid, MT_DATE, 0);
+ for (a=0; a<num_msgs; ++a) {
+ delnum = msglist[a];
+
+ 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))) {
- lprintf(5, "Expiring message %ld\n", delnum);
- cdb_delete(CDB_MSGMAIN, &delnum, sizeof(long));
- SetMessageInList(a, 0L);
+ fprintf(purgelist, "m=%ld\n", delnum);
++messages_purged;
- }
}
}
- CC->num_msgs = sort_msglist(CC->msglist, CC->num_msgs);
- put_msglist(qrbuf);
- end_critical_section(S_QUICKROOM);
}
+ if (msglist != NULL) phree(msglist);
+}
+
+
+/*
+ * 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, "");
+ }
+ }
+ }
+}
+
+
void PurgeMessages(void) {
+ FILE *purgelist;
+
lprintf(5, "PurgeMessages() called\n");
messages_purged = 0;
- ForEachRoom(DoPurgeMessages);
+
+ purgelist = tmpfile();
+ if (purgelist == NULL) {
+ lprintf(3, "Can't create purgelist temp file: %s\n",
+ strerror(errno));
+ return;
}
+ ForEachRoom(GatherPurgeMessages, (void *)purgelist );
+ DoPurgeMessages(purgelist);
+ fclose(purgelist);
+}
-void DoPurgeRooms(struct quickroom *qrbuf) {
- time_t age, purge_secs;
- struct PurgeList *pptr;
- /* 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 (qrbuf->QRflags & QR_MAILBOX) return;
- if (is_noneditable(qrbuf)) return;
+void AddValidUser(struct usersupp *usbuf, void *data) {
+ struct ValidUser *vuptr;
- /* If we don't know the modification date, be safe and don't purge */
- if (qrbuf->QRmtime <= (time_t)0) return;
+ vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
+ vuptr->next = ValidUserList;
+ vuptr->vu_usernum = usbuf->usernum;
+ ValidUserList = vuptr;
+}
- /* 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);
+void AddValidRoom(struct quickroom *qrbuf, void *data) {
+ struct ValidRoom *vrptr;
- if (age > purge_secs) {
-
+ vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
+ vrptr->next = ValidRoomList;
+ vrptr->vr_roomnum = qrbuf->QRnumber;
+ vrptr->vr_roomgen = qrbuf->QRgen;
+ ValidRoomList = vrptr;
+}
+
+void DoPurgeRooms(struct quickroom *qrbuf, void *data) {
+ time_t age, purge_secs;
+ struct PurgeList *pptr;
+ struct ValidUser *vuptr;
+ int do_purge = 0;
+
+ /* For mailbox rooms, there's only one purging rule: if the user who
+ * owns the room still exists, we keep the room; otherwise, we purge
+ * 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;
+ }
+ }
+ }
+ 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(9, "<%s> is <%ld> seconds old\n", qrbuf->QRname, age);
+ if (age > purge_secs) do_purge = 1;
+ } /* !QR_MAILBOX */
+
+ if (do_purge) {
pptr = (struct PurgeList *) mallok(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 ValidUser *vuptr;
char *transcript = NULL;
lprintf(5, "PurgeRooms() called\n");
- if (config.c_roompurge > 0) {
- ForEachRoom(DoPurgeRooms);
- }
- transcript = mallok(256);
+
+ /* Load up a table full of valid user numbers so we can delete
+ * user-owned rooms for users who no longer exist */
+ ForEachUser(AddValidUser, NULL);
+
+ /* Then cycle through the room file */
+ ForEachRoom(DoPurgeRooms, NULL);
+
+ /* Free the valid user list */
+ while (ValidUserList != NULL) {
+ vuptr = ValidUserList->next;
+ phree(ValidUserList);
+ ValidUserList = vuptr;
+ }
+
+
+ transcript = mallok(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);
+ transcript=reallok(transcript, strlen(transcript)+SIZ);
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;
struct PurgeList *pptr;
+ /* stupid recovery routine to re-create missing mailboxen.
+ * don't enable this.
+ struct quickroom qrbuf;
+ char mailboxname[ROOMNAMELEN];
+ MailboxName(mailboxname, us, MAILROOM);
+ create_room(mailboxname, 4, "", 0, 1);
+ if (getroom(&qrbuf, mailboxname) != 0) return;
+ lprintf(9, "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;
- }
+ }
else {
purge_time = ((time_t)config.c_userpurge) * 86400L;
- }
+ }
/* The default rule is to not purge. */
purge = 0;
pptr->next = UserPurgeList;
strcpy(pptr->name, us->fullname);
UserPurgeList = pptr;
- }
-
}
+}
+
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);
+ transcript = mallok(SIZ);
strcpy(transcript, "The following users have been auto-purged:\n");
while (UserPurgeList != NULL) {
- transcript=reallok(transcript, strlen(transcript)+256);
+ transcript=reallok(transcript, strlen(transcript)+SIZ);
sprintf(&transcript[strlen(transcript)], " %s\n",
UserPurgeList->name);
purge_user(UserPurgeList->name);
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);
- }
-
-void AddValidUser(struct usersupp *usbuf) {
- 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) {
- struct ValidRoom *vrptr;
-
- vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
- vrptr->next = ValidRoomList;
- vrptr->vr_roomnum = qrbuf->QRnumber;
- vrptr->vr_roomgen = qrbuf->QRgen;
- ValidRoomList = vrptr;
- }
+}
/*
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);
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->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) {
phree(VisitPurgeList);
VisitPurgeList = vptr;
++purged;
- }
-
- return(purged);
}
+ return(purged);
+}
+
void cmd_expi(char *argbuf) {
- char cmd[256];
+ char cmd[SIZ];
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, void *userdata) {
+ 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, NULL);
+}
+
+/*
+ * 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$";
}
projects / citadel.git / blobdiff