+++ /dev/null
-/* Copyright (c) 2006-2018 Dovecot authors, see the included COPYING file */
-
-/* FIXME: BDB isn't being used correctly/safely. */
-
-#include "lib.h"
-#include "dict-private.h"
-
-#ifdef BUILD_DB
-#include <db.h>
-
-struct db_dict {
- struct dict dict;
- enum dict_data_type value_type;
- pool_t pool;
-
- DB_ENV *db_env;
- DB *pdb;
- DB *sdb;
- DB_TXN *tid;
-};
-
-struct db_dict_iterate_context {
- struct dict_iterate_context ctx;
- pool_t pool;
-
- DBC *cursor;
- char *path;
- size_t path_len;
-
- DBT pkey, pdata;
-
- int (*iterate_next)(struct db_dict_iterate_context *ctx,
- const char **key_r, const char **value_r);
-
- enum dict_iterate_flags flags;
- bool failed;
-};
-
-struct db_dict_transaction_context {
- struct dict_transaction_context ctx;
-
- DB_TXN *tid;
-};
-
-static void db_dict_deinit(struct dict *_dict);
-
-static int associate_key(DB *pdb ATTR_UNUSED,
- const DBT *pkey ATTR_UNUSED,
- const DBT *pdata, DBT *skey)
-{
- i_zero(skey);
- skey->data = pdata->data;
- skey->size = pdata->size;
- return 0;
-}
-
-static int uint32_t_compare(DB *db ATTR_UNUSED,
- const DBT *keya, const DBT *keyb)
-{
- const uint32_t *ua = keya->data, *ub = keyb->data;
-
- return *ua > *ub ? 1 :
- (*ua < *ub ? -1 : 0);
-}
-
-static int db_dict_open(struct db_dict *dict, const char *uri,
- const char *username)
-{
- const char *dir;
- int ret;
-
- dict->db_env->set_errfile(dict->db_env, stderr);
- dict->db_env->set_errpfx(dict->db_env,
- p_strdup_printf(dict->pool, "db_env(%s)", username));
-
- dir = strrchr(uri, '/');
- if (dir != NULL)
- dir = t_strdup_until(uri, dir);
- else
- dir = ".";
-
- ret = dict->db_env->open(dict->db_env, dir, DB_CREATE |
- DB_INIT_MPOOL | DB_INIT_TXN, 0);
- if (ret != 0) {
- i_error("db_env.open(%s) failed: %s\n", dir, db_strerror(ret));
- return -1;
- }
-
- ret = dict->db_env->txn_begin(dict->db_env, NULL, &dict->tid, 0);
- if (ret != 0) {
- i_error("db_env.txn_begin() failed: %s\n", db_strerror(ret));
- return -1;
- }
-
- /* create both primary and secondary databases */
- ret = db_create(&dict->pdb, dict->db_env, 0);
- if (ret != 0) {
- i_error("db_create(primary) failed: %s\n", db_strerror(ret));
- return -1;
- }
- dict->pdb->set_errfile(dict->pdb, stderr);
- dict->pdb->set_errpfx(dict->pdb,
- p_strdup_printf(dict->pool, "db(primary, %s)", username));
-
- ret = db_create(&dict->sdb, dict->db_env, 0);
- if (ret != 0) {
- i_error("db_create(secondary) failed: %s\n", db_strerror(ret));
- return -1;
- }
- dict->sdb->set_errfile(dict->sdb, stderr);
- dict->sdb->set_errpfx(dict->sdb,
- p_strdup_printf(dict->pool, "db(secondary, %s)", username));
-
- if ((ret = dict->pdb->open(dict->pdb, dict->tid, uri, NULL,
- DB_BTREE, DB_CREATE, 0)) != 0) {
- i_error("pdb.open() failed: %s\n", db_strerror(ret));
- return -1;
- }
- if (dict->sdb->set_flags(dict->sdb, DB_DUP) != 0)
- return -1;
-
- /* by default keys are compared as strings. if we store uint32_t,
- we need a customized compare function */
- if (dict->value_type == DICT_DATA_TYPE_UINT32) {
- if (dict->sdb->set_bt_compare(dict->sdb, uint32_t_compare) != 0)
- return -1;
- }
-
- if ((ret = dict->sdb->open(dict->sdb, dict->tid, NULL, NULL,
- DB_BTREE, DB_CREATE, 0)) != 0) {
- i_error("sdb.open() failed: %s\n", db_strerror(ret));
- return -1;
- }
- if ((ret = dict->pdb->associate(dict->pdb, dict->tid, dict->sdb,
- associate_key, DB_CREATE)) != 0) {
- i_error("pdb.associate() failed: %s\n", db_strerror(ret));
- return -1;
- }
- return 0;
-}
-
-static int
-db_dict_init(struct dict *driver, const char *uri,
- enum dict_data_type value_type,
- const char *username, const char *base_dir ATTR_UNUSED,
- struct dict **dict_r)
-{
- struct db_dict *dict;
- pool_t pool;
- int ret, major, minor, patch;
-
- (void)db_version(&major, &minor, &patch);
- if (major != DB_VERSION_MAJOR || minor != DB_VERSION_MINOR) {
- i_error("Berkeley DB version mismatch: "
- "Compiled against %d.%d.%d headers, "
- "run-time linked against %d.%d.%d library",
- DB_VERSION_MAJOR, DB_VERSION_MINOR, DB_VERSION_PATCH,
- major, minor, patch);
- return -1;
- }
-
- pool = pool_alloconly_create("db dict", 1024);
- dict = p_new(pool, struct db_dict, 1);
- dict->pool = pool;
- dict->dict = *driver;
- dict->value_type = value_type;
-
- /* prepare the environment */
- ret = db_env_create(&dict->db_env, 0);
- if (ret != 0) {
- i_error("db_env_create() failed: %s\n", db_strerror(ret));
- pool_unref(&pool);
- return -1;
- }
-
- if (db_dict_open(dict, uri, username) < 0) {
- i_error("db(%s) open failed", uri);
- db_dict_deinit(&dict->dict);
- return -1;
- }
- *dict_r = &dict->dict;
- return 0;
-}
-
-static void db_dict_deinit(struct dict *_dict)
-{
- struct db_dict *dict = (struct db_dict *)_dict;
-
- if (dict->tid != NULL)
- (void)dict->tid->commit(dict->tid, 0);
- if (dict->pdb != NULL)
- dict->pdb->close(dict->pdb, 0);
- if (dict->sdb != NULL)
- dict->sdb->close(dict->sdb, 0);
- dict->db_env->close(dict->db_env, 0);
- pool_unref(&dict->pool);
-}
-
-static int db_dict_iterate_set(struct db_dict_iterate_context *ctx, int ret,
- const char **key_r, const char **value_r)
-{
- struct db_dict *dict = (struct db_dict *)ctx->ctx.dict;
- uint32_t value;
-
- if (ret == DB_NOTFOUND)
- return 0;
- else if (ret != 0)
- return -1;
-
- p_clear(ctx->pool);
- *key_r = p_strndup(ctx->pool, ctx->pkey.data, ctx->pkey.size);
-
- switch (dict->value_type) {
- case DICT_DATA_TYPE_UINT32:
- i_assert(ctx->pdata.size == sizeof(uint32_t));
-
- /* data may not be aligned, so use memcpy() */
- memcpy(&value, ctx->pdata.data, sizeof(value));
- *value_r = p_strdup(ctx->pool, dec2str(value));
- break;
- case DICT_DATA_TYPE_STRING:
- *value_r = p_strndup(ctx->pool,
- ctx->pdata.data, ctx->pdata.size);
- break;
- }
- return 1;
-}
-
-static int db_dict_lookup(struct dict *_dict, pool_t pool,
- const char *key, const char **value_r)
-{
- struct db_dict *dict = (struct db_dict *)_dict;
- DBT pkey, pdata;
- uint32_t value;
- int ret;
-
- i_zero(&pkey);
- i_zero(&pdata);
-
- pkey.data = (char *)key;
- pkey.size = strlen(key);
-
- ret = dict->pdb->get(dict->pdb, NULL, &pkey, &pdata, 0);
- if (ret == DB_NOTFOUND)
- return 0;
- else if (ret != 0)
- return -1;
-
- switch (dict->value_type) {
- case DICT_DATA_TYPE_UINT32:
- i_assert(pdata.size == sizeof(uint32_t));
-
- /* data may not be aligned, so use memcpy() */
- memcpy(&value, pdata.data, sizeof(value));
- *value_r = p_strdup(pool, dec2str(value));
- break;
- case DICT_DATA_TYPE_STRING:
- *value_r = p_strndup(pool, pdata.data, pdata.size);
- break;
- }
- return 1;
-}
-
-static int db_dict_iterate_next(struct db_dict_iterate_context *ctx,
- const char **key_r, const char **value_r)
-{
- DBT pkey, pdata, skey;
- int ret;
-
- i_zero(&pkey);
- i_zero(&pdata);
- i_zero(&skey);
-
- if ((ctx->flags & DICT_ITERATE_FLAG_SORT_BY_VALUE) != 0) {
- while ((ret = ctx->cursor->c_pget(ctx->cursor, &skey,
- &ctx->pkey, &ctx->pdata,
- DB_NEXT)) == 0) {
- /* make sure the path matches */
- if (ctx->path == NULL)
- break;
- if (ctx->path_len <= ctx->pkey.size &&
- strncmp(ctx->path, ctx->pkey.data,
- ctx->path_len) == 0)
- break;
- }
- } else {
- ret = ctx->cursor->c_get(ctx->cursor, &ctx->pkey, &ctx->pdata,
- DB_NEXT);
- if (ctx->path != NULL && ret == 0 &&
- (ctx->path_len > ctx->pkey.size ||
- strncmp(ctx->path, ctx->pkey.data, ctx->path_len) != 0)) {
- /* there are no more matches */
- return 0;
- }
- }
-
- return db_dict_iterate_set(ctx, ret, key_r, value_r);
-}
-
-static int db_dict_iterate_first(struct db_dict_iterate_context *ctx,
- const char **key_r, const char **value_r)
-{
- struct db_dict *dict = (struct db_dict *)ctx->ctx.dict;
- int ret;
-
- ctx->iterate_next = db_dict_iterate_next;
-
- if ((ctx->flags & DICT_ITERATE_FLAG_SORT_BY_VALUE) != 0) {
- /* iterating through secondary database returns values sorted */
- ret = dict->sdb->cursor(dict->sdb, NULL, &ctx->cursor, 0);
- } else {
- ret = dict->pdb->cursor(dict->pdb, NULL, &ctx->cursor, 0);
- if (ret == 0 && ctx->path != NULL) {
- ctx->pkey.data = ctx->path;
- ctx->pkey.size = strlen(ctx->path);
-
- ret = ctx->cursor->c_get(ctx->cursor, &ctx->pkey,
- &ctx->pdata, DB_SET_RANGE);
- if (ret == 0 && strncmp(ctx->path, ctx->pkey.data,
- ctx->pkey.size) != 0)
- return 0;
- return db_dict_iterate_set(ctx, ret, key_r, value_r);
- }
- }
- return db_dict_iterate_next(ctx, key_r, value_r);
-}
-
-static struct dict_iterate_context *
-db_dict_iterate_init(struct dict *_dict, const char *path,
- enum dict_iterate_flags flags)
-{
- struct db_dict_iterate_context *ctx;
-
- ctx = i_new(struct db_dict_iterate_context, 1);
- ctx->pool = pool_alloconly_create("db iter", 1024);
- ctx->cursor = NULL;
- ctx->ctx.dict = _dict;
- ctx->flags = flags;
- ctx->path = i_strdup_empty(path);
- ctx->path_len = ctx->path == NULL ? 0 : strlen(ctx->path);
-
- ctx->iterate_next = db_dict_iterate_first;
- return &ctx->ctx;
-}
-
-static bool db_dict_iterate(struct dict_iterate_context *_ctx,
- const char **key_r, const char **value_r)
-{
- struct db_dict_iterate_context *ctx =
- (struct db_dict_iterate_context *)_ctx;
- int ret;
-
- ret = ctx->iterate_next(ctx, key_r, value_r);
- if (ret < 0)
- ctx->failed = TRUE;
- return ret > 0;
-}
-
-static int db_dict_iterate_deinit(struct dict_iterate_context *_ctx)
-{
- struct db_dict_iterate_context *ctx =
- (struct db_dict_iterate_context *)_ctx;
- int ret = ctx->failed ? -1 : 0;
-
- ctx->cursor->c_close(ctx->cursor);
- pool_unref(&ctx->pool);
- i_free(ctx->path);
- i_free(ctx);
- return ret;
-}
-
-static struct dict_transaction_context *
-db_dict_transaction_init(struct dict *_dict)
-{
- struct db_dict *dict = (struct db_dict *)_dict;
- struct db_dict_transaction_context *ctx;
-
- ctx = i_new(struct db_dict_transaction_context, 1);
- ctx->ctx.dict = _dict;
- dict->db_env->txn_begin(dict->db_env, NULL, &ctx->tid, 0);
-
- return &ctx->ctx;
-}
-
-static int
-db_dict_transaction_commit(struct dict_transaction_context *_ctx,
- bool async ATTR_UNUSED,
- dict_transaction_commit_callback_t *callback,
- void *context)
-{
- struct db_dict_transaction_context *ctx =
- (struct db_dict_transaction_context *)_ctx;
- int ret;
-
- ret = ctx->tid->commit(ctx->tid, 0) < 0 ? -1 : 1;
- i_free(ctx);
-
- if (callback != NULL)
- callback(ret, context);
- return ret;
-}
-
-static void db_dict_transaction_rollback(struct dict_transaction_context *_ctx)
-{
- struct db_dict_transaction_context *ctx =
- (struct db_dict_transaction_context *)_ctx;
-
- ctx->tid->abort(ctx->tid);
- i_free(ctx);
-}
-
-static void db_dict_set(struct dict_transaction_context *_ctx,
- const char *key, const char *value)
-{
- struct db_dict_transaction_context *ctx =
- (struct db_dict_transaction_context *)_ctx;
- struct db_dict *dict = (struct db_dict *)_ctx->dict;
- DBT dkey, ddata;
-
- i_zero(&dkey);
- i_zero(&ddata);
-
- dkey.data = (char *)key;
- dkey.size = strlen(key);
-
- if (dict->value_type == DICT_DATA_TYPE_UINT32) {
- uint32_t ivalue;
-
- if (str_to_uint32(value, &ivalue) < 0) {
- i_error("db: Value not uint32: %s", value);
- ivalue = 0;
- }
- ddata.data = &ivalue;
- ddata.size = sizeof(ivalue);
- } else {
- ddata.data = (char *)value;
- ddata.size = strlen(value);
- }
-
- dict->pdb->put(dict->pdb, ctx->tid, &dkey, &ddata, 0);
-}
-
-static void db_dict_unset(struct dict_transaction_context *_ctx,
- const char *key)
-{
- struct db_dict_transaction_context *ctx =
- (struct db_dict_transaction_context *)_ctx;
- struct db_dict *dict = (struct db_dict *)_ctx->dict;
- DBT dkey;
-
- i_zero(&dkey);
- dkey.data = (char *)key;
- dkey.size = strlen(key);
-
- dict->pdb->del(dict->pdb, ctx->tid, &dkey, 0);
-}
-
-static void
-db_dict_atomic_inc(struct dict_transaction_context *_ctx ATTR_UNUSED,
- const char *key ATTR_UNUSED, long long diff ATTR_UNUSED)
-{
- /* FIXME */
-}
-
-struct dict dict_driver_db = {
- .name = "db",
- {
- .init = db_dict_init,
- .deinit = db_dict_deinit,
- .lookup = db_dict_lookup,
- .iterate_init = db_dict_iterate_init,
- .iterate = db_dict_iterate,
- .iterate_deinit = db_dict_iterate_deinit,
- .transaction_init = db_dict_transaction_init,
- .transaction_commit = db_dict_transaction_commit,
- .transaction_rollback = db_dict_transaction_rollback,
- .set = db_dict_set,
- .unset = db_dict_unset,
- .atomic_inc = db_dict_atomic_inc,
- }
-};
-#endif