citadel/database.c

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