citadel/server/database.c

   1 // This is a data store backend for the Citadel server which uses Berkeley DB.
   2 //
   3 // Copyright (c) 1987-2023 by the citadel.org team
   4 //
   5 // This program is open source software.  Use, duplication, or disclosure
   6 // is subject to the terms of the GNU General Public License, version 3.
   7
   8 // Citadel will checkpoint the db at the end of every session, but only if
   9 // the specified number of kilobytes has been written, or if the specified
  10 // number of minutes has passed, since the last checkpoint.
  11 #define MAX_CHECKPOINT_KBYTES   256
  12 #define MAX_CHECKPOINT_MINUTES  15
  13
  14 #include "sysdep.h"
  15 #include <stdlib.h>
  16 #include <unistd.h>
  17 #include <sys/stat.h>
  18 #include <stdio.h>
  19 #include <dirent.h>
  20 #include <zlib.h>
  21 #include <db.h>
  22
  23 #if DB_VERSION_MAJOR < 5
  24 #error Citadel requires Berkeley DB v5.0 or newer.  Please upgrade.
  25 #endif
  26
  27 #include <libcitadel.h>
  28 #include "ctdl_module.h"
  29 #include "control.h"
  30 #include "citserver.h"
  31 #include "config.h"
  32
  33 static DB *dbp[MAXCDB];         // One DB handle for each Citadel database
  34 static DB_ENV *dbenv;           // The DB environment (global)
  35
  36
  37 void cdb_abort(void) {
  38         syslog(LOG_DEBUG, "db: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d",
  39                 getuid(), getgid(), geteuid(), getegid()
  40         );
  41         raise(SIGABRT);         // This will exit in a way that can produce a core dump if needed.
  42         exit(CTDLEXIT_DB);      // Exit if the signal failed to end the program.
  43 }
  44
  45
  46 // Verbose logging callback
  47 void cdb_verbose_log(const DB_ENV *dbenv, const char *msg, const char *what_is_this) {
  48         if (!IsEmptyStr(msg)) {
  49                 syslog(LOG_DEBUG, "db: %s", msg);
  50         }
  51 }
  52
  53
  54 // Verbose logging callback
  55 void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg) {
  56         syslog(LOG_ERR, "db: %s", msg);
  57 }
  58
  59
  60 // wrapper for txn_abort() that logs/aborts on error
  61 static void txabort(DB_TXN *tid) {
  62         int ret;
  63
  64         ret = tid->abort(tid);
  65
  66         if (ret) {
  67                 syslog(LOG_ERR, "db: txn_abort: %s", db_strerror(ret));
  68                 cdb_abort();
  69         }
  70 }
  71
  72
  73 // wrapper for txn_commit() that logs/aborts on error
  74 static void txcommit(DB_TXN *tid) {
  75         int ret;
  76
  77         ret = tid->commit(tid, 0);
  78
  79         if (ret) {
  80                 syslog(LOG_ERR, "db: txn_commit: %s", db_strerror(ret));
  81                 cdb_abort();
  82         }
  83 }
  84
  85
  86 // wrapper for txn_begin() that logs/aborts on error
  87 static void txbegin(DB_TXN **tid) {
  88         int ret;
  89
  90         ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
  91
  92         if (ret) {
  93                 syslog(LOG_ERR, "db: txn_begin: %s", db_strerror(ret));
  94                 cdb_abort();
  95         }
  96 }
  97
  98
  99 // panic callback
 100 static void dbpanic(DB_ENV *env, int errval) {
 101         syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval));
 102         cdb_abort();
 103 }
 104
 105
 106 static void cclose(DBC *cursor) {
 107         int ret;
 108
 109         if ((ret = cursor->c_close(cursor))) {
 110                 syslog(LOG_ERR, "db: c_close: %s", db_strerror(ret));
 111                 cdb_abort();
 112         }
 113 }
 114
 115
 116 static void bailIfCursor(DBC **cursors, const char *msg) {
 117         int i;
 118
 119         for (i = 0; i < MAXCDB; i++)
 120                 if (cursors[i] != NULL) {
 121                         syslog(LOG_ERR, "db: cursor still in progress on cdb %02x: %s", i, msg);
 122                         cdb_abort();
 123                 }
 124 }
 125
 126
 127 void cdb_check_handles(void) {
 128         bailIfCursor(TSD->cursors, "in check_handles");
 129
 130         if (TSD->tid != NULL) {
 131                 syslog(LOG_ERR, "db: transaction still in progress!");
 132                 cdb_abort();
 133         }
 134 }
 135
 136
 137 // Request a checkpoint of the database.  Called once per minute by the thread manager.
 138 void cdb_checkpoint(void) {
 139         int ret;
 140
 141         syslog(LOG_DEBUG, "db: -- checkpoint --");
 142         ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 143
 144         if (ret != 0) {
 145                 syslog(LOG_ERR, "db: cdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
 146                 cdb_abort();
 147         }
 148
 149         // After a successful checkpoint, we can cull the unused logs
 150         if (CtdlGetConfigInt("c_auto_cull")) {
 151                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);
 152         }
 153         else {
 154                 ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
 155         }
 156 }
 157
 158
 159 // Open the various databases we'll be using.  Any database which
 160 // does not exist should be created.  Note that we don't need a
 161 // critical section here, because there aren't any active threads
 162 // manipulating the database yet.
 163 void open_databases(void) {
 164         int ret;
 165         int i;
 166         char dbfilename[32];
 167         u_int32_t flags = 0;
 168         int dbversion_major, dbversion_minor, dbversion_patch;
 169
 170         syslog(LOG_DEBUG, "db: open_databases() starting");
 171         syslog(LOG_DEBUG, "db:    Linked zlib: %s", zlibVersion());
 172         syslog(LOG_DEBUG, "db: Compiled libdb: %s", DB_VERSION_STRING);
 173         syslog(LOG_DEBUG, "db:   Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch));
 174
 175         // Create synthetic integer version numbers and compare them.
 176         // Never allow citserver to run with a libdb older then the one with which it was compiled.
 177         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
 178         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
 179         if (compiled_db_version > linked_db_version) {
 180                 syslog(LOG_ERR, "db: citserver is running with a version of libdb older than the one with which it was compiled.");
 181                 syslog(LOG_ERR, "db: This is an invalid configuration.  citserver will now exit to prevent data loss.");
 182                 exit(CTDLEXIT_DB);
 183         }
 184
 185         // Silently try to create the database subdirectory.  If it's already there, no problem.
 186         if ((mkdir(ctdl_db_dir, 0700) != 0) && (errno != EEXIST)) {
 187                 syslog(LOG_ERR, "db: database directory [%s] does not exist and could not be created: %m", ctdl_db_dir);
 188                 exit(CTDLEXIT_DB);
 189         }
 190         if (chmod(ctdl_db_dir, 0700) != 0) {
 191                 syslog(LOG_ERR, "db: unable to set database directory permissions [%s]: %m", ctdl_db_dir);
 192                 exit(CTDLEXIT_DB);
 193         }
 194         if (chown(ctdl_db_dir, CTDLUID, (-1)) != 0) {
 195                 syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_db_dir);
 196                 exit(CTDLEXIT_DB);
 197         }
 198         syslog(LOG_DEBUG, "db: Setting up DB environment");
 199         ret = db_env_create(&dbenv, 0);
 200         if (ret) {
 201                 syslog(LOG_ERR, "db: db_env_create: %s", db_strerror(ret));
 202                 syslog(LOG_ERR, "db: exit code %d", ret);
 203                 exit(CTDLEXIT_DB);
 204         }
 205         dbenv->set_errpfx(dbenv, "citserver");
 206         dbenv->set_paniccall(dbenv, dbpanic);
 207         dbenv->set_errcall(dbenv, cdb_verbose_err);
 208         dbenv->set_errpfx(dbenv, "ctdl");
 209         dbenv->set_msgcall(dbenv, cdb_verbose_log);
 210         dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1);
 211         dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1);
 212
 213         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
 214         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
 215         if (ret) {
 216                 syslog(LOG_ERR, "db: set_cachesize: %s", db_strerror(ret));
 217                 dbenv->close(dbenv, 0);
 218                 syslog(LOG_ERR, "db: exit code %d", ret);
 219                 exit(CTDLEXIT_DB);
 220         }
 221
 222         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
 223                 syslog(LOG_ERR, "db: set_lk_detect: %s", db_strerror(ret));
 224                 dbenv->close(dbenv, 0);
 225                 syslog(LOG_ERR, "db: exit code %d", ret);
 226                 exit(CTDLEXIT_DB);
 227         }
 228
 229         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
 230         syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_db_dir, flags);
 231         ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                                // try opening the database cleanly
 232         if (ret == DB_RUNRECOVERY) {
 233                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 234                 syslog(LOG_ERR, "db: attempting recovery...");
 235                 flags |= DB_RECOVER;
 236                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try recovery
 237         }
 238         if (ret == DB_RUNRECOVERY) {
 239                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 240                 syslog(LOG_ERR, "db: attempting catastrophic recovery...");
 241                 flags &= ~DB_RECOVER;
 242                 flags |= DB_RECOVER_FATAL;
 243                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try catastrophic recovery
 244         }
 245         if (ret) {
 246                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 247                 dbenv->close(dbenv, 0);
 248                 syslog(LOG_ERR, "db: exit code %d", ret);
 249                 exit(CTDLEXIT_DB);
 250         }
 251
 252         syslog(LOG_INFO, "db: mounting databases");
 253         for (i = 0; i < MAXCDB; ++i) {
 254                 ret = db_create(&dbp[i], dbenv, 0);                                     // Create a database handle
 255                 if (ret) {
 256                         syslog(LOG_ERR, "db: db_create: %s", db_strerror(ret));
 257                         syslog(LOG_ERR, "db: exit code %d", ret);
 258                         exit(CTDLEXIT_DB);
 259                 }
 260
 261                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);                 // table names by number
 262                 ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600);
 263                 if (ret) {
 264                         syslog(LOG_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret));
 265                         if (ret == ENOMEM) {
 266                                 syslog(LOG_ERR, "db: You may need to tune your database; please check http://www.citadel.org for more information.");
 267                         }
 268                         syslog(LOG_ERR, "db: exit code %d", ret);
 269                         exit(CTDLEXIT_DB);
 270                 }
 271         }
 272 }
 273
 274
 275 // Make sure we own all the files, because in a few milliseconds we're going to drop root privs.
 276 void cdb_chmod_data(void) {
 277         DIR *dp;
 278         struct dirent *d;
 279         char filename[PATH_MAX];
 280
 281         dp = opendir(ctdl_db_dir);
 282         if (dp != NULL) {
 283                 while (d = readdir(dp), d != NULL) {
 284                         if (d->d_name[0] != '.') {
 285                                 snprintf(filename, sizeof filename, "%s/%s", ctdl_db_dir, d->d_name);
 286                                 syslog(LOG_DEBUG, "db: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600));
 287                                 syslog(LOG_DEBUG, "db: chown(%s, CTDLUID, -1) returned %d", filename, chown(filename, CTDLUID, (-1)));
 288                         }
 289                 }
 290                 closedir(dp);
 291         }
 292 }
 293
 294
 295 // Close all of the db database files we've opened.  This can be done in a loop, since it's just a bunch of closes.
 296 void close_databases(void) {
 297         int i;
 298         int ret;
 299
 300         syslog(LOG_INFO, "db: performing final checkpoint");
 301         if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
 302                 syslog(LOG_ERR, "db: txn_checkpoint: %s", db_strerror(ret));
 303         }
 304
 305         syslog(LOG_INFO, "db: flushing the database logs");
 306         if ((ret = dbenv->log_flush(dbenv, NULL))) {
 307                 syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret));
 308         }
 309
 310         // close the tables
 311         syslog(LOG_INFO, "db: closing databases");
 312         for (i = 0; i < MAXCDB; ++i) {
 313                 syslog(LOG_INFO, "db: closing database %02x", i);
 314                 ret = dbp[i]->close(dbp[i], 0);
 315                 if (ret) {
 316                         syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret));
 317                 }
 318
 319         }
 320
 321         // This seemed nifty at the time but did anyone really look at it?
 322         // #ifdef DB_STAT_ALL
 323         // dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
 324         // #endif
 325
 326         // Close the handle.
 327         ret = dbenv->close(dbenv, 0);
 328         if (ret) {
 329                 syslog(LOG_ERR, "db: DBENV->close: %s", db_strerror(ret));
 330         }
 331 }
 332
 333
 334 // Decompress a database item if it was compressed on disk
 335 void cdb_decompress_if_necessary(struct cdbdata *cdb) {
 336         static int magic = COMPRESS_MAGIC;
 337
 338         if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) {
 339                 return;
 340         }
 341
 342         // At this point we know we're looking at a compressed item.
 343
 344         struct CtdlCompressHeader zheader;
 345         char *uncompressed_data;
 346         char *compressed_data;
 347         uLongf destLen, sourceLen;
 348         size_t cplen;
 349
 350         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 351         cplen = sizeof(struct CtdlCompressHeader);
 352         if (sizeof(struct CtdlCompressHeader) > cdb->len) {
 353                 cplen = cdb->len;
 354         }
 355         memcpy(&zheader, cdb->ptr, cplen);
 356
 357         compressed_data = cdb->ptr;
 358         compressed_data += sizeof(struct CtdlCompressHeader);
 359
 360         sourceLen = (uLongf) zheader.compressed_len;
 361         destLen = (uLongf) zheader.uncompressed_len;
 362         uncompressed_data = malloc(zheader.uncompressed_len);
 363
 364         if (uncompress((Bytef *) uncompressed_data,
 365                        (uLongf *) &destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
 366                 syslog(LOG_ERR, "db: uncompress() error");
 367                 cdb_abort();
 368         }
 369
 370         free(cdb->ptr);
 371         cdb->len = (size_t) destLen;
 372         cdb->ptr = uncompressed_data;
 373 }
 374
 375
 376 // Store a piece of data.  Returns 0 if the operation was successful.  If a
 377 // key already exists it should be overwritten.
 378 int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) {
 379
 380         DBT dkey, ddata;
 381         DB_TXN *tid = NULL;
 382         int ret = 0;
 383         struct CtdlCompressHeader zheader;
 384         char *compressed_data = NULL;
 385         int compressing = 0;
 386         size_t buffer_len = 0;
 387         uLongf destLen = 0;
 388
 389         memset(&dkey, 0, sizeof(DBT));
 390         memset(&ddata, 0, sizeof(DBT));
 391         dkey.size = ckeylen;
 392         dkey.data = (void *) ckey;
 393         ddata.size = cdatalen;
 394         ddata.data = cdata;
 395
 396         // "visit" and "usetable" records are numerous and have big, mostly-empty string buffers in them.
 397         // If we compress these we can get them down to 1% of their size most of the time.
 398         if ((cdb == CDB_VISIT) || (cdb == CDB_USETABLE)) {
 399                 compressing = 1;
 400                 zheader.magic = COMPRESS_MAGIC;
 401                 zheader.uncompressed_len = cdatalen;
 402                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 403                 destLen = (uLongf) buffer_len;
 404                 compressed_data = malloc(buffer_len);
 405                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
 406                         syslog(LOG_ERR, "db: compress2() error");
 407                         cdb_abort();
 408                 }
 409                 zheader.compressed_len = (size_t) destLen;
 410                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 411                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 412                 ddata.data = compressed_data;
 413         }
 414
 415         if (TSD->tid != NULL) {
 416                 ret = dbp[cdb]->put(dbp[cdb],   // db
 417                                     TSD->tid,   // transaction ID
 418                                     &dkey,      // key
 419                                     &ddata,     // data
 420                                     0           // flags
 421                 );
 422                 if (ret) {
 423                         syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
 424                         cdb_abort();
 425                 }
 426                 if (compressing) {
 427                         free(compressed_data);
 428                 }
 429                 return ret;
 430         }
 431         else {
 432                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 433
 434               retry:
 435                 txbegin(&tid);
 436
 437                 if ((ret = dbp[cdb]->put(dbp[cdb],      // db
 438                                          tid,           // transaction ID
 439                                          &dkey,         // key
 440                                          &ddata,        // data
 441                                          0))) {         // flags
 442                         if (ret == DB_LOCK_DEADLOCK) {
 443                                 txabort(tid);
 444                                 goto retry;
 445                         }
 446                         else {
 447                                 syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
 448                                 cdb_abort();
 449                         }
 450                 }
 451                 else {
 452                         txcommit(tid);
 453                         if (compressing) {
 454                                 free(compressed_data);
 455                         }
 456                         return ret;
 457                 }
 458         }
 459         return ret;
 460 }
 461
 462
 463 // Delete a piece of data.  Returns 0 if the operation was successful.
 464 int cdb_delete(int cdb, void *key, int keylen) {
 465         DBT dkey;
 466         DB_TXN *tid;
 467         int ret;
 468
 469         memset(&dkey, 0, sizeof dkey);
 470         dkey.size = keylen;
 471         dkey.data = key;
 472
 473         if (TSD->tid != NULL) {
 474                 ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
 475                 if (ret) {
 476                         syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
 477                         if (ret != DB_NOTFOUND) {
 478                                 cdb_abort();
 479                         }
 480                 }
 481         }
 482         else {
 483                 bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
 484
 485               retry:
 486                 txbegin(&tid);
 487
 488                 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) {
 489                         if (ret == DB_LOCK_DEADLOCK) {
 490                                 txabort(tid);
 491                                 goto retry;
 492                         }
 493                         else {
 494                                 syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
 495                                 cdb_abort();
 496                         }
 497                 }
 498                 else {
 499                         txcommit(tid);
 500                 }
 501         }
 502         return ret;
 503 }
 504
 505
 506 static DBC *localcursor(int cdb) {
 507         int ret;
 508         DBC *curs;
 509
 510         if (TSD->cursors[cdb] == NULL) {
 511                 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
 512         }
 513         else {
 514                 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
 515         }
 516
 517         if (ret) {
 518                 syslog(LOG_ERR, "db: localcursor: %s", db_strerror(ret));
 519                 cdb_abort();
 520         }
 521
 522         return curs;
 523 }
 524
 525
 526 // Fetch a piece of data.  If not found, returns NULL.  Otherwise, it returns
 527 // a struct cdbdata which it is the caller's responsibility to free later on
 528 // using the cdb_free() routine.
 529 struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) {
 530
 531         if (keylen == 0) {              // key length zero is impossible
 532                 return(NULL);
 533         }
 534
 535         struct cdbdata *tempcdb;
 536         DBT dkey, dret;
 537         int ret;
 538
 539         memset(&dkey, 0, sizeof(DBT));
 540         dkey.size = keylen;
 541         dkey.data = (void *) key;
 542
 543         if (TSD->tid != NULL) {
 544                 memset(&dret, 0, sizeof(DBT));
 545                 dret.flags = DB_DBT_MALLOC;
 546                 ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
 547         }
 548         else {
 549                 DBC *curs;
 550
 551                 do {
 552                         memset(&dret, 0, sizeof(DBT));
 553                         dret.flags = DB_DBT_MALLOC;
 554                         curs = localcursor(cdb);
 555                         ret = curs->c_get(curs, &dkey, &dret, DB_SET);
 556                         cclose(curs);
 557                 } while (ret == DB_LOCK_DEADLOCK);
 558         }
 559
 560         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 561                 syslog(LOG_ERR, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret));
 562                 cdb_abort();
 563         }
 564
 565         if (ret != 0) {
 566                 return NULL;
 567         }
 568
 569         tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 570         if (tempcdb == NULL) {
 571                 syslog(LOG_ERR, "db: cdb_fetch() cannot allocate memory for tempcdb: %m");
 572                 cdb_abort();
 573         }
 574         else {
 575                 tempcdb->len = dret.size;
 576                 tempcdb->ptr = dret.data;
 577                 cdb_decompress_if_necessary(tempcdb);
 578                 return (tempcdb);
 579         }
 580 }
 581
 582
 583 // Free a cdbdata item.
 584 //
 585 // Note that we only free the 'ptr' portion if it is not NULL.  This allows
 586 // other code to assume ownership of that memory simply by storing the
 587 // pointer elsewhere and then setting 'ptr' to NULL.  cdb_free() will then
 588 // avoid freeing it.
 589 void cdb_free(struct cdbdata *cdb) {
 590         if (cdb->ptr) {
 591                 free(cdb->ptr);
 592         }
 593         free(cdb);
 594 }
 595
 596
 597 void cdb_close_cursor(int cdb) {
 598         if (TSD->cursors[cdb] != NULL) {
 599                 cclose(TSD->cursors[cdb]);
 600         }
 601
 602         TSD->cursors[cdb] = NULL;
 603 }
 604
 605
 606 // Prepare for a sequential search of an entire database.
 607 // (There is guaranteed to be no more than one traversal in
 608 // progress per thread at any given time.)
 609 void cdb_rewind(int cdb) {
 610         int ret = 0;
 611
 612         if (TSD->cursors[cdb] != NULL) {
 613                 syslog(LOG_ERR, "db: cdb_rewind: must close cursor on database %d before reopening", cdb);
 614                 cdb_abort();
 615                 // cclose(TSD->cursors[cdb]);
 616         }
 617
 618         // Now initialize the cursor
 619         ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 620         if (ret) {
 621                 syslog(LOG_ERR, "db: cdb_rewind: db_cursor: %s", db_strerror(ret));
 622                 cdb_abort();
 623         }
 624 }
 625
 626
 627 // Fetch the next item in a sequential search.  Returns a pointer to a
 628 // cdbdata structure, or NULL if we've hit the end.
 629 struct cdbdata *cdb_next_item(int cdb) {
 630         DBT key, data;
 631         struct cdbdata *cdbret;
 632         int ret = 0;
 633
 634         // Initialize the key/data pair so the flags aren't set.
 635         memset(&key, 0, sizeof(key));
 636         memset(&data, 0, sizeof(data));
 637         data.flags = DB_DBT_MALLOC;
 638
 639         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
 640
 641         if (ret) {
 642                 if (ret != DB_NOTFOUND) {
 643                         syslog(LOG_ERR, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret));
 644                         cdb_abort();
 645                 }
 646                 cdb_close_cursor(cdb);
 647                 return NULL;    // presumably, end of file
 648         }
 649
 650         cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 651         cdbret->len = data.size;
 652         cdbret->ptr = data.data;
 653         cdb_decompress_if_necessary(cdbret);
 654
 655         return (cdbret);
 656 }
 657
 658
 659 // Transaction-based stuff.  I'm writing this as I bake cookies...
 660 void cdb_begin_transaction(void) {
 661         bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 662
 663         if (TSD->tid != NULL) {
 664                 syslog(LOG_ERR, "db: cdb_begin_transaction: ERROR: nested transaction");
 665                 cdb_abort();
 666         }
 667
 668         txbegin(&TSD->tid);
 669 }
 670
 671
 672 void cdb_end_transaction(void) {
 673         int i;
 674
 675         for (i = 0; i < MAXCDB; i++) {
 676                 if (TSD->cursors[i] != NULL) {
 677                         syslog(LOG_WARNING, "db: cdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
 678                         cclose(TSD->cursors[i]);
 679                         TSD->cursors[i] = NULL;
 680                 }
 681         }
 682
 683         if (TSD->tid == NULL) {
 684                 syslog(LOG_ERR, "db: cdb_end_transaction: ERROR: txcommit(NULL) !!");
 685                 cdb_abort();
 686         }
 687         else {
 688                 txcommit(TSD->tid);
 689         }
 690
 691         TSD->tid = NULL;
 692 }
 693
 694
 695 // Truncate (delete every record)
 696 void cdb_trunc(int cdb) {
 697         int ret;
 698         u_int32_t count;
 699
 700         if (TSD->tid != NULL) {
 701                 syslog(LOG_ERR, "db: cdb_trunc must not be called in a transaction.");
 702                 cdb_abort();
 703         }
 704         else {
 705                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 706
 707               retry:
 708
 709                 if ((ret = dbp[cdb]->truncate(dbp[cdb], // db
 710                                               NULL,     // transaction ID
 711                                               &count,   // #rows deleted
 712                                               0))) {    // flags
 713                         if (ret == DB_LOCK_DEADLOCK) {
 714                                 goto retry;
 715                         }
 716                         else {
 717                                 syslog(LOG_ERR, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret));
 718                                 if (ret == ENOMEM) {
 719                                         syslog(LOG_ERR, "db: You may need to tune your database; please read http://www.citadel.org for more information.");
 720                                 }
 721                                 exit(CTDLEXIT_DB);
 722                         }
 723                 }
 724         }
 725 }
 726
 727
 728 // compact (defragment) the database, possibly returning space back to the underlying filesystem
 729 void cdb_compact(void) {
 730         int ret;
 731         int i;
 732
 733         syslog(LOG_DEBUG, "db: cdb_compact() started");
 734         for (i = 0; i < MAXCDB; i++) {
 735                 syslog(LOG_DEBUG, "db: compacting database %d", i);
 736                 ret = dbp[i]->compact(dbp[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 737                 if (ret) {
 738                         syslog(LOG_ERR, "db: compact: %s", db_strerror(ret));
 739                 }
 740         }
 741         syslog(LOG_DEBUG, "db: cdb_compact() finished");
 742 }
 743
 744
 745 // Has an item already been seen (is it in the CDB_USETABLE) ?
 746 // Returns 0 if it hasn't, 1 if it has
 747 // In either case, writes the item to the database for next time.
 748 int CheckIfAlreadySeen(StrBuf *guid) {
 749         int found = 0;
 750         struct UseTable ut;
 751         struct cdbdata *cdbut;
 752
 753         syslog(LOG_DEBUG, "db: CheckIfAlreadySeen(%s)", ChrPtr(guid));
 754         cdbut = cdb_fetch(CDB_USETABLE, SKEY(guid));
 755         if (cdbut != NULL) {
 756                 found = 1;
 757                 cdb_free(cdbut);
 758         }
 759
 760         // (Re)write the record, to update the timestamp.  Zeroing it out makes it compress better.
 761         memset(&ut, 0, sizeof(struct UseTable));
 762         memcpy(ut.ut_msgid, SKEY(guid));
 763         ut.ut_timestamp = time(NULL);
 764         cdb_store(CDB_USETABLE, SKEY(guid), &ut, sizeof(struct UseTable));
 765         return (found);
 766 }
 767
 768
 769 char *ctdl_module_init_database() {
 770         if (!threading) {
 771                 // nothing to do here
 772         }
 773
 774         // return our module id for the log
 775         return "database";
 776 }