citadel/database.c

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