src/lib-storage/mail-user.c

	mail-user.c revision b16ee3cbbcd18cb86f2f73b5cc163ebfb995ffaf
/* Copyright (c) 2008-2010 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "array.h"
#include "hostpid.h"
#include "network.h"
#include "module-dir.h"
#include "home-expand.h"
#include "str.h"
#include "strescape.h"
#include "var-expand.h"
#include "settings-parser.h"
#include "auth-master.h"
#include "master-service.h"
#include "mail-storage-settings.h"
#include "mail-storage-private.h"
#include "mail-namespace.h"
#include "mail-storage.h"
#include "mail-user.h"

#include <stdlib.h>

struct mail_user_module_register mail_user_module_register = { 0 };
struct auth_master_connection *mail_user_auth_master_conn;

static const char *mail_user_get_temp_prefix_base(struct mail_user *user);

static void mail_user_deinit_base(struct mail_user *user)
{
    mail_namespaces_deinit(&user->namespaces);
    pool_unref(&user->pool);
}

struct mail_user *mail_user_alloc(const char *username,
                  const struct setting_parser_info *set_info,
                  const struct mail_user_settings *set)
{
    struct mail_user *user;
    pool_t pool;

    i_assert(username != NULL);
    i_assert(*username != '\0');

    pool = pool_alloconly_create("mail user", 16*1024);
    user = p_new(pool, struct mail_user, 1);
    user->pool = pool;
    user->refcount = 1;
    user->username = p_strdup(pool, username);
    user->set_info = set_info;
    user->unexpanded_set = settings_dup(set_info, set, pool);
    user->set = settings_dup(set_info, set, pool);
    user->v.deinit = mail_user_deinit_base;
    user->v.get_temp_prefix = mail_user_get_temp_prefix_base;
    p_array_init(&user->module_contexts, user->pool, 5);
    return user;
}

static int
mail_user_expand_plugins_envs(struct mail_user *user, const char **error_r)
{
    const char **envs, *home;
    string_t *str;
    unsigned int i, count;

    if (!array_is_created(&user->set->plugin_envs))
        return 0;

    str = t_str_new(256);
    envs = array_get_modifiable(&user->set->plugin_envs, &count);
    i_assert((count % 2) == 0);
    for (i = 0; i < count; i += 2) {
        if (user->_home == NULL &&
            var_has_key(envs[i+1], 'h', "home") &&
            mail_user_get_home(user, &home) <= 0) {
            *error_r = t_strdup_printf(
                "userdb didn't return a home directory, "
                "but plugin setting %s used it (%%h): %s",
                envs[i], envs[i+1]);
            return -1;
        }
        str_truncate(str, 0);
        var_expand(str, envs[i+1], mail_user_var_expand_table(user));
        envs[i+1] = p_strdup(user->pool, str_c(str));
    }
    return 0;
}

int mail_user_init(struct mail_user *user, const char **error_r)
{
    const struct mail_storage_settings *mail_set;
    const char *home, *key, *value;

    if (user->_home == NULL &&
        settings_vars_have_key(user->set_info, user->set,
                   'h', "home", &key, &value) &&
        mail_user_get_home(user, &home) <= 0) {
        *error_r = t_strdup_printf(
            "userdb didn't return a home directory, "
            "but %s used it (%%h): %s", key, value);
        return -1;
    }

    settings_var_expand(user->set_info, user->set,
                user->pool, mail_user_var_expand_table(user));
    if (mail_user_expand_plugins_envs(user, error_r) < 0)
        return -1;

    mail_set = mail_user_set_get_storage_set(user);
    user->mail_debug = mail_set->mail_debug;

    user->initialized = TRUE;
    hook_mail_user_created(user);
    return 0;
}

void mail_user_ref(struct mail_user *user)
{
    i_assert(user->refcount > 0);

    user->refcount++;
}

void mail_user_unref(struct mail_user **_user)
{
    struct mail_user *user = *_user;

    i_assert(user->refcount > 0);

    *_user = NULL;
    if (--user->refcount == 0)
        user->v.deinit(user);
}

struct mail_user *mail_user_find(struct mail_user *user, const char *name)
{
    struct mail_namespace *ns;

    for (ns = user->namespaces; ns != NULL; ns = ns->next) {
        if (ns->owner != NULL && strcmp(ns->owner->username, name) == 0)
            return ns->owner;
    }
    return NULL;
}

void mail_user_set_vars(struct mail_user *user, uid_t uid, const char *service,
            const struct ip_addr *local_ip,
            const struct ip_addr *remote_ip)
{
    user->uid = uid;
    user->service = p_strdup(user->pool, service);
    if (local_ip != NULL && local_ip->family != 0) {
        user->local_ip = p_new(user->pool, struct ip_addr, 1);
        *user->local_ip = *local_ip;
    }
    if (remote_ip != NULL && remote_ip->family != 0) {
        user->remote_ip = p_new(user->pool, struct ip_addr, 1);
        *user->remote_ip = *remote_ip;
    }
}

const struct var_expand_table *
mail_user_var_expand_table(struct mail_user *user)
{
    static struct var_expand_table static_tab[] = {
        { 'u', NULL, "user" },
        { 'n', NULL, "username" },
        { 'd', NULL, "domain" },
        { 's', NULL, "service" },
        { 'h', NULL, "home" },
        { 'l', NULL, "lip" },
        { 'r', NULL, "rip" },
        { 'p', NULL, "pid" },
        { 'i', NULL, "uid" },
        { '\0', NULL, NULL }
    };
    struct var_expand_table *tab;

    if (user->var_expand_table != NULL)
        return user->var_expand_table;

    tab = p_malloc(user->pool, sizeof(static_tab));
    memcpy(tab, static_tab, sizeof(static_tab));

    tab[0].value = user->username;
    tab[1].value = p_strdup(user->pool, t_strcut(user->username, '@'));
    tab[2].value = strchr(user->username, '@');
    if (tab[2].value != NULL) tab[2].value++;
    tab[3].value = user->service;
    tab[4].value = user->_home; /* don't look it up unless we need it */
    tab[5].value = user->local_ip == NULL ? NULL :
        p_strdup(user->pool, net_ip2addr(user->local_ip));
    tab[6].value = user->remote_ip == NULL ? NULL :
        p_strdup(user->pool, net_ip2addr(user->remote_ip));
    tab[7].value = my_pid;
    tab[8].value = p_strdup(user->pool, dec2str(user->uid));

    user->var_expand_table = tab;
    return user->var_expand_table;
}

void mail_user_set_home(struct mail_user *user, const char *home)
{
    user->_home = p_strdup(user->pool, home);
    user->home_looked_up = TRUE;
}

void mail_user_add_namespace(struct mail_user *user,
                 struct mail_namespace **namespaces)
{
    struct mail_namespace **tmp, *next, *ns = *namespaces;

    for (; ns != NULL; ns = next) {
        next = ns->next;

        tmp = &user->namespaces;
        for (; *tmp != NULL; tmp = &(*tmp)->next) {
            if (strlen(ns->prefix) < strlen((*tmp)->prefix))
                break;
        }
        ns->next = *tmp;
        *tmp = ns;
    }
    *namespaces = user->namespaces;
}

void mail_user_drop_useless_namespaces(struct mail_user *user)
{
    struct mail_namespace *ns, *next;

    for (ns = user->namespaces; ns != NULL; ns = next) {
        next = ns->next;

        if ((ns->flags & NAMESPACE_FLAG_USABLE) == 0 &&
            (ns->flags & NAMESPACE_FLAG_AUTOCREATED) != 0)
            mail_namespace_destroy(ns);
    }
}

const char *mail_user_home_expand(struct mail_user *user, const char *path)
{
    (void)mail_user_try_home_expand(user, &path);
    return path;
}

int mail_user_get_home(struct mail_user *user, const char **home_r)
{
    struct auth_user_info info;
    struct auth_user_reply reply;
    pool_t userdb_pool;
    const char *username, *const *fields;
    int ret;

    memset(&info, 0, sizeof(info));
    info.service = "lib-storage";
    if (user->local_ip != NULL)
        info.local_ip = *user->local_ip;
    if (user->remote_ip != NULL)
        info.remote_ip = *user->remote_ip;

    if (user->home_looked_up) {
        *home_r = user->_home;
        return user->_home != NULL ? 1 : 0;
    }

    if (mail_user_auth_master_conn == NULL)
        return 0;

    userdb_pool = pool_alloconly_create("userdb lookup", 512);
    ret = auth_master_user_lookup(mail_user_auth_master_conn,
                      user->username, &info, userdb_pool,
                      &username, &fields);
    if (ret < 0)
        *home_r = NULL;
    else {
        auth_user_fields_parse(fields, userdb_pool, &reply);
        user->_home = ret == 0 ? NULL :
            p_strdup(user->pool, reply.home);
        user->home_looked_up = TRUE;
        ret = user->_home != NULL ? 1 : 0;
        *home_r = user->_home;
    }
    pool_unref(&userdb_pool);
    return ret;
}

bool mail_user_is_plugin_loaded(struct mail_user *user, struct module *module)
{
    const char *const *plugins;
    bool ret;

    T_BEGIN {
        plugins = t_strsplit_spaces(user->set->mail_plugins, ", ");
        ret = str_array_find(plugins, module_get_plugin_name(module));
    } T_END;
    return ret;
}

const char *mail_user_plugin_getenv(struct mail_user *user, const char *name)
{
    return mail_user_set_plugin_getenv(user->set, name);
}

const char *mail_user_set_plugin_getenv(const struct mail_user_settings *set,
                    const char *name)
{
    const char *const *envs;
    unsigned int i, count;

    if (!array_is_created(&set->plugin_envs))
        return NULL;

    envs = array_get(&set->plugin_envs, &count);
    for (i = 0; i < count; i += 2) {
        if (strcmp(envs[i], name) == 0)
            return envs[i+1];
    }
    return NULL;
}

int mail_user_try_home_expand(struct mail_user *user, const char **pathp)
{
    const char *home, *path = *pathp;

    if (mail_user_get_home(user, &home) < 0)
        return -1;

    path = home_expand_tilde(path, home);
    if (path == NULL)
        return -1;

    *pathp = path;
    return 0;
}

static const char *mail_user_get_temp_prefix_base(struct mail_user *user)
{
    struct mail_namespace *ns;
    const char *dir;

    if (user->_home != NULL) {
        return t_strconcat(user->_home, "/.temp.", my_hostname, ".",
                   my_pid, ".", NULL);
    }

    ns = mail_namespace_find_inbox(user->namespaces);
    if (ns == NULL)
        ns = user->namespaces;

    if (ns->storage->temp_path_prefix != NULL)
        return ns->storage->temp_path_prefix;

    dir = mailbox_list_get_path(ns->list, NULL,
                    MAILBOX_LIST_PATH_TYPE_DIR);
    return t_strconcat(dir, "/",
               mailbox_list_get_temp_prefix(ns->list), NULL);
}

const char *mail_user_get_temp_prefix(struct mail_user *user)
{
    return user->v.get_temp_prefix(user);
}

const char *mail_user_get_anvil_userip_ident(struct mail_user *user)
{
    if (user->remote_ip == NULL)
        return NULL;
    return t_strconcat(net_ip2addr(user->remote_ip), "/",
               str_tabescape(user->username), NULL);
}