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