src/doveadm/doveadm-mail-mailbox.c

	doveadm-mail-mailbox.c revision 27a44fcfd8d19bffe0f267f20a2b5d3fe7600fdd
/* Copyright (c) 2010-2012 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "array.h"
#include "str.h"
#include "unichar.h"
#include "imap-utf7.h"
#include "mail-namespace.h"
#include "mail-storage.h"
#include "mail-search-build.h"
#include "doveadm-print.h"
#include "doveadm-mailbox-list-iter.h"
#include "doveadm-mail.h"

#include <stdio.h>

struct doveadm_mailbox_cmd_context {
    struct doveadm_mail_cmd_context ctx;
    bool subscriptions;
};

struct mailbox_cmd_context {
    struct doveadm_mailbox_cmd_context ctx;
    ARRAY_TYPE(const_string) mailboxes;
};

struct delete_cmd_context {
    struct doveadm_mailbox_cmd_context ctx;
    ARRAY_TYPE(const_string) mailboxes;
    bool recursive;
};

struct rename_cmd_context {
    struct doveadm_mailbox_cmd_context ctx;
    const char *oldname, *newname;
};

struct list_cmd_context {
    struct doveadm_mailbox_cmd_context ctx;
    struct mail_search_args *search_args;
    bool mutf7;
};

void doveadm_mailbox_args_check(const char *const args[])
{
    unsigned int i;

    for (i = 0; args[i] != NULL; i++) {
        if (!uni_utf8_str_is_valid(args[i])) {
            i_fatal_status(EX_DATAERR,
                "Mailbox name not valid UTF-8: %s", args[i]);
        }
    }
}

static bool cmd_mailbox_parse_arg(struct doveadm_mail_cmd_context *_ctx, int c)
{
    struct doveadm_mailbox_cmd_context *ctx =
        (struct doveadm_mailbox_cmd_context *)_ctx;

    switch (c) {
    case 's':
        ctx->subscriptions = TRUE;
        break;
    default:
        return FALSE;
    }
    return TRUE;
}

#define doveadm_mailbox_cmd_alloc(type) \
    (type *)doveadm_mailbox_cmd_alloc_size(sizeof(type))
static struct doveadm_mail_cmd_context *
doveadm_mailbox_cmd_alloc_size(size_t size)
{
    struct doveadm_mail_cmd_context *ctx;

    ctx = doveadm_mail_cmd_alloc_size(size);
    ctx->getopt_args = "s";
    ctx->v.parse_arg = cmd_mailbox_parse_arg;
    return ctx;
}

static bool
cmd_mailbox_list_parse_arg(struct doveadm_mail_cmd_context *_ctx, int c)
{
    struct list_cmd_context *ctx = (struct list_cmd_context *)_ctx;

    switch (c) {
    case '7':
        ctx->mutf7 = TRUE;
        break;
    case '8':
        ctx->mutf7 = FALSE;
        break;
    case 's':
        ctx->ctx.subscriptions = TRUE;
        break;
    default:
        return FALSE;
    }
    return TRUE;
}

static int
cmd_mailbox_list_run(struct doveadm_mail_cmd_context *_ctx,
             struct mail_user *user)
{
    struct list_cmd_context *ctx = (struct list_cmd_context *)_ctx;
    enum mailbox_list_iter_flags iter_flags =
        MAILBOX_LIST_ITER_RAW_LIST |
        MAILBOX_LIST_ITER_RETURN_NO_FLAGS;
    struct doveadm_mailbox_list_iter *iter;
    const struct mailbox_info *info;
    string_t *str = t_str_new(256);

    if (ctx->ctx.subscriptions)
        iter_flags |= MAILBOX_LIST_ITER_SELECT_SUBSCRIBED;

    iter = doveadm_mailbox_list_iter_full_init(_ctx, user, ctx->search_args,
                           iter_flags);
    while ((info = doveadm_mailbox_list_iter_next(iter)) != NULL) {
        if (!ctx->mutf7)
            doveadm_print(info->vname);
        else {
            str_truncate(str, 0);
            if (imap_utf8_to_utf7(info->vname, str) < 0)
                i_unreached();
            doveadm_print(str_c(str));
        }
    }
    if (doveadm_mailbox_list_iter_deinit(&iter) < 0)
        return -1;
    return 0;
}

struct mail_search_args *
doveadm_mail_mailbox_search_args_build(const char *const args[])
{
    struct mail_search_args *search_args;
    struct mail_search_arg *arg;
    enum mail_search_arg_type type;
    unsigned int i;

    doveadm_mailbox_args_check(args);
    search_args = mail_search_build_init();
    for (i = 0; args[i] != NULL; i++) {
        if (strchr(args[i], '*') != NULL ||
            strchr(args[i], '%') != NULL)
            type = SEARCH_MAILBOX_GLOB;
        else
            type = SEARCH_MAILBOX;
        arg = mail_search_build_add(search_args, type);
        arg->value.str = p_strdup(search_args->pool, args[i]);
    }
    if (i > 1) {
        struct mail_search_arg *subargs = search_args->args;

        search_args->args = NULL;
        arg = mail_search_build_add(search_args, SEARCH_OR);
        arg->value.subargs = subargs;
    }
    return search_args;
}

static void cmd_mailbox_list_init(struct doveadm_mail_cmd_context *_ctx,
                  const char *const args[])
{
    struct list_cmd_context *ctx = (struct list_cmd_context *)_ctx;

    doveadm_print_header("mailbox", "mailbox",
                 DOVEADM_PRINT_HEADER_FLAG_HIDE_TITLE);
    ctx->search_args = doveadm_mail_mailbox_search_args_build(args);
}

static struct doveadm_mail_cmd_context *cmd_mailbox_list_alloc(void)
{
    struct list_cmd_context *ctx;

    ctx = doveadm_mailbox_cmd_alloc(struct list_cmd_context);
    ctx->ctx.ctx.v.init = cmd_mailbox_list_init;
    ctx->ctx.ctx.v.run = cmd_mailbox_list_run;
    ctx->ctx.ctx.v.parse_arg = cmd_mailbox_list_parse_arg;
    ctx->ctx.ctx.getopt_args = "78s";
    doveadm_print_init(DOVEADM_PRINT_TYPE_FLOW);
    return &ctx->ctx.ctx;
}

static int
cmd_mailbox_create_run(struct doveadm_mail_cmd_context *_ctx,
               struct mail_user *user)
{
    struct mailbox_cmd_context *ctx = (struct mailbox_cmd_context *)_ctx;
    struct mail_namespace *ns;
    struct mailbox *box;
    const char *const *namep;
    int ret = 0;

    array_foreach(&ctx->mailboxes, namep) {
        const char *name = *namep;
        unsigned int len;
        bool directory = FALSE;

        ns = mail_namespace_find(user->namespaces, name);
        if (ns == NULL) {
            i_fatal_status(DOVEADM_EX_NOTFOUND,
                       "Can't find namespace for: %s", name);
        }

        len = strlen(name);
        if (len > 0 && name[len-1] == mail_namespace_get_sep(ns)) {
            name = t_strndup(name, len-1);
            directory = TRUE;
        }

        box = mailbox_alloc(ns->list, name, 0);
        if (mailbox_create(box, NULL, directory) < 0) {
            i_error("Can't create mailbox %s: %s", name,
                mailbox_get_last_error(box, NULL));
            doveadm_mail_failed_mailbox(_ctx, box);
            ret = -1;
        }
        if (ctx->ctx.subscriptions) {
            if (mailbox_set_subscribed(box, TRUE) < 0) {
                i_error("Can't subscribe to mailbox %s: %s", name,
                    mailbox_get_last_error(box, NULL));
                doveadm_mail_failed_mailbox(_ctx, box);
                ret = -1;
            }
        }
        mailbox_free(&box);
    }
    return ret;
}

static void cmd_mailbox_create_init(struct doveadm_mail_cmd_context *_ctx,
                    const char *const args[])
{
    struct mailbox_cmd_context *ctx = (struct mailbox_cmd_context *)_ctx;
    const char *name;
    unsigned int i;

    if (args[0] == NULL)
        doveadm_mail_help_name("mailbox create");
    doveadm_mailbox_args_check(args);

    for (i = 0; args[i] != NULL; i++) {
        name = p_strdup(ctx->ctx.ctx.pool, args[i]);
        array_append(&ctx->mailboxes, &name, 1);
    }
}

static struct doveadm_mail_cmd_context *cmd_mailbox_create_alloc(void)
{
    struct mailbox_cmd_context *ctx;

    ctx = doveadm_mailbox_cmd_alloc(struct mailbox_cmd_context);
    ctx->ctx.ctx.v.init = cmd_mailbox_create_init;
    ctx->ctx.ctx.v.run = cmd_mailbox_create_run;
    p_array_init(&ctx->mailboxes, ctx->ctx.ctx.pool, 16);
    return &ctx->ctx.ctx;
}

static int i_strcmp_reverse_p(const char *const *s1, const char *const *s2)
{
    return -strcmp(*s1, *s2);
}

static int
get_child_mailboxes(struct mail_user *user, ARRAY_TYPE(const_string) *mailboxes,
            const char *name)
{
    struct mailbox_list_iterate_context *iter;
    struct mail_namespace *ns;
    const struct mailbox_info *info;
    const char *pattern, *child_name;

    ns = mail_namespace_find(user->namespaces, name);
    if (ns == NULL)
        return 0;

    pattern = t_strdup_printf("%s%c*", name, mail_namespace_get_sep(ns));
    iter = mailbox_list_iter_init(ns->list, pattern,
                      MAILBOX_LIST_ITER_RETURN_NO_FLAGS);
    while ((info = mailbox_list_iter_next(iter)) != NULL) {
        child_name = t_strdup(info->vname);
        array_append(mailboxes, &child_name, 1);
    }
    return mailbox_list_iter_deinit(&iter);
}

static int
cmd_mailbox_delete_run(struct doveadm_mail_cmd_context *_ctx,
               struct mail_user *user)
{
    struct delete_cmd_context *ctx = (struct delete_cmd_context *)_ctx;
    struct mail_namespace *ns;
    struct mailbox *box;
    struct mail_storage *storage;
    const char *const *namep;
    ARRAY_TYPE(const_string) recursive_mailboxes;
    const ARRAY_TYPE(const_string) *mailboxes = &ctx->mailboxes;
    int ret = 0;

    if (ctx->recursive) {
        t_array_init(&recursive_mailboxes, 32);
        array_foreach(&ctx->mailboxes, namep) {
            if (get_child_mailboxes(user, &recursive_mailboxes,
                        *namep) < 0) {
                doveadm_mail_failed_error(_ctx, MAIL_ERROR_TEMP);
                ret = -1;
            }
            array_append(&recursive_mailboxes, namep, 1);
        }
        array_sort(&recursive_mailboxes, i_strcmp_reverse_p);
        mailboxes = &recursive_mailboxes;
    }

    array_foreach(mailboxes, namep) {
        const char *name = *namep;

        ns = mail_namespace_find(user->namespaces, name);
        if (ns == NULL) {
            i_error("Can't find namespace for: %s", name);
            doveadm_mail_failed_error(_ctx, MAIL_ERROR_NOTFOUND);
            ret = -1;
            continue;
        }

        box = mailbox_alloc(ns->list, name, 0);
        storage = mailbox_get_storage(box);
        if (mailbox_delete(box) < 0) {
            i_error("Can't delete mailbox %s: %s", name,
                mailbox_get_last_error(box, NULL));
            doveadm_mail_failed_mailbox(_ctx, box);
            ret = -1;
        }
        if (ctx->ctx.subscriptions) {
            if (mailbox_set_subscribed(box, FALSE) < 0) {
                i_error("Can't unsubscribe mailbox %s: %s", name,
                    mail_storage_get_last_error(storage, NULL));
                doveadm_mail_failed_mailbox(_ctx, box);
                ret = -1;
            }
        }
        mailbox_free(&box);
    }
    return ret;
}

static void cmd_mailbox_delete_init(struct doveadm_mail_cmd_context *_ctx,
                    const char *const args[])
{
    struct delete_cmd_context *ctx = (struct delete_cmd_context *)_ctx;
    const char *name;
    unsigned int i;

    if (args[0] == NULL)
        doveadm_mail_help_name("mailbox delete");
    doveadm_mailbox_args_check(args);

    for (i = 0; args[i] != NULL; i++) {
        name = p_strdup(ctx->ctx.ctx.pool, args[i]);
        array_append(&ctx->mailboxes, &name, 1);
    }
    array_sort(&ctx->mailboxes, i_strcmp_reverse_p);
}

static bool
cmd_mailbox_delete_parse_arg(struct doveadm_mail_cmd_context *_ctx, int c)
{
    struct delete_cmd_context *ctx = (struct delete_cmd_context *)_ctx;

    switch (c) {
    case 'r':
        ctx->recursive = TRUE;
        break;
    case 's':
        ctx->ctx.subscriptions = TRUE;
        break;
    default:
        return FALSE;
    }
    return TRUE;
}

static struct doveadm_mail_cmd_context *cmd_mailbox_delete_alloc(void)
{
    struct delete_cmd_context *ctx;

    ctx = doveadm_mailbox_cmd_alloc(struct delete_cmd_context);
    ctx->ctx.ctx.v.init = cmd_mailbox_delete_init;
    ctx->ctx.ctx.v.run = cmd_mailbox_delete_run;
    ctx->ctx.ctx.v.parse_arg = cmd_mailbox_delete_parse_arg;
    ctx->ctx.ctx.getopt_args = "rs";
    p_array_init(&ctx->mailboxes, ctx->ctx.ctx.pool, 16);
    return &ctx->ctx.ctx;
}

static int
cmd_mailbox_rename_run(struct doveadm_mail_cmd_context *_ctx,
               struct mail_user *user)
{
    struct rename_cmd_context *ctx = (struct rename_cmd_context *)_ctx;
    struct mail_namespace *oldns, *newns;
    struct mailbox *oldbox, *newbox;
    const char *oldname = ctx->oldname;
    const char *newname = ctx->newname;
    int ret = 0;

    oldns = mail_namespace_find(user->namespaces, oldname);
    if (oldns == NULL) {
        i_fatal_status(DOVEADM_EX_NOTFOUND,
                   "Can't find namespace for: %s", oldname);
    }
    newns = mail_namespace_find(user->namespaces, newname);
    if (newns == NULL) {
        i_fatal_status(DOVEADM_EX_NOTFOUND,
                   "Can't find namespace for: %s", newname);
    }

    oldbox = mailbox_alloc(oldns->list, oldname, 0);
    newbox = mailbox_alloc(newns->list, newname, 0);
    if (mailbox_rename(oldbox, newbox, TRUE) < 0) {
        i_error("Can't rename mailbox %s to %s: %s", oldname, newname,
            mailbox_get_last_error(oldbox, NULL));
        doveadm_mail_failed_mailbox(_ctx, oldbox);
        ret = -1;
    }
    if (ctx->ctx.subscriptions) {
        if (mailbox_set_subscribed(oldbox, FALSE) < 0) {
            i_error("Can't unsubscribe mailbox %s: %s", ctx->oldname,
                mailbox_get_last_error(oldbox, NULL));
            doveadm_mail_failed_mailbox(_ctx, oldbox);
            ret = -1;
        }
        if (mailbox_set_subscribed(newbox, TRUE) < 0) {
            i_error("Can't subscribe to mailbox %s: %s", ctx->newname,
                mailbox_get_last_error(newbox, NULL));
            doveadm_mail_failed_mailbox(_ctx, newbox);
            ret = -1;
        }
    }

    mailbox_free(&oldbox);
    mailbox_free(&newbox);
    return ret;
}

static void cmd_mailbox_rename_init(struct doveadm_mail_cmd_context *_ctx,
                    const char *const args[])
{
    struct rename_cmd_context *ctx = (struct rename_cmd_context *)_ctx;

    if (str_array_length(args) != 2)
        doveadm_mail_help_name("mailbox rename");
    doveadm_mailbox_args_check(args);

    ctx->oldname = p_strdup(ctx->ctx.ctx.pool, args[0]);
    ctx->newname = p_strdup(ctx->ctx.ctx.pool, args[1]);
}

static struct doveadm_mail_cmd_context *cmd_mailbox_rename_alloc(void)
{
    struct rename_cmd_context *ctx;

    ctx = doveadm_mailbox_cmd_alloc(struct rename_cmd_context);
    ctx->ctx.ctx.v.init = cmd_mailbox_rename_init;
    ctx->ctx.ctx.v.run = cmd_mailbox_rename_run;
    return &ctx->ctx.ctx;
}

static int
cmd_mailbox_subscribe_run(struct doveadm_mail_cmd_context *_ctx,
              struct mail_user *user)
{
    struct mailbox_cmd_context *ctx = (struct mailbox_cmd_context *)_ctx;
    struct mail_namespace *ns;
    struct mailbox *box;
    const char *const *namep;
    int ret = 0;

    array_foreach(&ctx->mailboxes, namep) {
        const char *name = *namep;

        ns = mail_namespace_find(user->namespaces, name);
        if (ns == NULL) {
            i_fatal_status(DOVEADM_EX_NOTFOUND,
                       "Can't find namespace for: %s", name);
        }

        box = mailbox_alloc(ns->list, name, 0);
        if (mailbox_set_subscribed(box, ctx->ctx.subscriptions) < 0) {
            i_error("Can't %s mailbox %s: %s", name,
                ctx->ctx.subscriptions ? "subscribe to" :
                "unsubscribe",
                mailbox_get_last_error(box, NULL));
            doveadm_mail_failed_mailbox(_ctx, box);
            ret = -1;
        }
        mailbox_free(&box);
    }
    return ret;
}

static void cmd_mailbox_subscribe_init(struct doveadm_mail_cmd_context *_ctx,
                       const char *const args[])
{
    struct mailbox_cmd_context *ctx = (struct mailbox_cmd_context *)_ctx;
    const char *name;
    unsigned int i;

    if (args[0] == NULL) {
        doveadm_mail_help_name(ctx->ctx.subscriptions ?
                       "mailbox subscribe" :
                       "mailbox unsubscribe");
    }
    doveadm_mailbox_args_check(args);

    for (i = 0; args[i] != NULL; i++) {
        name = p_strdup(ctx->ctx.ctx.pool, args[i]);
        array_append(&ctx->mailboxes, &name, 1);
    }
}

static struct doveadm_mail_cmd_context *
cmd_mailbox_subscriptions_alloc(bool subscriptions)
{
    struct mailbox_cmd_context *ctx;

    ctx = doveadm_mail_cmd_alloc(struct mailbox_cmd_context);
    ctx->ctx.subscriptions = subscriptions;

    ctx->ctx.ctx.v.parse_arg = cmd_mailbox_parse_arg;
    ctx->ctx.ctx.v.init = cmd_mailbox_subscribe_init;
    ctx->ctx.ctx.v.run = cmd_mailbox_subscribe_run;
    p_array_init(&ctx->mailboxes, ctx->ctx.ctx.pool, 16);
    return &ctx->ctx.ctx;
}

static struct doveadm_mail_cmd_context *cmd_mailbox_subscribe_alloc(void)
{
    return cmd_mailbox_subscriptions_alloc(TRUE);
}

static struct doveadm_mail_cmd_context *cmd_mailbox_unsubscribe_alloc(void)
{
    return cmd_mailbox_subscriptions_alloc(FALSE);
}

struct doveadm_mail_cmd cmd_mailbox_list = {
    cmd_mailbox_list_alloc, "mailbox list",
    "[-7|-8] [-s] [<mailbox mask> [...]]"
};
struct doveadm_mail_cmd cmd_mailbox_create = {
    cmd_mailbox_create_alloc, "mailbox create",
    "[-s] <mailbox> [...]"
};
struct doveadm_mail_cmd cmd_mailbox_delete = {
    cmd_mailbox_delete_alloc, "mailbox delete",
    "[-s] <mailbox> [...]"
};
struct doveadm_mail_cmd cmd_mailbox_rename = {
    cmd_mailbox_rename_alloc, "mailbox rename",
    "[-s] <old name> <new name>"
};
struct doveadm_mail_cmd cmd_mailbox_subscribe = {
    cmd_mailbox_subscribe_alloc, "mailbox subscribe",
    "<mailbox> [...]"
};
struct doveadm_mail_cmd cmd_mailbox_unsubscribe = {
    cmd_mailbox_unsubscribe_alloc, "mailbox unsubscribe",
    "<mailbox> [...]"
};