4 * This module handles the expiry of old messages and the purging of old users.
10 * A brief technical discussion:
12 * Several of the purge operations found in this module operate in two
13 * stages: the first stage generates a linked list of objects to be deleted,
14 * then the second stage deletes all listed objects from the database.
16 * At first glance this may seem cumbersome and unnecessary. The reason it is
17 * implemented in this way is because Berkeley DB, and possibly other backends
18 * we may hook into in the future, explicitly do _not_ support the deletion of
19 * records from a file while the file is being traversed. The delete operation
20 * will succeed, but the traversal is not guaranteed to visit every object if
21 * this is done. Therefore we utilize the two-stage purge.
23 * When using Berkeley DB, there's another reason for the two-phase purge: we
24 * don't want the entire thing being done as one huge transaction.
36 #include <sys/types.h>
38 #if TIME_WITH_SYS_TIME
39 # include <sys/time.h>
43 # include <sys/time.h>
52 #include <libcitadel.h>
55 #include "citserver.h"
64 #include "serv_network.h" /* Needed for defenition of UseTable */
67 #include "ctdl_module.h"
71 struct PurgeList *next;
72 char name[ROOMNAMELEN]; /* use the larger of username or roomname */
76 struct VPurgeList *next;
83 struct ValidRoom *next;
89 struct ValidUser *next;
95 struct ctdlroomref *next;
100 struct UPurgeList *next;
105 struct EPurgeList *next;
111 struct PurgeList *UserPurgeList = NULL;
112 struct PurgeList *RoomPurgeList = NULL;
113 struct ValidRoom *ValidRoomList = NULL;
114 struct ValidUser *ValidUserList = NULL;
116 int users_not_purged;
117 char *users_corrupt_msg = NULL;
119 struct ctdlroomref *rr = NULL;
121 extern struct CitContext *ContextList;
125 * First phase of message purge -- gather the locations of messages which
126 * qualify for purging and write them to a temp file.
128 void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
129 struct ExpirePolicy epbuf;
132 struct CtdlMessage *msg = NULL;
134 struct cdbdata *cdbfr;
135 long *msglist = NULL;
139 purgelist = (FILE *)data;
140 fprintf(purgelist, "r=%s\n", qrbuf->QRname);
143 GetExpirePolicy(&epbuf, qrbuf);
145 /* If the room is set to never expire messages ... do nothing */
146 if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
147 if (epbuf.expire_mode == EXPIRE_MANUAL) return;
149 cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
152 msglist = malloc(cdbfr->len);
153 memcpy(msglist, cdbfr->ptr, cdbfr->len);
154 num_msgs = cdbfr->len / sizeof(long);
158 /* Nothing to do if there aren't any messages */
160 if (msglist != NULL) free(msglist);
164 /* If the room is set to expire by count, do that */
165 if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
166 if (num_msgs > epbuf.expire_value) {
167 for (a=0; a<(num_msgs - epbuf.expire_value); ++a) {
168 fprintf(purgelist, "m=%ld\n", msglist[a]);
174 /* If the room is set to expire by age... */
175 if (epbuf.expire_mode == EXPIRE_AGE) {
176 for (a=0; a<num_msgs; ++a) {
179 msg = CtdlFetchMessage(delnum, 0); /* dont need body */
181 xtime = atol(msg->cm_fields['T']);
182 CtdlFreeMessage(msg);
188 && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
189 fprintf(purgelist, "m=%ld\n", delnum);
195 if (msglist != NULL) free(msglist);
200 * Second phase of message purge -- read list of msgs from temp file and
203 void DoPurgeMessages(FILE *purgelist) {
204 char roomname[ROOMNAMELEN];
209 strcpy(roomname, "nonexistent room ___ ___");
210 while (fgets(buf, sizeof buf, purgelist) != NULL) {
211 buf[strlen(buf)-1]=0;
212 if (!strncasecmp(buf, "r=", 2)) {
213 strcpy(roomname, &buf[2]);
215 if (!strncasecmp(buf, "m=", 2)) {
216 msgnum = atol(&buf[2]);
218 CtdlDeleteMessages(roomname, &msgnum, 1, "");
225 void PurgeMessages(void) {
228 lprintf(CTDL_DEBUG, "PurgeMessages() called\n");
231 purgelist = tmpfile();
232 if (purgelist == NULL) {
233 lprintf(CTDL_CRIT, "Can't create purgelist temp file: %s\n",
238 ForEachRoom(GatherPurgeMessages, (void *)purgelist );
239 DoPurgeMessages(purgelist);
244 void AddValidUser(struct ctdluser *usbuf, void *data) {
245 struct ValidUser *vuptr;
247 vuptr = (struct ValidUser *)malloc(sizeof(struct ValidUser));
248 vuptr->next = ValidUserList;
249 vuptr->vu_usernum = usbuf->usernum;
250 ValidUserList = vuptr;
253 void AddValidRoom(struct ctdlroom *qrbuf, void *data) {
254 struct ValidRoom *vrptr;
256 vrptr = (struct ValidRoom *)malloc(sizeof(struct ValidRoom));
257 vrptr->next = ValidRoomList;
258 vrptr->vr_roomnum = qrbuf->QRnumber;
259 vrptr->vr_roomgen = qrbuf->QRgen;
260 ValidRoomList = vrptr;
263 void DoPurgeRooms(struct ctdlroom *qrbuf, void *data) {
264 time_t age, purge_secs;
265 struct PurgeList *pptr;
266 struct ValidUser *vuptr;
269 /* For mailbox rooms, there's only one purging rule: if the user who
270 * owns the room still exists, we keep the room; otherwise, we purge
271 * it. Bypass any other rules.
273 if (qrbuf->QRflags & QR_MAILBOX) {
274 /* if user not found, do_purge will be 1 */
276 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
277 if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
283 /* Any of these attributes render a room non-purgable */
284 if (qrbuf->QRflags & QR_PERMANENT) return;
285 if (qrbuf->QRflags & QR_DIRECTORY) return;
286 if (qrbuf->QRflags & QR_NETWORK) return;
287 if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
288 if (is_noneditable(qrbuf)) return;
290 /* If we don't know the modification date, be safe and don't purge */
291 if (qrbuf->QRmtime <= (time_t)0) return;
293 /* If no room purge time is set, be safe and don't purge */
294 if (config.c_roompurge < 0) return;
296 /* Otherwise, check the date of last modification */
297 age = time(NULL) - (qrbuf->QRmtime);
298 purge_secs = (time_t)config.c_roompurge * (time_t)86400;
299 if (purge_secs <= (time_t)0) return;
300 lprintf(CTDL_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
301 if (age > purge_secs) do_purge = 1;
305 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
306 pptr->next = RoomPurgeList;
307 strcpy(pptr->name, qrbuf->QRname);
308 RoomPurgeList = pptr;
315 int PurgeRooms(void) {
316 struct PurgeList *pptr;
317 int num_rooms_purged = 0;
318 struct ctdlroom qrbuf;
319 struct ValidUser *vuptr;
320 char *transcript = NULL;
322 lprintf(CTDL_DEBUG, "PurgeRooms() called\n");
325 /* Load up a table full of valid user numbers so we can delete
326 * user-owned rooms for users who no longer exist */
327 ForEachUser(AddValidUser, NULL);
329 /* Then cycle through the room file */
330 ForEachRoom(DoPurgeRooms, NULL);
332 /* Free the valid user list */
333 while (ValidUserList != NULL) {
334 vuptr = ValidUserList->next;
336 ValidUserList = vuptr;
340 transcript = malloc(SIZ);
341 strcpy(transcript, "The following rooms have been auto-purged:\n");
343 while (RoomPurgeList != NULL) {
344 if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
345 transcript=realloc(transcript, strlen(transcript)+SIZ);
346 snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
350 pptr = RoomPurgeList->next;
352 RoomPurgeList = pptr;
356 if (num_rooms_purged > 0) aide_message(transcript, "Room Autopurger Message");
359 lprintf(CTDL_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
360 return(num_rooms_purged);
365 * Back end function to check user accounts for associated Unix accounts
366 * which no longer exist. (Only relevant for host auth mode.)
368 void do_uid_user_purge(struct ctdluser *us, void *data) {
369 struct PurgeList *pptr;
371 if ((us->uid != (-1)) && (us->uid != CTDLUID)) {
372 if (getpwuid(us->uid) == NULL) {
373 pptr = (struct PurgeList *)
374 malloc(sizeof(struct PurgeList));
375 pptr->next = UserPurgeList;
376 strcpy(pptr->name, us->fullname);
377 UserPurgeList = pptr;
389 * Back end function to check user accounts for expiration.
391 void do_user_purge(struct ctdluser *us, void *data) {
395 struct PurgeList *pptr;
397 /* Set purge time; if the user overrides the system default, use it */
398 if (us->USuserpurge > 0) {
399 purge_time = ((time_t)us->USuserpurge) * 86400L;
402 purge_time = ((time_t)config.c_userpurge) * 86400L;
405 /* The default rule is to not purge. */
408 /* If the user hasn't called in two months and expiring of accounts is turned on, his/her account
409 * has expired, so purge the record.
411 if (config.c_userpurge > 0)
414 if ((now - us->lastcall) > purge_time) purge = 1;
417 /* If the record is marked as permanent, don't purge it.
419 if (us->flags & US_PERM) purge = 0;
421 /* If the user is an Aide, don't purge him/her/it.
423 if (us->axlevel == 6) purge = 0;
425 /* If the access level is 0, the record should already have been
426 * deleted, but maybe the user was logged in at the time or something.
427 * Delete the record now.
429 if (us->axlevel == 0) purge = 1;
431 /* If the user set his/her password to 'deleteme', he/she
432 * wishes to be deleted, so purge the record.
433 * Moved this lower down so that aides and permanent users get purged if they ask to be.
435 if (!strcasecmp(us->password, "deleteme")) purge = 1;
437 /* 0 calls is impossible. If there are 0 calls, it must
438 * be a corrupted record, so purge it.
440 if (us->timescalled == 0) purge = 1;
442 /* User number 0, as well as any negative user number, is
445 if (us->usernum < 1L) purge = 1;
447 /* If the user has no full name entry then we can't purge them
448 * since the actual purge can't find them.
449 * This shouldn't happen but does somehow.
450 * So we make an Aide message to alert to it but don't add it to the purge list
452 if (IsEmptyStr(us->fullname))
455 if (users_corrupt_msg == NULL)
457 users_corrupt_msg = malloc(SIZ);
458 strcpy(users_corrupt_msg, "The auto-purger found the following user numbers with no name.\n"
459 "Unfortunately the auto-purger is not yet able to fix this problem.\n"
460 "This problem is not considered serious since a user with no name can\n"
464 users_corrupt_msg=realloc(users_corrupt_msg, strlen(users_corrupt_msg)+SIZ);
465 snprintf(&users_corrupt_msg[strlen(users_corrupt_msg)], SIZ, " %ld\n", us->usernum);
470 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
471 pptr->next = UserPurgeList;
472 strcpy(pptr->name, us->fullname);
473 UserPurgeList = pptr;
483 int PurgeUsers(void) {
484 struct PurgeList *pptr;
485 int num_users_purged = 0;
486 char *transcript = NULL;
488 lprintf(CTDL_DEBUG, "PurgeUsers() called\n");
489 users_not_purged = 0;
491 switch(config.c_auth_mode) {
492 case AUTHMODE_NATIVE:
493 ForEachUser(do_user_purge, NULL);
496 ForEachUser(do_uid_user_purge, NULL);
499 lprintf(CTDL_DEBUG, "Unknown authentication mode!\n");
503 transcript = malloc(SIZ);
505 if (users_not_purged == 0) {
506 strcpy(transcript, "The auto-purger was told to purge every user. It is\n"
507 "refusing to do this because it usually indicates a problem\n"
508 "such as an inability to communicate with a name service.\n"
510 while (UserPurgeList != NULL) {
511 pptr = UserPurgeList->next;
513 UserPurgeList = pptr;
519 strcpy(transcript, "The following users have been auto-purged:\n");
520 while (UserPurgeList != NULL) {
521 transcript=realloc(transcript, strlen(transcript)+SIZ);
522 snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
523 UserPurgeList->name);
524 purge_user(UserPurgeList->name);
525 pptr = UserPurgeList->next;
527 UserPurgeList = pptr;
532 if (num_users_purged > 0) aide_message(transcript, "User Purge Message");
535 if(users_corrupt_msg)
537 aide_message(users_corrupt_msg, "User Corruption Message");
538 free (users_corrupt_msg);
539 users_corrupt_msg = NULL;
543 lprintf(CTDL_DEBUG, "Purged %d users.\n", num_users_purged);
544 return(num_users_purged);
551 * This is a really cumbersome "garbage collection" function. We have to
552 * delete visits which refer to rooms and/or users which no longer exist. In
553 * order to prevent endless traversals of the room and user files, we first
554 * build linked lists of rooms and users which _do_ exist on the system, then
555 * traverse the visit file, checking each record against those two lists and
556 * purging the ones that do not have a match on _both_ lists. (Remember, if
557 * either the room or user being referred to is no longer on the system, the
558 * record is completely useless.)
560 int PurgeVisits(void) {
561 struct cdbdata *cdbvisit;
563 struct VPurgeList *VisitPurgeList = NULL;
564 struct VPurgeList *vptr;
568 struct ValidRoom *vrptr;
569 struct ValidUser *vuptr;
570 int RoomIsValid, UserIsValid;
572 /* First, load up a table full of valid room/gen combinations */
573 ForEachRoom(AddValidRoom, NULL);
575 /* Then load up a table full of valid user numbers */
576 ForEachUser(AddValidUser, NULL);
578 /* Now traverse through the visits, purging irrelevant records... */
579 cdb_rewind(CDB_VISIT);
580 while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
581 memset(&vbuf, 0, sizeof(struct visit));
582 memcpy(&vbuf, cdbvisit->ptr,
583 ( (cdbvisit->len > sizeof(struct visit)) ?
584 sizeof(struct visit) : cdbvisit->len) );
590 /* Check to see if the room exists */
591 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
592 if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
593 && (vrptr->vr_roomgen==vbuf.v_roomgen))
597 /* Check to see if the user exists */
598 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
599 if (vuptr->vu_usernum == vbuf.v_usernum)
603 /* Put the record on the purge list if it's dead */
604 if ((RoomIsValid==0) || (UserIsValid==0)) {
605 vptr = (struct VPurgeList *)
606 malloc(sizeof(struct VPurgeList));
607 vptr->next = VisitPurgeList;
608 vptr->vp_roomnum = vbuf.v_roomnum;
609 vptr->vp_roomgen = vbuf.v_roomgen;
610 vptr->vp_usernum = vbuf.v_usernum;
611 VisitPurgeList = vptr;
616 /* Free the valid room/gen combination list */
617 while (ValidRoomList != NULL) {
618 vrptr = ValidRoomList->next;
620 ValidRoomList = vrptr;
623 /* Free the valid user list */
624 while (ValidUserList != NULL) {
625 vuptr = ValidUserList->next;
627 ValidUserList = vuptr;
630 /* Now delete every visit on the purged list */
631 while (VisitPurgeList != NULL) {
632 IndexLen = GenerateRelationshipIndex(IndexBuf,
633 VisitPurgeList->vp_roomnum,
634 VisitPurgeList->vp_roomgen,
635 VisitPurgeList->vp_usernum);
636 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
637 vptr = VisitPurgeList->next;
638 free(VisitPurgeList);
639 VisitPurgeList = vptr;
647 * Purge the use table of old entries.
650 int PurgeUseTable(void) {
652 struct cdbdata *cdbut;
654 struct UPurgeList *ul = NULL;
655 struct UPurgeList *uptr;
657 /* Phase 1: traverse through the table, discovering old records... */
658 lprintf(CTDL_DEBUG, "Purge use table: phase 1\n");
659 cdb_rewind(CDB_USETABLE);
660 while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL) {
663 * TODODRW: change this to create a new function time_t cdb_get_timestamp( struct cdbdata *)
664 * this will release this file from the serv_network.h
665 * Maybe it could be a macro that extracts and casts the reult
667 memcpy(&ut, cdbut->ptr,
668 ((cdbut->len > sizeof(struct UseTable)) ?
669 sizeof(struct UseTable) : cdbut->len));
672 if ( (time(NULL) - ut.ut_timestamp) > USETABLE_RETAIN ) {
673 uptr = (struct UPurgeList *) malloc(sizeof(struct UPurgeList));
676 safestrncpy(uptr->up_key, ut.ut_msgid, sizeof uptr->up_key);
684 /* Phase 2: delete the records */
685 lprintf(CTDL_DEBUG, "Purge use table: phase 2\n");
687 cdb_delete(CDB_USETABLE, ul->up_key, strlen(ul->up_key));
693 lprintf(CTDL_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
700 * Purge the EUID Index of old records.
703 int PurgeEuidIndexTable(void) {
705 struct cdbdata *cdbei;
706 struct EPurgeList *el = NULL;
707 struct EPurgeList *eptr;
709 struct CtdlMessage *msg = NULL;
711 /* Phase 1: traverse through the table, discovering old records... */
712 lprintf(CTDL_DEBUG, "Purge EUID index: phase 1\n");
713 cdb_rewind(CDB_EUIDINDEX);
714 while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei != NULL) {
716 memcpy(&msgnum, cdbei->ptr, sizeof(long));
718 msg = CtdlFetchMessage(msgnum, 0);
720 CtdlFreeMessage(msg); /* it still exists, so do nothing */
723 eptr = (struct EPurgeList *) malloc(sizeof(struct EPurgeList));
726 eptr->ep_keylen = cdbei->len - sizeof(long);
727 eptr->ep_key = malloc(cdbei->len);
728 memcpy(eptr->ep_key, &cdbei->ptr[sizeof(long)], eptr->ep_keylen);
738 /* Phase 2: delete the records */
739 lprintf(CTDL_DEBUG, "Purge euid index: phase 2\n");
741 cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
748 lprintf(CTDL_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
753 void *purge_databases(void *args)
756 static time_t last_purge = 0;
760 while (!CtdlThreadCheckStop()) {
761 /* Do the auto-purge if the current hour equals the purge hour,
762 * but not if the operation has already been performed in the
763 * last twelve hours. This is usually enough granularity.
766 localtime_r(&now, &tm);
767 if ((tm.tm_hour != config.c_purge_hour) || ((now - last_purge) < 43200)) {
773 lprintf(CTDL_INFO, "Auto-purger: starting.\n");
775 if (!CtdlThreadCheckStop())
777 retval = PurgeUsers();
778 lprintf(CTDL_NOTICE, "Purged %d users.\n", retval);
781 if (!CtdlThreadCheckStop())
784 lprintf(CTDL_NOTICE, "Expired %d messages.\n", messages_purged);
787 if (!CtdlThreadCheckStop())
789 retval = PurgeRooms();
790 lprintf(CTDL_NOTICE, "Expired %d rooms.\n", retval);
793 if (!CtdlThreadCheckStop())
795 retval = PurgeVisits();
796 lprintf(CTDL_NOTICE, "Purged %d visits.\n", retval);
799 if (!CtdlThreadCheckStop())
801 retval = PurgeUseTable();
802 lprintf(CTDL_NOTICE, "Purged %d entries from the use table.\n", retval);
805 if (!CtdlThreadCheckStop())
807 retval = PurgeEuidIndexTable();
808 lprintf(CTDL_NOTICE, "Purged %d entries from the EUID index.\n", retval);
811 if (!CtdlThreadCheckStop())
813 retval = TDAP_ProcessAdjRefCountQueue();
814 lprintf(CTDL_NOTICE, "Processed %d message reference count adjustments.\n", retval);
817 if (!CtdlThreadCheckStop())
819 lprintf(CTDL_INFO, "Auto-purger: finished.\n");
820 last_purge = now; /* So we don't do it again soon */
823 lprintf(CTDL_INFO, "Auto-purger: STOPPED.\n");
828 /*****************************************************************************/
831 void do_fsck_msg(long msgnum, void *userdata) {
832 struct ctdlroomref *ptr;
834 ptr = (struct ctdlroomref *)malloc(sizeof(struct ctdlroomref));
836 ptr->msgnum = msgnum;
840 void do_fsck_room(struct ctdlroom *qrbuf, void *data)
842 getroom(&CC->room, qrbuf->QRname);
843 CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, do_fsck_msg, NULL);
847 * Check message reference counts
849 void cmd_fsck(char *argbuf) {
851 struct cdbdata *cdbmsg;
853 struct ctdlroomref *ptr;
856 if (CtdlAccessCheck(ac_aide)) return;
858 /* Lame way of checking whether anyone else is doing this now */
860 cprintf("%d Another FSCK is already running.\n", ERROR + RESOURCE_BUSY);
864 cprintf("%d Checking message reference counts\n", LISTING_FOLLOWS);
866 cprintf("\nThis could take a while. Please be patient!\n\n");
867 cprintf("Gathering pointers...\n");
868 ForEachRoom(do_fsck_room, NULL);
871 cprintf("Checking message base...\n");
872 for (msgnum = 0L; msgnum <= CitControl.MMhighest; ++msgnum) {
874 cdbmsg = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
875 if (cdbmsg != NULL) {
877 cprintf("Message %7ld ", msgnum);
879 GetMetaData(&smi, msgnum);
880 cprintf("refcount=%-2d ", smi.meta_refcount);
883 for (ptr = rr; ptr != NULL; ptr = ptr->next) {
884 if (ptr->msgnum == msgnum) ++realcount;
886 cprintf("realcount=%-2d\n", realcount);
888 if ( (smi.meta_refcount != realcount)
889 || (realcount == 0) ) {
890 AdjRefCount(msgnum, (smi.meta_refcount - realcount));
897 cprintf("Freeing memory...\n");
912 /*****************************************************************************/
914 CTDL_MODULE_INIT(expire)
918 CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
921 CtdlThreadCreate("Auto Purger", CTDLTHREAD_BIGSTACK, purge_databases, NULL);
922 /* return our Subversion id for the Log */