4 * This module handles the expiry of old messages and the purging of old users.
11 * A brief technical discussion:
13 * Several of the purge operations found in this module operate in two
14 * stages: the first stage generates a linked list of objects to be deleted,
15 * then the second stage deletes all listed objects from the database.
17 * At first glance this may seem cumbersome and unnecessary. The reason it is
18 * implemented in this way is because GDBM (and perhaps some other backends we
19 * may hook into in the future) explicitly do _not_ support the deletion of
20 * records from a file while the file is being traversed. The delete operation
21 * will succeed, but the traversal is not guaranteed to visit every object if
22 * this is done. Therefore we utilize the two-stage purge.
34 #include <sys/types.h>
46 #include "sysdep_decls.h"
47 #include "citserver.h"
50 #include "dynloader.h"
61 char v_roomname[ROOMNAMELEN];
68 struct PurgeList *next;
69 char name[ROOMNAMELEN]; /* use the larger of username or roomname */
73 struct VPurgeList *next;
80 struct ValidRoom *next;
86 struct ValidUser *next;
90 struct PurgeList *UserPurgeList = NULL;
91 struct PurgeList *RoomPurgeList = NULL;
92 struct ValidRoom *ValidRoomList = NULL;
93 struct ValidUser *ValidUserList = NULL;
96 extern struct CitContext *ContextList;
98 #define MODULE_NAME "Expire old messages, users, rooms"
99 #define MODULE_AUTHOR "Art Cancro"
100 #define MODULE_EMAIL "ajc@uncnsrd.mt-kisco.ny.us"
101 #define MAJOR_VERSION 1
102 #define MINOR_VERSION 0
104 static struct DLModule_Info info = {
112 void DoPurgeMessages(struct quickroom *qrbuf) {
113 struct ExpirePolicy epbuf;
120 GetExpirePolicy(&epbuf, qrbuf);
123 lprintf(9, "ExpirePolicy for <%s> is <%d> <%d>\n",
124 qrbuf->QRname, epbuf.expire_mode, epbuf.expire_value);
127 /* If the room is set to never expire messages ... do nothing */
128 if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
129 if (epbuf.expire_mode == EXPIRE_MANUAL) return;
131 begin_critical_section(S_QUICKROOM);
134 /* Nothing to do if there aren't any messages */
135 if (CC->num_msgs == 0) {
136 end_critical_section(S_QUICKROOM);
140 /* If the room is set to expire by count, do that */
141 if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
142 while (CC->num_msgs > epbuf.expire_value) {
143 delnum = MessageFromList(0);
144 lprintf(5, "Expiring message %ld\n", delnum);
145 AdjRefCount(delnum, -1);
146 memcpy(&CC->msglist[0], &CC->msglist[1],
147 (sizeof(long)*(CC->num_msgs - 1)));
148 CC->num_msgs = CC->num_msgs - 1;
153 /* If the room is set to expire by age... */
154 if (epbuf.expire_mode == EXPIRE_AGE) {
155 for (a=0; a<(CC->num_msgs); ++a) {
156 delnum = MessageFromList(a);
157 sprintf(msgid, "%ld", delnum);
158 xtime = output_message(msgid, MT_DATE, 0);
161 && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
162 lprintf(5, "Expiring message %ld\n", delnum);
163 AdjRefCount(delnum, -1);
164 SetMessageInList(a, 0L);
169 CC->num_msgs = sort_msglist(CC->msglist, CC->num_msgs);
171 end_critical_section(S_QUICKROOM);
174 void PurgeMessages(void) {
175 lprintf(5, "PurgeMessages() called\n");
177 ForEachRoom(DoPurgeMessages);
181 void AddValidUser(struct usersupp *usbuf) {
182 struct ValidUser *vuptr;
184 vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
185 vuptr->next = ValidUserList;
186 vuptr->vu_usernum = usbuf->usernum;
187 ValidUserList = vuptr;
190 void AddValidRoom(struct quickroom *qrbuf) {
191 struct ValidRoom *vrptr;
193 vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
194 vrptr->next = ValidRoomList;
195 vrptr->vr_roomnum = qrbuf->QRnumber;
196 vrptr->vr_roomgen = qrbuf->QRgen;
197 ValidRoomList = vrptr;
200 void DoPurgeRooms(struct quickroom *qrbuf) {
201 time_t age, purge_secs;
202 struct PurgeList *pptr;
203 struct ValidUser *vuptr;
206 /* For mailbox rooms, there's only one purging rule: if the user who
207 * owns the room still exists, we keep the room; otherwise, we purge
208 * it. Bypass any other rules.
210 if (qrbuf->QRflags & QR_MAILBOX) {
211 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
212 if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
222 /* Any of these attributes render a room non-purgable */
223 if (qrbuf->QRflags & QR_PERMANENT) return;
224 if (qrbuf->QRflags & QR_DIRECTORY) return;
225 if (qrbuf->QRflags & QR_NETWORK) return;
226 if (is_noneditable(qrbuf)) return;
228 /* If we don't know the modification date, be safe and don't purge */
229 if (qrbuf->QRmtime <= (time_t)0) return;
231 /* If no room purge time is set, be safe and don't purge */
232 if (config.c_roompurge < 0) return;
234 /* Otherwise, check the date of last modification */
235 age = time(NULL) - (qrbuf->QRmtime);
236 purge_secs = (time_t)config.c_roompurge * (time_t)86400;
237 if (purge_secs <= (time_t)0) return;
238 lprintf(9, "<%s> is <%ld> seconds old\n", qrbuf->QRname, age);
239 if (age > purge_secs) do_purge = 1;
241 BYPASS: if (do_purge) {
242 pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
243 pptr->next = RoomPurgeList;
244 strcpy(pptr->name, qrbuf->QRname);
245 RoomPurgeList = pptr;
252 int PurgeRooms(void) {
253 struct PurgeList *pptr;
254 int num_rooms_purged = 0;
255 struct quickroom qrbuf;
256 struct ValidUser *vuptr;
257 char *transcript = NULL;
259 lprintf(5, "PurgeRooms() called\n");
262 /* Load up a table full of valid user numbers so we can delete
263 * user-owned rooms for users who no longer exist */
264 ForEachUser(AddValidUser);
266 /* Then cycle through the room file */
267 ForEachRoom(DoPurgeRooms);
269 /* Free the valid user list */
270 while (ValidUserList != NULL) {
271 vuptr = ValidUserList->next;
272 phree(ValidUserList);
273 ValidUserList = vuptr;
277 transcript = mallok(256);
278 strcpy(transcript, "The following rooms have been auto-purged:\n");
280 while (RoomPurgeList != NULL) {
281 if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
282 transcript=reallok(transcript, strlen(transcript)+256);
283 sprintf(&transcript[strlen(transcript)], " %s\n",
287 pptr = RoomPurgeList->next;
288 phree(RoomPurgeList);
289 RoomPurgeList = pptr;
293 if (num_rooms_purged > 0) aide_message(transcript);
296 lprintf(5, "Purged %d rooms.\n", num_rooms_purged);
297 return(num_rooms_purged);
301 void do_user_purge(struct usersupp *us) {
305 struct PurgeList *pptr;
307 /* Set purge time; if the user overrides the system default, use it */
308 if (us->USuserpurge > 0) {
309 purge_time = ((time_t)us->USuserpurge) * 86400L;
312 purge_time = ((time_t)config.c_userpurge) * 86400L;
315 /* The default rule is to not purge. */
318 /* If the user hasn't called in two months, his/her account
319 * has expired, so purge the record.
322 if ((now - us->lastcall) > purge_time) purge = 1;
324 /* If the user set his/her password to 'deleteme', he/she
325 * wishes to be deleted, so purge the record.
327 if (!strcasecmp(us->password, "deleteme")) purge = 1;
329 /* If the record is marked as permanent, don't purge it.
331 if (us->flags & US_PERM) purge = 0;
333 /* If the access level is 0, the record should already have been
334 * deleted, but maybe the user was logged in at the time or something.
335 * Delete the record now.
337 if (us->axlevel == 0) purge = 1;
339 /* 0 calls is impossible. If there are 0 calls, it must
340 * be a corrupted record, so purge it.
342 if (us->timescalled == 0) purge = 1;
345 pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
346 pptr->next = UserPurgeList;
347 strcpy(pptr->name, us->fullname);
348 UserPurgeList = pptr;
355 int PurgeUsers(void) {
356 struct PurgeList *pptr;
357 int num_users_purged = 0;
358 char *transcript = NULL;
360 lprintf(5, "PurgeUsers() called\n");
361 if (config.c_userpurge > 0) {
362 ForEachUser(do_user_purge);
365 transcript = mallok(256);
366 strcpy(transcript, "The following users have been auto-purged:\n");
368 while (UserPurgeList != NULL) {
369 transcript=reallok(transcript, strlen(transcript)+256);
370 sprintf(&transcript[strlen(transcript)], " %s\n",
371 UserPurgeList->name);
372 purge_user(UserPurgeList->name);
373 pptr = UserPurgeList->next;
374 phree(UserPurgeList);
375 UserPurgeList = pptr;
379 if (num_users_purged > 0) aide_message(transcript);
382 lprintf(5, "Purged %d users.\n", num_users_purged);
383 return(num_users_purged);
390 * This is a really cumbersome "garbage collection" function. We have to
391 * delete visits which refer to rooms and/or users which no longer exist. In
392 * order to prevent endless traversals of the room and user files, we first
393 * build linked lists of rooms and users which _do_ exist on the system, then
394 * traverse the visit file, checking each record against those two lists and
395 * purging the ones that do not have a match on _both_ lists. (Remember, if
396 * either the room or user being referred to is no longer on the system, the
397 * record is completely useless.)
399 int PurgeVisits(void) {
400 struct cdbdata *cdbvisit;
402 struct VPurgeList *VisitPurgeList = NULL;
403 struct VPurgeList *vptr;
407 struct ValidRoom *vrptr;
408 struct ValidUser *vuptr;
409 int RoomIsValid, UserIsValid;
411 /* First, load up a table full of valid room/gen combinations */
412 ForEachRoom(AddValidRoom);
414 /* Then load up a table full of valid user numbers */
415 ForEachUser(AddValidUser);
417 /* Now traverse through the visits, purging irrelevant records... */
418 cdb_rewind(CDB_VISIT);
419 while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
420 memset(&vbuf, 0, sizeof(struct visit));
421 memcpy(&vbuf, cdbvisit->ptr,
422 ( (cdbvisit->len > sizeof(struct visit)) ?
423 sizeof(struct visit) : cdbvisit->len) );
429 /* Check to see if the room exists */
430 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
431 if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
432 && (vrptr->vr_roomgen==vbuf.v_roomgen))
436 /* Check to see if the user exists */
437 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
438 if (vuptr->vu_usernum == vbuf.v_usernum)
442 /* Put the record on the purge list if it's dead */
443 if ((RoomIsValid==0) || (UserIsValid==0)) {
444 vptr = (struct VPurgeList *)
445 mallok(sizeof(struct VPurgeList));
446 vptr->next = VisitPurgeList;
447 vptr->vp_roomnum = vbuf.v_roomnum;
448 vptr->vp_roomgen = vbuf.v_roomgen;
449 vptr->vp_usernum = vbuf.v_usernum;
450 VisitPurgeList = vptr;
455 /* Free the valid room/gen combination list */
456 while (ValidRoomList != NULL) {
457 vrptr = ValidRoomList->next;
458 phree(ValidRoomList);
459 ValidRoomList = vrptr;
462 /* Free the valid user list */
463 while (ValidUserList != NULL) {
464 vuptr = ValidUserList->next;
465 phree(ValidUserList);
466 ValidUserList = vuptr;
469 /* Now delete every visit on the purged list */
470 while (VisitPurgeList != NULL) {
471 IndexLen = GenerateRelationshipIndex(IndexBuf,
472 VisitPurgeList->vp_roomnum,
473 VisitPurgeList->vp_roomgen,
474 VisitPurgeList->vp_usernum);
475 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
476 vptr = VisitPurgeList->next;
477 phree(VisitPurgeList);
478 VisitPurgeList = vptr;
486 void cmd_expi(char *argbuf) {
491 if ((!(CC->logged_in))&&(!(CC->internal_pgm))) {
492 cprintf("%d Not logged in.\n",ERROR+NOT_LOGGED_IN);
496 if ((!is_room_aide()) && (!(CC->internal_pgm)) ) {
497 cprintf("%d Higher access required.\n",
498 ERROR+HIGHER_ACCESS_REQUIRED);
502 extract(cmd, argbuf, 0);
503 if (!strcasecmp(cmd, "users")) {
504 retval = PurgeUsers();
505 cprintf("%d Purged %d users.\n", OK, retval);
508 else if (!strcasecmp(cmd, "messages")) {
510 cprintf("%d Expired %d messages.\n", OK, messages_purged);
513 else if (!strcasecmp(cmd, "rooms")) {
514 retval = PurgeRooms();
515 cprintf("%d Expired %d rooms.\n", OK, retval);
518 else if (!strcasecmp(cmd, "visits")) {
519 retval = PurgeVisits();
520 cprintf("%d Purged %d visits.\n", OK, retval);
522 else if (!strcasecmp(cmd, "defrag")) {
524 cprintf("%d Defragmented the databases.\n", OK);
527 cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
534 struct DLModule_Info *Dynamic_Module_Init(void)
536 CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");