citadel/database.c

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