citadel/database.c

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