citadel/server/modules/expire/serv_expire.c

   1 // This module handles the expiry of old messages and the purging of old users.
   2 //
   3 // You might also see this module affectionately referred to as TDAP (The Dreaded Auto-Purger).
   4 //
   5 // Copyright (c) 1988-2023 by citadel.org (Art Cancro, Wilifried Goesgens, and others)
   6 //
   7 // This program is open source software.  Use, duplication, or disclosure
   8 // is subject to the terms of the GNU General Public License, version 3.
   9
  10
  11 #include "../../sysdep.h"
  12 #include <stdlib.h>
  13 #include <unistd.h>
  14 #include <stdio.h>
  15 #include <fcntl.h>
  16 #include <signal.h>
  17 #include <pwd.h>
  18 #include <errno.h>
  19 #include <sys/types.h>
  20 #include <time.h>
  21 #include <sys/wait.h>
  22 #include <string.h>
  23 #include <limits.h>
  24 #include <libcitadel.h>
  25 #include "../../citadel_defs.h"
  26 #include "../../server.h"
  27 #include "../../citserver.h"
  28 #include "../../support.h"
  29 #include "../../config.h"
  30 #include "policy.h"
  31 #include "../../database.h"
  32 #include "../../msgbase.h"
  33 #include "../../user_ops.h"
  34 #include "../../room_ops.h"
  35 #include "../../control.h"
  36 #include "../../threads.h"
  37 #include "../../context.h"
  38
  39 #include "../../ctdl_module.h"
  40
  41
  42 struct PurgeList {
  43         struct PurgeList *next;
  44         char name[ROOMNAMELEN];         // use the larger of username or roomname
  45 };
  46
  47 struct VPurgeList {
  48         struct VPurgeList *next;
  49         long vp_roomnum;
  50         long vp_roomgen;
  51         long vp_usernum;
  52 };
  53
  54 struct ValidRoom {
  55         struct ValidRoom *next;
  56         long vr_roomnum;
  57         long vr_roomgen;
  58 };
  59
  60 struct ValidUser {
  61         struct ValidUser *next;
  62         long vu_usernum;
  63 };
  64
  65 struct ctdlroomref {
  66         struct ctdlroomref *next;
  67         long msgnum;
  68 };
  69
  70 struct EPurgeList {
  71         struct EPurgeList *next;
  72         int ep_keylen;
  73         char *ep_key;
  74 };
  75
  76
  77 struct PurgeList *UserPurgeList = NULL;
  78 struct PurgeList *RoomPurgeList = NULL;
  79 struct ValidRoom *ValidRoomList = NULL;
  80 struct ValidUser *ValidUserList = NULL;
  81 int messages_purged;
  82 int users_not_purged;
  83 struct ctdlroomref *rr = NULL;
  84 int force_purge_now = 0;                        // set to nonzero to force a run right now
  85
  86
  87 // First phase of message purge -- gather the locations of messages which
  88 // qualify for purging and write them to a temp file.
  89 void GatherPurgeMessages(struct ctdlroom *qrbuf, void *data) {
  90         struct ExpirePolicy epbuf;
  91         long delnum;
  92         time_t xtime, now;
  93         struct CtdlMessage *msg = NULL;
  94         int a;
  95         long *msglist = NULL;
  96         int num_msgs = 0;
  97         FILE *purgelist;
  98
  99         purgelist = (FILE *)data;
 100         fprintf(purgelist, "r=%s\n", qrbuf->QRname);
 101
 102         time(&now);
 103         GetExpirePolicy(&epbuf, qrbuf);
 104         syslog(LOG_DEBUG, "expire: scanning room %ld (%s), policy %d", qrbuf->QRnumber, qrbuf->QRname, epbuf.expire_mode);
 105
 106         // If the room is set to never expire messages ... do nothing
 107         if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
 108         if (epbuf.expire_mode == EXPIRE_MANUAL) return;
 109
 110         // Don't purge messages containing system configuration, dumbass.
 111         if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
 112
 113         // Ok, we got this far ... now let's see what's in the room.
 114         num_msgs = CtdlFetchMsgList(qrbuf->QRnumber, &msglist);
 115
 116         // Nothing to do if there aren't any messages
 117         if (num_msgs <= 0) {
 118                 free(msglist);
 119                 return;
 120         }
 121
 122         // If the room is set to expire by count, do that.
 123         if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
 124                 TRACE;
 125                 if (num_msgs > epbuf.expire_value) {
 126                         for (a=0; a<(num_msgs - epbuf.expire_value); ++a) {
 127                                 fprintf(purgelist, "m=%ld\n", msglist[a]);
 128                                 ++messages_purged;
 129                         }
 130                 }
 131         }
 132
 133         // If the room is set to expire by age...
 134         if (epbuf.expire_mode == EXPIRE_AGE) {
 135                 TRACE;
 136                 for (a=0; a<num_msgs; ++a) {
 137                         delnum = msglist[a];
 138                         msg = CtdlFetchMessage(delnum, 0);      // don't need the body
 139                         if (msg != NULL) {
 140                                 xtime = atol(msg->cm_fields[eTimestamp]);
 141                                 CM_Free(msg);
 142                         }
 143                         else {
 144                                 xtime = 0L;
 145                         }
 146
 147                         if ((xtime > 0L) && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
 148                                 fprintf(purgelist, "m=%ld\n", delnum);
 149                                 ++messages_purged;
 150                         }
 151                 }
 152         }
 153
 154         if (msglist != NULL) {
 155                 free(msglist);
 156         }
 157 }
 158
 159
 160 // Second phase of message purge -- read list of msgs from temp file and delete them.
 161 void DoPurgeMessages(FILE *purgelist) {
 162         char roomname[ROOMNAMELEN];
 163         long msgnum;
 164         char buf[SIZ];
 165
 166         rewind(purgelist);
 167         strcpy(roomname, "nonexistent room ___ ___");
 168         while (fgets(buf, sizeof buf, purgelist) != NULL) {
 169                 buf[strlen(buf)-1]=0;
 170                 if (!strncasecmp(buf, "r=", 2)) {
 171                         strcpy(roomname, &buf[2]);
 172                 }
 173                 if (!strncasecmp(buf, "m=", 2)) {
 174                         msgnum = atol(&buf[2]);
 175                         if (msgnum > 0L) {
 176                                 CtdlDeleteMessages(roomname, &msgnum, 1, "");
 177                         }
 178                 }
 179         }
 180 }
 181
 182
 183 void PurgeMessages(void) {
 184         FILE *purgelist;
 185
 186         syslog(LOG_DEBUG, "PurgeMessages() called");
 187         messages_purged = 0;
 188
 189         purgelist = tmpfile();
 190         if (purgelist == NULL) {
 191                 syslog(LOG_CRIT, "Can't create purgelist temp file: %s", strerror(errno));
 192                 return;
 193         }
 194
 195         CtdlForEachRoom(GatherPurgeMessages, (void *)purgelist );
 196         DoPurgeMessages(purgelist);
 197         fclose(purgelist);
 198 }
 199
 200
 201 void AddValidUser(char *username, void *data) {
 202         struct ValidUser *vuptr;
 203         struct ctdluser usbuf;
 204
 205         if (CtdlGetUser(&usbuf, username) != 0) {
 206                 return;
 207         }
 208
 209         vuptr = (struct ValidUser *)malloc(sizeof(struct ValidUser));
 210         if (!vuptr) abort();
 211         vuptr->next = ValidUserList;
 212         vuptr->vu_usernum = usbuf.usernum;
 213         ValidUserList = vuptr;
 214 }
 215
 216
 217 void AddValidRoom(struct ctdlroom *qrbuf, void *data) {
 218         struct ValidRoom *vrptr;
 219
 220         vrptr = (struct ValidRoom *)malloc(sizeof(struct ValidRoom));
 221         if (!vrptr) abort();
 222         vrptr->next = ValidRoomList;
 223         vrptr->vr_roomnum = qrbuf->QRnumber;
 224         vrptr->vr_roomgen = qrbuf->QRgen;
 225         ValidRoomList = vrptr;
 226 }
 227
 228
 229 void DoPurgeRooms(struct ctdlroom *qrbuf, void *data) {
 230         time_t age, purge_secs;
 231         struct PurgeList *pptr;
 232         struct ValidUser *vuptr;
 233         int do_purge = 0;
 234
 235         // For mailbox rooms, there's only one purging rule: if the user who
 236         // owns the room still exists, we keep the room; otherwise, we purge
 237         // it.  Bypass any other rules.
 238         if (qrbuf->QRflags & QR_MAILBOX) {
 239                 // if user not found, do_purge will be 1
 240                 do_purge = 1;
 241                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 242                         if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
 243                                 do_purge = 0;
 244                         }
 245                 }
 246         }
 247         else {
 248                 // Any of these attributes render a room non-purgable
 249                 if (qrbuf->QRflags & QR_PERMANENT) return;
 250                 if (qrbuf->QRflags & QR_DIRECTORY) return;
 251                 if (qrbuf->QRflags2 & QR2_SYSTEM) return;
 252                 if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
 253                 if (CtdlIsNonEditable(qrbuf)) return;
 254
 255                 // If we don't know the modification date, be safe and don't purge
 256                 if (qrbuf->QRmtime <= (time_t)0) return;
 257
 258                 // If no room purge time is set, be safe and don't purge
 259                 if (CtdlGetConfigLong("c_roompurge") < 0) return;
 260
 261                 // Otherwise, check the date of last modification
 262                 age = time(NULL) - (qrbuf->QRmtime);
 263                 purge_secs = CtdlGetConfigLong("c_roompurge") * 86400;
 264                 if (purge_secs <= (time_t)0) return;
 265                 syslog(LOG_DEBUG, "<%s> is <%ld> seconds old", qrbuf->QRname, (long)age);
 266                 if (age > purge_secs) do_purge = 1;
 267         } // !QR_MAILBOX
 268
 269         if (do_purge) {
 270                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 271                 if (!pptr) abort();
 272                 pptr->next = RoomPurgeList;
 273                 strcpy(pptr->name, qrbuf->QRname);
 274                 RoomPurgeList = pptr;
 275         }
 276
 277 }
 278
 279
 280 int PurgeRooms(void) {
 281         struct PurgeList *pptr;
 282         int num_rooms_purged = 0;
 283         struct ctdlroom qrbuf;
 284         struct ValidUser *vuptr;
 285
 286         syslog(LOG_DEBUG, "PurgeRooms() called");
 287
 288         // Load up a table full of valid user numbers so we can delete
 289         // user-owned rooms for users who no longer exist
 290         ForEachUser(AddValidUser, NULL);
 291
 292         // Then cycle through the room file
 293         CtdlForEachRoom(DoPurgeRooms, NULL);
 294
 295         // Free the valid user list
 296         while (ValidUserList != NULL) {
 297                 vuptr = ValidUserList->next;
 298                 free(ValidUserList);
 299                 ValidUserList = vuptr;
 300         }
 301
 302         while (RoomPurgeList != NULL) {
 303                 if (CtdlGetRoom(&qrbuf, RoomPurgeList->name) == 0) {
 304                         CtdlDeleteRoom(&qrbuf);
 305                         ++num_rooms_purged;
 306                 }
 307                 pptr = RoomPurgeList->next;
 308                 free(RoomPurgeList);
 309                 RoomPurgeList = pptr;
 310         }
 311
 312         syslog(LOG_DEBUG, "Purged %d rooms.", num_rooms_purged);
 313         return(num_rooms_purged);
 314 }
 315
 316
 317 // Back end function to check user accounts for expiration.
 318 void do_user_purge(char *username, void *data) {
 319         int purge;
 320         time_t now;
 321         time_t purge_time;
 322         struct PurgeList *pptr;
 323         struct ctdluser us;
 324
 325         if (CtdlGetUser(&us, username) != 0) {
 326                 return;
 327         }
 328
 329         // Set purge time; if the user overrides the system default, use it
 330         if (us.USuserpurge > 0) {
 331                 purge_time = ((time_t)us.USuserpurge) * 86400;
 332         }
 333         else {
 334                 purge_time = CtdlGetConfigLong("c_userpurge") * 86400;
 335         }
 336
 337         // The default rule is to not purge.
 338         purge = 0;
 339
 340         // If the user has not logged in for the configured amount of time, expire the account.
 341         if (CtdlGetConfigLong("c_userpurge") > 0) {
 342                 now = time(NULL);
 343                 if ((now - us.lastcall) > purge_time) purge = 1;
 344         }
 345
 346         // If the account is marked as permanent, don't purge it.
 347         if (us.flags & US_PERM) purge = 0;
 348
 349         // If the account is an administrator, don't purge it.
 350         if (us.axlevel == 6) purge = 0;
 351
 352         // If the access level is 0, the record should already have been
 353         // deleted, but maybe the user was logged in at the time or something.
 354         // Delete the record now.
 355         if (us.axlevel == 0) purge = 1;
 356
 357         // If the user set his/her password to 'deleteme', he/she
 358         // wishes to be deleted, so purge the record.
 359         // Moved this lower down so that aides and permanent users get purged if they ask to be.
 360         if (!strcasecmp(us.password, "deleteme")) purge = 1;
 361
 362         // any negative user number, is also impossible.
 363         if (us.usernum < 0L) purge = 1;
 364
 365         // Don't purge user 0. That user is there for the system
 366         if (us.usernum == 0L) purge = 0;
 367
 368         // If the user has no full name entry then we can't purge them since the actual purge can't find them.
 369         // This shouldn't happen but does somehow.
 370         if (IsEmptyStr(us.fullname)) {
 371                 purge = 0;
 372                 if (us.usernum > 0L) {
 373                         purge = 0;
 374                         syslog(LOG_INFO, "expire: refusing to purge user %ld who has no name", us.usernum);
 375                 }
 376         }
 377
 378         if (purge == 1) {
 379                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 380                 if (!pptr) abort();
 381                 pptr->next = UserPurgeList;
 382                 strcpy(pptr->name, us.fullname);
 383                 UserPurgeList = pptr;
 384         }
 385         else {
 386                 ++users_not_purged;
 387         }
 388
 389 }
 390
 391
 392 int PurgeUsers(void) {
 393         struct PurgeList *pptr;
 394         int num_users_purged = 0;
 395
 396         syslog(LOG_DEBUG, "PurgeUsers() called");
 397         users_not_purged = 0;
 398
 399         switch(CtdlGetConfigInt("c_auth_mode")) {
 400                 case AUTHMODE_NATIVE:
 401                         ForEachUser(do_user_purge, NULL);
 402                         break;
 403                 default:
 404                         syslog(LOG_DEBUG, "User purge for auth mode %d is not implemented.", CtdlGetConfigInt("c_auth_mode"));
 405                         break;
 406         }
 407
 408         if (users_not_purged == 0) {
 409                 syslog(LOG_INFO, "expire: refusing to purge all users because this usually indicates an error");
 410                 while (UserPurgeList != NULL) {
 411                         pptr = UserPurgeList->next;
 412                         free(UserPurgeList);
 413                         UserPurgeList = pptr;
 414                         ++num_users_purged;
 415                 }
 416         }
 417         else {
 418                 while (UserPurgeList != NULL) {
 419                         purge_user(UserPurgeList->name);
 420                         pptr = UserPurgeList->next;
 421                         free(UserPurgeList);
 422                         UserPurgeList = pptr;
 423                         ++num_users_purged;
 424                 }
 425         }
 426
 427         syslog(LOG_DEBUG, "Purged %d users.", num_users_purged);
 428         return(num_users_purged);
 429 }
 430
 431
 432 // Purge visits
 433 //
 434 // This is a really cumbersome "garbage collection" function.  We have to
 435 // delete visits which refer to rooms and/or users which no longer exist.  In
 436 // order to prevent endless traversals of the room and user files, we first
 437 // build linked lists of rooms and users which _do_ exist on the system, then
 438 // traverse the visit file, checking each record against those two lists and
 439 // purging the ones that do not have a match on _both_ lists.  (Remember, if
 440 // either the room or user being referred to is no longer on the system, the
 441 // record is useless and should be removed.)
 442 //
 443 int PurgeVisits(void) {
 444         struct cdbkeyval cdbvisit;
 445         struct visit vbuf;
 446         struct VPurgeList *VisitPurgeList = NULL;
 447         struct VPurgeList *vptr;
 448         int purged = 0;
 449         char IndexBuf[32];
 450         int IndexLen;
 451         struct ValidRoom *vrptr;
 452         struct ValidUser *vuptr;
 453         int RoomIsValid, UserIsValid;
 454
 455         // First, load up a table full of valid room/gen combinations
 456         CtdlForEachRoom(AddValidRoom, NULL);
 457
 458         // Then load up a table full of valid user numbers
 459         ForEachUser(AddValidUser, NULL);
 460
 461         // Now traverse through the visits, purging irrelevant records...
 462         cdb_rewind(CDB_VISIT);
 463         while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit.val.ptr!=NULL) {            // always read through to the end
 464                 memset(&vbuf, 0, sizeof(struct visit));
 465                 memcpy(&vbuf, cdbvisit.val.ptr, ((cdbvisit.val.len > sizeof(struct visit)) ? sizeof(struct visit) : cdbvisit.val.len));
 466                 RoomIsValid = 0;
 467                 UserIsValid = 0;
 468
 469                 // Check to see if the room exists
 470                 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
 471                         if ( (vrptr->vr_roomnum==vbuf.v_roomnum) && (vrptr->vr_roomgen==vbuf.v_roomgen)) {
 472                                 RoomIsValid = 1;
 473                         }
 474                 }
 475
 476                 // Check to see if the user exists
 477                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 478                         if (vuptr->vu_usernum == vbuf.v_usernum) {
 479                                 UserIsValid = 1;
 480                         }
 481                 }
 482
 483                 // Put the record on the purge list if it's dead
 484                 if ((RoomIsValid==0) || (UserIsValid==0)) {
 485                         vptr = (struct VPurgeList *) malloc(sizeof(struct VPurgeList));
 486                         if (!vptr) abort();
 487                         vptr->next = VisitPurgeList;
 488                         vptr->vp_roomnum = vbuf.v_roomnum;
 489                         vptr->vp_roomgen = vbuf.v_roomgen;
 490                         vptr->vp_usernum = vbuf.v_usernum;
 491                         VisitPurgeList = vptr;
 492                 }
 493
 494         }
 495
 496         // Free the valid room/gen combination list
 497         while (ValidRoomList != NULL) {
 498                 vrptr = ValidRoomList->next;
 499                 free(ValidRoomList);
 500                 ValidRoomList = vrptr;
 501         }
 502
 503         // Free the valid user list
 504         while (ValidUserList != NULL) {
 505                 vuptr = ValidUserList->next;
 506                 free(ValidUserList);
 507                 ValidUserList = vuptr;
 508         }
 509
 510         // Now delete every visit on the purged list
 511         cdb_begin_transaction();
 512         while (VisitPurgeList != NULL) {
 513                 IndexLen = GenerateRelationshipIndex(IndexBuf,
 514                                 VisitPurgeList->vp_roomnum,
 515                                 VisitPurgeList->vp_roomgen,
 516                                 VisitPurgeList->vp_usernum);
 517                 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
 518                 vptr = VisitPurgeList->next;
 519                 free(VisitPurgeList);
 520                 VisitPurgeList = vptr;
 521                 ++purged;
 522         }
 523         cdb_end_transaction();
 524
 525         return(purged);
 526 }
 527
 528
 529 // Purge the use table of old entries.
 530 // Holy crap, this is WAY better.  We need to replace most linked lists with arrays.
 531 int PurgeUseTable(StrBuf *ErrMsg) {
 532         int purged = 0;
 533         int total = 0;
 534         struct cdbkeyval cdbut;
 535         struct UseTable ut;
 536         Array *purge_list = array_new(sizeof(int));
 537
 538         // Phase 1: traverse through the table, discovering old records...
 539
 540         syslog(LOG_DEBUG, "Purge use table: phase 1");
 541         cdb_rewind(CDB_USETABLE);
 542         while(cdbut = cdb_next_item(CDB_USETABLE), cdbut.val.ptr!=NULL) {               // always read through to the end
 543                 ++total;
 544                 if (cdbut.val.len > sizeof(struct UseTable))
 545                         memcpy(&ut, cdbut.val.ptr, sizeof(struct UseTable));
 546                 else {
 547                         memset(&ut, 0, sizeof(struct UseTable));
 548                         memcpy(&ut, cdbut.val.ptr, cdbut.val.len);
 549                 }
 550
 551                 if ( (time(NULL) - ut.timestamp) > USETABLE_RETAIN ) {
 552                         array_append(purge_list, &ut.hash);
 553                         ++purged;
 554                 }
 555         }
 556
 557         // Phase 2: delete the records
 558         syslog(LOG_DEBUG, "Purge use table: phase 2");
 559         int i;
 560         cdb_begin_transaction();
 561         for (i=0; i<purged; ++i) {
 562                 struct UseTable *u = (struct UseTable *)array_get_element_at(purge_list, i);
 563                 cdb_delete(CDB_USETABLE, &u->hash, sizeof(int));
 564         }
 565         cdb_end_transaction();
 566         array_free(purge_list);
 567
 568         syslog(LOG_DEBUG, "Purge use table: finished (purged %d of %d records)", purged, total);
 569         return(purged);
 570 }
 571
 572
 573 // Purge the EUID Index of old records.
 574 int PurgeEuidIndexTable(void) {
 575         int purged = 0;
 576         struct cdbkeyval cdbei;
 577         struct EPurgeList *el = NULL;
 578         struct EPurgeList *eptr;
 579         long msgnum;
 580         struct CtdlMessage *msg = NULL;
 581
 582         // Phase 1: traverse through the table, discovering old records...
 583         syslog(LOG_DEBUG, "Purge EUID index: phase 1");
 584         cdb_rewind(CDB_EUIDINDEX);
 585         while(cdbei = cdb_next_item(CDB_EUIDINDEX), cdbei.val.ptr!=NULL) {      // always read through to the end
 586
 587                 memcpy(&msgnum, cdbei.val.ptr, sizeof(long));
 588
 589                 msg = CtdlFetchMessage(msgnum, 0);
 590                 if (msg != NULL) {
 591                         CM_Free(msg);   // it still exists, so do nothing
 592                 }
 593                 else {
 594                         eptr = (struct EPurgeList *) malloc(sizeof(struct EPurgeList));
 595                         if (!eptr) abort();
 596                         if (eptr != NULL) {
 597                                 eptr->next = el;
 598                                 eptr->ep_keylen = cdbei.val.len - sizeof(long);
 599                                 eptr->ep_key = malloc(cdbei.val.len);
 600                                 if (!eptr->ep_key) abort();
 601                                 memcpy(eptr->ep_key, &cdbei.val.ptr[sizeof(long)], eptr->ep_keylen);
 602                                 el = eptr;
 603                         }
 604                         ++purged;
 605                 }
 606
 607
 608         }
 609
 610         // Phase 2: delete the records
 611         syslog(LOG_DEBUG, "Purge euid index: phase 2");
 612         cdb_begin_transaction();
 613         while (el != NULL) {
 614                 cdb_delete(CDB_EUIDINDEX, el->ep_key, el->ep_keylen);
 615                 free(el->ep_key);
 616                 eptr = el->next;
 617                 free(el);
 618                 el = eptr;
 619         }
 620         cdb_end_transaction();
 621
 622         syslog(LOG_DEBUG, "Purge euid index: finished (purged %d records)", purged);
 623         return(purged);
 624 }
 625
 626
 627 void purge_databases(void) {
 628         static time_t last_purge = 0;
 629         time_t now;
 630         struct tm tm;
 631         int users_purged, rooms_purged, visits_purged, usete_purged, euidindices_purged = 0;
 632
 633         // Do the auto-purge if the current hour equals the purge hour,
 634         // but not if the operation has already been performed in the
 635         // last twelve hours.  This is usually enough granularity.
 636         now = time(NULL);
 637         localtime_r(&now, &tm);
 638         if (((tm.tm_hour != CtdlGetConfigInt("c_purge_hour")) || ((now - last_purge) < 43200)) && (force_purge_now == 0)) {
 639                 return;
 640         }
 641
 642         syslog(LOG_INFO, "Auto-purger: starting.");
 643
 644         if (!server_shutting_down) {
 645                 users_purged = PurgeUsers();
 646                 syslog(LOG_NOTICE, "Purged %d users.", users_purged);
 647         }
 648
 649         if (!server_shutting_down) {
 650                 PurgeMessages();
 651                 syslog(LOG_NOTICE, "Expired %d messages.", messages_purged);
 652         }
 653
 654         if (!server_shutting_down) {
 655                 rooms_purged = PurgeRooms();
 656                 syslog(LOG_NOTICE, "Expired %d rooms.", rooms_purged);
 657         }
 658
 659         if (!server_shutting_down) {
 660                 visits_purged = PurgeVisits();
 661                 syslog(LOG_NOTICE, "Purged %d visits.", visits_purged);
 662         }
 663
 664         if (!server_shutting_down) {
 665                 StrBuf *ErrMsg;
 666                 ErrMsg = NewStrBuf();
 667                 usete_purged = PurgeUseTable(ErrMsg);
 668                 syslog(LOG_NOTICE, "Purged %d entries from the use table.", usete_purged);
 669                 FreeStrBuf(&ErrMsg);
 670         }
 671
 672         if (!server_shutting_down) {
 673                 euidindices_purged = PurgeEuidIndexTable();
 674                 syslog(LOG_NOTICE, "Purged %d entries from the EUID index.", euidindices_purged);
 675         }
 676
 677         if (users_purged + messages_purged + rooms_purged + visits_purged + usete_purged + euidindices_purged != 0) {
 678                 char msg[SIZ];
 679                 snprintf(msg, sizeof msg,
 680                         "Citadel Server has deleted %d users, %d messages, %d rooms, %d visit records, %d use table entries, "
 681                         "and %d EUID indices due to expire policy set on those objects.\n",
 682                         users_purged, messages_purged, rooms_purged, visits_purged, usete_purged, euidindices_purged
 683                 );
 684                 CtdlAideMessage(msg, "Expired Objects Report");
 685         }
 686
 687         //if (!server_shutting_down) {
 688         //      FIXME this is where we could do a non-interactive delete of zero-refcount messages
 689         //}
 690
 691         if ( (!server_shutting_down) && (CtdlGetConfigInt("c_shrink_db_files") != 0) ) {
 692                 cdb_compact();                                  // Shrink the DB files on disk
 693         }
 694
 695         if (!server_shutting_down) {
 696                 syslog(LOG_INFO, "Auto-purger: finished.");
 697                 last_purge = now;                               // So we don't do it again soon
 698                 force_purge_now = 0;
 699         }
 700         else {
 701                 syslog(LOG_INFO, "Auto-purger: STOPPED.");
 702         }
 703 }
 704
 705
 706 // Manually initiate a run of The Dreaded Auto-Purger (tm)
 707 void cmd_tdap(char *argbuf) {
 708         if (CtdlAccessCheck(ac_aide)) return;
 709         force_purge_now = 1;
 710         cprintf("%d Manually initiating a purger run now.\n", CIT_OK);
 711 }
 712
 713
 714 // Initialization function, called from modules_init.c
 715 char *ctdl_module_init_expire(void) {
 716         if (!threading) {
 717                 CtdlRegisterProtoHook(cmd_tdap, "TDAP", "Manually initiate auto-purger");
 718                 CtdlRegisterProtoHook(cmd_gpex, "GPEX", "Get expire policy");
 719                 CtdlRegisterProtoHook(cmd_spex, "SPEX", "Set expire policy");
 720                 CtdlRegisterSessionHook(purge_databases, EVT_TIMER, PRIO_CLEANUP + 20);
 721         }
 722
 723         // return our module name for the log
 724         return "expire";
 725 }