*
* This module handles the expiry of old messages and the purging of old users.
*
+ * $Id$
*/
-/* $Id$ */
+
+/*
+ * A brief technical discussion:
+ *
+ * Several of the purge operations found in this module operate in two
+ * stages: the first stage generates a linked list of objects to be deleted,
+ * 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
+ * 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.
+ */
+
+
+#include "sysdep.h"
#include <stdlib.h>
#include <unistd.h>
#include <stdio.h>
#include <sys/wait.h>
#include <string.h>
#include <limits.h>
-#include <pthread.h>
#include "citadel.h"
#include "server.h"
#include <syslog.h>
#include "msgbase.h"
#include "user_ops.h"
#include "control.h"
+#include "tools.h"
struct oldvisit {
long v_generation;
long v_lastseen;
unsigned int v_flags;
- };
-
-
-
-
-struct PurgedUser {
- struct PurgedUser *next;
- char name[26];
- };
-
-struct PurgedUser *plist = NULL;
+};
+
+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 PurgeList *UserPurgeList = NULL;
+struct PurgeList *RoomPurgeList = NULL;
+struct ValidRoom *ValidRoomList = NULL;
+struct ValidUser *ValidUserList = NULL;
+int messages_purged;
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 0
-#define MINOR_VERSION 1
-
-static struct DLModule_Info info = {
- MODULE_NAME,
- MODULE_AUTHOR,
- MODULE_EMAIL,
- MAJOR_VERSION,
- MINOR_VERSION
- };
-
void DoPurgeMessages(struct quickroom *qrbuf) {
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;
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) {
+ 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) {
- while (CC->num_msgs > epbuf.expire_value) {
- delnum = MessageFromList(0);
+ while (num_msgs > epbuf.expire_value) {
+ delnum = msglist[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;
- }
+ AdjRefCount(delnum, -1);
+ memcpy(&msglist[0], &msglist[1],
+ (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<(CC->num_msgs); ++a) {
- delnum = MessageFromList(a);
- sprintf(msgid, "%ld", delnum);
- xtime = output_message(msgid, MT_DATE, 0, 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))) {
- cdb_delete(CDB_MSGMAIN, &delnum, sizeof(long));
- SetMessageInList(a, 0L);
lprintf(5, "Expiring message %ld\n", delnum);
- }
+ AdjRefCount(delnum, -1);
+ msglist[a] = 0L;
+ ++messages_purged;
}
}
- CC->num_msgs = sort_msglist(CC->msglist, CC->num_msgs);
- put_msglist(qrbuf);
- end_critical_section(S_QUICKROOM);
}
+ 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);
+
+ end_critical_section(S_QUICKROOM);
+}
+
void PurgeMessages(void) {
lprintf(5, "PurgeMessages() called\n");
+ messages_purged = 0;
ForEachRoom(DoPurgeMessages);
+}
+
+
+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;
+}
+
+void DoPurgeRooms(struct quickroom *qrbuf) {
+ 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) {
+ 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));
+ 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");
+
+
+ /* Load up a table full of valid user numbers so we can delete
+ * user-owned rooms for users who no longer exist */
+ ForEachUser(AddValidUser);
+
+ /* Then cycle through the room file */
+ ForEachRoom(DoPurgeRooms);
+
+ /* Free the valid user list */
+ while (ValidUserList != NULL) {
+ vuptr = ValidUserList->next;
+ phree(ValidUserList);
+ ValidUserList = vuptr;
}
+ transcript = mallok(256);
+ 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",
+ 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) {
int purge;
time_t now;
time_t purge_time;
- struct PurgedUser *pptr;
+ struct PurgeList *pptr;
/* 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;
if (us->timescalled == 0) purge = 1;
if (purge == 1) {
- pptr = (struct PurgedUser *) malloc(sizeof(struct PurgedUser));
- pptr->next = plist;
+ pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
+ pptr->next = UserPurgeList;
strcpy(pptr->name, us->fullname);
- plist = pptr;
- }
-
+ UserPurgeList = pptr;
}
+}
+
int PurgeUsers(void) {
- struct PurgedUser *pptr;
+ struct PurgeList *pptr;
int num_users_purged = 0;
+ char *transcript = NULL;
lprintf(5, "PurgeUsers() called\n");
if (config.c_userpurge > 0) {
ForEachUser(do_user_purge);
- }
+ }
- while (plist != NULL) {
- purge_user(plist->name);
- pptr = plist->next;
- free(plist);
- plist = pptr;
+ transcript = mallok(256);
+ strcpy(transcript, "The following users have been auto-purged:\n");
+
+ 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;
- }
+ }
+
+ if (num_users_purged > 0) aide_message(transcript);
+ phree(transcript);
lprintf(5, "Purged %d users.\n", num_users_purged);
return(num_users_purged);
+}
+
+
+/*
+ * Purge visits
+ *
+ * This is a really cumbersome "garbage collection" function. We have to
+ * delete visits which refer to rooms and/or users which no longer exist. In
+ * order to prevent endless traversals of the room and user files, we first
+ * build linked lists of rooms and users which _do_ exist on the system, then
+ * traverse the visit file, checking each record against those two lists and
+ * purging the ones that do not have a match on _both_ lists. (Remember, if
+ * either the room or user being referred to is no longer on the system, the
+ * record is completely useless.)
+ */
+int PurgeVisits(void) {
+ struct cdbdata *cdbvisit;
+ struct visit vbuf;
+ struct VPurgeList *VisitPurgeList = NULL;
+ struct VPurgeList *vptr;
+ int purged = 0;
+ char IndexBuf[32];
+ int IndexLen;
+ struct ValidRoom *vrptr;
+ struct ValidUser *vuptr;
+ int RoomIsValid, UserIsValid;
+
+ /* First, load up a table full of valid room/gen combinations */
+ ForEachRoom(AddValidRoom);
+
+ /* Then load up a table full of valid user numbers */
+ ForEachUser(AddValidUser);
+
+ /* Now traverse through the visits, purging irrelevant records... */
+ cdb_rewind(CDB_VISIT);
+ while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
+ memset(&vbuf, 0, sizeof(struct visit));
+ memcpy(&vbuf, cdbvisit->ptr,
+ ( (cdbvisit->len > sizeof(struct visit)) ?
+ sizeof(struct visit) : cdbvisit->len) );
+ cdb_free(cdbvisit);
+
+ RoomIsValid = 0;
+ UserIsValid = 0;
+
+ /* Check to see if the room exists */
+ for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
+ 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));
+ 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);
+ 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) {
+ IndexLen = GenerateRelationshipIndex(IndexBuf,
+ VisitPurgeList->vp_roomnum,
+ VisitPurgeList->vp_roomgen,
+ VisitPurgeList->vp_usernum);
+ cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
+ vptr = VisitPurgeList->next;
+ phree(VisitPurgeList);
+ VisitPurgeList = vptr;
+ ++purged;
+ }
+
+ return(purged);
+}
+
void cmd_expi(char *argbuf) {
char cmd[256];
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;
- }
+ }
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 Finished purging messages.\n", OK);
+ cprintf("%d Expired %d messages.\n", OK, messages_purged);
return;
- }
- else {
- cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
- return;
- }
}
-
-/****************************************************************************
- BEGIN TEMPORARY STUFF
- */
-
-void reindex_this_msglist(struct quickroom *qrbuf) {
- struct cdbdata *c;
- char dbkey[256];
- int a;
-
- getroom(qrbuf, qrbuf->QRname);
-
- sprintf(dbkey, "%s%ld", qrbuf->QRname, qrbuf->QRgen);
- for (a=0; a<strlen(dbkey); ++a) dbkey[a]=tolower(dbkey[a]);
-
- c = cdb_fetch(CDB_MSGLISTS, dbkey, strlen(dbkey));
- if (c != NULL) {
- cprintf("Converting msglist for <%s><%ld>\n",
- qrbuf->QRname, qrbuf->QRnumber);
- cdb_delete(CDB_MSGLISTS, dbkey, strlen(dbkey));
- cdb_store(CDB_MSGLISTS,
- &qrbuf->QRnumber, sizeof(long),
- c->ptr, c->len);
- cdb_free(c);
- }
- else {
- cprintf("NOT converting msglist for <%s><%ld>\n",
- qrbuf->QRname, qrbuf->QRnumber);
- }
-
+ else if (!strcasecmp(cmd, "rooms")) {
+ retval = PurgeRooms();
+ cprintf("%d Expired %d rooms.\n", OK, retval);
+ return;
}
-
-void reindex_msglists(void) {
- ForEachRoom(reindex_this_msglist);
+ else if (!strcasecmp(cmd, "visits")) {
+ retval = PurgeVisits();
+ cprintf("%d Purged %d visits.\n", OK, retval);
}
-
-void number_thisroom(struct quickroom *qrbuf) {
- getroom(qrbuf, qrbuf->QRname);
- cprintf("%s\n", qrbuf->QRname);
- if (qrbuf->QRnumber == 0L) {
- qrbuf->QRnumber = get_new_room_number();
- cprintf(" * assigned room number %ld\n", qrbuf->QRnumber);
- }
- putroom(qrbuf, qrbuf->QRname);
+ else if (!strcasecmp(cmd, "defrag")) {
+ defrag_databases();
+ cprintf("%d Defragmented the databases.\n", OK);
}
-
-void rewrite_a_visit(struct usersupp *rel_user) {
- struct cdbdata *cdbvisit;
- struct oldvisit *visits;
- struct quickroom qrbuf;
- int num_visits;
- int a;
- struct visit vbuf;
-
- cdbvisit = cdb_fetch(CDB_VISIT, &rel_user->usernum, sizeof(long));
- if (cdbvisit != NULL) {
- num_visits = cdbvisit->len / sizeof(struct oldvisit);
- visits = (struct oldvisit *)
- malloc(num_visits * sizeof(struct oldvisit));
- memcpy(visits, cdbvisit->ptr,
- (num_visits * sizeof(struct oldvisit)));
- cdb_free(cdbvisit);
- cdb_delete(CDB_VISIT, &rel_user->usernum, sizeof(long));
- }
else {
- num_visits = 0;
- visits = NULL;
- }
-
- if (num_visits > 0) {
- for (a=0; a<num_visits; ++a) {
- getroom(&qrbuf, visits[a].v_roomname);
- vbuf.v_flags = visits[a].v_flags;
- vbuf.v_lastseen = visits[a].v_lastseen;
- CtdlSetRelationship(&vbuf,
- rel_user,
- &qrbuf);
- cprintf("SetR: <%ld><%ld><%ld> <%d> <%ld>\n",
- vbuf.v_roomnum,
- vbuf.v_roomgen,
- vbuf.v_usernum,
- vbuf.v_flags,
- vbuf.v_lastseen);
- }
- free(visits);
- }
- }
-
-void rewrite_visits(void) {
- ForEachUser(rewrite_a_visit);
- }
-
-void number_rooms(void) {
- ForEachRoom(number_thisroom);
- }
-
-void cmd_aaaa(char *argbuf) {
- cprintf("%d Here goes...\n", LISTING_FOLLOWS);
- number_rooms();
- reindex_msglists();
- rewrite_visits();
- cprintf("000\n");
+ cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
+ return;
}
+}
-/* END TEMPORARY STUFF
- ****************************************************************************/
-
-struct DLModule_Info *Dynamic_Module_Init(void)
+char *Dynamic_Module_Init(void)
{
- CtdlRegisterProtoHook(cmd_aaaa, "AAAA", "convert");
- CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
- return &info;
+ CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
+ return "$Id$";
}
projects / citadel.git / blobdiff