src/doveadm/doveadm-mailbox-list-iter.c

	doveadm-mailbox-list-iter.c revision e8c6287f4489b7dc3f4af8eab3f97abe44cf1706
/* Copyright (c) 2010-2012 Dovecot authors, see the included COPYING file */

#include "lib.h"
#include "array.h"
#include "str.h"
#include "mail-search.h"
#include "mail-namespace.h"
#include "mailbox-list.h"
#include "doveadm-mail.h"
#include "doveadm-mailbox-list-iter.h"

struct doveadm_mailbox_list_iter {
    struct mail_user *user;
    struct doveadm_mail_cmd_context *ctx;
    struct mail_search_args *search_args;
    enum mailbox_list_iter_flags iter_flags;

    struct mailbox_list_iterate_context *iter;

    struct mailbox_info info;
    ARRAY_TYPE(const_string) patterns;
    unsigned int pattern_idx;

    bool only_selectable;
};

static int
search_args_get_mailbox_patterns(const struct mail_search_arg *args,
                 ARRAY_TYPE(const_string) *patterns,
                 bool *have_guid, bool *have_wildcards)
{
    const struct mail_search_arg *subargs;

    for (; args != NULL; args = args->next) {
        switch (args->type) {
        case SEARCH_OR:
            /* we don't currently try to optimize OR. */
            break;
        case SEARCH_SUB:
        case SEARCH_INTHREAD:
            subargs = args->value.subargs;
            for (; subargs != NULL; subargs = subargs->next) {
                if (!search_args_get_mailbox_patterns(subargs,
                            patterns, have_guid,
                            have_wildcards))
                    return 0;
            }
            break;
        case SEARCH_MAILBOX_GLOB:
            *have_wildcards = TRUE;
            /* fall through */
        case SEARCH_MAILBOX:
            if (args->match_not) {
                array_clear(patterns);
                return 0;
            }
            array_append(patterns, &args->value.str, 1);
            break;
        case SEARCH_MAILBOX_GUID:
            *have_guid = TRUE;
            break;
        default:
            break;
        }
    }
    return 1;
}

static struct doveadm_mailbox_list_iter *
doveadm_mailbox_list_iter_init_nsmask(struct doveadm_mail_cmd_context *ctx,
                      struct mail_user *user,
                      struct mail_search_args *search_args,
                      enum mailbox_list_iter_flags iter_flags,
                      enum namespace_type ns_mask)
{
    static const char *all_pattern = "*";
    struct doveadm_mailbox_list_iter *iter;
    bool have_guid = FALSE, have_wildcards = FALSE;

    iter = i_new(struct doveadm_mailbox_list_iter, 1);
    iter->ctx = ctx;
    iter->search_args = search_args;
    iter->user = user;
    i_array_init(&iter->patterns, 16);
    search_args_get_mailbox_patterns(search_args->args, &iter->patterns,
                     &have_guid, &have_wildcards);

    if (array_count(&iter->patterns) == 0) {
        iter_flags |= MAILBOX_LIST_ITER_SKIP_ALIASES;
        if (have_guid)
            ns_mask |= NAMESPACE_SHARED | NAMESPACE_PUBLIC;
        array_append(&iter->patterns, &all_pattern, 1);
    } else if (have_wildcards) {
        iter_flags |= MAILBOX_LIST_ITER_STAR_WITHIN_NS;
        ns_mask |= NAMESPACE_SHARED | NAMESPACE_PUBLIC;
    } else {
        /* just return the listed mailboxes without actually
           iterating through. this also allows accessing mailboxes
           without lookup ACL right */
        return iter;
    }
    (void)array_append_space(&iter->patterns);

    iter->only_selectable = TRUE;
    iter->iter_flags = iter_flags;
    iter->iter = mailbox_list_iter_init_namespaces(user->namespaces,
                               array_idx(&iter->patterns, 0),
                               ns_mask, iter_flags);
    return iter;
}

struct doveadm_mailbox_list_iter *
doveadm_mailbox_list_iter_init(struct doveadm_mail_cmd_context *ctx,
                   struct mail_user *user,
                   struct mail_search_args *search_args,
                   enum mailbox_list_iter_flags iter_flags)
{
    enum namespace_type ns_mask = NAMESPACE_PRIVATE;

    return doveadm_mailbox_list_iter_init_nsmask(ctx, user, search_args,
                             iter_flags, ns_mask);
}

struct doveadm_mailbox_list_iter *
doveadm_mailbox_list_iter_full_init(struct doveadm_mail_cmd_context *ctx,
                    struct mail_user *user,
                    struct mail_search_args *search_args,
                    enum mailbox_list_iter_flags iter_flags)
{
    enum namespace_type ns_mask =
        NAMESPACE_PRIVATE | NAMESPACE_SHARED | NAMESPACE_PUBLIC;
    struct doveadm_mailbox_list_iter *iter;

    iter = doveadm_mailbox_list_iter_init_nsmask(ctx, user, search_args,
                             iter_flags, ns_mask);
    iter->only_selectable = FALSE;
    return iter;
}

int doveadm_mailbox_list_iter_deinit(struct doveadm_mailbox_list_iter **_iter)
{
    struct doveadm_mailbox_list_iter *iter = *_iter;
    int ret;

    *_iter = NULL;

    if (iter->iter == NULL)
        ret = 0;
    else if ((ret = mailbox_list_iter_deinit(&iter->iter)) < 0) {
        i_error("Listing mailboxes failed");
        doveadm_mail_failed_error(iter->ctx, MAIL_ERROR_TEMP);
    }
    array_free(&iter->patterns);
    i_free(iter);
    return ret;
}

const struct mailbox_info *
doveadm_mailbox_list_iter_next(struct doveadm_mailbox_list_iter *iter)
{
    const struct mailbox_info *info;
    const char *const *patterns;
    unsigned int count;

    while (iter->iter == NULL) {
        patterns = array_get(&iter->patterns, &count);
        if (iter->pattern_idx == count)
            return NULL;

        iter->info.name = patterns[iter->pattern_idx++];
        iter->info.ns = mail_namespace_find(iter->user->namespaces,
                            iter->info.name);
        if (iter->info.ns != NULL)
            return &iter->info;
        /* FIXME: maybe fail?.. or just wait for v2.2 to get rid of
           this error condition */
    }

    while ((info = mailbox_list_iter_next(iter->iter)) != NULL) {
        char sep = mail_namespace_get_sep(info->ns);

        if ((info->flags & (MAILBOX_NOSELECT |
                    MAILBOX_NONEXISTENT)) != 0) {
            if (iter->only_selectable)
                continue;
        }

        if (mail_search_args_match_mailbox(iter->search_args,
                           info->name, sep))
            break;
    }
    return info;
}