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 < 18
  24 #error Citadel requires Berkeley DB v18.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 *foo) {
  48         if (!IsEmptyStr(msg)) {
  49                 syslog(LOG_DEBUG, "db: %s %s", msg, foo);
  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_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         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
 213         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
 214         if (ret) {
 215                 syslog(LOG_ERR, "db: set_cachesize: %s", db_strerror(ret));
 216                 dbenv->close(dbenv, 0);
 217                 syslog(LOG_ERR, "db: exit code %d", ret);
 218                 exit(CTDLEXIT_DB);
 219         }
 220
 221         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
 222                 syslog(LOG_ERR, "db: set_lk_detect: %s", db_strerror(ret));
 223                 dbenv->close(dbenv, 0);
 224                 syslog(LOG_ERR, "db: exit code %d", ret);
 225                 exit(CTDLEXIT_DB);
 226         }
 227
 228         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG;
 229         syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_db_dir, flags);
 230         ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                                // try opening the database cleanly
 231         if (ret == DB_RUNRECOVERY) {
 232                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 233                 syslog(LOG_ERR, "db: attempting recovery...");
 234                 flags |= DB_RECOVER;
 235                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try recovery
 236         }
 237         if (ret == DB_RUNRECOVERY) {
 238                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 239                 syslog(LOG_ERR, "db: attempting catastrophic recovery...");
 240                 flags &= ~DB_RECOVER;
 241                 flags |= DB_RECOVER_FATAL;
 242                 ret = dbenv->open(dbenv, ctdl_db_dir, flags, 0);                        // try catastrophic recovery
 243         }
 244         if (ret) {
 245                 syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
 246                 dbenv->close(dbenv, 0);
 247                 syslog(LOG_ERR, "db: exit code %d", ret);
 248                 exit(CTDLEXIT_DB);
 249         }
 250
 251         syslog(LOG_INFO, "db: mounting databases");
 252         for (i = 0; i < MAXCDB; ++i) {
 253                 ret = db_create(&dbp[i], dbenv, 0);                                     // Create a database handle
 254                 if (ret) {
 255                         syslog(LOG_ERR, "db: db_create: %s", db_strerror(ret));
 256                         syslog(LOG_ERR, "db: exit code %d", ret);
 257                         exit(CTDLEXIT_DB);
 258                 }
 259
 260                 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i);                 // table names by number
 261                 ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600);
 262                 if (ret) {
 263                         syslog(LOG_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret));
 264                         if (ret == ENOMEM) {
 265                                 syslog(LOG_ERR, "db: You may need to tune your database; please check http://www.citadel.org for more information.");
 266                         }
 267                         syslog(LOG_ERR, "db: exit code %d", ret);
 268                         exit(CTDLEXIT_DB);
 269                 }
 270         }
 271 }
 272
 273
 274 // Make sure we own all the files, because in a few milliseconds we're going to drop root privs.
 275 void cdb_chmod_data(void) {
 276         DIR *dp;
 277         struct dirent *d;
 278         char filename[PATH_MAX];
 279
 280         dp = opendir(ctdl_db_dir);
 281         if (dp != NULL) {
 282                 while (d = readdir(dp), d != NULL) {
 283                         if (d->d_name[0] != '.') {
 284                                 snprintf(filename, sizeof filename, "%s/%s", ctdl_db_dir, d->d_name);
 285                                 syslog(LOG_DEBUG, "db: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600));
 286                                 syslog(LOG_DEBUG, "db: chown(%s, CTDLUID, -1) returned %d", filename, chown(filename, CTDLUID, (-1)));
 287                         }
 288                 }
 289                 closedir(dp);
 290         }
 291 }
 292
 293
 294 // 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.
 295 void close_databases(void) {
 296         int i;
 297         int ret;
 298
 299         syslog(LOG_INFO, "db: performing final checkpoint");
 300         if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) {
 301                 syslog(LOG_ERR, "db: txn_checkpoint: %s", db_strerror(ret));
 302         }
 303
 304         syslog(LOG_INFO, "db: flushing the database logs");
 305         if ((ret = dbenv->log_flush(dbenv, NULL))) {
 306                 syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret));
 307         }
 308
 309         // close the tables
 310         syslog(LOG_INFO, "db: closing databases");
 311         for (i = 0; i < MAXCDB; ++i) {
 312                 syslog(LOG_INFO, "db: closing database %02x", i);
 313                 ret = dbp[i]->close(dbp[i], 0);
 314                 if (ret) {
 315                         syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret));
 316                 }
 317
 318         }
 319
 320         // This seemed nifty at the time but did anyone really look at it?
 321         // #ifdef DB_STAT_ALL
 322         // dbenv->lock_stat_print(dbenv, DB_STAT_ALL);
 323         // #endif
 324
 325         // Close the handle.
 326         ret = dbenv->close(dbenv, 0);
 327         if (ret) {
 328                 syslog(LOG_ERR, "db: DBENV->close: %s", db_strerror(ret));
 329         }
 330 }
 331
 332
 333 // Decompress a database item if it was compressed on disk
 334 void cdb_decompress_if_necessary(struct cdbdata *cdb) {
 335         static int magic = COMPRESS_MAGIC;
 336
 337         if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) {
 338                 return;
 339         }
 340
 341         // At this point we know we're looking at a compressed item.
 342
 343         struct CtdlCompressHeader zheader;
 344         char *uncompressed_data;
 345         char *compressed_data;
 346         uLongf destLen, sourceLen;
 347         size_t cplen;
 348
 349         memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
 350         cplen = sizeof(struct CtdlCompressHeader);
 351         if (sizeof(struct CtdlCompressHeader) > cdb->len) {
 352                 cplen = cdb->len;
 353         }
 354         memcpy(&zheader, cdb->ptr, cplen);
 355
 356         compressed_data = cdb->ptr;
 357         compressed_data += sizeof(struct CtdlCompressHeader);
 358
 359         sourceLen = (uLongf) zheader.compressed_len;
 360         destLen = (uLongf) zheader.uncompressed_len;
 361         uncompressed_data = malloc(zheader.uncompressed_len);
 362
 363         if (uncompress((Bytef *) uncompressed_data,
 364                        (uLongf *) &destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
 365                 syslog(LOG_ERR, "db: uncompress() error");
 366                 cdb_abort();
 367         }
 368
 369         free(cdb->ptr);
 370         cdb->len = (size_t) destLen;
 371         cdb->ptr = uncompressed_data;
 372 }
 373
 374
 375 // Store a piece of data.  Returns 0 if the operation was successful.  If a
 376 // key already exists it should be overwritten.
 377 int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) {
 378
 379         DBT dkey, ddata;
 380         DB_TXN *tid = NULL;
 381         int ret = 0;
 382         struct CtdlCompressHeader zheader;
 383         char *compressed_data = NULL;
 384         int compressing = 0;
 385         size_t buffer_len = 0;
 386         uLongf destLen = 0;
 387
 388         memset(&dkey, 0, sizeof(DBT));
 389         memset(&ddata, 0, sizeof(DBT));
 390         dkey.size = ckeylen;
 391         dkey.data = (void *) ckey;
 392         ddata.size = cdatalen;
 393         ddata.data = cdata;
 394
 395         // "visit" records are numerous and have big, mostly-empty string buffers in them.
 396         // If we compress these we can get them down to 1% of their size most of the time.
 397         if (cdb == CDB_VISIT) {
 398                 compressing = 1;
 399                 zheader.magic = COMPRESS_MAGIC;
 400                 zheader.uncompressed_len = cdatalen;
 401                 buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader);
 402                 destLen = (uLongf) buffer_len;
 403                 compressed_data = malloc(buffer_len);
 404                 if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
 405                         syslog(LOG_ERR, "db: compress2() error");
 406                         cdb_abort();
 407                 }
 408                 zheader.compressed_len = (size_t) destLen;
 409                 memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader));
 410                 ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len);
 411                 ddata.data = compressed_data;
 412         }
 413
 414         if (TSD->tid != NULL) {
 415                 ret = dbp[cdb]->put(dbp[cdb],   // db
 416                                     TSD->tid,   // transaction ID
 417                                     &dkey,      // key
 418                                     &ddata,     // data
 419                                     0           // flags
 420                 );
 421                 if (ret) {
 422                         syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
 423                         cdb_abort();
 424                 }
 425                 if (compressing) {
 426                         free(compressed_data);
 427                 }
 428                 return ret;
 429         }
 430         else {
 431                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 432
 433               retry:
 434                 txbegin(&tid);
 435
 436                 if ((ret = dbp[cdb]->put(dbp[cdb],      // db
 437                                          tid,           // transaction ID
 438                                          &dkey,         // key
 439                                          &ddata,        // data
 440                                          0))) {         // flags
 441                         if (ret == DB_LOCK_DEADLOCK) {
 442                                 txabort(tid);
 443                                 goto retry;
 444                         }
 445                         else {
 446                                 syslog(LOG_ERR, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
 447                                 cdb_abort();
 448                         }
 449                 }
 450                 else {
 451                         txcommit(tid);
 452                         if (compressing) {
 453                                 free(compressed_data);
 454                         }
 455                         return ret;
 456                 }
 457         }
 458         return ret;
 459 }
 460
 461
 462 // Delete a piece of data.  Returns 0 if the operation was successful.
 463 int cdb_delete(int cdb, void *key, int keylen) {
 464         DBT dkey;
 465         DB_TXN *tid;
 466         int ret;
 467
 468         memset(&dkey, 0, sizeof dkey);
 469         dkey.size = keylen;
 470         dkey.data = key;
 471
 472         if (TSD->tid != NULL) {
 473                 ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0);
 474                 if (ret) {
 475                         syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
 476                         if (ret != DB_NOTFOUND) {
 477                                 cdb_abort();
 478                         }
 479                 }
 480         }
 481         else {
 482                 bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor");
 483
 484               retry:
 485                 txbegin(&tid);
 486
 487                 if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) {
 488                         if (ret == DB_LOCK_DEADLOCK) {
 489                                 txabort(tid);
 490                                 goto retry;
 491                         }
 492                         else {
 493                                 syslog(LOG_ERR, "db: cdb_delete(%d): %s", cdb, db_strerror(ret));
 494                                 cdb_abort();
 495                         }
 496                 }
 497                 else {
 498                         txcommit(tid);
 499                 }
 500         }
 501         return ret;
 502 }
 503
 504
 505 static DBC *localcursor(int cdb) {
 506         int ret;
 507         DBC *curs;
 508
 509         if (TSD->cursors[cdb] == NULL) {
 510                 ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
 511         }
 512         else {
 513                 ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
 514         }
 515
 516         if (ret) {
 517                 syslog(LOG_ERR, "db: localcursor: %s", db_strerror(ret));
 518                 cdb_abort();
 519         }
 520
 521         return curs;
 522 }
 523
 524
 525 // Fetch a piece of data.  If not found, returns NULL.  Otherwise, it returns
 526 // a struct cdbdata which it is the caller's responsibility to free later on
 527 // using the cdb_free() routine.
 528 struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) {
 529
 530         if (keylen == 0) {              // key length zero is impossible
 531                 return(NULL);
 532         }
 533
 534         struct cdbdata *tempcdb;
 535         DBT dkey, dret;
 536         int ret;
 537
 538         memset(&dkey, 0, sizeof(DBT));
 539         dkey.size = keylen;
 540         dkey.data = (void *) key;
 541
 542         if (TSD->tid != NULL) {
 543                 memset(&dret, 0, sizeof(DBT));
 544                 dret.flags = DB_DBT_MALLOC;
 545                 ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0);
 546         }
 547         else {
 548                 DBC *curs;
 549
 550                 do {
 551                         memset(&dret, 0, sizeof(DBT));
 552                         dret.flags = DB_DBT_MALLOC;
 553                         curs = localcursor(cdb);
 554                         ret = curs->c_get(curs, &dkey, &dret, DB_SET);
 555                         cclose(curs);
 556                 } while (ret == DB_LOCK_DEADLOCK);
 557         }
 558
 559         if ((ret != 0) && (ret != DB_NOTFOUND)) {
 560                 syslog(LOG_ERR, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret));
 561                 cdb_abort();
 562         }
 563
 564         if (ret != 0) {
 565                 return NULL;
 566         }
 567
 568         tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 569         if (tempcdb == NULL) {
 570                 syslog(LOG_ERR, "db: cdb_fetch() cannot allocate memory for tempcdb: %m");
 571                 cdb_abort();
 572         }
 573         else {
 574                 tempcdb->len = dret.size;
 575                 tempcdb->ptr = dret.data;
 576                 cdb_decompress_if_necessary(tempcdb);
 577                 return (tempcdb);
 578         }
 579 }
 580
 581
 582 // Free a cdbdata item.
 583 //
 584 // Note that we only free the 'ptr' portion if it is not NULL.  This allows
 585 // other code to assume ownership of that memory simply by storing the
 586 // pointer elsewhere and then setting 'ptr' to NULL.  cdb_free() will then
 587 // avoid freeing it.
 588 void cdb_free(struct cdbdata *cdb) {
 589         if (cdb->ptr) {
 590                 free(cdb->ptr);
 591         }
 592         free(cdb);
 593 }
 594
 595
 596 void cdb_close_cursor(int cdb) {
 597         if (TSD->cursors[cdb] != NULL) {
 598                 cclose(TSD->cursors[cdb]);
 599         }
 600
 601         TSD->cursors[cdb] = NULL;
 602 }
 603
 604
 605 // Prepare for a sequential search of an entire database.
 606 // (There is guaranteed to be no more than one traversal in
 607 // progress per thread at any given time.)
 608 void cdb_rewind(int cdb) {
 609         int ret = 0;
 610
 611         if (TSD->cursors[cdb] != NULL) {
 612                 syslog(LOG_ERR, "db: cdb_rewind: must close cursor on database %d before reopening", cdb);
 613                 cdb_abort();
 614                 // cclose(TSD->cursors[cdb]);
 615         }
 616
 617         // Now initialize the cursor
 618         ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0);
 619         if (ret) {
 620                 syslog(LOG_ERR, "db: cdb_rewind: db_cursor: %s", db_strerror(ret));
 621                 cdb_abort();
 622         }
 623 }
 624
 625
 626 // Fetch the next item in a sequential search.  Returns a pointer to a
 627 // cdbdata structure, or NULL if we've hit the end.
 628 struct cdbdata *cdb_next_item(int cdb) {
 629         DBT key, data;
 630         struct cdbdata *cdbret;
 631         int ret = 0;
 632
 633         // Initialize the key/data pair so the flags aren't set.
 634         memset(&key, 0, sizeof(key));
 635         memset(&data, 0, sizeof(data));
 636         data.flags = DB_DBT_MALLOC;
 637
 638         ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT);
 639
 640         if (ret) {
 641                 if (ret != DB_NOTFOUND) {
 642                         syslog(LOG_ERR, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret));
 643                         cdb_abort();
 644                 }
 645                 cdb_close_cursor(cdb);
 646                 return NULL;    // presumably, end of file
 647         }
 648
 649         cdbret = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 650         cdbret->len = data.size;
 651         cdbret->ptr = data.data;
 652         cdb_decompress_if_necessary(cdbret);
 653
 654         return (cdbret);
 655 }
 656
 657
 658 // Transaction-based stuff.  I'm writing this as I bake cookies...
 659 void cdb_begin_transaction(void) {
 660         bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor");
 661
 662         if (TSD->tid != NULL) {
 663                 syslog(LOG_ERR, "db: cdb_begin_transaction: ERROR: nested transaction");
 664                 cdb_abort();
 665         }
 666
 667         txbegin(&TSD->tid);
 668 }
 669
 670
 671 void cdb_end_transaction(void) {
 672         int i;
 673
 674         for (i = 0; i < MAXCDB; i++) {
 675                 if (TSD->cursors[i] != NULL) {
 676                         syslog(LOG_WARNING, "db: cdb_end_transaction: WARNING: cursor %d still open at transaction end", i);
 677                         cclose(TSD->cursors[i]);
 678                         TSD->cursors[i] = NULL;
 679                 }
 680         }
 681
 682         if (TSD->tid == NULL) {
 683                 syslog(LOG_ERR, "db: cdb_end_transaction: ERROR: txcommit(NULL) !!");
 684                 cdb_abort();
 685         }
 686         else {
 687                 txcommit(TSD->tid);
 688         }
 689
 690         TSD->tid = NULL;
 691 }
 692
 693
 694 // Truncate (delete every record)
 695 void cdb_trunc(int cdb) {
 696         int ret;
 697         u_int32_t count;
 698
 699         if (TSD->tid != NULL) {
 700                 syslog(LOG_ERR, "db: cdb_trunc must not be called in a transaction.");
 701                 cdb_abort();
 702         }
 703         else {
 704                 bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 705
 706               retry:
 707
 708                 if ((ret = dbp[cdb]->truncate(dbp[cdb], // db
 709                                               NULL,     // transaction ID
 710                                               &count,   // #rows deleted
 711                                               0))) {    // flags
 712                         if (ret == DB_LOCK_DEADLOCK) {
 713                                 goto retry;
 714                         }
 715                         else {
 716                                 syslog(LOG_ERR, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret));
 717                                 if (ret == ENOMEM) {
 718                                         syslog(LOG_ERR, "db: You may need to tune your database; please read http://www.citadel.org for more information.");
 719                                 }
 720                                 exit(CTDLEXIT_DB);
 721                         }
 722                 }
 723         }
 724 }
 725
 726
 727 // compact (defragment) the database, possibly returning space back to the underlying filesystem
 728 void cdb_compact(void) {
 729         int ret;
 730         int i;
 731
 732         syslog(LOG_DEBUG, "db: cdb_compact() started");
 733         for (i = 0; i < MAXCDB; i++) {
 734                 syslog(LOG_DEBUG, "db: compacting database %d", i);
 735                 ret = dbp[i]->compact(dbp[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL);
 736                 if (ret) {
 737                         syslog(LOG_ERR, "db: compact: %s", db_strerror(ret));
 738                 }
 739         }
 740         syslog(LOG_DEBUG, "db: cdb_compact() finished");
 741 }
 742
 743
 744 // Has an item already been seen (is it in the CDB_USETABLE) ?
 745 // Returns 0 if it hasn't, 1 if it has
 746 // In either case, writes the item to the database for next time.
 747 int CheckIfAlreadySeen(StrBuf *guid) {
 748         int found = 0;
 749         struct UseTable ut;
 750         struct cdbdata *cdbut;
 751         int hash = HashLittle(ChrPtr(guid), StrLength(guid));
 752
 753         syslog(LOG_DEBUG, "db: CheckIfAlreadySeen(0x%8x)", hash);
 754         cdbut = cdb_fetch(CDB_USETABLE, &hash, sizeof(hash));
 755         if (cdbut != NULL) {
 756                 found = 1;
 757                 cdb_free(cdbut);
 758         }
 759
 760         // (Re)write the record, to update the timestamp.
 761         ut.hash = hash;
 762         ut.timestamp = time(NULL);
 763         cdb_store(CDB_USETABLE, &hash, sizeof(hash), &ut, sizeof(struct UseTable));
 764         return (found);
 765 }
 766
 767
 768 char *ctdl_module_init_database() {
 769         if (!threading) {
 770                 // nothing to do here
 771         }
 772
 773         // return our module id for the log
 774         return "database";
 775 }