X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fdatabase.c;h=8b5820edb1a5eb9d0e229bf52b33d3f78154fa62;hb=0566e798cbfc711e22b2e7328ed1d07a14265313;hp=92b993f471582fe9c181e1fde3050ec8eace5fe3;hpb=2f58ab6f74735280dc60aa1449ba1195994982f9;p=citadel.git diff --git a/citadel/database.c b/citadel/database.c index 92b993f47..8b5820edb 100644 --- a/citadel/database.c +++ b/citadel/database.c @@ -1,8 +1,15 @@ /* - * $Id$ - * * This is a data store backend for the Citadel server which uses Berkeley DB. * + * Copyright (c) 1987-2019 by the citadel.org team + * + * This program is open source software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License version 3. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. */ /***************************************************************************** @@ -21,68 +28,54 @@ #include "sysdep.h" #include #include -#include -#include -#include -#include -#include #include +#include #include +#include -#ifdef HAVE_DB_H #include -#elif defined(HAVE_DB4_DB_H) -#include -#else -#error Neither nor was found by configure. Install db4-devel. -#endif - -#if DB_VERSION_MAJOR < 4 || DB_VERSION_MINOR < 1 -#error Citadel requires Berkeley DB v4.1 or newer. Please upgrade. +#if DB_VERSION_MAJOR < 5 +#error Citadel requires Berkeley DB v5.0 or newer. Please upgrade. #endif - #include -#include "citadel.h" -#include "server.h" -#include "citserver.h" -#include "database.h" -#include "msgbase.h" -#include "sysdep_decls.h" -#include "threads.h" -#include "config.h" -#include "control.h" #include "ctdl_module.h" - +#include "control.h" +#include "citserver.h" +#include "config.h" static DB *dbp[MAXCDB]; /* One DB handle for each Citadel database */ static DB_ENV *dbenv; /* The DB environment (global) */ -#ifdef HAVE_ZLIB -#include -#endif +void cdb_abort(void) +{ + syslog(LOG_DEBUG, "db: citserver is stopping in order to prevent data loss. uid=%d gid=%d euid=%d egid=%d", + getuid(), getgid(), geteuid(), getegid() + ); + exit(CTDLEXIT_DB); +} /* Verbose logging callback */ -void cdb_verbose_log(const DB_ENV *dbenv, const char *msg) +void cdb_verbose_log(const DB_ENV * dbenv, const char *msg) { if (!IsEmptyStr(msg)) { - CtdlLogPrintf(CTDL_DEBUG, "DB: %s\n", msg); + syslog(LOG_DEBUG, "db: %s", msg); } } /* Verbose logging callback */ -void cdb_verbose_err(const DB_ENV *dbenv, const char *errpfx, const char *msg) +void cdb_verbose_err(const DB_ENV * dbenv, const char *errpfx, const char *msg) { - CtdlLogPrintf(CTDL_ALERT, "DB: %s\n", msg); + syslog(LOG_ERR, "db: %s", msg); } -/* just a little helper function */ +/* wrapper for txn_abort() that logs/aborts on error */ static void txabort(DB_TXN * tid) { int ret; @@ -90,13 +83,13 @@ static void txabort(DB_TXN * tid) ret = tid->abort(tid); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_abort: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_ERR, "db: txn_abort: %s", db_strerror(ret)); + cdb_abort(); } } -/* this one is even more helpful than the last. */ + +/* wrapper for txn_commit() that logs/aborts on error */ static void txcommit(DB_TXN * tid) { int ret; @@ -104,13 +97,13 @@ static void txcommit(DB_TXN * tid) ret = tid->commit(tid, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_commit: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_ERR, "db: txn_commit: %s", db_strerror(ret)); + cdb_abort(); } } -/* are you sensing a pattern yet? */ + +/* wrapper for txn_begin() that logs/aborts on error */ static void txbegin(DB_TXN ** tid) { int ret; @@ -118,110 +111,52 @@ static void txbegin(DB_TXN ** tid) ret = dbenv->txn_begin(dbenv, NULL, tid, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: txn_begin: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_ERR, "db: txn_begin: %s", db_strerror(ret)); + cdb_abort(); } } + +/* panic callback */ static void dbpanic(DB_ENV * env, int errval) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: Berkeley DB panic: %d\n", errval); + syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval)); } + static void cclose(DBC * cursor) { int ret; if ((ret = cursor->c_close(cursor))) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: c_close: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_ERR, "db: c_close: %s", db_strerror(ret)); + cdb_abort(); } } + static void bailIfCursor(DBC ** cursors, const char *msg) { int i; for (i = 0; i < MAXCDB; i++) if (cursors[i] != NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_*: cursor still in progress on cdb %02x: %s\n", - i, msg); - abort(); + syslog(LOG_ERR, "db: cursor still in progress on cdb %02x: %s", i, msg); + cdb_abort(); } } -void check_handles(void *arg) -{ - if (arg != NULL) { - ThreadTSD *tsd = (ThreadTSD *) arg; - - bailIfCursor(tsd->cursors, "in check_handles"); - - if (tsd->tid != NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_*: transaction still in progress!"); - abort(); - } - } -} void cdb_check_handles(void) { - check_handles(pthread_getspecific(ThreadKey)); -} - - -/* - * Cull the database logs - */ -static void cdb_cull_logs(void) -{ - u_int32_t flags; - int ret; - char **file, **list; - char errmsg[SIZ]; - - flags = DB_ARCH_ABS; + bailIfCursor(TSD->cursors, "in check_handles"); - /* Get the list of names. */ - if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) { - CtdlLogPrintf(CTDL_ERR, "cdb_cull_logs: %s\n", db_strerror(ret)); - return; - } - - /* Print the list of names. */ - if (list != NULL) { - for (file = list; *file != NULL; ++file) { - CtdlLogPrintf(CTDL_DEBUG, "Deleting log: %s\n", *file); - ret = unlink(*file); - if (ret != 0) { - snprintf(errmsg, sizeof(errmsg), - " ** ERROR **\n \n \n " - "Citadel was unable to delete the " - "database log file '%s' because of the " - "following error:\n \n %s\n \n" - " This log file is no longer in use " - "and may be safely deleted.\n", - *file, strerror(errno)); - aide_message(errmsg, "Database Warning Message"); - } - } - free(list); + if (TSD->tid != NULL) { + syslog(LOG_ERR, "db: transaction still in progress!"); + cdb_abort(); } } -/* - * Manually initiate log file cull. - */ -void cmd_cull(char *argbuf) { - if (CtdlAccessCheck(ac_internal)) return; - cdb_cull_logs(); - cprintf("%d Database log file cull completed.\n", CIT_OK); -} - /* * Request a checkpoint of the database. Called once per minute by the thread manager. @@ -230,25 +165,24 @@ void cdb_checkpoint(void) { int ret; - CtdlLogPrintf(CTDL_DEBUG, "-- db checkpoint --\n"); - ret = dbenv->txn_checkpoint(dbenv, - MAX_CHECKPOINT_KBYTES, - MAX_CHECKPOINT_MINUTES, 0); + syslog(LOG_DEBUG, "db: -- checkpoint --"); + ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0); if (ret != 0) { - CtdlLogPrintf(CTDL_EMERG, "cdb_checkpoint: txn_checkpoint: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_ERR, "db: cdb_checkpoint() txn_checkpoint: %s", db_strerror(ret)); + cdb_abort(); } /* After a successful checkpoint, we can cull the unused logs */ - if (config.c_auto_cull) { - cdb_cull_logs(); + if (CtdlGetConfigInt("c_auto_cull")) { + ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1); + } + else { + ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0); } } - /* * Open the various databases we'll be using. Any database which * does not exist should be created. Note that we don't need a @@ -262,57 +196,37 @@ void open_databases(void) char dbfilename[32]; u_int32_t flags = 0; int dbversion_major, dbversion_minor, dbversion_patch; - int current_dbversion = 0; - - CtdlLogPrintf(CTDL_DEBUG, "cdb_*: open_databases() starting\n"); - CtdlLogPrintf(CTDL_DEBUG, "Compiled db: %s\n", DB_VERSION_STRING); - CtdlLogPrintf(CTDL_INFO, " Linked db: %s\n", - db_version(&dbversion_major, &dbversion_minor, &dbversion_patch)); - - current_dbversion = (dbversion_major * 1000000) + (dbversion_minor * 1000) + dbversion_patch; - CtdlLogPrintf(CTDL_DEBUG, "Calculated dbversion: %d\n", current_dbversion); - CtdlLogPrintf(CTDL_DEBUG, " Previous dbversion: %d\n", CitControl.MMdbversion); - - if ( (getenv("SUPPRESS_DBVERSION_CHECK") == NULL) - && (CitControl.MMdbversion > current_dbversion) ) { - CtdlLogPrintf(CTDL_EMERG, "You are attempting to run the Citadel server using a version\n" - "of Berkeley DB that is older than that which last created or\n" - "updated the database. Because this would probably cause data\n" - "corruption or loss, the server is aborting execution now.\n"); - exit(CTDLEXIT_DB); - } - - CitControl.MMdbversion = current_dbversion; - put_control(); - -#ifdef HAVE_ZLIB - CtdlLogPrintf(CTDL_INFO, "Linked zlib: %s\n", zlibVersion()); -#endif + syslog(LOG_DEBUG, "db: open_databases() starting"); + syslog(LOG_DEBUG, "db: Compiled libdb: %s", DB_VERSION_STRING); + syslog(LOG_DEBUG, "db: Linked libdb: %s", db_version(&dbversion_major, &dbversion_minor, &dbversion_patch)); + syslog(LOG_DEBUG, "db: Linked zlib: %s", zlibVersion()); /* - * Silently try to create the database subdirectory. If it's - * already there, no problem. + * Silently try to create the database subdirectory. If it's already there, no problem. */ - mkdir(ctdl_data_dir, 0700); - chmod(ctdl_data_dir, 0700); - chown(ctdl_data_dir, CTDLUID, (-1)); - - CtdlLogPrintf(CTDL_DEBUG, "cdb_*: Setting up DB environment\n"); - db_env_set_func_yield(sched_yield); + if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)) { + syslog(LOG_ERR, "db: unable to create database directory [%s]: %m", ctdl_data_dir); + } + if (chmod(ctdl_data_dir, 0700) != 0) { + syslog(LOG_ERR, "db: unable to set database directory permissions [%s]: %m", ctdl_data_dir); + } + if (chown(ctdl_data_dir, CTDLUID, (-1)) != 0) { + syslog(LOG_ERR, "db: unable to set the owner for [%s]: %m", ctdl_data_dir); + } + syslog(LOG_DEBUG, "db: Setting up DB environment"); + // db_env_set_func_yield((int (*)(u_long, u_long))sched_yield); ret = db_env_create(&dbenv, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: db_env_create: %s\n", db_strerror(ret)); - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: db_env_create: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } dbenv->set_errpfx(dbenv, "citserver"); dbenv->set_paniccall(dbenv, dbpanic); dbenv->set_errcall(dbenv, cdb_verbose_err); dbenv->set_errpfx(dbenv, "ctdl"); -#if (DB_VERSION_MAJOR == 4) && (DB_VERSION_MINOR >= 3) dbenv->set_msgcall(dbenv, cdb_verbose_log); -#endif dbenv->set_verbose(dbenv, DB_VERB_DEADLOCK, 1); dbenv->set_verbose(dbenv, DB_VERB_RECOVERY, 1); @@ -322,84 +236,70 @@ void open_databases(void) */ ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: set_cachesize: %s\n", db_strerror(ret)); + syslog(LOG_ERR, "db: set_cachesize: %s", db_strerror(ret)); dbenv->close(dbenv, 0); - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) { - CtdlLogPrintf(CTDL_EMERG, "cdb_*: set_lk_detect: %s\n", db_strerror(ret)); + syslog(LOG_ERR, "db: set_lk_detect: %s", db_strerror(ret)); dbenv->close(dbenv, 0); - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } - flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_RECOVER; - CtdlLogPrintf(CTDL_DEBUG, "dbenv->open(dbenv, %s, %d, 0)\n", ctdl_data_dir, flags); - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); + flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_TXN | DB_INIT_LOCK | DB_THREAD | DB_INIT_LOG; + syslog(LOG_DEBUG, "db: dbenv->open(dbenv, %s, %d, 0)", ctdl_data_dir, flags); + ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try opening the database cleanly if (ret == DB_RUNRECOVERY) { - CtdlLogPrintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret)); - CtdlLogPrintf(CTDL_ALERT, "Attempting recovery...\n"); + syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: attempting recovery..."); flags |= DB_RECOVER; - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); + ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try recovery } if (ret == DB_RUNRECOVERY) { - CtdlLogPrintf(CTDL_ALERT, "dbenv->open: %s\n", db_strerror(ret)); - CtdlLogPrintf(CTDL_ALERT, "Attempting catastrophic recovery...\n"); + syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: attempting catastrophic recovery..."); flags &= ~DB_RECOVER; flags |= DB_RECOVER_FATAL; - ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); + ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0); // try catastrophic recovery } if (ret) { - CtdlLogPrintf(CTDL_EMERG, "dbenv->open: %s\n", db_strerror(ret)); + syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret)); dbenv->close(dbenv, 0); - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } - CtdlLogPrintf(CTDL_INFO, "Starting up DB\n"); - + syslog(LOG_INFO, "db: mounting databases"); for (i = 0; i < MAXCDB; ++i) { - - /* Create a database handle */ - ret = db_create(&dbp[i], dbenv, 0); + ret = db_create(&dbp[i], dbenv, 0); // Create a database handle if (ret) { - CtdlLogPrintf(CTDL_EMERG, "db_create: %s\n", db_strerror(ret)); - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: db_create: %s", db_strerror(ret)); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } - - /* Arbitrary names for our tables -- we reference them by - * number, so we don't have string names for them. - */ - snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i); - - ret = dbp[i]->open(dbp[i], - NULL, - dbfilename, - NULL, - DB_BTREE, - DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, - 0600); + snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", i); // table names by number + ret = dbp[i]->open(dbp[i], NULL, dbfilename, NULL, DB_BTREE, DB_CREATE | DB_AUTO_COMMIT | DB_THREAD, 0600); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "db_open[%02x]: %s\n", i, db_strerror(ret)); + syslog(LOG_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret)); if (ret == ENOMEM) { - CtdlLogPrintf(CTDL_EMERG, "You may need to tune your database; please read http://www.citadel.org/doku.php/faq:troubleshooting:out_of_lock_entries for more information.\n"); + 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."); } - CtdlLogPrintf(CTDL_EMERG, "exit code %d\n", ret); + syslog(LOG_ERR, "db: exit code %d", ret); exit(CTDLEXIT_DB); } } - } -/* Make sure we own all the files, because in a few milliseconds - * we're going to drop root privs. +/* + * Make sure we own all the files, because in a few milliseconds we're going to drop root privs. */ -void cdb_chmod_data(void) { +void cdb_chmod_data(void) +{ DIR *dp; struct dirent *d; char filename[PATH_MAX]; @@ -408,22 +308,15 @@ void cdb_chmod_data(void) { if (dp != NULL) { while (d = readdir(dp), d != NULL) { if (d->d_name[0] != '.') { - snprintf(filename, sizeof filename, - "%s/%s", ctdl_data_dir, d->d_name); - CtdlLogPrintf(9, "chmod(%s, 0600) returned %d\n", - filename, chmod(filename, 0600) - ); - CtdlLogPrintf(9, "chown(%s, CTDLUID, -1) returned %d\n", + snprintf(filename, sizeof filename, "%s/%s", ctdl_data_dir, d->d_name); + syslog(LOG_DEBUG, "db: chmod(%s, 0600) returned %d", filename, chmod(filename, 0600)); + syslog(LOG_DEBUG, "db: chown(%s, CTDLUID, -1) returned %d", filename, chown(filename, CTDLUID, (-1)) ); } } closedir(dp); } - - CtdlLogPrintf(CTDL_DEBUG, "open_databases() finished\n"); - - CtdlRegisterProtoHook(cmd_cull, "CULL", "Cull database logs"); } @@ -433,28 +326,31 @@ void cdb_chmod_data(void) { */ void close_databases(void) { - int a; + int i; int ret; - ctdl_thread_internal_free_tsd(); - + syslog(LOG_INFO, "db: performing final checkpoint"); if ((ret = dbenv->txn_checkpoint(dbenv, 0, 0, 0))) { - CtdlLogPrintf(CTDL_EMERG, - "txn_checkpoint: %s\n", db_strerror(ret)); + syslog(LOG_ERR, "txn_checkpoint: %s", db_strerror(ret)); + } + + syslog(LOG_INFO, "db: flushing the database logs"); + if ((ret = dbenv->log_flush(dbenv, NULL))) { + syslog(LOG_ERR, "db: log_flush: %s", db_strerror(ret)); } - /* print some statistics... */ #ifdef DB_STAT_ALL + /* print some statistics... */ dbenv->lock_stat_print(dbenv, DB_STAT_ALL); #endif /* close the tables */ - for (a = 0; a < MAXCDB; ++a) { - CtdlLogPrintf(CTDL_INFO, "Closing database %02x\n", a); - ret = dbp[a]->close(dbp[a], 0); + syslog(LOG_INFO, "db: closing databases"); + for (i = 0; i < MAXCDB; ++i) { + syslog(LOG_INFO, "db: closing database %02x", i); + ret = dbp[i]->close(dbp[i], 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, - "db_close: %s\n", db_strerror(ret)); + syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret)); } } @@ -462,35 +358,36 @@ void close_databases(void) /* Close the handle. */ ret = dbenv->close(dbenv, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, - "DBENV->close: %s\n", db_strerror(ret)); + syslog(LOG_EMERG, "db: DBENV->close: %s", db_strerror(ret)); } } /* - * Compression functions only used if we have zlib + * Decompress a database item if it was compressed on disk */ void cdb_decompress_if_necessary(struct cdbdata *cdb) { static int magic = COMPRESS_MAGIC; - if (cdb == NULL) - return; - if (cdb->ptr == NULL) - return; - if (memcmp(cdb->ptr, &magic, sizeof(magic))) + if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) { return; + } -#ifdef HAVE_ZLIB /* At this point we know we're looking at a compressed item. */ struct CtdlCompressHeader zheader; char *uncompressed_data; char *compressed_data; uLongf destLen, sourceLen; + size_t cplen; - memcpy(&zheader, cdb->ptr, sizeof(struct CtdlCompressHeader)); + memset(&zheader, 0, sizeof(struct CtdlCompressHeader)); + cplen = sizeof(struct CtdlCompressHeader); + if (sizeof(struct CtdlCompressHeader) > cdb->len) { + cplen = cdb->len; + } + memcpy(&zheader, cdb->ptr, cplen); compressed_data = cdb->ptr; compressed_data += sizeof(struct CtdlCompressHeader); @@ -500,97 +397,77 @@ void cdb_decompress_if_necessary(struct cdbdata *cdb) uncompressed_data = malloc(zheader.uncompressed_len); if (uncompress((Bytef *) uncompressed_data, - (uLongf *) & destLen, - (const Bytef *) compressed_data, - (uLong) sourceLen) != Z_OK) { - CtdlLogPrintf(CTDL_EMERG, "uncompress() error\n"); - abort(); + (uLongf *) & destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) { + syslog(LOG_EMERG, "db: uncompress() error"); + cdb_abort(); } free(cdb->ptr); cdb->len = (size_t) destLen; cdb->ptr = uncompressed_data; -#else /* HAVE_ZLIB */ - CtdlLogPrintf(CTDL_EMERG, "Database contains compressed data, but this citserver was built without compression support.\n"); - abort(); -#endif /* HAVE_ZLIB */ } - /* * Store a piece of data. Returns 0 if the operation was successful. If a * key already exists it should be overwritten. */ -int cdb_store(int cdb, void *ckey, int ckeylen, void *cdata, int cdatalen) +int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen) { DBT dkey, ddata; DB_TXN *tid; int ret = 0; -#ifdef HAVE_ZLIB struct CtdlCompressHeader zheader; char *compressed_data = NULL; int compressing = 0; size_t buffer_len = 0; uLongf destLen = 0; -#endif memset(&dkey, 0, sizeof(DBT)); memset(&ddata, 0, sizeof(DBT)); dkey.size = ckeylen; - dkey.data = ckey; + dkey.data = (void *) ckey; ddata.size = cdatalen; ddata.data = cdata; -#ifdef HAVE_ZLIB - /* Only compress Visit records. Everything else is uncompressed. */ - if (cdb == CDB_VISIT) { + /* Only compress Visit and UseTable records. Everything else is uncompressed. */ + if ((cdb == CDB_VISIT) || (cdb == CDB_USETABLE)) { compressing = 1; zheader.magic = COMPRESS_MAGIC; zheader.uncompressed_len = cdatalen; - buffer_len = ((cdatalen * 101) / 100) + 100 - + sizeof(struct CtdlCompressHeader); + buffer_len = ((cdatalen * 101) / 100) + 100 + sizeof(struct CtdlCompressHeader); destLen = (uLongf) buffer_len; compressed_data = malloc(buffer_len); - if (compress2((Bytef *) (compressed_data + - sizeof(struct - CtdlCompressHeader)), - &destLen, (Bytef *) cdata, (uLongf) cdatalen, - 1) != Z_OK) { - CtdlLogPrintf(CTDL_EMERG, "compress2() error\n"); - abort(); + if (compress2((Bytef *) (compressed_data + sizeof(struct CtdlCompressHeader)), + &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) { + syslog(LOG_EMERG, "db: compress2() error"); + cdb_abort(); } zheader.compressed_len = (size_t) destLen; - memcpy(compressed_data, &zheader, - sizeof(struct CtdlCompressHeader)); - ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + - zheader.compressed_len); + memcpy(compressed_data, &zheader, sizeof(struct CtdlCompressHeader)); + ddata.size = (size_t) (sizeof(struct CtdlCompressHeader) + zheader.compressed_len); ddata.data = compressed_data; } -#endif - if (MYTID != NULL) { - ret = dbp[cdb]->put(dbp[cdb], /* db */ - MYTID, /* transaction ID */ - &dkey, /* key */ - &ddata, /* data */ - 0); /* flags */ + if (TSD->tid != NULL) { + ret = dbp[cdb]->put(dbp[cdb], // db + TSD->tid, // transaction ID + &dkey, // key + &ddata, // data + 0 // flags + ); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_store(%d): %s\n", cdb, - db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); + cdb_abort(); } -#ifdef HAVE_ZLIB - if (compressing) + if (compressing) { free(compressed_data); -#endif + } return ret; - } else { - bailIfCursor(MYCURSORS, - "attempt to write during r/o cursor"); + bailIfCursor(TSD->cursors, "attempt to write during r/o cursor"); retry: txbegin(&tid); @@ -604,19 +481,18 @@ int cdb_store(int cdb, void *ckey, int ckeylen, void *cdata, int cdatalen) txabort(tid); goto retry; } else { - CtdlLogPrintf(CTDL_EMERG, "cdb_store(%d): %s\n", - cdb, db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret)); + cdb_abort(); } } else { txcommit(tid); -#ifdef HAVE_ZLIB - if (compressing) + if (compressing) { free(compressed_data); -#endif + } return ret; } } + return ret; } @@ -634,30 +510,27 @@ int cdb_delete(int cdb, void *key, int keylen) dkey.size = keylen; dkey.data = key; - if (MYTID != NULL) { - ret = dbp[cdb]->del(dbp[cdb], MYTID, &dkey, 0); + if (TSD->tid != NULL) { + ret = dbp[cdb]->del(dbp[cdb], TSD->tid, &dkey, 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_delete(%d): %s\n", cdb, - db_strerror(ret)); - if (ret != DB_NOTFOUND) - abort(); + syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); + if (ret != DB_NOTFOUND) { + cdb_abort(); + } } } else { - bailIfCursor(MYCURSORS, - "attempt to delete during r/o cursor"); + bailIfCursor(TSD->cursors, "attempt to delete during r/o cursor"); retry: txbegin(&tid); - if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) - && ret != DB_NOTFOUND) { + if ((ret = dbp[cdb]->del(dbp[cdb], tid, &dkey, 0)) && ret != DB_NOTFOUND) { if (ret == DB_LOCK_DEADLOCK) { txabort(tid); goto retry; } else { - CtdlLogPrintf(CTDL_EMERG, "cdb_delete(%d): %s\n", - cdb, db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_delete(%d): %s", cdb, db_strerror(ret)); + cdb_abort(); } } else { txcommit(tid); @@ -666,21 +539,22 @@ int cdb_delete(int cdb, void *key, int keylen) return ret; } + static DBC *localcursor(int cdb) { int ret; DBC *curs; - if (MYCURSORS[cdb] == NULL) - ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &curs, 0); - else - ret = - MYCURSORS[cdb]->c_dup(MYCURSORS[cdb], &curs, - DB_POSITION); + if (TSD->cursors[cdb] == NULL) { + ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0); + } + else { + ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION); + } if (ret) { - CtdlLogPrintf(CTDL_EMERG, "localcursor: %s\n", db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: localcursor: %s", db_strerror(ret)); + cdb_abort(); } return curs; @@ -692,57 +566,54 @@ static DBC *localcursor(int cdb) * a struct cdbdata which it is the caller's responsibility to free later on * using the cdb_free() routine. */ -struct cdbdata *cdb_fetch(int cdb, void *key, int keylen) +struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen) { - struct cdbdata *tempcdb; DBT dkey, dret; int ret; memset(&dkey, 0, sizeof(DBT)); dkey.size = keylen; - dkey.data = key; + dkey.data = (void *) key; - if (MYTID != NULL) { + if (TSD->tid != NULL) { memset(&dret, 0, sizeof(DBT)); dret.flags = DB_DBT_MALLOC; - ret = dbp[cdb]->get(dbp[cdb], MYTID, &dkey, &dret, 0); + ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &dkey, &dret, 0); // crashing here } else { DBC *curs; do { memset(&dret, 0, sizeof(DBT)); dret.flags = DB_DBT_MALLOC; - curs = localcursor(cdb); - ret = curs->c_get(curs, &dkey, &dret, DB_SET); cclose(curs); } while (ret == DB_LOCK_DEADLOCK); - } if ((ret != 0) && (ret != DB_NOTFOUND)) { - CtdlLogPrintf(CTDL_EMERG, "cdb_fetch(%d): %s\n", cdb, - db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_fetch(%d): %s", cdb, db_strerror(ret)); + cdb_abort(); } - if (ret != 0) + if (ret != 0) { return NULL; + } + tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata)); if (tempcdb == NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_fetch: Cannot allocate memory for tempcdb\n"); - abort(); + syslog(LOG_EMERG, "db: cdb_fetch: Cannot allocate memory for tempcdb"); + cdb_abort(); + return NULL; /* make it easier for static analysis... */ + } else { + tempcdb->len = dret.size; + tempcdb->ptr = dret.data; + cdb_decompress_if_necessary(tempcdb); + return (tempcdb); } - - tempcdb->len = dret.size; - tempcdb->ptr = dret.data; - cdb_decompress_if_necessary(tempcdb); - return (tempcdb); } @@ -762,14 +633,17 @@ void cdb_free(struct cdbdata *cdb) free(cdb); } + void cdb_close_cursor(int cdb) { - if (MYCURSORS[cdb] != NULL) - cclose(MYCURSORS[cdb]); + if (TSD->cursors[cdb] != NULL) { + cclose(TSD->cursors[cdb]); + } - MYCURSORS[cdb] = NULL; + TSD->cursors[cdb] = NULL; } + /* * Prepare for a sequential search of an entire database. * (There is guaranteed to be no more than one traversal in @@ -779,22 +653,19 @@ void cdb_rewind(int cdb) { int ret = 0; - if (MYCURSORS[cdb] != NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_rewind: must close cursor on database %d before reopening.\n", - cdb); - abort(); - /* cclose(MYCURSORS[cdb]); */ + if (TSD->cursors[cdb] != NULL) { + syslog(LOG_EMERG, "db: cdb_rewind: must close cursor on database %d before reopening", cdb); + cdb_abort(); + /* cclose(TSD->cursors[cdb]); */ } /* * Now initialize the cursor */ - ret = dbp[cdb]->cursor(dbp[cdb], MYTID, &MYCURSORS[cdb], 0); + ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &TSD->cursors[cdb], 0); if (ret) { - CtdlLogPrintf(CTDL_EMERG, "cdb_rewind: db_cursor: %s\n", - db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_rewind: db_cursor: %s", db_strerror(ret)); + cdb_abort(); } } @@ -814,16 +685,14 @@ struct cdbdata *cdb_next_item(int cdb) memset(&data, 0, sizeof(data)); data.flags = DB_DBT_MALLOC; - ret = MYCURSORS[cdb]->c_get(MYCURSORS[cdb], &key, &data, DB_NEXT); + ret = TSD->cursors[cdb]->c_get(TSD->cursors[cdb], &key, &data, DB_NEXT); if (ret) { if (ret != DB_NOTFOUND) { - CtdlLogPrintf(CTDL_EMERG, "cdb_next_item(%d): %s\n", - cdb, db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_next_item(%d): %s", cdb, db_strerror(ret)); + cdb_abort(); } - cclose(MYCURSORS[cdb]); - MYCURSORS[cdb] = NULL; + cdb_close_cursor(cdb); return NULL; /* presumably, end of file */ } @@ -836,49 +705,45 @@ struct cdbdata *cdb_next_item(int cdb) } - /* * Transaction-based stuff. I'm writing this as I bake cookies... */ - void cdb_begin_transaction(void) { - bailIfCursor(MYCURSORS, - "can't begin transaction during r/o cursor"); + bailIfCursor(TSD->cursors, "can't begin transaction during r/o cursor"); - if (MYTID != NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_begin_transaction: ERROR: nested transaction\n"); - abort(); + if (TSD->tid != NULL) { + syslog(LOG_EMERG, "db: cdb_begin_transaction: ERROR: nested transaction"); + cdb_abort(); } - txbegin(&MYTID); + txbegin(&TSD->tid); } + void cdb_end_transaction(void) { int i; for (i = 0; i < MAXCDB; i++) - if (MYCURSORS[i] != NULL) { - CtdlLogPrintf(CTDL_WARNING, - "cdb_end_transaction: WARNING: cursor %d still open at transaction end\n", - i); - cclose(MYCURSORS[i]); - MYCURSORS[i] = NULL; + if (TSD->cursors[i] != NULL) { + syslog(LOG_WARNING, "db: cdb_end_transaction: WARNING: cursor %d still open at transaction end", i); + cclose(TSD->cursors[i]); + TSD->cursors[i] = NULL; } - if (MYTID == NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_end_transaction: ERROR: txcommit(NULL) !!\n"); - abort(); - } else - txcommit(MYTID); + if (TSD->tid == NULL) { + syslog(LOG_ERR, "db: cdb_end_transaction: ERROR: txcommit(NULL) !!"); + cdb_abort(); + } else { + txcommit(TSD->tid); + } - MYTID = NULL; + TSD->tid = NULL; } + /* * Truncate (delete every record) */ @@ -888,13 +753,11 @@ void cdb_trunc(int cdb) int ret; u_int32_t count; - if (MYTID != NULL) { - CtdlLogPrintf(CTDL_EMERG, - "cdb_trunc must not be called in a transaction.\n"); - abort(); + if (TSD->tid != NULL) { + syslog(LOG_EMERG, "db: cdb_trunc must not be called in a transaction."); + cdb_abort(); } else { - bailIfCursor(MYCURSORS, - "attempt to write during r/o cursor"); + bailIfCursor(TSD->cursors, "attempt to write during r/o cursor"); retry: /* txbegin(&tid); */ @@ -907,13 +770,114 @@ void cdb_trunc(int cdb) /* txabort(tid); */ goto retry; } else { - CtdlLogPrintf(CTDL_EMERG, - "cdb_truncate(%d): %s\n", cdb, - db_strerror(ret)); - abort(); + syslog(LOG_EMERG, "db: cdb_truncate(%d): %s", cdb, db_strerror(ret)); + if (ret == ENOMEM) { + 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."); + } + exit(CTDLEXIT_DB); } } else { /* txcommit(tid); */ } } } + + +/* + * compact (defragment) the database , possibly returning space back to the underlying filesystem + */ +void cdb_compact(void) +{ + int ret; + int i; + + syslog(LOG_DEBUG, "db: cdb_compact() started"); + for (i = 0; i < MAXCDB; i++) { + syslog(LOG_DEBUG, "db: compacting database %d", i); + ret = dbp[i]->compact(dbp[i], NULL, NULL, NULL, NULL, DB_FREE_SPACE, NULL); + if (ret) { + syslog(LOG_ERR, "db: compact: %s", db_strerror(ret)); + } + } + syslog(LOG_DEBUG, "db: cdb_compact() finished"); +} + + +// Has an item already been seen (is it in the CDB_USETABLE) ? +// Returns 0 if it hasn't, 1 if it has +// In either case, writes the item to the database for next time. +int CheckIfAlreadySeen(StrBuf *guid) +{ + int found = 0; + struct UseTable ut; + struct cdbdata *cdbut; + + syslog(LOG_DEBUG, "db: CheckIfAlreadySeen(%s)", ChrPtr(guid)); + cdbut = cdb_fetch(CDB_USETABLE, SKEY(guid)); + if (cdbut != NULL) { + found = 1; + cdb_free(cdbut); + } + + /* (Re)write the record, to update the timestamp. Zeroing it out makes it compress better. */ + memset(&ut, 0, sizeof(struct UseTable)); + memcpy(ut.ut_msgid, SKEY(guid)); + ut.ut_timestamp = time(NULL); + cdb_store(CDB_USETABLE, SKEY(guid), &ut, sizeof(struct UseTable)); + return (found); +} + + +void cmd_rsen(char *argbuf) +{ + char Token[SIZ]; + long TLen; + char Time[SIZ]; + + struct UseTable ut; + struct cdbdata *cdbut; + + if (CtdlAccessCheck(ac_aide)) { + return; + } + + TLen = extract_token(Token, argbuf, 1, '|', sizeof Token); + if (strncmp(argbuf, "GET", 3) == 0) { + cdbut = cdb_fetch(CDB_USETABLE, Token, TLen); + if (cdbut != NULL) { + memcpy(&ut, cdbut->ptr, ((cdbut->len > sizeof(struct UseTable)) ? sizeof(struct UseTable) : cdbut->len)); + + cprintf("%d %ld\n", CIT_OK, ut.ut_timestamp); + } else { + cprintf("%d not found\n", ERROR + NOT_HERE); + } + + } else if (strncmp(argbuf, "SET", 3) == 0) { + memcpy(ut.ut_msgid, Token, TLen); + extract_token(Time, argbuf, 2, '|', sizeof Time); + ut.ut_timestamp = atol(Time); + cdb_store(CDB_USETABLE, Token, TLen, &ut, sizeof(struct UseTable)); + cprintf("%d token updated\n", CIT_OK); + } else if (strncmp(argbuf, "DEL", 3) == 0) { + if (cdb_delete(CDB_USETABLE, Token, TLen)) + cprintf("%d not found\n", ERROR + NOT_HERE); + else + cprintf("%d deleted.\n", CIT_OK); + + } else { + cprintf("%d Usage: [GET|SET|DEL]|Token|timestamp\n", ERROR); + } + +} + + +CTDL_MODULE_INIT(database) +{ + if (!threading) { + CtdlRegisterProtoHook(cmd_rsen, "RSEN", "manipulate Aggregators seen database"); + } + + /* return our module id for the log */ + return "database"; +}