citadel/database.c

   1 /*
   2  * This is a data store backend for the Citadel server which uses Berkeley DB.
   3  *
   4  * Copyright (c) 1987-2017 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or
   7  * modify it under the terms of the GNU General Public License version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  */
  15
  16 /*****************************************************************************
  17        Tunable configuration parameters for the Berkeley DB back end
  18  *****************************************************************************/
  19
  20 /* Citadel will checkpoint the db at the end of every session, but only if
  21  * the specified number of kilobytes has been written, or if the specified
  22  * number of minutes has passed, since the last checkpoint.
  23  */
  24 #define MAX_CHECKPOINT_KBYTES   256
  25 #define MAX_CHECKPOINT_MINUTES  15
  26
  27 /*****************************************************************************/
  28
  29 #include "sysdep.h"
  30 #include <stdio.h>
  31 #include <dirent.h>
  32 #include <zlib.h>
  33
  34 #ifdef HAVE_DB_H
  35 #include <db.h>
  36 #elif defined(HAVE_DB4_DB_H)
  37 #include <db5/db.h>
  38 #else
  39 #error Neither <db.h> nor <db5/db.h> was found by configure. Install db5-devel.
  40 #endif
  41
  42 #if DB_VERSION_MAJOR < 5
  43 #error Citadel requires Berkeley DB v5.0 or newer.  Please upgrade.
  44 #endif
  45
  46 #include <libcitadel.h>
  47
  48 #include "ctdl_module.h"
  49 #include "control.h"
  50 #include "citserver.h"
  51 #include "config.h"
  52 #pragma GCC diagnostic ignored "-Wcast-qual"
  53
  54 static DB *dbp[MAXCDB];         /* One DB handle for each Citadel database */
  55 static DB_ENV *dbenv;           /* The DB environment (global) */
  56
  57
  58 void cdb_abort(void) {
  59         syslog(LOG_DEBUG,
  60                 "citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
  61                 getuid(),
  62                 getgid(),
  63                 geteuid(),
  64                 getegid()
  65         );
  66         cit_backtrace();
  67         exit(CTDLEXIT_DB);
  68 }
  69
  70
  71 /* Verbose logging callback */
  72 void cdb_verbose_log(const DB_ENV *dbenv, const char *msg)
  73 {
  74         if (!IsEmptyStr(msg)) {
  75                 syslog(LOG_DEBUG, "DB: %s", msg);
  76                 cit_backtrace();
  77         }
  78 }
  79
  80
  81 /* Verbose logging callback */
  82 void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg)
  83 {
  84         int *FOO = NULL;
  85         syslog(LOG_ALERT, "DB: %s", msg);
  86         cit_backtrace();
  87         *FOO = 1;
  88 }
  89
  90
  91 /* just a little helper function */
  92 static void txabort(DB_TXN * tid)
  93 {
  94         int ret;
  95
  96         ret = tid->abort(tid);
  97
  98         if (ret) {
  99                 syslog(LOG_EMERG, "bdb(): txn_abort: %s", db_strerror(ret));
 100                 cdb_abort();
 101         }
 102 }
 103
 104 /* this one is even more helpful than the last. */
 105 static void txcommit(DB_TXN * tid)
 106 {
 107         int ret;
 108
 109         ret = tid->commit(tid, 0);
 110
 111         if (ret) {
 112                 syslog(LOG_EMERG, "bdb(): txn_commit: %s", db_strerror(ret));
 113                 cdb_abort();
 114         }
 115 }
 116
 117 /* are you sensing a pattern yet? */
 118 static void txbegin(DB_TXN ** tid)
 119 {
 120         int ret;
 121
 122         ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
 123
 124         if (ret) {
 125                 syslog(LOG_EMERG, "bdb(): txn_begin: %s", db_strerror(ret));
 126                 cdb_abort();
 127         }
 128 }
 129
 130 static void dbpanic(DB_ENV * env, int errval)
 131 {
 132         syslog(LOG_EMERG, "bdb(): PANIC: %s", db_strerror(errval));
 133         cit_backtrace();
 134 }
 135
 136 static void cclose(DBC * cursor)
 137 {
 138         int ret;
 139
 140         if ((ret = cursor->c_close(cursor))) {
 141                 syslog(LOG_EMERG, "bdb(): c_close: %s", db_strerror(ret));
 142                 cdb_abort();
 143         }
 144 }
 145
 146 static void bailIfCursor(DBC ** cursors, const char *msg)
 147 {
 148         int i;
 149
 150         for (i = 0; i < MAXCDB; i++)
 151                 if (cursors[i] != NULL) {
 152                         syslog(LOG_EMERG, "bdb(): cursor still in progress on cdb %02x: %s", i, msg);
 153                         cdb_abort();
 154                 }
 155 }
 156
 157
 158 void cdb_check_handles(void)
 159 {
 160         bailIfCursor(TSD->cursors, "in check_handles");
 161
 162         if (TSD->tid != NULL) {
 163                 syslog(LOG_EMERG, "bdb(): transaction still in progress!");
 164                 cdb_abort();
 165         }
 166 }
 167
 168
 169 /*
 170  * Cull the database logs by removing log files that are no longer needed.
 171  * Note: this code will be removed once we are confident that Berkeley DB can do this on its own.
 172  */
 173 void cdb_cull_logs(void)
 174 {
 175         u_int32_t flags;
 176         int ret;
 177         char **file, **list;
 178         char errmsg[SIZ];
 179
 180         flags = DB_ARCH_ABS;
 181
 182         /* Get the list of names. */
 183         if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
 184                 syslog(LOG_ERR, "cdb_cull_logs: %s", db_strerror(ret));
 185                 return;
 186         }
 187
 188         /* Print the list of names. */
 189         if (list != NULL) {
 190                 for (file = list; *file != NULL; ++file) {
 191                         syslog(LOG_DEBUG, "Deleting log: %s", *file);
 192                         ret = unlink(*file);
 193                         if (ret != 0) {
 194                                 snprintf(errmsg, sizeof(errmsg),
 195                                          " ** ERROR **\n \n \n "
 196                                          "Citadel was unable to delete the "
 197                                          "database log file '%s' because of the "
 198                                          "following error:\n \n %s\n \n"
 199                                          " This log file is no longer in use "
 200                                          "and may be safely deleted.\n",
 201                                          *file, strerror(errno));
 202                                 CtdlAideMessage(errmsg, "Database Warning Message");
 203                         }
 204                 }
 205                 free(list);
 206         }
 207 }
 208
 209
 210 /*
 211  * Request a checkpoint of the database.  Called once per minute by the thread manager.
 212  */
 213 void cdb_checkpoint(void)
 214 {
 215         int ret;
 216
 217         syslog(LOG_DEBUG, "-- db checkpoint --");
 218         ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 219
 220         if (ret != 0) {
 221                 syslog(LOG_EMERG, "cdb_checkpoint: txn_checkpoint: %s", db_strerror(ret));
 222                 cdb_abort();
 223         }
 224
 225         /* After a successful checkpoint, we can cull the unused logs */
 226         if (CtdlGetConfigInt("c_auto_cull")) {
 227 #ifdef DB_LOG_AUTO_REMOVE
 228                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);      // This version of Berkeley DB can cull the logs on its own!
 229 #else
 230                 cdb_cull_logs();                                                // Citadel knows how to do it too.
 231 #endif
 232         }
 233 #ifdef DB_LOG_AUTO_REMOVE
 234         else {
 235                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
 236         }
 237 #endif
 238 }
 239
 240
 241
 242 /*
 243  * Open the various databases we'll be using.  Any database which
 244  * does not exist should be created.  Note that we don't need a
 245  * critical section here, because there aren't any active threads
 246  * manipulating the database yet.
 247  */
 248 void open_databases(void)
 249 {
 250         int ret;
 251         int i;
 252         char dbfilename[32];
 253         u_int32_t flags = 0;
 254         int dbversion_major, dbversion_minor, dbversion_patch;
 255
 256         syslog(LOG_DEBUG, "bdb(): open_databases() starting");
 257         syslog(LOG_DEBUG, "Compiled db: %s", DB_VERSION_STRING);
 258         syslog(LOG_INFO, "  Linked db: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
 259         syslog(LOG_INFO, "Linked zlib: %s", zlibVersion());
 260
 261         /*
 262          * Silently try to create the database subdirectory.  If it's
 263          * already there, no problem.
 264          */
 265         if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)){
 266                 syslog(LOG_EMERG,
 267                               "unable to create database directory [%s]: %s",
 268                               ctdl_data_dir, strerror(errno));
 269         }
 270         if (chmod(ctdl_data_dir, 0700) != 0){
 271                 syslog(LOG_EMERG,
 272                               "unable to set database directory accessrights [%s]: %s",
 273                               ctdl_data_dir, strerror(errno));
 274         }
 275         if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0){
 276                 syslog(LOG_EMERG,
 277                               "unable to set the owner for [%s]: %s",
 278                               ctdl_data_dir, strerror(errno));
 279         }
 280         syslog(LOG_DEBUG, "bdb(): Setting up DB environment\n");
 281         /* db_env_set_func_yield((int (*)(u_long,  u_long))sched_yield); */
 282         ret = db_env_create(&dbenv, 0);
 283         if (ret) {
 284                 syslog(LOG_EMERG, "bdb(): db_env_create: %s", db_strerror(ret));
 285                 syslog(LOG_EMERG, "exit code %d", ret);
 286                 exit(CTDLEXIT_DB);
 287         }
 288         dbenv->set_errpfx(dbenv, "citserver");
 289         dbenv->set_paniccall(dbenv, dbpanic);
 290         dbenv->set_errcall(dbenv, cdb_verbose_err);
 291         dbenv->set_errpfx(dbenv, "ctdl");
 292         dbenv->set_msgcall(dbenv, cdb_verbose_log);
 293         dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
 294         dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
 295
 296         /*
 297          * We want to specify the shared memory buffer pool cachesize,
 298          * but everything else is the default.
 299          */
 300         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
 301         if (ret) {
 302                 syslog(LOG_EMERG, "bdb(): set_cachesize: %s", db_strerror(ret));
 303                 dbenv->close(dbenv, 0);
 304                 syslog(LOG_EMERG, "exit code %d", ret);
 305                 exit(CTDLEXIT_DB);
 306         }
 307
 308         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
 309                 syslog(LOG_EMERG, "bdb(): set_lk_detect: %s", db_strerror(ret));
 310                 dbenv->close(dbenv, 0);
 311                 syslog(LOG_EMERG, "exit code %d", ret);
 312                 exit(CTDLEXIT_DB);
 313         }
 314
 315         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_RECOVER;
 316         syslog(LOG_DEBUG, "dbenv->open(dbenv, %s, %d, 0)", ctdl_data_dir, flags);
 317         ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 318         if (ret == DB_RUNRECOVERY) {
 319                 syslog(LOG_ALERT, "dbenv->open: %s", db_strerror(ret));
 320                 syslog(LOG_ALERT, "Attempting recovery...\n");
 321                 flags |= DB_RECOVER;
 322                 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 323         }
 324         if (ret == DB_RUNRECOVERY) {
 325                 syslog(LOG_ALERT, "dbenv->open: %s", db_strerror(ret));
 326                 syslog(LOG_ALERT, "Attempting catastrophic recovery...");
 327                 flags &= ~DB_RECOVER;
 328                 flags |= DB_RECOVER_FATAL;
 329                 ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);
 330         }
 331         if (ret) {
 332                 syslog(LOG_EMERG, "dbenv->open: %s", db_strerror(ret));
 333                 dbenv->close(dbenv, 0);
 334                 syslog(LOG_EMERG, "exit code %d", ret);
 335                 exit(CTDLEXIT_DB);
 336         }
 337
 338         syslog(LOG_INFO, "Starting up DB");
 339
 340         for (i = 0; i < MAXCDB; ++i) {
 341
 342                 /* Create a database handle */
 343                 ret = db_create(&dbp[i], dbenv, 0);
 344                 if (ret) {
 345                         syslog(LOG_EMERG, "db_create: %s", db_strerror(ret));
 346                         syslog(LOG_EMERG, "exit code %d", ret);
 347                         exit(CTDLEXIT_DB);
 348                 }
 349
 350
 351                 /* Arbitrary names for our tables -- we reference them by
 352                  * number, so we don't have string names for them.
 353                  */
 354                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);
 355
 356                 ret = dbp[i]->open(dbp[i],
 357                                    NULL,
 358                                    dbfilename,
 359                                    NULL,
 360                                    DB_BTREE,
 361                                    DB_CREATE | DB_AUTO_COMMIT | DB_THREAD,
 362                                    0600
 363                 );
 364                 if (ret) {
 365                         syslog(LOG_EMERG, "db_open[%02x]: %s", i, db_strerror(ret));
 366                         if (ret == ENOMEM) {
 367                                 syslog(LOG_EMERG, "You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information.");
 368                         }
 369                         syslog(LOG_EMERG, "exit code %d", ret);
 370                         exit(CTDLEXIT_DB);
 371                 }
 372         }
 373
 374 }
 375
 376
 377 /* Make sure we own all the files, because in a few milliseconds
 378  * we're going to drop root privs.
 379  */
 380 void cdb_chmod_data(void) {
 381         DIR *dp;
 382         struct dirent *d;
 383         char filename[PATH_MAX];
 384
 385         dp = opendir(ctdl_data_dir);
 386         if (dp != NULL) {
 387                 while (d = readdir(dp), d != NULL) {
 388                         if (d->d_name[0] != '.') {
 389                                 snprintf(filename, sizeof filename, "%s/%s", ctdl_data_dir, d->d_name);
 390                                 syslog(LOG_DEBUG, "chmod(%s, 0600) returned %d", filename, chmod(filename, 0600));
 391                                 syslog(LOG_DEBUG, "chown(%s, CTDLUID, -1) returned %d",
 392                                         filename, chown(filename, CTDLUID, (-1))
 393                                 );
 394                         }
 395                 }
 396                 closedir(dp);
 397         }
 398
 399         syslog(LOG_DEBUG, "open_databases() finished");
 400 }
 401
 402
 403 /*
 404  * Close all of the db database files we've opened.  This can be done
 405  * in a loop, since it's just a bunch of closes.
 406  */
 407 void close_databases(void)
 408 {
 409         int a;
 410         int ret;
 411
 412         syslog(LOG_INFO, "Performing final checkpoint.");
 413         if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
 414                 syslog(LOG_ERR, "txn_checkpoint: %s", db_strerror(ret));
 415         }
 416
 417         syslog(LOG_INFO, "Flushing the database logs.");
 418         if ((ret = dbenv->log_flush(dbenv, NULL))) {
 419                 syslog(LOG_ERR, "log_flush: %s", db_strerror(ret));
 420         }
 421
 422         /* print some statistics... */
 423 #ifdef DB_STAT_ALL
 424         dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
 425 #endif
 426
 427         /* close the tables */
 428         for (a = 0; a < MAXCDB; ++a) {
 429                 syslog(LOG_INFO, "Closing database %02x", a);
 430                 ret = dbp[a]->close(dbp[a], 0);
 431                 if (ret) {
 432                         syslog(LOG_EMERG, "db_close: %s", db_strerror(ret));
 433                 }
 434
 435         }
 436
 437         /* Close the handle. */
 438         ret = dbenv->close(dbenv, 0);
 439         if (ret) {
 440                 syslog(LOG_EMERG, "DBENV->close: %s", db_strerror(ret));
 441         }
 442 }
 443
 444
 445 /*
 446  * Decompress a database item if it was compressed on disk
 447  */
 448 void cdb_decompress_if_necessary(struct cdbdata *cdb)
 449 {
 450         static int magic = COMPRESS_MAGIC;
 451
 452         if ((cdb == NULL) ||
 453             (cdb->ptr == NULL) ||
 454             (cdb->len < sizeof(magic)) ||
 455             (memcmp(cdb->ptr, &magic, sizeof(magic))))
 456             return;
 457
 458         /* At this point we know we're looking at a compressed item. */
 459
 460         struct CtdlCompressHeader zheader;
 461         char *uncompressed_data;
 462         char *compressed_data;
 463         uLongf destLen, sourceLen;
 464         size_t cplen;
 465
 466         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 467         cplen = sizeof(struct CtdlCompressHeader);
 468         if (sizeof(struct CtdlCompressHeader) > cdb->len)
 469                 cplen = cdb->len;
 470         memcpy(&zheader, cdb->ptr, cplen);
 471
 472         compressed_data = cdb->ptr;
 473         compressed_data += sizeof(struct CtdlCompressHeader);
 474
 475         sourceLen = (uLongf) zheader.compressed_len;
 476         destLen = (uLongf) zheader.uncompressed_len;
 477         uncompressed_data = malloc(zheader.uncompressed_len);
 478
 479         if (uncompress((Bytef *) uncompressed_data,
 480                        (uLongf *) & destLen,
 481                        (const Bytef *) compressed_data,
 482                        (uLong) sourceLen) != Z_OK)
 483         {
 484                 syslog(LOG_EMERG, "uncompress() error");
 485                 cdb_abort();
 486         }
 487
 488         free(cdb->ptr);
 489         cdb->len = (size_t) destLen;
 490         cdb->ptr = uncompressed_data;
 491 }
 492
 493
 494 /*
 495  * Store a piece of data.  Returns 0 if the operation was successful.  If a
 496  * key already exists it should be overwritten.
 497  */
 498 int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
 499 {
 500
 501         DBT dkey, ddata;
 502         DB_TXN *tid;
 503         int ret = 0;
 504
 505         struct CtdlCompressHeader zheader;
 506         char *compressed_data = NULL;
 507         int compressing = 0;
 508         size_t buffer_len = 0;
 509         uLongf destLen = 0;
 510
 511         memset(&dkey, 0, sizeof(DBT));
 512         memset(&ddata, 0, sizeof(DBT));
 513         dkey.size = ckeylen;
 514         dkey.data = (void *)ckey;
 515         ddata.size = cdatalen;
 516         ddata.data = cdata;
 517
 518         /* Only compress Visit and UseTable records.  Everything else is uncompressed. */
 519         if ( (cdb == CDB_VISIT) || (cdb == CDB_USETABLE) ) {
 520                 compressing = 1;
 521                 zheader.magic = COMPRESS_MAGIC;
 522                 zheader.uncompressed_len = cdatalen;
 523                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 524                 destLen = (uLongf) buffer_len;
 525                 compressed_data = malloc(buffer_len);
 526                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)),
 527                         &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK)
 528                 {
 529                         syslog(LOG_EMERG, "compress2() error");
 530                         cdb_abort();
 531                 }
 532                 zheader.compressed_len = (size_t) destLen;
 533                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 534                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 535                 ddata.data = compressed_data;
 536         }
 537
 538         if (TSD->tid != NULL) {
 539                 ret = dbp[cdb]->put(dbp[cdb],   /* db */
 540                                     TSD->tid,   /* transaction ID */
 541                                     &dkey,      /* key */
 542                                     &ddata,     /* data */
 543                                     0); /* flags */
 544                 if (ret) {
 545                         syslog(LOG_EMERG, "cdb_store(%d): %s", cdb, db_strerror(ret));
 546                         cdb_abort();
 547                 }
 548                 if (compressing)
 549                         free(compressed_data);
 550                 return ret;
 551         }
 552         else {
 553                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 554
 555               retry:
 556                 txbegin(&tid);
 557
 558                 if ((ret = dbp[cdb]->put(dbp[cdb],      /* db */
 559                                          tid,   /* transaction ID */
 560                                          &dkey, /* key */
 561                                          &ddata,        /* data */
 562                                          0))) { /* flags */
 563                         if (ret == DB_LOCK_DEADLOCK) {
 564                                 txabort(tid);
 565                                 goto retry;
 566                         } else {
 567                                 syslog(LOG_EMERG, "cdb_store(%d): %s", cdb, db_strerror(ret));
 568                                 cdb_abort();
 569                         }
 570                 } else {
 571                         txcommit(tid);
 572                         if (compressing) {
 573                                 free(compressed_data);
 574                         }
 575                         return ret;
 576                 }
 577         }
 578         return ret;
 579 }
 580
 581
 582 /*
 583  * Delete a piece of data.  Returns 0 if the operation was successful.
 584  */
 585 int cdb_delete(int cdb, void *key, int keylen)
 586 {
 587
 588         DBT dkey;
 589         DB_TXN *tid;
 590         int ret;
 591
 592         memset(&dkey, 0, sizeof dkey);
 593         dkey.size = keylen;
 594         dkey.data = key;
 595
 596         if (TSD->tid != NULL) {
 597                 ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
 598                 if (ret) {
 599                         syslog(LOG_EMERG, "cdb_delete(%d): %s", cdb, db_strerror(ret));
 600                         if (ret != DB_NOTFOUND) {
 601                                 cdb_abort();
 602                         }
 603                 }
 604         } else {
 605                 bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
 606
 607               retry:
 608                 txbegin(&tid);
 609
 610                 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0))
 611                     && ret != DB_NOTFOUND) {
 612                         if (ret == DB_LOCK_DEADLOCK) {
 613                                 txabort(tid);
 614                                 goto retry;
 615                         } else {
 616                                 syslog(LOG_EMERG, "cdb_delete(%d): %s",
 617                                         cdb, db_strerror(ret));
 618                                 cdb_abort();
 619                         }
 620                 } else {
 621                         txcommit(tid);
 622                 }
 623         }
 624         return ret;
 625 }
 626
 627 static DBC *localcursor(int cdb)
 628 {
 629         int ret;
 630         DBC *curs;
 631
 632         if (TSD->cursors[cdb] == NULL)
 633                 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
 634         else
 635                 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
 636
 637         if (ret) {
 638                 syslog(LOG_EMERG, "localcursor: %s", db_strerror(ret));
 639                 cdb_abort();
 640         }
 641
 642         return curs;
 643 }
 644
 645
 646 /*
 647  * Fetch a piece of data.  If not found, returns NULL.  Otherwise, it returns
 648  * a struct cdbdata which it is the caller's responsibility to free later on
 649  * using the cdb_free() routine.
 650  */
 651 struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen)
 652 {
 653         struct cdbdata *tempcdb;
 654         DBT dkey, dret;
 655         int ret;
 656
 657         memset(&dkey, 0, sizeof(DBT));
 658         dkey.size = keylen;
 659         dkey.data = (void *)key;
 660
 661         if (TSD->tid != NULL) {
 662                 memset(&dret, 0, sizeof(DBT));
 663                 dret.flags = DB_DBT_MALLOC;
 664                 ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
 665         } else {
 666                 DBC *curs;
 667
 668                 do {
 669                         memset(&dret, 0, sizeof(DBT));
 670                         dret.flags = DB_DBT_MALLOC;
 671
 672                         curs = localcursor(cdb);
 673
 674                         ret = curs->c_get(curs, &dkey, &dret, DB_SET);
 675                         cclose(curs);
 676                 }
 677                 while (ret == DB_LOCK_DEADLOCK);
 678
 679         }
 680
 681         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 682                 syslog(LOG_EMERG, "cdb_fetch(%d): %s", cdb, db_strerror(ret));
 683                 cdb_abort();
 684         }
 685
 686         if (ret != 0)
 687                 return NULL;
 688         tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 689
 690         if (tempcdb == NULL) {
 691                 syslog(LOG_EMERG, "cdb_fetch: Cannot allocate memory for tempcdb");
 692                 cdb_abort();
 693                 return NULL; /* make it easier for static analysis... */
 694         }
 695         else
 696         {
 697                 tempcdb->len = dret.size;
 698                 tempcdb->ptr = dret.data;
 699                 cdb_decompress_if_necessary(tempcdb);
 700                 return (tempcdb);
 701         }
 702 }
 703
 704
 705 /*
 706  * Free a cdbdata item.
 707  *
 708  * Note that we only free the 'ptr' portion if it is not NULL.  This allows
 709  * other code to assume ownership of that memory simply by storing the
 710  * pointer elsewhere and then setting 'ptr' to NULL.  cdb_free() will then
 711  * avoid freeing it.
 712  */
 713 void cdb_free(struct cdbdata *cdb)
 714 {
 715         if (cdb->ptr) {
 716                 free(cdb->ptr);
 717         }
 718         free(cdb);
 719 }
 720
 721 void cdb_close_cursor(int cdb)
 722 {
 723         if (TSD->cursors[cdb] != NULL) {
 724                 cclose(TSD->cursors[cdb]);
 725         }
 726
 727         TSD->cursors[cdb] = NULL;
 728 }
 729
 730 /*
 731  * Prepare for a sequential search of an entire database.
 732  * (There is guaranteed to be no more than one traversal in
 733  * progress per thread at any given time.)
 734  */
 735 void cdb_rewind(int cdb)
 736 {
 737         int ret = 0;
 738
 739         if (TSD->cursors[cdb] != NULL) {
 740                 syslog(LOG_EMERG, "cdb_rewind: must close cursor on database %d before reopening.", cdb);
 741                 cdb_abort();
 742                 /* cclose(TSD->cursors[cdb]); */
 743         }
 744
 745         /*
 746          * Now initialize the cursor
 747          */
 748         ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 749         if (ret) {
 750                 syslog(LOG_EMERG, "cdb_rewind: db_cursor: %s", db_strerror(ret));
 751                 cdb_abort();
 752         }
 753 }
 754
 755
 756 /*
 757  * Fetch the next item in a sequential search.  Returns a pointer to a
 758  * cdbdata structure, or NULL if we've hit the end.
 759  */
 760 struct cdbdata *cdb_next_item(int cdb)
 761 {
 762         DBT key, data;
 763         struct cdbdata *cdbret;
 764         int ret = 0;
 765
 766         /* Initialize the key/data pair so the flags aren't set. */
 767         memset(&key, 0, sizeof(key));
 768         memset(&data, 0, sizeof(data));
 769         data.flags = DB_DBT_MALLOC;
 770
 771         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
 772
 773         if (ret) {
 774                 if (ret != DB_NOTFOUND) {
 775                         syslog(LOG_EMERG, "cdb_next_item(%d): %s", cdb, db_strerror(ret));
 776                         cdb_abort();
 777                 }
 778                 cdb_close_cursor(cdb);
 779                 return NULL;    /* presumably, end of file */
 780         }
 781
 782         cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 783         cdbret->len = data.size;
 784         cdbret->ptr = data.data;
 785         cdb_decompress_if_necessary(cdbret);
 786
 787         return (cdbret);
 788 }
 789
 790
 791
 792 /*
 793  * Transaction-based stuff.  I'm writing this as I bake cookies...
 794  */
 795
 796 void cdb_begin_transaction(void)
 797 {
 798
 799         bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 800
 801         if (TSD->tid != NULL) {
 802                 syslog(LOG_EMERG, "cdb_begin_transaction: ERROR: nested transaction");
 803                 cdb_abort();
 804         }
 805
 806         txbegin(&TSD->tid);
 807 }
 808
 809 void cdb_end_transaction(void)
 810 {
 811         int i;
 812
 813         for (i = 0; i < MAXCDB; i++)
 814                 if (TSD->cursors[i] != NULL) {
 815                         syslog(LOG_WARNING,
 816                                 "cdb_end_transaction: WARNING: cursor %d still open at transaction end",
 817                                 i);
 818                         cclose(TSD->cursors[i]);
 819                         TSD->cursors[i] = NULL;
 820                 }
 821
 822         if (TSD->tid == NULL) {
 823                 syslog(LOG_ERR, "cdb_end_transaction: ERROR: txcommit(NULL) !!");
 824                 cdb_abort();
 825         }
 826         else {
 827                 txcommit(TSD->tid);
 828         }
 829
 830         TSD->tid = NULL;
 831 }
 832
 833 /*
 834  * Truncate (delete every record)
 835  */
 836 void cdb_trunc(int cdb)
 837 {
 838         /* DB_TXN *tid; */
 839         int ret;
 840         u_int32_t count;
 841
 842         if (TSD->tid != NULL) {
 843                 syslog(LOG_EMERG, "cdb_trunc must not be called in a transaction.");
 844                 cdb_abort();
 845         }
 846         else {
 847                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 848
 849               retry:
 850                 /* txbegin(&tid); */
 851
 852                 if ((ret = dbp[cdb]->truncate(dbp[cdb], /* db */
 853                                               NULL,     /* transaction ID */
 854                                               &count,   /* #rows deleted */
 855                                               0))) {    /* flags */
 856                         if (ret == DB_LOCK_DEADLOCK) {
 857                                 /* txabort(tid); */
 858                                 goto retry;
 859                         } else {
 860                                 syslog(LOG_EMERG, "cdb_truncate(%d): %s", cdb, db_strerror(ret));
 861                                 if (ret == ENOMEM) {
 862                                         syslog(LOG_EMERG, "You may need to tune your database; please read http://www.citadel.org/doku.php?id=faq:troubleshooting:out_of_lock_entries for more information.");
 863                                 }
 864                                 exit(CTDLEXIT_DB);
 865                         }
 866                 } else {
 867                         /* txcommit(tid); */
 868                 }
 869         }
 870 }
 871
 872
 873 //time_t CheckIfAlreadySeen(const char *Facility,
 874                           //StrBuf *guid,
 875                           //time_t now,
 876                           //time_t antiexpire,
 877                           //eCheckType cType,
 878                           //long ccid,
 879                           //long ioid
 880 //) {
 881
 882
 883 time_t CheckIfAlreadySeen(StrBuf *guid, time_t now, time_t antiexpire, eCheckType cType)
 884 {
 885         time_t InDBTimeStamp = 0;
 886         struct UseTable ut;
 887         struct cdbdata *cdbut;
 888
 889         memset(&ut, 0, sizeof(struct UseTable));        // zeroing it out makes it compress better
 890
 891         if (cType != eWrite)
 892         {
 893                 syslog(LOG_DEBUG, "Loading [%s]", ChrPtr(guid));
 894                 cdbut = cdb_fetch(CDB_USETABLE, SKEY(guid));
 895                 if ((cdbut != NULL) && (cdbut->ptr != NULL)) {
 896                         memcpy(&ut, cdbut->ptr, ((cdbut->len > sizeof(struct UseTable)) ?  sizeof(struct UseTable) : cdbut->len));
 897                         InDBTimeStamp = now - ut.ut_timestamp;
 898
 899                         if (InDBTimeStamp < antiexpire)
 900                         {
 901                                 syslog(LOG_DEBUG, "Found - Not expired %ld < %ld", InDBTimeStamp, antiexpire);
 902                                 cdb_free(cdbut);
 903                                 return InDBTimeStamp;
 904                         }
 905                         else
 906                         {
 907                                 syslog(LOG_DEBUG, "Found - Expired. %ld >= %ld", InDBTimeStamp, antiexpire);
 908                                 cdb_free(cdbut);
 909                         }
 910                 }
 911                 else
 912                 {
 913                         if (cdbut) cdb_free(cdbut);
 914
 915                         syslog(LOG_DEBUG, "not Found");
 916                         if (cType == eCheckUpdate)
 917                                 return 0;
 918                 }
 919
 920                 if (cType == eCheckExist)
 921                         return InDBTimeStamp;
 922         }
 923
 924         memcpy(ut.ut_msgid, SKEY(guid));
 925         ut.ut_timestamp = now;
 926
 927         /* rewrite the record anyway, to update the timestamp */
 928         syslog(LOG_DEBUG, "(re)writing usetable record");
 929         cdb_store(CDB_USETABLE, SKEY(guid), &ut, sizeof(struct UseTable));
 930         return InDBTimeStamp;
 931 }
 932
 933
 934 void cmd_rsen(char *argbuf) {
 935         char Token[SIZ];
 936         long TLen;
 937         char Time[SIZ];
 938
 939         struct UseTable ut;
 940         struct cdbdata *cdbut;
 941
 942         if (CtdlAccessCheck(ac_aide)) return;
 943
 944         TLen = extract_token(Token, argbuf, 1, '|', sizeof Token);
 945         if (strncmp(argbuf, "GET", 3) == 0) {
 946                 cdbut = cdb_fetch(CDB_USETABLE, Token, TLen);
 947                 if (cdbut != NULL) {
 948                         memcpy(&ut, cdbut->ptr,
 949                                ((cdbut->len > sizeof(struct UseTable)) ?
 950                                 sizeof(struct UseTable) : cdbut->len));
 951
 952                         cprintf("%d %ld\n", CIT_OK, ut.ut_timestamp);
 953                 }
 954                 else {
 955                         cprintf("%d not found\n", ERROR + NOT_HERE);
 956                 }
 957
 958         }
 959         else if (strncmp(argbuf, "SET", 3) == 0) {
 960                 memcpy(ut.ut_msgid, Token, TLen);
 961                 extract_token(Time, argbuf, 2, '|', sizeof Time);
 962                 ut.ut_timestamp = atol(Time);
 963                 cdb_store(CDB_USETABLE,
 964                           Token, TLen,
 965                           &ut, sizeof(struct UseTable) );
 966                 cprintf("%d token updated\n", CIT_OK);
 967         }
 968         else if (strncmp(argbuf, "DEL", 3) == 0) {
 969                 if (cdb_delete(CDB_USETABLE, Token, TLen))
 970                         cprintf("%d not found\n", ERROR + NOT_HERE);
 971                 else
 972                         cprintf("%d deleted.\n", CIT_OK);
 973
 974         }
 975         else {
 976                 cprintf("%d Usage: [GET|SET|DEL]|Token|timestamp\n", ERROR);
 977         }
 978
 979 }
 980
 981 CTDL_MODULE_INIT(database)
 982 {
 983         if (!threading)
 984         {
 985                 CtdlRegisterProtoHook(cmd_rsen, "RSEN", "manipulate Aggregators seen database");
 986         }
 987
 988         /* return our module id for the log */
 989         return "database";
 990 }