citadel/server/database.c

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