citadel/database.c

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