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