People who disagree with me are always wrong and need to die.
[citadel.git] / citadel / database.c
index ea47a169e3df1cc460ea18ad0dbb2beb8f0525ac..8b5820edb1a5eb9d0e229bf52b33d3f78154fa62 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * This is a data store backend for the Citadel server which uses Berkeley DB.
  *
- * Copyright (c) 1987-2017 by the citadel.org team
+ * 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.
@@ -10,7 +10,6 @@
  * 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.
- *
  */
 
 /*****************************************************************************
 #include <dirent.h>
 #include <zlib.h>
 
-#ifdef HAVE_DB_H
 #include <db.h>
-#elif defined(HAVE_DB4_DB_H)
-#include <db5/db.h>
-#else
-#error Neither <db.h> nor <db5/db.h> was found by configure. Install db5-devel.
-#endif
 
 #if DB_VERSION_MAJOR < 5
 #error Citadel requires Berkeley DB v5.0 or newer.  Please upgrade.
@@ -57,39 +50,32 @@ static DB *dbp[MAXCDB];             /* One DB handle for each Citadel database */
 static DB_ENV *dbenv;          /* The DB environment (global) */
 
 
-void cdb_abort(void) {
+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()
+               getuid(), getgid(), geteuid(), getegid()
        );
-       cit_backtrace();
        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)) {
                syslog(LOG_DEBUG, "db: %s", msg);
-               cit_backtrace();
        }
 }
 
 
 /* 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)
 {
-       int *FOO = NULL;
-       syslog(LOG_ALERT, "db: %s", msg);
-       cit_backtrace();
-       *FOO = 1;
+       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;
@@ -97,12 +83,13 @@ static void txabort(DB_TXN * tid)
        ret = tid->abort(tid);
 
        if (ret) {
-               syslog(LOG_EMERG, "db: txn_abort: %s", db_strerror(ret));
+               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;
@@ -110,12 +97,13 @@ static void txcommit(DB_TXN * tid)
        ret = tid->commit(tid, 0);
 
        if (ret) {
-               syslog(LOG_EMERG, "db: txn_commit: %s", db_strerror(ret));
+               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;
@@ -123,34 +111,37 @@ static void txbegin(DB_TXN ** tid)
        ret = dbenv->txn_begin(dbenv, NULL, tid, 0);
 
        if (ret) {
-               syslog(LOG_EMERG, "db: txn_begin: %s", db_strerror(ret));
+               syslog(LOG_ERR, "db: txn_begin: %s", db_strerror(ret));
                cdb_abort();
        }
 }
 
+
+/* panic callback */
 static void dbpanic(DB_ENV * env, int errval)
 {
-       syslog(LOG_EMERG, "db: PANIC: %s", db_strerror(errval));
-       cit_backtrace();
+       syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval));
 }
 
+
 static void cclose(DBC * cursor)
 {
        int ret;
 
        if ((ret = cursor->c_close(cursor))) {
-               syslog(LOG_EMERG, "db: c_close: %s", db_strerror(ret));
+               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) {
-                       syslog(LOG_EMERG, "db: cursor still in progress on cdb %02x: %s", i, msg);
+                       syslog(LOG_ERR, "db: cursor still in progress on cdb %02x: %s", i, msg);
                        cdb_abort();
                }
 }
@@ -161,53 +152,12 @@ void cdb_check_handles(void)
        bailIfCursor(TSD->cursors, "in check_handles");
 
        if (TSD->tid != NULL) {
-               syslog(LOG_EMERG, "db: transaction still in progress!");
+               syslog(LOG_ERR, "db: transaction still in progress!");
                cdb_abort();
        }
 }
 
 
-/*
- * Cull the database logs by removing log files that are no longer needed.
- * Note: this code will be removed once we are confident that Berkeley DB can do this on its own.
- */
-void cdb_cull_logs(void)
-{
-       u_int32_t flags;
-       int ret;
-       char **file, **list;
-       char errmsg[SIZ];
-
-       flags = DB_ARCH_ABS;
-
-       /* Get the list of names. */
-       if ((ret = dbenv->log_archive(dbenv, &list, flags)) != 0) {
-               syslog(LOG_ERR, "db: cdb_cull_logs() %s", db_strerror(ret));
-               return;
-       }
-
-       /* Print the list of names. */
-       if (list != NULL) {
-               for (file = list; *file != NULL; ++file) {
-                       syslog(LOG_DEBUG, "db: deleting log %s", *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));
-                               CtdlAideMessage(errmsg, "Database Warning Message");
-                       }
-               }
-               free(list);
-       }
-}
-
-
 /*
  * Request a checkpoint of the database.  Called once per minute by the thread manager.
  */
@@ -219,27 +169,20 @@ void cdb_checkpoint(void)
        ret = dbenv->txn_checkpoint(dbenv, MAX_CHECKPOINT_KBYTES, MAX_CHECKPOINT_MINUTES, 0);
 
        if (ret != 0) {
-               syslog(LOG_EMERG, "db: cdb_checkpoint() txn_checkpoint: %s", db_strerror(ret));
+               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 (CtdlGetConfigInt("c_auto_cull")) {
-#ifdef DB_LOG_AUTO_REMOVE
-               ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);      // This version of Berkeley DB can cull the logs on its own!
-#else
-               cdb_cull_logs();                                                // Citadel knows how to do it too.
-#endif
+               ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 1);
        }
-#ifdef DB_LOG_AUTO_REMOVE
        else {
                ret = dbenv->log_set_config(dbenv, DB_LOG_AUTO_REMOVE, 0);
        }
-#endif
 }
 
 
-
 /*
  * Open the various databases we'll be using.  Any database which
  * does not exist should be created.  Note that we don't need a
@@ -260,24 +203,23 @@ void open_databases(void)
        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.
         */
-       if ((mkdir(ctdl_data_dir, 0700) != 0) && (errno != EEXIST)){
-               syslog(LOG_EMERG, "db: unable to create database directory [%s]: %s", ctdl_data_dir, strerror(errno));
+       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_EMERG, "db: unable to set database directory accessrights [%s]: %s", ctdl_data_dir, strerror(errno));
+       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_EMERG, "db: unable to set the owner for [%s]: %s", ctdl_data_dir, strerror(errno));
+       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\n");
-       /* db_env_set_func_yield((int (*)(u_long,  u_long))sched_yield); */
+       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) {
-               syslog(LOG_EMERG, "db: db_env_create: %s", db_strerror(ret));
-               syslog(LOG_EMERG, "db: exit code %d", 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");
@@ -294,85 +236,70 @@ void open_databases(void)
         */
        ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
        if (ret) {
-               syslog(LOG_EMERG, "db: set_cachesize: %s", db_strerror(ret));
+               syslog(LOG_ERR, "db: set_cachesize: %s", db_strerror(ret));
                dbenv->close(dbenv, 0);
-               syslog(LOG_EMERG, "db: exit code %d", ret);
+               syslog(LOG_ERR, "db: exit code %d", ret);
                exit(CTDLEXIT_DB);
        }
 
        if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
-               syslog(LOG_EMERG, "db: set_lk_detect: %s", db_strerror(ret));
+               syslog(LOG_ERR, "db: set_lk_detect: %s", db_strerror(ret));
                dbenv->close(dbenv, 0);
-               syslog(LOG_EMERG, "db: exit code %d", 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;
+       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);
+       ret = dbenv->open(dbenv, ctdl_data_dir, flags, 0);                              // try opening the database cleanly
        if (ret == DB_RUNRECOVERY) {
-               syslog(LOG_ALERT, "db: dbenv->open: %s", db_strerror(ret));
-               syslog(LOG_ALERT, "db: attempting recovery...");
+               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) {
-               syslog(LOG_ALERT, "db: dbenv->open: %s", db_strerror(ret));
-               syslog(LOG_ALERT, "db: attempting catastrophic recovery...");
+               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) {
-               syslog(LOG_EMERG, "db: dbenv->open: %s", db_strerror(ret));
+               syslog(LOG_ERR, "db: dbenv->open: %s", db_strerror(ret));
                dbenv->close(dbenv, 0);
-               syslog(LOG_EMERG, "db: exit code %d", ret);
+               syslog(LOG_ERR, "db: exit code %d", ret);
                exit(CTDLEXIT_DB);
        }
 
        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) {
-                       syslog(LOG_EMERG, "db: db_create: %s", db_strerror(ret));
-                       syslog(LOG_EMERG, "db: exit code %d", 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) {
-                       syslog(LOG_EMERG, "db: db_open[%02x]: %s", i, db_strerror(ret));
+                       syslog(LOG_ERR, "db: db_open[%02x]: %s", i, 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.");
+                               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.");
                        }
-                       syslog(LOG_EMERG, "db: exit code %d", 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];
@@ -390,8 +317,6 @@ void cdb_chmod_data(void) {
                }
                closedir(dp);
        }
-
-       syslog(LOG_DEBUG, "db: open_databases() finished");
 }
 
 
@@ -401,7 +326,7 @@ void cdb_chmod_data(void) {
  */
 void close_databases(void)
 {
-       int a;
+       int i;
        int ret;
 
        syslog(LOG_INFO, "db: performing final checkpoint");
@@ -414,17 +339,18 @@ void close_databases(void)
                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) {
-               syslog(LOG_INFO, "db: closing database %02x", 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) {
-                       syslog(LOG_EMERG, "db: db_close: %s", db_strerror(ret));
+                       syslog(LOG_ERR, "db: db_close: %s", db_strerror(ret));
                }
 
        }
@@ -444,11 +370,9 @@ void cdb_decompress_if_necessary(struct cdbdata *cdb)
 {
        static int magic = COMPRESS_MAGIC;
 
-       if ((cdb == NULL) || 
-           (cdb->ptr == NULL) || 
-           (cdb->len < sizeof(magic)) ||
-           (memcmp(cdb->ptr, &magic, sizeof(magic))))
-           return;
+       if ((cdb == NULL) || (cdb->ptr == NULL) || (cdb->len < sizeof(magic)) || (memcmp(cdb->ptr, &magic, sizeof(magic)))) {
+               return;
+       }
 
        /* At this point we know we're looking at a compressed item. */
 
@@ -460,8 +384,9 @@ void cdb_decompress_if_necessary(struct cdbdata *cdb)
 
        memset(&zheader, 0, sizeof(struct CtdlCompressHeader));
        cplen = sizeof(struct CtdlCompressHeader);
-       if (sizeof(struct CtdlCompressHeader) > cdb->len)
+       if (sizeof(struct CtdlCompressHeader) > cdb->len) {
                cplen = cdb->len;
+       }
        memcpy(&zheader, cdb->ptr, cplen);
 
        compressed_data = cdb->ptr;
@@ -472,10 +397,7 @@ 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)
-       {
+                      (uLongf *) & destLen, (const Bytef *) compressed_data, (uLong) sourceLen) != Z_OK) {
                syslog(LOG_EMERG, "db: uncompress() error");
                cdb_abort();
        }
@@ -506,12 +428,12 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
        memset(&dkey, 0, sizeof(DBT));
        memset(&ddata, 0, sizeof(DBT));
        dkey.size = ckeylen;
-       dkey.data = (void *)ckey;
+       dkey.data = (void *) ckey;
        ddata.size = cdatalen;
        ddata.data = cdata;
 
        /* Only compress Visit and UseTable records.  Everything else is uncompressed. */
-       if ( (cdb == CDB_VISIT) || (cdb == CDB_USETABLE) ) {
+       if ((cdb == CDB_VISIT) || (cdb == CDB_USETABLE)) {
                compressing = 1;
                zheader.magic = COMPRESS_MAGIC;
                zheader.uncompressed_len = cdatalen;
@@ -519,8 +441,7 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
                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)
-               {
+                             &destLen, (Bytef *) cdata, (uLongf) cdatalen, 1) != Z_OK) {
                        syslog(LOG_EMERG, "db: compress2() error");
                        cdb_abort();
                }
@@ -531,20 +452,21 @@ int cdb_store(int cdb, const void *ckey, int ckeylen, void *cdata, int cdatalen)
        }
 
        if (TSD->tid != NULL) {
-               ret = dbp[cdb]->put(dbp[cdb],   /* db */
-                                   TSD->tid,   /* transaction ID */
-                                   &dkey,      /* key */
-                                   &ddata,     /* data */
-                                   0); /* flags */
+               ret = dbp[cdb]->put(dbp[cdb],   // db
+                                   TSD->tid,   // transaction ID
+                                   &dkey,      // key
+                                   &ddata,     // data
+                                   0           // flags
+               );
                if (ret) {
                        syslog(LOG_EMERG, "db: cdb_store(%d): %s", cdb, db_strerror(ret));
                        cdb_abort();
                }
-               if (compressing)
+               if (compressing) {
                        free(compressed_data);
+               }
                return ret;
-       }
-       else {
+       } else {
                bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 
              retry:
@@ -602,8 +524,7 @@ int cdb_delete(int cdb, void *key, int keylen)
              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;
@@ -618,15 +539,18 @@ int cdb_delete(int cdb, void *key, int keylen)
        return ret;
 }
 
+
 static DBC *localcursor(int cdb)
 {
        int ret;
        DBC *curs;
 
-       if (TSD->cursors[cdb] == NULL)
+       if (TSD->cursors[cdb] == NULL) {
                ret = dbp[cdb]->cursor(dbp[cdb], TSD->tid, &curs, 0);
-       else
+       }
+       else {
                ret = TSD->cursors[cdb]->c_dup(TSD->cursors[cdb], &curs, DB_POSITION);
+       }
 
        if (ret) {
                syslog(LOG_EMERG, "db: localcursor: %s", db_strerror(ret));
@@ -650,26 +574,23 @@ struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen)
 
        memset(&dkey, 0, sizeof(DBT));
        dkey.size = keylen;
-       dkey.data = (void *)key;
+       dkey.data = (void *) key;
 
        if (TSD->tid != NULL) {
                memset(&dret, 0, sizeof(DBT));
                dret.flags = DB_DBT_MALLOC;
-               ret = dbp[cdb]->get(dbp[cdb], TSD->tid, &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)) {
@@ -677,17 +598,17 @@ struct cdbdata *cdb_fetch(int cdb, const void *key, int keylen)
                cdb_abort();
        }
 
-       if (ret != 0)
+       if (ret != 0) {
                return NULL;
+       }
+
        tempcdb = (struct cdbdata *) malloc(sizeof(struct cdbdata));
 
        if (tempcdb == NULL) {
                syslog(LOG_EMERG, "db: cdb_fetch: Cannot allocate memory for tempcdb");
                cdb_abort();
-               return NULL; /* make it easier for static analysis... */
-       }
-       else
-       {
+               return NULL;    /* make it easier for static analysis... */
+       } else {
                tempcdb->len = dret.size;
                tempcdb->ptr = dret.data;
                cdb_decompress_if_necessary(tempcdb);
@@ -712,6 +633,7 @@ void cdb_free(struct cdbdata *cdb)
        free(cdb);
 }
 
+
 void cdb_close_cursor(int cdb)
 {
        if (TSD->cursors[cdb] != NULL) {
@@ -721,6 +643,7 @@ void cdb_close_cursor(int cdb)
        TSD->cursors[cdb] = NULL;
 }
 
+
 /* 
  * Prepare for a sequential search of an entire database.
  * (There is guaranteed to be no more than one traversal in
@@ -782,11 +705,9 @@ struct cdbdata *cdb_next_item(int cdb)
 }
 
 
-
 /*
  * Transaction-based stuff.  I'm writing this as I bake cookies...
  */
-
 void cdb_begin_transaction(void)
 {
 
@@ -800,6 +721,7 @@ void cdb_begin_transaction(void)
        txbegin(&TSD->tid);
 }
 
+
 void cdb_end_transaction(void)
 {
        int i;
@@ -814,14 +736,14 @@ void cdb_end_transaction(void)
        if (TSD->tid == NULL) {
                syslog(LOG_ERR, "db: cdb_end_transaction: ERROR: txcommit(NULL) !!");
                cdb_abort();
-       }
-       else {
+       } else {
                txcommit(TSD->tid);
        }
 
        TSD->tid = NULL;
 }
 
+
 /*
  * Truncate (delete every record)
  */
@@ -834,8 +756,7 @@ void cdb_trunc(int cdb)
        if (TSD->tid != NULL) {
                syslog(LOG_EMERG, "db: cdb_trunc must not be called in a transaction.");
                cdb_abort();
-       }
-       else {
+       } else {
                bailIfCursor(TSD->cursors, "attempt to write during r/o cursor");
 
              retry:
@@ -851,7 +772,8 @@ void cdb_trunc(int cdb)
                        } else {
                                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.");
+                                       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);
                        }
@@ -862,6 +784,25 @@ void cdb_trunc(int cdb)
 }
 
 
+/*
+ * 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
@@ -884,64 +825,59 @@ int CheckIfAlreadySeen(StrBuf *guid)
        memcpy(ut.ut_msgid, SKEY(guid));
        ut.ut_timestamp = time(NULL);
        cdb_store(CDB_USETABLE, SKEY(guid), &ut, sizeof(struct UseTable));
-       return(found);
+       return (found);
 }
 
 
-void cmd_rsen(char *argbuf) {
+void cmd_rsen(char *argbuf)
+{
        char Token[SIZ];
        long TLen;
        char Time[SIZ];
 
        struct UseTable ut;
        struct cdbdata *cdbut;
-       
-       if (CtdlAccessCheck(ac_aide)) return;
+
+       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));
-                       
+                       memcpy(&ut, cdbut->ptr, ((cdbut->len > sizeof(struct UseTable)) ? sizeof(struct UseTable) : cdbut->len));
+
                        cprintf("%d %ld\n", CIT_OK, ut.ut_timestamp);
-               }
-               else {
+               } else {
                        cprintf("%d not found\n", ERROR + NOT_HERE);
                }
 
-       }
-       else if (strncmp(argbuf, "SET", 3) == 0) {
+       } 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) );
+               cdb_store(CDB_USETABLE, Token, TLen, &ut, sizeof(struct UseTable));
                cprintf("%d token updated\n", CIT_OK);
-       }
-       else if (strncmp(argbuf, "DEL", 3) == 0) {
+       } 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 {
+       } else {
                cprintf("%d Usage: [GET|SET|DEL]|Token|timestamp\n", ERROR);
        }
 
 }
 
+
 CTDL_MODULE_INIT(database)
 {
-       if (!threading)
-       {
+       if (!threading) {
                CtdlRegisterProtoHook(cmd_rsen, "RSEN", "manipulate Aggregators seen database");
        }
 
        /* return our module id for the log */
-       return "database";
+       return "database";
 }