citadel/serv_expire.c

   1 /*
   2  * serv_expire.c
   3  *
   4  * This module handles the expiry of old messages and the purging of old users.
   5  *
   6  */
   7 /* $Id$ */
   8
   9
  10 /*
  11  * A brief technical discussion:
  12  *
  13  * Several of the purge operations found in this module operate in two
  14  * stages: the first stage generates a linked list of objects to be deleted,
  15  * then the second stage deletes all listed objects from the database.
  16  *
  17  * At first glance this may seem cumbersome and unnecessary.  The reason it is
  18  * implemented in this way is because GDBM (and perhaps some other backends we
  19  * may hook into in the future) explicitly do _not_ support the deletion of
  20  * records from a file while the file is being traversed.  The delete operation
  21  * will succeed, but the traversal is not guaranteed to visit every object if
  22  * this is done.  Therefore we utilize the two-stage purge.
  23  */
  24
  25
  26 #include <stdlib.h>
  27 #include <unistd.h>
  28 #include <stdio.h>
  29 #include <fcntl.h>
  30 #include <signal.h>
  31 #include <pwd.h>
  32 #include <errno.h>
  33 #include <sys/types.h>
  34 #include <sys/time.h>
  35 #include <sys/wait.h>
  36 #include <string.h>
  37 #include <limits.h>
  38 #include <pthread.h>
  39 #include "citadel.h"
  40 #include "server.h"
  41 #include <syslog.h>
  42 #include <time.h>
  43 #include "sysdep_decls.h"
  44 #include "citserver.h"
  45 #include "support.h"
  46 #include "config.h"
  47 #include "dynloader.h"
  48 #include "room_ops.h"
  49 #include "policy.h"
  50 #include "database.h"
  51 #include "msgbase.h"
  52 #include "user_ops.h"
  53 #include "control.h"
  54 #include "tools.h"
  55
  56
  57 struct oldvisit {
  58         char v_roomname[ROOMNAMELEN];
  59         long v_generation;
  60         long v_lastseen;
  61         unsigned int v_flags;
  62         };
  63
  64 struct PurgeList {
  65         struct PurgeList *next;
  66         char name[ROOMNAMELEN]; /* use the larger of username or roomname */
  67         };
  68
  69 struct VPurgeList {
  70         struct VPurgeList *next;
  71         long vp_roomnum;
  72         long vp_roomgen;
  73         long vp_usernum;
  74         };
  75
  76 struct ValidRoom {
  77         struct ValidRoom *next;
  78         long vr_roomnum;
  79         long vr_roomgen;
  80         };
  81
  82 struct ValidUser {
  83         struct ValidUser *next;
  84         long vu_usernum;
  85         };
  86
  87 struct PurgeList *UserPurgeList = NULL;
  88 struct PurgeList *RoomPurgeList = NULL;
  89 struct ValidRoom *ValidRoomList = NULL;
  90 struct ValidUser *ValidUserList = NULL;
  91 int messages_purged;
  92
  93 extern struct CitContext *ContextList;
  94
  95 #define MODULE_NAME     "Expire old messages, users, rooms"
  96 #define MODULE_AUTHOR   "Art Cancro"
  97 #define MODULE_EMAIL    "ajc@uncnsrd.mt-kisco.ny.us"
  98 #define MAJOR_VERSION   0
  99 #define MINOR_VERSION   1
 100
 101 static struct DLModule_Info info = {
 102         MODULE_NAME,
 103         MODULE_AUTHOR,
 104         MODULE_EMAIL,
 105         MAJOR_VERSION,
 106         MINOR_VERSION
 107         };
 108
 109 void DoPurgeMessages(struct quickroom *qrbuf) {
 110         struct ExpirePolicy epbuf;
 111         long delnum;
 112         time_t xtime, now;
 113         char msgid[64];
 114         int a;
 115
 116         messages_purged = 0;
 117         time(&now);
 118         GetExpirePolicy(&epbuf, qrbuf);
 119
 120         /*
 121         lprintf(9, "ExpirePolicy for <%s> is <%d> <%d>\n",
 122                 qrbuf->QRname, epbuf.expire_mode, epbuf.expire_value);
 123         */
 124
 125         /* If the room is set to never expire messages ... do nothing */
 126         if (epbuf.expire_mode == EXPIRE_NEXTLEVEL) return;
 127         if (epbuf.expire_mode == EXPIRE_MANUAL) return;
 128
 129         begin_critical_section(S_QUICKROOM);
 130         get_msglist(qrbuf);
 131
 132         /* Nothing to do if there aren't any messages */
 133         if (CC->num_msgs == 0) {
 134                 end_critical_section(S_QUICKROOM);
 135                 return;
 136                 }
 137
 138         /* If the room is set to expire by count, do that */
 139         if (epbuf.expire_mode == EXPIRE_NUMMSGS) {
 140                 while (CC->num_msgs > epbuf.expire_value) {
 141                         delnum = MessageFromList(0);
 142                         lprintf(5, "Expiring message %ld\n", delnum);
 143                         cdb_delete(CDB_MSGMAIN, &delnum, sizeof(long));
 144                         memcpy(&CC->msglist[0], &CC->msglist[1],
 145                                 (sizeof(long)*(CC->num_msgs - 1)));
 146                         CC->num_msgs = CC->num_msgs - 1;
 147                         ++messages_purged;
 148                         }
 149                 }
 150
 151         /* If the room is set to expire by age... */
 152         if (epbuf.expire_mode == EXPIRE_AGE) {
 153                 for (a=0; a<(CC->num_msgs); ++a) {
 154                         delnum = MessageFromList(a);
 155                         sprintf(msgid, "%ld", delnum);
 156                         xtime = output_message(msgid, MT_DATE, 0, 0);
 157
 158                         if ((xtime > 0L)
 159                            && (now - xtime > (time_t)(epbuf.expire_value * 86400L))) {
 160                                 cdb_delete(CDB_MSGMAIN, &delnum, sizeof(long));
 161                                 SetMessageInList(a, 0L);
 162                                 lprintf(5, "Expiring message %ld\n", delnum);
 163                                 }
 164                         }
 165                 }
 166         CC->num_msgs = sort_msglist(CC->msglist, CC->num_msgs);
 167         put_msglist(qrbuf);
 168         end_critical_section(S_QUICKROOM);
 169         }
 170
 171 void PurgeMessages(void) {
 172         lprintf(5, "PurgeMessages() called\n");
 173         ForEachRoom(DoPurgeMessages);
 174         }
 175
 176
 177 void DoPurgeRooms(struct quickroom *qrbuf) {
 178         time_t age, purge_secs;
 179         struct PurgeList *pptr;
 180
 181         /* Any of these attributes render a room non-purgable */
 182         if (qrbuf->QRflags & QR_PERMANENT) return;
 183         if (qrbuf->QRflags & QR_DIRECTORY) return;
 184         if (qrbuf->QRflags & QR_NETWORK) return;
 185         if (qrbuf->QRflags & QR_MAILBOX) return;
 186         if (is_noneditable(qrbuf)) return;
 187
 188         /* If we don't know the modification date, be safe and don't purge */
 189         if (qrbuf->QRmtime <= (time_t)0) return;
 190
 191         /* Otherwise, check the date of last modification */
 192         age = time(NULL) - (qrbuf->QRmtime);
 193         purge_secs = (time_t)config.c_roompurge * (time_t)86400;
 194         if (purge_secs <= (time_t)0) return;
 195         lprintf(9, "<%s> is <%ld> seconds old\n", qrbuf->QRname, age);
 196
 197         if (age > purge_secs) {
 198
 199                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 200                 pptr->next = RoomPurgeList;
 201                 strcpy(pptr->name, qrbuf->QRname);
 202                 RoomPurgeList = pptr;
 203
 204                 }
 205         }
 206
 207
 208 int PurgeRooms(void) {
 209         struct PurgeList *pptr;
 210         int num_rooms_purged = 0;
 211         struct quickroom qrbuf;
 212
 213         lprintf(5, "PurgeRooms() called\n");
 214         if (config.c_roompurge > 0) {
 215                 ForEachRoom(DoPurgeRooms);
 216                 }
 217
 218         while (RoomPurgeList != NULL) {
 219                 if (getroom(&qrbuf, RoomPurgeList->name) == 0) {
 220                         delete_room(&qrbuf);
 221                         }
 222                 pptr = RoomPurgeList->next;
 223                 free(RoomPurgeList);
 224                 RoomPurgeList = pptr;
 225                 ++num_rooms_purged;
 226                 }
 227
 228         lprintf(5, "Purged %d rooms.\n", num_rooms_purged);
 229         return(num_rooms_purged);
 230         }
 231
 232
 233 void do_user_purge(struct usersupp *us) {
 234         int purge;
 235         time_t now;
 236         time_t purge_time;
 237         struct PurgeList *pptr;
 238
 239         /* Set purge time; if the user overrides the system default, use it */
 240         if (us->USuserpurge > 0) {
 241                 purge_time = ((time_t)us->USuserpurge) * 86400L;
 242                 }
 243         else {
 244                 purge_time = ((time_t)config.c_userpurge) * 86400L;
 245                 }
 246
 247         /* The default rule is to not purge. */
 248         purge = 0;
 249
 250         /* If the user hasn't called in two months, his/her account
 251          * has expired, so purge the record.
 252          */
 253         now = time(NULL);
 254         if ((now - us->lastcall) > purge_time) purge = 1;
 255
 256         /* If the user set his/her password to 'deleteme', he/she
 257          * wishes to be deleted, so purge the record.
 258          */
 259         if (!strcasecmp(us->password, "deleteme")) purge = 1;
 260
 261         /* If the record is marked as permanent, don't purge it.
 262          */
 263         if (us->flags & US_PERM) purge = 0;
 264
 265         /* If the access level is 0, the record should already have been
 266          * deleted, but maybe the user was logged in at the time or something.
 267          * Delete the record now.
 268          */
 269         if (us->axlevel == 0) purge = 1;
 270
 271         /* 0 calls is impossible.  If there are 0 calls, it must
 272          * be a corrupted record, so purge it.
 273          */
 274         if (us->timescalled == 0) purge = 1;
 275
 276         if (purge == 1) {
 277                 pptr = (struct PurgeList *) malloc(sizeof(struct PurgeList));
 278                 pptr->next = UserPurgeList;
 279                 strcpy(pptr->name, us->fullname);
 280                 UserPurgeList = pptr;
 281                 }
 282
 283         }
 284
 285
 286
 287 int PurgeUsers(void) {
 288         struct PurgeList *pptr;
 289         int num_users_purged = 0;
 290
 291         lprintf(5, "PurgeUsers() called\n");
 292         if (config.c_userpurge > 0) {
 293                 ForEachUser(do_user_purge);
 294                 }
 295
 296         while (UserPurgeList != NULL) {
 297                 purge_user(UserPurgeList->name);
 298                 pptr = UserPurgeList->next;
 299                 free(UserPurgeList);
 300                 UserPurgeList = pptr;
 301                 ++num_users_purged;
 302                 }
 303
 304         lprintf(5, "Purged %d users.\n", num_users_purged);
 305         return(num_users_purged);
 306         }
 307
 308 void AddValidUser(struct usersupp *usbuf) {
 309         struct ValidUser *vuptr;
 310
 311         vuptr = (struct ValidUser *)malloc(sizeof(struct ValidUser));
 312         vuptr->next = ValidUserList;
 313         vuptr->vu_usernum = usbuf->usernum;
 314         ValidUserList = vuptr;
 315         }
 316
 317 void AddValidRoom(struct quickroom *qrbuf) {
 318         struct ValidRoom *vrptr;
 319
 320         vrptr = (struct ValidRoom *)malloc(sizeof(struct ValidRoom));
 321         vrptr->next = ValidRoomList;
 322         vrptr->vr_roomnum = qrbuf->QRnumber;
 323         vrptr->vr_roomgen = qrbuf->QRgen;
 324         ValidRoomList = vrptr;
 325         }
 326
 327
 328 /*
 329  * Purge visits
 330  *
 331  * This is a really cumbersome "garbage collection" function.  We have to
 332  * delete visits which refer to rooms and/or users which no longer exist.  In
 333  * order to prevent endless traversals of the room and user files, we first
 334  * build linked lists of rooms and users which _do_ exist on the system, then
 335  * traverse the visit file, checking each record against those two lists and
 336  * purging the ones that do not have a match on _both_ lists.  (Remember, if
 337  * either the room or user being referred to is no longer on the system, the
 338  * record is completely useless.)
 339  */
 340 int PurgeVisits(void) {
 341         struct cdbdata *cdbvisit;
 342         struct visit vbuf;
 343         struct VPurgeList *VisitPurgeList = NULL;
 344         struct VPurgeList *vptr;
 345         int purged = 0;
 346         char IndexBuf[32];
 347         int IndexLen;
 348         struct ValidRoom *vrptr;
 349         struct ValidUser *vuptr;
 350         int RoomIsValid, UserIsValid;
 351
 352         /* First, load up a table full of valid room/gen combinations */
 353         ForEachRoom(AddValidRoom);
 354
 355         /* Then load up a table full of valid user numbers */
 356         ForEachUser(AddValidUser);
 357
 358         /* Now traverse through the visits, purging irrelevant records... */
 359         cdb_rewind(CDB_VISIT);
 360         while(cdbvisit = cdb_next_item(CDB_VISIT), cdbvisit != NULL) {
 361                 memset(&vbuf, 0, sizeof(struct visit));
 362                 memcpy(&vbuf, cdbvisit->ptr,
 363                         ( (cdbvisit->len > sizeof(struct visit)) ?
 364                         sizeof(struct visit) : cdbvisit->len) );
 365                 cdb_free(cdbvisit);
 366
 367                 RoomIsValid = 0;
 368                 UserIsValid = 0;
 369
 370                 /* Check to see if the room exists */
 371                 for (vrptr=ValidRoomList; vrptr!=NULL; vrptr=vrptr->next) {
 372                         if ( (vrptr->vr_roomnum==vbuf.v_roomnum)
 373                              && (vrptr->vr_roomgen==vbuf.v_roomgen))
 374                                 RoomIsValid = 1;
 375                         }
 376
 377                 /* Check to see if the user exists */
 378                 for (vuptr=ValidUserList; vuptr!=NULL; vuptr=vuptr->next) {
 379                         if (vuptr->vu_usernum == vbuf.v_usernum)
 380                                 UserIsValid = 1;
 381                         }
 382
 383                 /* Put the record on the purge list if it's dead */
 384                 if ((RoomIsValid==0) || (UserIsValid==0)) {
 385                         vptr = (struct VPurgeList *)
 386                                 malloc(sizeof(struct VPurgeList));
 387                         vptr->next = VisitPurgeList;
 388                         vptr->vp_roomnum = vbuf.v_roomnum;
 389                         vptr->vp_roomgen = vbuf.v_roomgen;
 390                         vptr->vp_usernum = vbuf.v_usernum;
 391                         VisitPurgeList = vptr;
 392                         }
 393
 394                 }
 395
 396         /* Free the valid room/gen combination list */
 397         while (ValidRoomList != NULL) {
 398                 vrptr = ValidRoomList->next;
 399                 free(ValidRoomList);
 400                 ValidRoomList = vrptr;
 401                 }
 402
 403         /* Free the valid user list */
 404         while (ValidUserList != NULL) {
 405                 vuptr = ValidUserList->next;
 406                 free(ValidUserList);
 407                 ValidUserList = vuptr;
 408                 }
 409
 410         /* Now delete every visit on the purged list */
 411         while (VisitPurgeList != NULL) {
 412                 IndexLen = GenerateRelationshipIndex(IndexBuf,
 413                                 VisitPurgeList->vp_roomnum,
 414                                 VisitPurgeList->vp_roomgen,
 415                                 VisitPurgeList->vp_usernum);
 416                 cdb_delete(CDB_VISIT, IndexBuf, IndexLen);
 417                 vptr = VisitPurgeList->next;
 418                 free(VisitPurgeList);
 419                 VisitPurgeList = vptr;
 420                 ++purged;
 421                 }
 422
 423         return(purged);
 424         }
 425
 426
 427 void cmd_expi(char *argbuf) {
 428         char cmd[256];
 429         int retval;
 430
 431
 432         if ((!(CC->logged_in))&&(!(CC->internal_pgm))) {
 433                 cprintf("%d Not logged in.\n",ERROR+NOT_LOGGED_IN);
 434                 return;
 435                 }
 436
 437         if ((!is_room_aide()) && (!(CC->internal_pgm)) ) {
 438                 cprintf("%d Higher access required.\n",
 439                         ERROR+HIGHER_ACCESS_REQUIRED);
 440                 return;
 441                 }
 442
 443         extract(cmd, argbuf, 0);
 444         if (!strcasecmp(cmd, "users")) {
 445                 retval = PurgeUsers();
 446                 cprintf("%d Purged %d users.\n", OK, retval);
 447                 return;
 448                 }
 449         else if (!strcasecmp(cmd, "messages")) {
 450                 PurgeMessages();
 451                 cprintf("%d Expired %d messages.\n", OK, messages_purged);
 452                 return;
 453                 }
 454         else if (!strcasecmp(cmd, "rooms")) {
 455                 retval = PurgeRooms();
 456                 cprintf("%d Expired %d rooms.\n", OK, retval);
 457                 return;
 458                 }
 459         else if (!strcasecmp(cmd, "visits")) {
 460                 retval = PurgeVisits();
 461                 cprintf("%d Purged %d visits.\n", OK, retval);
 462                 }
 463         else if (!strcasecmp(cmd, "defrag")) {
 464                 defrag_databases();
 465                 cprintf("%d Defragmented the databases.\n", OK);
 466                 }
 467         else {
 468                 cprintf("%d Invalid command.\n", ERROR+ILLEGAL_VALUE);
 469                 return;
 470                 }
 471         }
 472
 473
 474
 475 struct DLModule_Info *Dynamic_Module_Init(void)
 476 {
 477    CtdlRegisterProtoHook(cmd_expi, "EXPI", "Expire old system objects");
 478    return &info;
 479 }