plugins/fts/fts-user.c

	fts-user.c revision 4c61d6b6ad6173f06563c2cee9bd813c59277dd2
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen/* Copyright (c) 2015 Dovecot authors, see the included COPYING file */
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "lib.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "module-context.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "mail-user.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "fts-language.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "fts-filter.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#include "fts-user.h"
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen#define FTS_USER_CONTEXT(obj) \
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    MODULE_CONTEXT(obj, fts_user_module)
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainenstruct fts_user {
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    union mail_user_module_context module_ctx;
a10ed8c47534b4c6b6bf2711ccfe577e720a47b4Timo Sirainen
06d948c4adc2bfd2934f74c8046bcc1d567426d8Timo Sirainen    struct fts_language_list *lang_list;
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    ARRAY_TYPE(fts_user_language) languages;
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen};
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen
a10ed8c47534b4c6b6bf2711ccfe577e720a47b4Timo Sirainenstatic MODULE_CONTEXT_DEFINE_INIT(fts_user_module,
a10ed8c47534b4c6b6bf2711ccfe577e720a47b4Timo Sirainen                  &mail_user_module_register);
06d948c4adc2bfd2934f74c8046bcc1d567426d8Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainenstatic int
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainenfts_user_init_languages(struct mail_user *user, struct fts_user *fuser)
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen{
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    const char *languages, *unknown;
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    const char *lang_config[3] = {NULL, NULL, NULL};
042a07daa4a5614159532a2a3878e76e3f176965Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    languages = mail_user_plugin_getenv(user, "fts_languages");
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    if (languages == NULL) {
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen        i_error("fts-dovecot: fts_languages setting is missing - disabling");
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen        return -1;
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    }
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen    lang_config[1] = mail_user_plugin_getenv(user, "fts_language_config");
06d948c4adc2bfd2934f74c8046bcc1d567426d8Timo Sirainen    fuser->lang_list = fts_language_list_init(lang_config);
06d948c4adc2bfd2934f74c8046bcc1d567426d8Timo Sirainen    if (lang_config[1] != NULL)
e9e2d23e1ea5a149a7d8828d2a45b9f2313c3785Timo Sirainen        lang_config[0] = "fts_language_config";

    if (!fts_language_list_add_names(fuser->lang_list, languages, &unknown)) {
        i_error("fts_languages: Unknown language '%s'", unknown);
        return -1;
    }
    if (array_count(fts_language_list_get_all(fuser->lang_list)) == 0) {
        i_error("fts-dovecot: fts_languages setting is empty - disabling");
        return -1;
    }
    return 0;
}

static int
fts_user_create_filters(struct mail_user *user, const struct fts_language *lang,
            struct fts_filter **filter_r, const char **error_r)
{
    const struct fts_filter *filter_class;
    struct fts_filter *filter = NULL, *parent = NULL;
    const char *filters_key, *const *filters, *filter_set_name;
    const char *str, *error, *set_key, *const *settings;
    unsigned int i;
    int ret = 0;

    filters_key = "fts_filters";
    str = mail_user_plugin_getenv(user, filters_key);
    if (str == NULL) {
        filters_key = t_strconcat("fts_filters_", lang->name, NULL);
        str = mail_user_plugin_getenv(user, filters_key);
        if (str == NULL) {
            *filter_r = NULL;
            return 0;
        }
    }

    filters = t_strsplit_spaces(str, " ");
    for (i = 0; filters[i] != NULL; i++) {
        filter_class = fts_filter_find(filters[i]);
        if (filter_class == NULL) {
            *error_r = t_strdup_printf("%s: Unknown filter '%s'",
                           filters_key, filters[i]);
            ret = -1;
            break;
        }

        /* try the language-specific setting first */
        filter_set_name = t_str_replace(filters[i], '-', '_');
        set_key = t_strdup_printf("fts_filters_%s_%s",
                      lang->name, filter_set_name);
        str = mail_user_plugin_getenv(user, set_key);
        if (str == NULL) {
            set_key = t_strdup_printf("fts_filters_%s", filter_set_name);
            str = mail_user_plugin_getenv(user, set_key);
        }
        settings = str == NULL ? NULL : t_strsplit_spaces(str, " ");

        if (fts_filter_create(filter_class, parent, lang, settings,
                      &filter, &error) < 0) {
            *error_r = t_strdup_printf(
                "Filter '%s' init via settings '%s' failed: %s",
                filters[i], set_key, error);
            ret = -1;
            break;
        }
        if (parent != NULL)
            fts_filter_unref(&parent);
        parent = filter;
    }
    if (ret < 0) {
        if (parent != NULL)
            fts_filter_unref(&parent);
        return -1;
    }
    *filter_r = filter;
    return 0;
}

static struct fts_user_language *
fts_user_language_find(struct fts_user *fuser,
               const struct fts_language *lang)
{
    struct fts_user_language *const *user_langp;

    array_foreach(&fuser->languages, user_langp) {
        if (strcmp((*user_langp)->lang->name, lang->name) == 0)
            return *user_langp;
    }
    return NULL;
}

int fts_user_language_get(struct mail_user *user,
              const struct fts_language *lang,
              struct fts_user_language **user_lang_r,
              const char **error_r)
{
    struct fts_user *fuser = FTS_USER_CONTEXT(user);
    struct fts_user_language *user_lang;
    struct fts_filter *filter;

    *user_lang_r = fts_user_language_find(fuser, lang);
    if (*user_lang_r != NULL)
        return 0;

    if (fts_user_create_filters(user, lang, &filter, error_r) < 0)
        return -1;

    user_lang = p_new(user->pool, struct fts_user_language, 1);
    user_lang->lang = lang;
    user_lang->filter = filter;
    array_append(&fuser->languages, &user_lang, 1);

    *user_lang_r = user_lang;
    return 0;
}

int fts_user_languages_fill_all(struct mail_user *user, const char **error_r)
{
    struct fts_user *fuser = FTS_USER_CONTEXT(user);
    const struct fts_language *const *langp;
    struct fts_user_language *user_lang;

    array_foreach(fts_language_list_get_all(fuser->lang_list), langp) {
        if (fts_user_language_get(user, *langp, &user_lang, error_r) < 0)
            return -1;
    }
    return 0;
}

struct fts_language_list *fts_user_get_language_list(struct mail_user *user)
{
    struct fts_user *fuser = FTS_USER_CONTEXT(user);

    return fuser->lang_list;
}

const ARRAY_TYPE(fts_user_language) *
fts_user_get_all_languages(struct mail_user *user)
{
    struct fts_user *fuser = FTS_USER_CONTEXT(user);

    return &fuser->languages;
}

static void fts_user_free(struct fts_user *fuser)
{
    struct fts_user_language *const *user_langp;

    if (fuser->lang_list != NULL)
        fts_language_list_deinit(&fuser->lang_list);

    array_foreach(&fuser->languages, user_langp) {
        if ((*user_langp)->filter != NULL)
            fts_filter_unref(&(*user_langp)->filter);
    }
}

static void fts_mail_user_deinit(struct mail_user *user)
{
    struct fts_user *fuser = FTS_USER_CONTEXT(user);

    fts_user_free(fuser);
    fuser->module_ctx.super.deinit(user);
}

void fts_mail_user_created(struct mail_user *user)
{
    struct mail_user_vfuncs *v = user->vlast;
    struct fts_user *fuser;

    fuser = p_new(user->pool, struct fts_user, 1);
    p_array_init(&fuser->languages, user->pool, 4);

    if (fts_user_init_languages(user, fuser) < 0) {
        fts_user_free(fuser);
        return;
    }

    fuser->module_ctx.super = *v;
    user->vlast = &fuser->module_ctx.super;
    v->deinit = fts_mail_user_deinit;
    MODULE_CONTEXT_SET(user, fts_user_module, fuser);
}