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