/*
* 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.
#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.
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()
);
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);
/* 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_ERR, "db: %s", msg);
- *FOO = 1;
}
-/* just a little helper function */
-static void txabort(DB_TXN * tid)
+/* wrapper for txn_abort() that logs/aborts on error */
+static void txabort(DB_TXN *tid)
{
int ret;
}
}
-/* this one is even more helpful than the last. */
-static void txcommit(DB_TXN * tid)
+
+/* wrapper for txn_commit() that logs/aborts on error */
+static void txcommit(DB_TXN *tid)
{
int ret;
}
}
-/* are you sensing a pattern yet? */
-static void txbegin(DB_TXN ** tid)
+
+/* wrapper for txn_begin() that logs/aborts on error */
+static void txbegin(DB_TXN **tid)
{
int ret;
}
}
+
+/* panic callback */
static void dbpanic(DB_ENV * env, int errval)
{
syslog(LOG_ERR, "db: PANIC: %s", db_strerror(errval));
}
+
static void cclose(DBC * cursor)
{
int ret;
}
}
+
static void bailIfCursor(DBC ** cursors, const char *msg)
{
int i;
}
-/*
- * 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.
*/
/* 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
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)){
+ 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 accessrights [%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){
+ 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_ERR, "db: db_env_create: %s", db_strerror(ret));
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_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_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_ERR, "db: dbenv->open: %s", db_strerror(ret));
}
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_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_ERR, "db: db_open[%02x]: %s", i, db_strerror(ret));
if (ret == ENOMEM) {
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];
}
closedir(dp);
}
-
- syslog(LOG_DEBUG, "db: open_databases() finished");
}
*/
void close_databases(void)
{
- int a;
+ int i;
int ret;
syslog(LOG_INFO, "db: performing final checkpoint");
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_ERR, "db: db_close: %s", db_strerror(ret));
}
{
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. */
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;
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();
}
{
DBT dkey, ddata;
- DB_TXN *tid;
+ DB_TXN *tid = NULL;
int ret = 0;
-
struct CtdlCompressHeader zheader;
char *compressed_data = NULL;
int compressing = 0;
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;
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();
}
}
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:
txbegin(&tid);
- if ((ret = dbp[cdb]->put(dbp[cdb], /* db */
- tid, /* transaction ID */
- &dkey, /* key */
- &ddata, /* data */
- 0))) { /* flags */
+ if ((ret = dbp[cdb]->put(dbp[cdb], // db
+ tid, // transaction ID
+ &dkey, // key
+ &ddata, // data
+ 0))) { // flags
if (ret == DB_LOCK_DEADLOCK) {
txabort(tid);
goto retry;
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;
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));
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)) {
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);
free(cdb);
}
+
void cdb_close_cursor(int cdb)
{
if (TSD->cursors[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
}
-
/*
* Transaction-based stuff. I'm writing this as I bake cookies...
*/
-
void cdb_begin_transaction(void)
{
txbegin(&TSD->tid);
}
+
void cdb_end_transaction(void)
{
int i;
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)
*/
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:
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";
}