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