citadel/database.c

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