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 GDBM (and perhaps some other backends we
  18  * 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 <syslog.h>
  55 #include "sysdep_decls.h"
  56 #include "citserver.h"
  57 #include "support.h"
  58 #include "config.h"
  59 #include "dynloader.h"
  60 #include "room_ops.h"
  61 #include "policy.h"
  62 #include "database.h"
  63 #include "msgbase.h"
  64 #include "user_ops.h"
  65 #include "control.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 roomref {
  94         struct roomref *next;
  95         long msgnum;
  96 };
  97
  98
  99 struct PurgeList *UserPurgeList = NULL;
 100 struct PurgeList *RoomPurgeList = NULL;
 101 struct ValidRoom *ValidRoomList = NULL;
 102 struct ValidUser *ValidUserList = NULL;
 103 int messages_purged;
 104
 105 struct roomref *rr = NULL;
 106
 107 extern struct CitContext *ContextList;
 108
 109
 110 /*
 111  * First phase of message purge -- gather the locations of messages which
 112  * qualify for purging and write them to a temp file.
 113  */
 114 void GatherPurgeMessages(struct quickroom *qrbuf, void *data) {
 115         struct ExpirePolicy epbuf;
 116         long delnum;
 117         time_t xtime, now;
 118         struct CtdlMessage *msg;
 119         int a;
 120         struct cdbdata *cdbfr;
 121         long *msglist = NULL;
 122         int num_msgs = 0;
 123         FILE *purgelist;
 124
 125         purgelist = (FILE *)data;
 126         fprintf(purgelist, "r=%s\n", qrbuf->QRname);
 127
 128         time(&now);
 129         GetExpirePolicy(&epbuf, qrbuf);
 130
 131         /* If the room is set to never expire messages ... do nothing */
 132         if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
 133         if (epbuf.expire_mode == EXPIRE_MANUAL) return;
 134
 135         cdbfr = cdb_fetch(CDB_MSGLISTS, &qrbuf->QRnumber, sizeof(long));
 136
 137         if (cdbfr != NULL) {
 138                 msglist = mallok(cdbfr->len);
 139                 memcpy(msglist, cdbfr->ptr, cdbfr->len);
 140                 num_msgs = cdbfr->len / sizeof(long);
 141                 cdb_free(cdbfr);
 142         }
 143
 144         /* Nothing to do if there aren't any messages */
 145         if (num_msgs == 0) {
 146                 if (msglist != NULL) phree(msglist);
 147                 return;
 148         }
 149
 150         /* If the room is set to expire by count, do that */
 151         if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
 152                 if (num_msgs > epbuf.expire_value) {
 153                         for (a=0; a<(num_msgs - epbuf.expire_value); ++a) {
 154                                 fprintf(purgelist, "m=%ld\n", msglist[a]);
 155                                 ++messages_purged;
 156                         }
 157                 }
 158         }
 159
 160         /* If the room is set to expire by age... */
 161         if (epbuf.expire_mode == EXPIRE_AGE) {
 162                 for (a=0; a<num_msgs; ++a) {
 163                         delnum = msglist[a];
 164
 165                         msg = CtdlFetchMessage(delnum);
 166                         if (msg != NULL) {
 167                                 xtime = atol(msg->cm_fields['T']);
 168                                 CtdlFreeMessage(msg);
 169                         } else {
 170                                 xtime = 0L;
 171                         }
 172
 173                         if ((xtime > 0L)
 174                            && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
 175                                 fprintf(purgelist, "m=%ld\n", delnum);
 176                                 ++messages_purged;
 177                         }
 178                 }
 179         }
 180
 181         if (msglist != NULL) phree(msglist);
 182 }
 183
 184
 185 /*
 186  * Second phase of message purge -- read list of msgs from temp file and
 187  * delete them.
 188  */
 189 void DoPurgeMessages(FILE *purgelist) {
 190         char roomname[ROOMNAMELEN];
 191         long msgnum;
 192         char buf[SIZ];
 193
 194         rewind(purgelist);
 195         strcpy(roomname, "nonexistent room ___ ___");
 196         while (fgets(buf, sizeof buf, purgelist) != NULL) {
 197                 buf[strlen(buf)-1]=0;
 198                 if (!strncasecmp(buf, "r=", 2)) {
 199                         strcpy(roomname, &buf[2]);
 200                 }
 201                 if (!strncasecmp(buf, "m=", 2)) {
 202                         msgnum = atol(&buf[2]);
 203                         if (msgnum > 0L) {
 204                                 CtdlDeleteMessages(roomname, msgnum, "");
 205                         }
 206                 }
 207         }
 208 }
 209
 210
 211 void PurgeMessages(void) {
 212         FILE *purgelist;
 213
 214         lprintf(5, "PurgeMessages() called\n");
 215         messages_purged = 0;
 216
 217         purgelist = tmpfile();
 218         if (purgelist == NULL) {
 219                 lprintf(3, "Can't create purgelist temp file: %s\n",
 220                         strerror(errno));
 221                 return;
 222         }
 223
 224         ForEachRoom(GatherPurgeMessages, (void *)purgelist );
 225         DoPurgeMessages(purgelist);
 226         fclose(purgelist);
 227 }
 228
 229
 230 void AddValidUser(struct usersupp *usbuf, void *data) {
 231         struct ValidUser *vuptr;
 232
 233         vuptr = (struct ValidUser *)mallok(sizeof(struct ValidUser));
 234         vuptr->next = ValidUserList;
 235         vuptr->vu_usernum = usbuf->usernum;
 236         ValidUserList = vuptr;
 237 }
 238
 239 void AddValidRoom(struct quickroom *qrbuf, void *data) {
 240         struct ValidRoom *vrptr;
 241
 242         vrptr = (struct ValidRoom *)mallok(sizeof(struct ValidRoom));
 243         vrptr->next = ValidRoomList;
 244         vrptr->vr_roomnum = qrbuf->QRnumber;
 245         vrptr->vr_roomgen = qrbuf->QRgen;
 246         ValidRoomList = vrptr;
 247 }
 248
 249 void DoPurgeRooms(struct quickroom *qrbuf, void *data) {
 250         time_t age, purge_secs;
 251         struct PurgeList *pptr;
 252         struct ValidUser *vuptr;
 253         int do_purge = 0;
 254
 255         /* For mailbox rooms, there's only one purging rule: if the user who
 256          * owns the room still exists, we keep the room; otherwise, we purge
 257          * it.  Bypass any other rules.
 258          */
 259         if (qrbuf->QRflags & QR_MAILBOX) {
 260                 /* if user not found, do_purge will be 1 */
 261                 do_purge = 1;
 262                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 263                         if (vuptr->vu_usernum == atol(qrbuf->QRname)) {
 264                                 do_purge = 0;
 265                         }
 266                 }
 267         }
 268         else {
 269                 /* Any of these attributes render a room non-purgable */
 270                 if (qrbuf->QRflags & QR_PERMANENT) return;
 271                 if (qrbuf->QRflags & QR_DIRECTORY) return;
 272                 if (qrbuf->QRflags & QR_NETWORK) return;
 273                 if (!strcasecmp(qrbuf->QRname, SYSCONFIGROOM)) return;
 274                 if (is_noneditable(qrbuf)) return;
 275
 276                 /* If we don't know the modification date, be safe and don't purge */
 277                 if (qrbuf->QRmtime <= (time_t)0) return;
 278
 279                 /* If no room purge time is set, be safe and don't purge */
 280                 if (config.c_roompurge < 0) return;
 281
 282                 /* Otherwise, check the date of last modification */
 283                 age = time(NULL) - (qrbuf->QRmtime);
 284                 purge_secs = (time_t)config.c_roompurge * (time_t)86400;
 285                 if (purge_secs <= (time_t)0) return;
 286                 lprintf(9, "<%s> is <%ld> seconds old\n", qrbuf->QRname, age);
 287                 if (age > purge_secs) do_purge = 1;
 288         } /* !QR_MAILBOX */
 289
 290         if (do_purge) {
 291                 pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
 292                 pptr->next = RoomPurgeList;
 293                 strcpy(pptr->name, qrbuf->QRname);
 294                 RoomPurgeList = pptr;
 295         }
 296
 297 }
 298
 299
 300
 301 int PurgeRooms(void) {
 302         struct PurgeList *pptr;
 303         int num_rooms_purged = 0;
 304         struct quickroom qrbuf;
 305         struct ValidUser *vuptr;
 306         char *transcript = NULL;
 307
 308         lprintf(5, "PurgeRooms() called\n");
 309
 310
 311         /* Load up a table full of valid user numbers so we can delete
 312          * user-owned rooms for users who no longer exist */
 313         ForEachUser(AddValidUser, NULL);
 314
 315         /* Then cycle through the room file */
 316         ForEachRoom(DoPurgeRooms, NULL);
 317
 318         /* Free the valid user list */
 319         while (ValidUserList != NULL) {
 320                 vuptr = ValidUserList->next;
 321                 phree(ValidUserList);
 322                 ValidUserList = vuptr;
 323         }
 324
 325
 326         transcript = mallok(SIZ);
 327         strcpy(transcript, "The following rooms have been auto-purged:\n");
 328
 329         while (RoomPurgeList != NULL) {
 330                 if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
 331                         transcript=reallok(transcript, strlen(transcript)+SIZ);
 332                         sprintf(&transcript[strlen(transcript)], " %s\n",
 333                                 qrbuf.QRname);
 334                         delete_room(&qrbuf);
 335                 }
 336                 pptr = RoomPurgeList->next;
 337                 phree(RoomPurgeList);
 338                 RoomPurgeList = pptr;
 339                 ++num_rooms_purged;
 340         }
 341
 342         if (num_rooms_purged > 0) aide_message(transcript);
 343         phree(transcript);
 344
 345         lprintf(5, "Purged %d rooms.\n", num_rooms_purged);
 346         return(num_rooms_purged);
 347 }
 348
 349
 350 void do_user_purge(struct usersupp *us, void *data) {
 351         int purge;
 352         time_t now;
 353         time_t purge_time;
 354         struct PurgeList *pptr;
 355
 356         /* stupid recovery routine to re-create missing mailboxen.
 357          * don't enable this.
 358         struct quickroom qrbuf;
 359         char mailboxname[ROOMNAMELEN];
 360         MailboxName(mailboxname, us, MAILROOM);
 361         create_room(mailboxname, 4, "", 0, 1);
 362         if (getroom(&qrbuf, mailboxname) != 0) return;
 363         lprintf(9, "Got %s\n", qrbuf.QRname);
 364          */
 365
 366
 367         /* Set purge time; if the user overrides the system default, use it */
 368         if (us->USuserpurge > 0) {
 369                 purge_time = ((time_t)us->USuserpurge) * 86400L;
 370         }
 371         else {
 372                 purge_time = ((time_t)config.c_userpurge) * 86400L;
 373         }
 374
 375         /* The default rule is to not purge. */
 376         purge = 0;
 377
 378         /* If the user hasn't called in two months, his/her account
 379          * has expired, so purge the record.
 380          */
 381         now = time(NULL);
 382         if ((now - us->lastcall) > purge_time) purge = 1;
 383
 384         /* If the user set his/her password to 'deleteme', he/she
 385          * wishes to be deleted, so purge the record.
 386          */
 387         if (!strcasecmp(us->password, "deleteme")) purge = 1;
 388
 389         /* If the record is marked as permanent, don't purge it.
 390          */
 391         if (us->flags & US_PERM) purge = 0;
 392
 393         /* If the access level is 0, the record should already have been
 394          * deleted, but maybe the user was logged in at the time or something.
 395          * Delete the record now.
 396          */
 397         if (us->axlevel == 0) purge = 1;
 398
 399         /* 0 calls is impossible.  If there are 0 calls, it must
 400          * be a corrupted record, so purge it.
 401          */
 402         if (us->timescalled == 0) purge = 1;
 403
 404         if (purge == 1) {
 405                 pptr = (struct PurgeList *) mallok(sizeof(struct PurgeList));
 406                 pptr->next = UserPurgeList;
 407                 strcpy(pptr->name, us->fullname);
 408                 UserPurgeList = pptr;
 409         }
 410
 411 }
 412
 413
 414
 415 int PurgeUsers(void) {
 416         struct PurgeList *pptr;
 417         int num_users_purged = 0;
 418         char *transcript = NULL;
 419
 420         lprintf(5, "PurgeUsers() called\n");
 421         if (config.c_userpurge > 0) {
 422                 ForEachUser(do_user_purge, NULL);
 423         }
 424
 425         transcript = mallok(SIZ);
 426         strcpy(transcript, "The following users have been auto-purged:\n");
 427
 428         while (UserPurgeList != NULL) {
 429                 transcript=reallok(transcript, strlen(transcript)+SIZ);
 430                 sprintf(&transcript[strlen(transcript)], " %s\n",
 431                         UserPurgeList->name);
 432                 purge_user(UserPurgeList->name);
 433                 pptr = UserPurgeList->next;
 434                 phree(UserPurgeList);
 435                 UserPurgeList = pptr;
 436                 ++num_users_purged;
 437         }
 438
 439         if (num_users_purged > 0) aide_message(transcript);
 440         phree(transcript);
 441
 442         lprintf(5, "Purged %d users.\n", num_users_purged);
 443         return(num_users_purged);
 444 }
 445
 446
 447 /*
 448  * Purge visits
 449  *
 450  * This is a really cumbersome "garbage collection" function.  We have to
 451  * delete visits which refer to rooms and/or users which no longer exist.  In
 452  * order to prevent endless traversals of the room and user files, we first
 453  * build linked lists of rooms and users which _do_ exist on the system, then
 454  * traverse the visit file, checking each record against those two lists and
 455  * purging the ones that do not have a match on _both_ lists.  (Remember, if
 456  * either the room or user being referred to is no longer on the system, the
 457  * record is completely useless.)
 458  */
 459 int PurgeVisits(void) {
 460         struct cdbdata *cdbvisit;
 461         struct visit vbuf;
 462         struct VPurgeList *VisitPurgeList = NULL;
 463         struct VPurgeList *vptr;
 464         int purged = 0;
 465         char IndexBuf[32];
 466         int IndexLen;
 467         struct ValidRoom *vrptr;
 468         struct ValidUser *vuptr;
 469         int RoomIsValid, UserIsValid;
 470
 471         /* First, load up a table full of valid room/gen combinations */
 472         ForEachRoom(AddValidRoom, NULL);
 473
 474         /* Then load up a table full of valid user numbers */
 475         ForEachUser(AddValidUser, NULL);
 476
 477         /* Now traverse through the visits, purging irrelevant records... */
 478         cdb_rewind(CDB_VISIT);
 479         while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
 480                 memset(&vbuf, 0, sizeof(struct visit));
 481                 memcpy(&vbuf, cdbvisit->ptr,
 482                         ( (cdbvisit->len > sizeof(struct visit)) ?
 483                         sizeof(struct visit) : cdbvisit->len) );
 484                 cdb_free(cdbvisit);
 485
 486                 RoomIsValid = 0;
 487                 UserIsValid = 0;
 488
 489                 /* Check to see if the room exists */
 490                 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
 491                         if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
 492                              && (vrptr->vr_roomgen==vbuf.v_roomgen))
 493                                 RoomIsValid = 1;
 494                 }
 495
 496                 /* Check to see if the user exists */
 497                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 498                         if (vuptr->vu_usernum == vbuf.v_usernum)
 499                                 UserIsValid = 1;
 500                 }
 501
 502                 /* Put the record on the purge list if it's dead */
 503                 if ((RoomIsValid==0) || (UserIsValid==0)) {
 504                         vptr = (struct VPurgeList *)
 505                                 mallok(sizeof(struct VPurgeList));
 506                         vptr->next = VisitPurgeList;
 507                         vptr->vp_roomnum = vbuf.v_roomnum;
 508                         vptr->vp_roomgen = vbuf.v_roomgen;
 509                         vptr->vp_usernum = vbuf.v_usernum;
 510                         VisitPurgeList = vptr;
 511                 }
 512
 513         }
 514
 515         /* Free the valid room/gen combination list */
 516         while (ValidRoomList != NULL) {
 517                 vrptr = ValidRoomList->next;
 518                 phree(ValidRoomList);
 519                 ValidRoomList = vrptr;
 520         }
 521
 522         /* Free the valid user list */
 523         while (ValidUserList != NULL) {
 524                 vuptr = ValidUserList->next;
 525                 phree(ValidUserList);
 526                 ValidUserList = vuptr;
 527         }
 528
 529         /* Now delete every visit on the purged list */
 530         while (VisitPurgeList != NULL) {
 531                 IndexLen = GenerateRelationshipIndex(IndexBuf,
 532                                 VisitPurgeList->vp_roomnum,
 533                                 VisitPurgeList->vp_roomgen,
 534                                 VisitPurgeList->vp_usernum);
 535                 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
 536                 vptr = VisitPurgeList->next;
 537                 phree(VisitPurgeList);
 538                 VisitPurgeList = vptr;
 539                 ++purged;
 540         }
 541
 542         return(purged);
 543 }
 544
 545
 546 void cmd_expi(char *argbuf) {
 547         char cmd[SIZ];
 548         int retval;
 549
 550         if (CtdlAccessCheck(ac_aide)) return;
 551
 552         extract(cmd, argbuf, 0);
 553         if (!strcasecmp(cmd, "users")) {
 554                 retval = PurgeUsers();
 555                 cprintf("%d Purged %d users.\n", OK, retval);
 556                 return;
 557         }
 558         else if (!strcasecmp(cmd, "messages")) {
 559                 PurgeMessages();
 560                 cprintf("%d Expired %d messages.\n", OK, messages_purged);
 561                 return;
 562         }
 563         else if (!strcasecmp(cmd, "rooms")) {
 564                 retval = PurgeRooms();
 565                 cprintf("%d Expired %d rooms.\n", OK, retval);
 566                 return;
 567         }
 568         else if (!strcasecmp(cmd, "visits")) {
 569                 retval = PurgeVisits();
 570                 cprintf("%d Purged %d visits.\n", OK, retval);
 571         }
 572         else if (!strcasecmp(cmd, "defrag")) {
 573                 defrag_databases();
 574                 cprintf("%d Defragmented the databases.\n", OK);
 575         }
 576         else {
 577                 cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
 578                 return;
 579         }
 580 }
 581
 582 /*****************************************************************************/
 583
 584
 585 void do_fsck_msg(long msgnum, void *userdata) {
 586         struct roomref *ptr;
 587
 588         ptr = (struct roomref *)mallok(sizeof(struct roomref));
 589         ptr->next = rr;
 590         ptr->msgnum = msgnum;
 591         rr = ptr;
 592 }
 593
 594 void do_fsck_room(struct quickroom *qrbuf, void *data)
 595 {
 596         getroom(&CC->quickroom, qrbuf->QRname);
 597         CtdlForEachMessage(MSGS_ALL, 0L, (-127), NULL, NULL,
 598                 do_fsck_msg, NULL);
 599 }
 600
 601 /*
 602  * Check message reference counts
 603  */
 604 void cmd_fsck(char *argbuf) {
 605         long msgnum;
 606         struct cdbdata *cdbmsg;
 607         struct SuppMsgInfo smi;
 608         struct roomref *ptr;
 609         int realcount;
 610
 611         if (CtdlAccessCheck(ac_aide)) return;
 612
 613         /* Lame way of checking whether anyone else is doing this now */
 614         if (rr != NULL) {
 615                 cprintf("%d Another FSCK is already running.\n", ERROR);
 616                 return;
 617         }
 618
 619         cprintf("%d Checking message reference counts\n", LISTING_FOLLOWS);
 620
 621         cprintf("\nThis could take a while.  Please be patient!\n\n");
 622         cprintf("Gathering pointers...\n");
 623         ForEachRoom(do_fsck_room, NULL);
 624
 625         get_control();
 626         cprintf("Checking message base...\n");
 627         for (msgnum = 0L; msgnum <= CitControl.MMhighest; ++msgnum) {
 628
 629                 cdbmsg = cdb_fetch(CDB_MSGMAIN, &msgnum, sizeof(long));
 630                 if (cdbmsg != NULL) {
 631                         cdb_free(cdbmsg);
 632                         cprintf("Message %7ld    ", msgnum);
 633
 634                         GetSuppMsgInfo(&smi, msgnum);
 635                         cprintf("refcount=%-2d   ", smi.smi_refcount);
 636
 637                         realcount = 0;
 638                         for (ptr = rr; ptr != NULL; ptr = ptr->next) {
 639                                 if (ptr->msgnum == msgnum) ++realcount;
 640                         }
 641                         cprintf("realcount=%-2d\n", realcount);
 642
 643                         if ( (smi.smi_refcount != realcount)
 644                            || (realcount == 0) ) {
 645                                 smi.smi_refcount = realcount;
 646                                 PutSuppMsgInfo(&smi);
 647                                 AdjRefCount(msgnum, 0); /* deletes if needed */
 648                         }
 649
 650                 }
 651
 652         }
 653
 654         cprintf("Freeing memory...\n");
 655         while (rr != NULL) {
 656                 ptr = rr->next;
 657                 phree(rr);
 658                 rr = ptr;
 659         }
 660
 661         cprintf("Done!\n");
 662         cprintf("000\n");
 663
 664 }
 665
 666
 667
 668
 669 /*****************************************************************************/
 670
 671 char *Dynamic_Module_Init(void)
 672 {
 673         CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
 674         CtdlRegisterProtoHook(cmd_fsck, "FSCK", "Check message ref counts");
 675         return "$Id$";
 676 }