src/lib-dict/dict.c

	dict.c revision e3fabe8d0faa9aab7cae2d0eee9653f581a3061d
76b43e4417bab52e913da39b5f5bc2a130d3f149Timo Sirainen/* Copyright (c) 2005-2008 Dovecot authors, see the included COPYING file */
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen#include "lib.h"
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen#include "array.h"
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen#include "dict-sql.h"
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen#include "dict-private.h"
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainenstatic ARRAY_DEFINE(dict_drivers, struct dict *);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainenstatic struct dict *dict_driver_lookup(const char *name)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    struct dict *const *dicts;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    unsigned int i, count;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    dicts = array_get(&dict_drivers, &count);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    for (i = 0; i < count; i++) {
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen        if (strcmp(dicts[i]->name, name) == 0)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen            return dicts[i];
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    }
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    return NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainenvoid dict_driver_register(struct dict *driver)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    if (!array_is_created(&dict_drivers))
91dca97b367c54a139c268b56a0c67f564bd9197Timo Sirainen        i_array_init(&dict_drivers, 8);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    if (dict_driver_lookup(driver->name) != NULL) {
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen        i_fatal("dict_driver_register(%s): Already registered",
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen            driver->name);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    }
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    array_append(&dict_drivers, &driver, 1);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainenvoid dict_driver_unregister(struct dict *driver)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    struct dict *const *dicts;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    unsigned int i, count;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    dicts = array_get(&dict_drivers, &count);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    for (i = 0; i < count; i++) {
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen        if (dicts[i] == driver) {
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen            array_delete(&dict_drivers, i, 1);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen            break;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen        }
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    }
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    i_assert(i < count);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen    if (array_count(&dict_drivers) == 0)
419cf63077e755935ce105747d6ebc67b7d38a7fTimo Sirainen        array_free(&dict_drivers);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainenvoid dict_drivers_register_builtin(void)
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen{
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen    dict_driver_register(&dict_driver_client);
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen    dict_driver_register(&dict_driver_file);
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen}
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainenvoid dict_drivers_unregister_builtin(void)
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen{
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen    dict_driver_unregister(&dict_driver_client);
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen    dict_driver_unregister(&dict_driver_file);
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen}
e3fabe8d0faa9aab7cae2d0eee9653f581a3061dTimo Sirainen
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainenstruct dict *dict_init(const char *uri, enum dict_data_type value_type,
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen               const char *username)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    struct dict *dict;
9844b5359f5cab77e4c31a7ac9e4a60a0073929eTimo Sirainen    const char *p, *name;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
080a75584cfbe21ffd2d23c6bbb4cd8fdfd0990cTimo Sirainen    i_assert(username != NULL);
080a75584cfbe21ffd2d23c6bbb4cd8fdfd0990cTimo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    p = strchr(uri, ':');
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    if (p == NULL) {
14cdb8cbe37616464c965aec90a8494b339db538Timo Sirainen        i_error("Dictionary URI is missing ':': %s", uri);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen        return NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    }
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
19e8adccba16ff419f5675b1575358c2956dce83Timo Sirainen    T_BEGIN {
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen        name = t_strdup_until(uri, p);
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen        dict = dict_driver_lookup(name);
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen        if (dict == NULL)
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen            i_error("Unknown dict module: %s", name);
19e8adccba16ff419f5675b1575358c2956dce83Timo Sirainen    } T_END;
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen    return dict == NULL ? NULL :
eddd9bf1a1369aea4a2715f6be1137da6d17d293Timo Sirainen        dict->v.init(dict, p+1, value_type, username);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainenvoid dict_deinit(struct dict **_dict)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen    struct dict *dict = *_dict;
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen
d5cebe7f98e63d4e2822863ef2faa4971e8b3a5dTimo Sirainen    *_dict = NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    dict->v.deinit(dict);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainenstatic bool dict_key_prefix_is_valid(const char *key)
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    return strncmp(key, DICT_PATH_SHARED, strlen(DICT_PATH_SHARED)) == 0 ||
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen        strncmp(key, DICT_PATH_PRIVATE, strlen(DICT_PATH_PRIVATE)) == 0;
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen}
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen
f8ead0942a9b7c8fcf91414ed1b534d5807ca555Timo Sirainenint dict_lookup(struct dict *dict, pool_t pool, const char *key,
f8ead0942a9b7c8fcf91414ed1b534d5807ca555Timo Sirainen        const char **value_r)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    i_assert(dict_key_prefix_is_valid(key));
f8ead0942a9b7c8fcf91414ed1b534d5807ca555Timo Sirainen    return dict->v.lookup(dict, pool, key, value_r);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainenstruct dict_iterate_context *
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainendict_iterate_init(struct dict *dict, const char *path,
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen          enum dict_iterate_flags flags)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    i_assert(dict_key_prefix_is_valid(path));
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen    return dict->v.iterate_init(dict, path, flags);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainenint dict_iterate(struct dict_iterate_context *ctx,
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen         const char **key_r, const char **value_r)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    return ctx->dict->v.iterate(ctx, key_r, value_r);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainenvoid dict_iterate_deinit(struct dict_iterate_context **_ctx)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    struct dict_iterate_context *ctx = *_ctx;
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    *_ctx = NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    ctx->dict->v.iterate_deinit(ctx);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainenstruct dict_transaction_context *dict_transaction_begin(struct dict *dict)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    return dict->v.transaction_init(dict);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainenint dict_transaction_commit(struct dict_transaction_context **_ctx)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    struct dict_transaction_context *ctx = *_ctx;
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    *_ctx = NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    return ctx->dict->v.transaction_commit(ctx);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainenvoid dict_transaction_rollback(struct dict_transaction_context **_ctx)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    struct dict_transaction_context *ctx = *_ctx;
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen
1dc6f277f5ac6a3dd5cd6aa75a7ef691de9acb7aTimo Sirainen    *_ctx = NULL;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    ctx->dict->v.transaction_rollback(ctx);
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainenvoid dict_set(struct dict_transaction_context *ctx,
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen          const char *key, const char *value)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    i_assert(dict_key_prefix_is_valid(key));
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen    ctx->dict->v.set(ctx, key, value);
2be7df5df08ac4639ad83559ec5fcf552c84fb4aTimo Sirainen    ctx->changed = TRUE;
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainenvoid dict_unset(struct dict_transaction_context *ctx,
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen        const char *key)
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    i_assert(dict_key_prefix_is_valid(key));
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen    ctx->dict->v.unset(ctx, key);
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen    ctx->changed = TRUE;
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen}
92d1458b00f4f236c4cec96a696253d3bbf8b05aTimo Sirainen
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainenvoid dict_atomic_inc(struct dict_transaction_context *ctx,
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen             const char *key, long long diff)
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen{
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen    i_assert(dict_key_prefix_is_valid(key));
fd1a8db8fa61f9c38f063f62753d1bfef0261e19Timo Sirainen
2be7df5df08ac4639ad83559ec5fcf552c84fb4aTimo Sirainen    if (diff != 0) {
52de9d38fcad80df481667bac821cb8222785fe6Timo Sirainen        ctx->dict->v.atomic_inc(ctx, key, diff);
2be7df5df08ac4639ad83559ec5fcf552c84fb4aTimo Sirainen        ctx->changed = TRUE;
2be7df5df08ac4639ad83559ec5fcf552c84fb4aTimo Sirainen    }
28c75d59f1d1a7caeb85635964f3881c0038eb23Timo Sirainen}