citadel/database.c

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