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