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