citadel/modules/expire/serv_expire.c

   1 /*
   2  * $Id$
   3  *
   4  * This module handles the expiry of old messages and the purging of old users.
   5  *
   6  */
   7
   8
   9 /*
  10  * A brief technical discussion:
  11  *
  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.
  15  *
  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.
  22  *
  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.
  25  */
  26
  27
  28 #include "sysdep.h"
  29 #include <stdlib.h>
  30 #include <unistd.h>
  31 #include <stdio.h>
  32 #include <fcntl.h>
  33 #include <signal.h>
  34 #include <pwd.h>
  35 #include <errno.h>
  36 #include <sys/types.h>
  37
  38 #if TIME_WITH_SYS_TIME
  39 # include <sys/time.h>
  40 # include <time.h>
  41 #else
  42 # if HAVE_SYS_TIME_H
  43 #  include <sys/time.h>
  44 # else
  45 #  include <time.h>
  46 # endif
  47 #endif
  48
  49 #include <sys/wait.h>
  50 #include <string.h>
  51 #include <limits.h>
  52 #include <libcitadel.h>
  53 #include "citadel.h"
  54 #include "server.h"
  55 #include "citserver.h"
  56 #include "support.h"
  57 #include "config.h"
  58 #include "room_ops.h"
  59 #include "policy.h"
  60 #include "database.h"
  61 #include "msgbase.h"
  62 #include "user_ops.h"
  63 #include "control.h"
  64 #include "serv_network.h"       /* Needed for defenition of UseTable */
  65
  66
  67 #include "ctdl_module.h"
  68
  69
  70 struct PurgeList {
  71         struct PurgeList *next;
  72         char name[ROOMNAMELEN]; /* use the larger of username or roomname */
  73 };
  74
  75 struct VPurgeList {
  76         struct VPurgeList *next;
  77         long vp_roomnum;
  78         long vp_roomgen;
  79         long vp_usernum;
  80 };
  81
  82 struct ValidRoom {
  83         struct ValidRoom *next;
  84         long vr_roomnum;
  85         long vr_roomgen;
  86 };
  87
  88 struct ValidUser {
  89         struct ValidUser *next;
  90         long vu_usernum;
  91 };
  92
  93
  94 struct ctdlroomref {
  95         struct ctdlroomref *next;
  96         long msgnum;
  97 };
  98
  99 struct UPurgeList {
 100         struct UPurgeList *next;
 101         char up_key[256];
 102 };
 103
 104 struct EPurgeList {
 105         struct EPurgeList *next;
 106         int ep_keylen;
 107         char *ep_key;
 108 };
 109
 110
 111 struct PurgeList *UserPurgeList = NULL;
 112 struct PurgeList *RoomPurgeList = NULL;
 113 struct ValidRoom *ValidRoomList = NULL;
 114 struct ValidUser *ValidUserList = NULL;
 115 int messages_purged;
 116 int users_not_purged;
 117
 118 struct ctdlroomref *rr = NULL;
 119
 120 extern struct CitContext *ContextList;
 121
 122
 123 /*
 124  * First phase of message purge -- gather the locations of messages which
 125  * qualify for purging and write them to a temp file.
 126  */
 127 void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
 128         struct ExpirePolicy epbuf;
 129         long delnum;
 130         time_t xtime, now;
 131         struct CtdlMessage *msg = NULL;
 132         int a;
 133         struct cdbdata *cdbfr;
 134         long *msglist = NULL;
 135         int num_msgs = 0;
 136         FILE *purgelist;
 137
 138         purgelist = (FILE *)data;
 139         fprintf(purgelist, "r=%s\n", qrbuf->QRname);
 140
 141         time(&now);
 142         GetExpirePolicy(&epbuf, qrbuf);
 143
 144         /* If the room is set to never expire messages ... do nothing */
 145         if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
 146         if (epbuf.expire_mode == EXPIRE_MANUAL) return;
 147
 148         cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
 149
 150         if (cdbfr != NULL) {
 151                 msglist = malloc(cdbfr->len);
 152                 memcpy(msglist, cdbfr->ptr, cdbfr->len);
 153                 num_msgs = cdbfr->len / sizeof(long);
 154                 cdb_free(cdbfr);
 155         }
 156
 157         /* Nothing to do if there aren't any messages */
 158         if (num_msgs == 0) {
 159                 if (msglist != NULL) free(msglist);
 160                 return;
 161         }
 162
 163         /* If the room is set to expire by count, do that */
 164         if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
 165                 if (num_msgs > epbuf.expire_value) {
 166                         for (a=0; a<(num_msgs - epbuf.expire_value); ++a) {
 167                                 fprintf(purgelist, "m=%ld\n", msglist[a]);
 168                                 ++messages_purged;
 169                         }
 170                 }
 171         }
 172
 173         /* If the room is set to expire by age... */
 174         if (epbuf.expire_mode == EXPIRE_AGE) {
 175                 for (a=0; a<num_msgs; ++a) {
 176                         delnum = msglist[a];
 177
 178                         msg = CtdlFetchMessage(delnum, 0); /* dont need body */
 179                         if (msg != NULL) {
 180                                 xtime = atol(msg->cm_fields['T']);
 181                                 CtdlFreeMessage(msg);
 182                         } else {
 183                                 xtime = 0L;
 184                         }
 185
 186                         if ((xtime > 0L)
 187                            && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
 188                                 fprintf(purgelist, "m=%ld\n", delnum);
 189                                 ++messages_purged;
 190                         }
 191                 }
 192         }
 193
 194         if (msglist != NULL) free(msglist);
 195 }
 196
 197
 198 /*
 199  * Second phase of message purge -- read list of msgs from temp file and
 200  * delete them.
 201  */
 202 void DoPurgeMessages(FILE *purgelist) {
 203         char roomname[ROOMNAMELEN];
 204         long msgnum;
 205         char buf[SIZ];
 206
 207         rewind(purgelist);
 208         strcpy(roomname, "nonexistent room ___ ___");
 209         while (fgets(buf, sizeof buf, purgelist) != NULL) {
 210                 buf[strlen(buf)-1]=0;
 211                 if (!strncasecmp(buf, "r=", 2)) {
 212                         strcpy(roomname, &buf[2]);
 213                 }
 214                 if (!strncasecmp(buf, "m=", 2)) {
 215                         msgnum = atol(&buf[2]);
 216                         if (msgnum > 0L) {
 217                                 CtdlDeleteMessages(roomname, &msgnum, 1, "");
 218                         }
 219                 }
 220         }
 221 }
 222
 223
 224 void PurgeMessages(void) {
 225         FILE *purgelist;
 226
 227         lprintf(CTDL_DEBUG, "PurgeMessages() called\n");
 228         messages_purged = 0;
 229
 230         purgelist = tmpfile();
 231         if (purgelist == NULL) {
 232                 lprintf(CTDL_CRIT, "Can't create purgelist temp file: %s\n",
 233                         strerror(errno));
 234                 return;
 235         }
 236
 237         ForEachRoom(GatherPurgeMessages, (void *)purgelist );
 238         DoPurgeMessages(purgelist);
 239         fclose(purgelist);
 240 }
 241
 242
 243 void AddValidUser(struct ctdluser *usbuf, void *data) {
 244         struct ValidUser *vuptr;
 245
 246         vuptr = (struct ValidUser *)malloc(sizeof(struct ValidUser));
 247         vuptr->next = ValidUserList;
 248         vuptr->vu_usernum = usbuf->usernum;
 249         ValidUserList = vuptr;
 250 }
 251
 252 void AddValidRoom(struct ctdlroom *qrbuf, void *data) {
 253         struct ValidRoom *vrptr;
 254
 255         vrptr = (struct ValidRoom *)malloc(sizeof(struct ValidRoom));
 256         vrptr->next = ValidRoomList;
 257         vrptr->vr_roomnum = qrbuf->QRnumber;
 258         vrptr->vr_roomgen = qrbuf->QRgen;
 259         ValidRoomList = vrptr;
 260 }
 261
 262 void DoPurgeRooms(struct ctdlroom *qrbuf, void *data) {
 263         time_t age, purge_secs;
 264         struct PurgeList *pptr;
 265         struct ValidUser *vuptr;
 266         int do_purge = 0;
 267
 268         /* For mailbox rooms, there's only one purging rule: if the user who
 269          * owns the room still exists, we keep the room; otherwise, we purge
 270          * it.  Bypass any other rules.
 271          */
 272         if (qrbuf->QRflags & QR_MAILBOX) {
 273                 /* if user not found, do_purge will be 1 */
 274                 do_purge = 1;
 275                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 276                         if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
 277                                 do_purge = 0;
 278                         }
 279                 }
 280         }
 281         else {
 282                 /* Any of these attributes render a room non-purgable */
 283                 if (qrbuf->QRflags & QR_PERMANENT) return;
 284                 if (qrbuf->QRflags & QR_DIRECTORY) return;
 285                 if (qrbuf->QRflags & QR_NETWORK) return;
 286                 if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
 287                 if (is_noneditable(qrbuf)) return;
 288
 289                 /* If we don't know the modification date, be safe and don't purge */
 290                 if (qrbuf->QRmtime <= (time_t)0) return;
 291
 292                 /* If no room purge time is set, be safe and don't purge */
 293                 if (config.c_roompurge < 0) return;
 294
 295                 /* Otherwise, check the date of last modification */
 296                 age = time(NULL) - (qrbuf->QRmtime);
 297                 purge_secs = (time_t)config.c_roompurge * (time_t)86400;
 298                 if (purge_secs <= (time_t)0) return;
 299                 lprintf(CTDL_DEBUG, "<%s> is <%ld> seconds old\n", qrbuf->QRname, (long)age);
 300                 if (age > purge_secs) do_purge = 1;
 301         } /* !QR_MAILBOX */
 302
 303         if (do_purge) {
 304                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 305                 pptr->next = RoomPurgeList;
 306                 strcpy(pptr->name, qrbuf->QRname);
 307                 RoomPurgeList = pptr;
 308         }
 309
 310 }
 311
 312
 313
 314 int PurgeRooms(void) {
 315         struct PurgeList *pptr;
 316         int num_rooms_purged = 0;
 317         struct ctdlroom qrbuf;
 318         struct ValidUser *vuptr;
 319         char *transcript = NULL;
 320
 321         lprintf(CTDL_DEBUG, "PurgeRooms() called\n");
 322
 323
 324         /* Load up a table full of valid user numbers so we can delete
 325          * user-owned rooms for users who no longer exist */
 326         ForEachUser(AddValidUser, NULL);
 327
 328         /* Then cycle through the room file */
 329         ForEachRoom(DoPurgeRooms, NULL);
 330
 331         /* Free the valid user list */
 332         while (ValidUserList != NULL) {
 333                 vuptr = ValidUserList->next;
 334                 free(ValidUserList);
 335                 ValidUserList = vuptr;
 336         }
 337
 338
 339         transcript = malloc(SIZ);
 340         strcpy(transcript, "The following rooms have been auto-purged:\n");
 341
 342         while (RoomPurgeList != NULL) {
 343                 if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
 344                         transcript=realloc(transcript, strlen(transcript)+SIZ);
 345                         snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
 346                                 qrbuf.QRname);
 347                         delete_room(&qrbuf);
 348                 }
 349                 pptr = RoomPurgeList->next;
 350                 free(RoomPurgeList);
 351                 RoomPurgeList = pptr;
 352                 ++num_rooms_purged;
 353         }
 354
 355         if (num_rooms_purged > 0) aide_message(transcript, "Room Autopurger Message");
 356         free(transcript);
 357
 358         lprintf(CTDL_DEBUG, "Purged %d rooms.\n", num_rooms_purged);
 359         return(num_rooms_purged);
 360 }
 361
 362
 363 /*
 364  * Back end function to check user accounts for associated Unix accounts
 365  * which no longer exist.  (Only relevant for host auth mode.)
 366  */
 367 void do_uid_user_purge(struct ctdluser *us, void *data) {
 368         struct PurgeList *pptr;
 369
 370         if ((us->uid != (-1)) && (us->uid != CTDLUID)) {
 371                 if (getpwuid(us->uid) == NULL) {
 372                         pptr = (struct PurgeList *)
 373                                 malloc(sizeof(struct PurgeList));
 374                         pptr->next = UserPurgeList;
 375                         strcpy(pptr->name, us->fullname);
 376                         UserPurgeList = pptr;
 377                 }
 378         }
 379         else {
 380                 ++users_not_purged;
 381         }
 382 }
 383
 384
 385
 386 /*
 387  * Back end function to check user accounts for expiration.
 388  */
 389 void do_user_purge(struct ctdluser *us, void *data) {
 390         int purge;
 391         time_t now;
 392         time_t purge_time;
 393         struct PurgeList *pptr;
 394
 395         /* Set purge time; if the user overrides the system default, use it */
 396         if (us->USuserpurge > 0) {
 397                 purge_time = ((time_t)us->USuserpurge) * 86400L;
 398         }
 399         else {
 400                 purge_time = ((time_t)config.c_userpurge) * 86400L;
 401         }
 402
 403         /* The default rule is to not purge. */
 404         purge = 0;
 405
 406         /* If the user hasn't called in two months, his/her account
 407          * has expired, so purge the record.
 408          */
 409         now = time(NULL);
 410         if ((now - us->lastcall) > purge_time) purge = 1;
 411
 412         /* If the user set his/her password to 'deleteme', he/she
 413          * wishes to be deleted, so purge the record.
 414          */
 415         if (!strcasecmp(us->password, "deleteme")) purge = 1;
 416
 417         /* If the record is marked as permanent, don't purge it.
 418          */
 419         if (us->flags & US_PERM) purge = 0;
 420
 421         /* If the user is an Aide, don't purge him/her/it.
 422          */
 423         if (us->axlevel == 6) purge = 0;
 424
 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.
 428          */
 429         if (us->axlevel == 0) purge = 1;
 430
 431         /* 0 calls is impossible.  If there are 0 calls, it must
 432          * be a corrupted record, so purge it.
 433          */
 434         if (us->timescalled == 0) purge = 1;
 435
 436         /* User number 0, as well as any negative user number, is
 437          * also impossible.
 438          */
 439         if (us->usernum < 1L) purge = 1;
 440
 441         if (purge == 1) {
 442                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 443                 pptr->next = UserPurgeList;
 444                 strcpy(pptr->name, us->fullname);
 445                 UserPurgeList = pptr;
 446         }
 447         else {
 448                 ++users_not_purged;
 449         }
 450
 451 }
 452
 453
 454
 455 int PurgeUsers(void) {
 456         struct PurgeList *pptr;
 457         int num_users_purged = 0;
 458         char *transcript = NULL;
 459
 460         lprintf(CTDL_DEBUG, "PurgeUsers() called\n");
 461         users_not_purged = 0;
 462
 463         if (config.c_auth_mode == 1) {
 464                 /* host auth mode */
 465                 ForEachUser(do_uid_user_purge, NULL);
 466         }
 467         else {
 468                 /* native auth mode */
 469                 if (config.c_userpurge > 0) {
 470                         ForEachUser(do_user_purge, NULL);
 471                 }
 472         }
 473
 474         transcript = malloc(SIZ);
 475
 476         if (users_not_purged == 0) {
 477                 strcpy(transcript, "The auto-purger was told to purge every user.  It is\n"
 478                                 "refusing to do this because it usually indicates a problem\n"
 479                                 "such as an inability to communicate with a name service.\n"
 480                 );
 481                 while (UserPurgeList != NULL) {
 482                         pptr = UserPurgeList->next;
 483                         free(UserPurgeList);
 484                         UserPurgeList = pptr;
 485                         ++num_users_purged;
 486                 }
 487         }
 488
 489         else {
 490                 strcpy(transcript, "The following users have been auto-purged:\n");
 491                 while (UserPurgeList != NULL) {
 492                         transcript=realloc(transcript, strlen(transcript)+SIZ);
 493                         snprintf(&transcript[strlen(transcript)], SIZ, " %s\n",
 494                                 UserPurgeList->name);
 495                         purge_user(UserPurgeList->name);
 496                         pptr = UserPurgeList->next;
 497                         free(UserPurgeList);
 498                         UserPurgeList = pptr;
 499                         ++num_users_purged;
 500                 }
 501         }
 502
 503         if (num_users_purged > 0) aide_message(transcript, "User Purge Message");
 504         free(transcript);
 505
 506         lprintf(CTDL_DEBUG, "Purged %d users.\n", num_users_purged);
 507         return(num_users_purged);
 508 }
 509
 510
 511 /*
 512  * Purge visits
 513  *
 514  * This is a really cumbersome "garbage collection" function.  We have to
 515  * delete visits which refer to rooms and/or users which no longer exist.  In
 516  * order to prevent endless traversals of the room and user files, we first
 517  * build linked lists of rooms and users which _do_ exist on the system, then
 518  * traverse the visit file, checking each record against those two lists and
 519  * purging the ones that do not have a match on _both_ lists.  (Remember, if
 520  * either the room or user being referred to is no longer on the system, the
 521  * record is completely useless.)
 522  */
 523 int PurgeVisits(void) {
 524         struct cdbdata *cdbvisit;
 525         struct visit vbuf;
 526         struct VPurgeList *VisitPurgeList = NULL;
 527         struct VPurgeList *vptr;
 528         int purged = 0;
 529         char IndexBuf[32];
 530         int IndexLen;
 531         struct ValidRoom *vrptr;
 532         struct ValidUser *vuptr;
 533         int RoomIsValid, UserIsValid;
 534
 535         /* First, load up a table full of valid room/gen combinations */
 536         ForEachRoom(AddValidRoom, NULL);
 537
 538         /* Then load up a table full of valid user numbers */
 539         ForEachUser(AddValidUser, NULL);
 540
 541         /* Now traverse through the visits, purging irrelevant records... */
 542         cdb_rewind(CDB_VISIT);
 543         while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
 544                 memset(&vbuf, 0, sizeof(struct visit));
 545                 memcpy(&vbuf, cdbvisit->ptr,
 546                         ( (cdbvisit->len > sizeof(struct visit)) ?
 547                         sizeof(struct visit) : cdbvisit->len) );
 548                 cdb_free(cdbvisit);
 549
 550                 RoomIsValid = 0;
 551                 UserIsValid = 0;
 552
 553                 /* Check to see if the room exists */
 554                 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
 555                         if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
 556                              && (vrptr->vr_roomgen==vbuf.v_roomgen))
 557                                 RoomIsValid = 1;
 558                 }
 559
 560                 /* Check to see if the user exists */
 561                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 562                         if (vuptr->vu_usernum == vbuf.v_usernum)
 563                                 UserIsValid = 1;
 564                 }
 565
 566                 /* Put the record on the purge list if it's dead */
 567                 if ((RoomIsValid==0) || (UserIsValid==0)) {
 568                         vptr = (struct VPurgeList *)
 569                                 malloc(sizeof(struct VPurgeList));
 570                         vptr->next = VisitPurgeList;
 571                         vptr->vp_roomnum = vbuf.v_roomnum;
 572                         vptr->vp_roomgen = vbuf.v_roomgen;
 573                         vptr->vp_usernum = vbuf.v_usernum;
 574                         VisitPurgeList = vptr;
 575                 }
 576
 577         }
 578
 579         /* Free the valid room/gen combination list */
 580         while (ValidRoomList != NULL) {
 581                 vrptr = ValidRoomList->next;
 582                 free(ValidRoomList);
 583                 ValidRoomList = vrptr;
 584         }
 585
 586         /* Free the valid user list */
 587         while (ValidUserList != NULL) {
 588                 vuptr = ValidUserList->next;
 589                 free(ValidUserList);
 590                 ValidUserList = vuptr;
 591         }
 592
 593         /* Now delete every visit on the purged list */
 594         while (VisitPurgeList != NULL) {
 595                 IndexLen = GenerateRelationshipIndex(IndexBuf,
 596                                 VisitPurgeList->vp_roomnum,
 597                                 VisitPurgeList->vp_roomgen,
 598                                 VisitPurgeList->vp_usernum);
 599                 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
 600                 vptr = VisitPurgeList->next;
 601                 free(VisitPurgeList);
 602                 VisitPurgeList = vptr;
 603                 ++purged;
 604         }
 605
 606         return(purged);
 607 }
 608
 609 /*
 610  * Purge the use table of old entries.
 611  *
 612  */
 613 int PurgeUseTable(void) {
 614         int purged = 0;
 615         struct cdbdata *cdbut;
 616         struct UseTable ut;
 617         struct UPurgeList *ul = NULL;
 618         struct UPurgeList *uptr;
 619
 620         /* Phase 1: traverse through the table, discovering old records... */
 621         lprintf(CTDL_DEBUG, "Purge use table: phase 1\n");
 622         cdb_rewind(CDB_USETABLE);
 623         while(cdbut = cdb_next_item(CDB_USETABLE), cdbut != NULL) {
 624
 625         /*
 626          * TODODRW: change this to create a new function time_t cdb_get_timestamp( struct cdbdata *)
 627          * this will release this file from the serv_network.h
 628          * Maybe it could be a macro that extracts and casts the reult
 629          */
 630                 memcpy(&ut, cdbut->ptr,
 631                        ((cdbut->len > sizeof(struct UseTable)) ?
 632                         sizeof(struct UseTable) : cdbut->len));
 633                 cdb_free(cdbut);
 634
 635                 if ( (time(NULL) - ut.ut_timestamp) > USETABLE_RETAIN ) {
 636                         uptr = (struct UPurgeList *) malloc(sizeof(struct UPurgeList));
 637                         if (uptr != NULL) {
 638                                 uptr->next = ul;
 639                                 safestrncpy(uptr->up_key, ut.ut_msgid, sizeof uptr->up_key);
 640                                 ul = uptr;
 641                         }
 642                         ++purged;
 643                 }
 644
 645         }
 646
 647         /* Phase 2: delete the records */
 648         lprintf(CTDL_DEBUG, "Purge use table: phase 2\n");
 649         while (ul != NULL) {
 650                 cdb_delete(CDB_USETABLE, ul->up_key, strlen(ul->up_key));
 651                 uptr = ul->next;
 652                 free(ul);
 653                 ul = uptr;
 654         }
 655
 656         lprintf(CTDL_DEBUG, "Purge use table: finished (purged %d records)\n", purged);
 657         return(purged);
 658 }
 659
 660
 661
 662 /*
 663  * Purge the EUID Index of old records.
 664  *
 665  */
 666 int PurgeEuidIndexTable(void) {
 667         int purged = 0;
 668         struct cdbdata *cdbei;
 669         struct EPurgeList *el = NULL;
 670         struct EPurgeList *eptr;
 671         long msgnum;
 672         struct CtdlMessage *msg = NULL;
 673
 674         /* Phase 1: traverse through the table, discovering old records... */
 675         lprintf(CTDL_DEBUG, "Purge EUID index: phase 1\n");
 676         cdb_rewind(CDB_EUIDINDEX);
 677         while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei != NULL) {
 678
 679                 memcpy(&msgnum, cdbei->ptr, sizeof(long));
 680
 681                 msg = CtdlFetchMessage(msgnum, 0);
 682                 if (msg != NULL) {
 683                         CtdlFreeMessage(msg);   /* it still exists, so do nothing */
 684                 }
 685                 else {
 686                         eptr = (struct EPurgeList *) malloc(sizeof(struct EPurgeList));
 687                         if (eptr != NULL) {
 688                                 eptr->next = el;
 689                                 eptr->ep_keylen = cdbei->len - sizeof(long);
 690                                 eptr->ep_key = malloc(cdbei->len);
 691                                 memcpy(eptr->ep_key, &cdbei->ptr[sizeof(long)], eptr->ep_keylen);
 692                                 el = eptr;
 693                         }
 694                         ++purged;
 695                 }
 696
 697                 cdb_free(cdbei);
 698
 699         }
 700
 701         /* Phase 2: delete the records */
 702         lprintf(CTDL_DEBUG, "Purge euid index: phase 2\n");
 703         while (el != NULL) {
 704                 cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
 705                 free(el->ep_key);
 706                 eptr = el->next;
 707                 free(el);
 708                 el = eptr;
 709         }
 710
 711         lprintf(CTDL_DEBUG, "Purge euid index: finished (purged %d records)\n", purged);
 712         return(purged);
 713 }
 714
 715
 716 void purge_databases(void) {
 717         int retval;
 718         static time_t last_purge = 0;
 719         time_t now;
 720         struct tm tm;
 721
 722         /* Do the auto-purge if the current hour equals the purge hour,
 723          * but not if the operation has already been performed in the
 724          * last twelve hours.  This is usually enough granularity.
 725          */
 726         now = time(NULL);
 727         localtime_r(&now, &tm);
 728         if (tm.tm_hour != config.c_purge_hour) return;
 729         if ((now - last_purge) < 43200) return;
 730
 731         lprintf(CTDL_INFO, "Auto-purger: starting.\n");
 732
 733         retval = PurgeUsers();
 734         lprintf(CTDL_NOTICE, "Purged %d users.\n", retval);
 735
 736         PurgeMessages();
 737         lprintf(CTDL_NOTICE, "Expired %d messages.\n", messages_purged);
 738
 739         retval = PurgeRooms();
 740         lprintf(CTDL_NOTICE, "Expired %d rooms.\n", retval);
 741
 742         retval = PurgeVisits();
 743         lprintf(CTDL_NOTICE, "Purged %d visits.\n", retval);
 744
 745         retval = PurgeUseTable();
 746         lprintf(CTDL_NOTICE, "Purged %d entries from the use table.\n", retval);
 747
 748         retval = PurgeEuidIndexTable();
 749         lprintf(CTDL_NOTICE, "Purged %d entries from the EUID index.\n", retval);
 750
 751         retval = TDAP_ProcessAdjRefCountQueue();
 752         lprintf(CTDL_NOTICE, "Processed %d message reference count adjustments.\n", retval);
 753
 754         lprintf(CTDL_INFO, "Auto-purger: finished.\n");
 755
 756         last_purge = now;       /* So we don't do it again soon */
 757 }
 758
 759 /*****************************************************************************/
 760
 761
 762 void do_fsck_msg(long msgnum, void *userdata) {
 763         struct ctdlroomref *ptr;
 764
 765         ptr = (struct ctdlroomref *)malloc(sizeof(struct ctdlroomref));
 766         ptr->next = rr;
 767         ptr->msgnum = msgnum;
 768         rr = ptr;
 769 }
 770
 771 void do_fsck_room(struct ctdlroom *qrbuf, void *data)
 772 {
 773         getroom(&CC->room, qrbuf->QRname);
 774         CtdlForEachMessage(MSGS_ALL, 0L, NULL, NULL, NULL, do_fsck_msg, NULL);
 775 }
 776
 777 /*
 778  * Check message reference counts
 779  */
 780 void cmd_fsck(char *argbuf) {
 781         long msgnum;
 782         struct cdbdata *cdbmsg;
 783         struct MetaData smi;
 784         struct ctdlroomref *ptr;
 785         int realcount;
 786
 787         if (CtdlAccessCheck(ac_aide)) return;
 788
 789         /* Lame way of checking whether anyone else is doing this now */
 790         if (rr != NULL) {
 791                 cprintf("%d Another FSCK is already running.\n", ERROR + RESOURCE_BUSY);
 792                 return;
 793         }
 794
 795         cprintf("%d Checking message reference counts\n", LISTING_FOLLOWS);
 796
 797         cprintf("\nThis could take a while.  Please be patient!\n\n");
 798         cprintf("Gathering pointers...\n");
 799         ForEachRoom(do_fsck_room, NULL);
 800
 801         get_control();
 802         cprintf("Checking message base...\n");
 803         for (msgnum = 0L; msgnum <= CitControl.MMhighest; ++msgnum) {
 804
 805                 cdbmsg = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
 806                 if (cdbmsg != NULL) {
 807                         cdb_free(cdbmsg);
 808                         cprintf("Message %7ld    ", msgnum);
 809
 810                         GetMetaData(&smi, msgnum);
 811                         cprintf("refcount=%-2d   ", smi.meta_refcount);
 812
 813                         realcount = 0;
 814                         for (ptr = rr; ptr != NULL; ptr = ptr->next) {
 815                                 if (ptr->msgnum == msgnum) ++realcount;
 816                         }
 817                         cprintf("realcount=%-2d\n", realcount);
 818
 819                         if ( (smi.meta_refcount != realcount)
 820                            || (realcount == 0) ) {
 821                                 AdjRefCount(msgnum, (smi.meta_refcount - realcount));
 822                         }
 823
 824                 }
 825
 826         }
 827
 828         cprintf("Freeing memory...\n");
 829         while (rr != NULL) {
 830                 ptr = rr->next;
 831                 free(rr);
 832                 rr = ptr;
 833         }
 834
 835         cprintf("Done!\n");
 836         cprintf("000\n");
 837
 838 }
 839
 840
 841
 842
 843 /*****************************************************************************/
 844
 845 CTDL_MODULE_INIT(expire)
 846 {
 847         CtdlRegisterSessionHook(purge_databases, EVT_TIMER);
 848         CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
 849
 850         /* return our Subversion id for the Log */
 851         return "$Id$";
 852 }