citadel/database.c

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