virtual-config.c revision e93184a9055c2530366dfe617e07199603c399dd
02c335c23bf5fa225a467c19f2c063fb0dc7b8c3Timo Sirainen/* Copyright (c) 2008-2016 Dovecot authors, see the included COPYING file */
db0735f9b388c5bcfb781b1b25015e898d63d953Timo Sirainenvirtual_search_args_parse(const string_t *rule, const char **error_r)
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen input = i_stream_create_from_data(str_data(rule), str_len(rule));
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen imap_parser = imap_parser_create(input, NULL, (size_t)-1);
5c2d695acf9f95ae0dcdda89c4d2391ceda4d672Timo Sirainen ret = imap_parser_finish_line(imap_parser, 0, 0, &args);
7bb371485650002935888b2f9b72b23aba5a5d9aStephan Bosch *error_r = t_strdup(imap_parser_get_error(imap_parser, NULL));
84078771687fabf75819918f0f3aecdc3ed08b36Timo Sirainen if (mail_search_build(mail_search_register_get_imap(),
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainenvirtual_config_add_rule(struct virtual_parse_context *ctx, const char **error_r)
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen unsigned int i, count;
66c0f96d704f09c88dd03b0ee13a3e9711ffe593Timo Sirainen if (ctx->rule_idx == array_count(&ctx->mbox->backend_boxes)) {
7e209b78ca757294dbbc15604c88673b3a6b0c39Timo Sirainen crc32_str_more(ctx->mbox->search_args_crc32, str_c(ctx->rule));
db0735f9b388c5bcfb781b1b25015e898d63d953Timo Sirainen search_args = virtual_search_args_parse(ctx->rule, error_r);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen *error_r = t_strconcat("Previous search rule is invalid: ",
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen /* update at all the mailboxes that were introduced since the previous
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen bboxes = array_get(&ctx->mbox->backend_boxes, &count);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen ctx->rule_idx = array_count(&ctx->mbox->backend_boxes);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainenvirtual_config_parse_line(struct virtual_parse_context *ctx, const char *line,
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen const char **error_r)
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen struct mail_user *user = ctx->mbox->storage->storage.user;
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen const char *p;
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen /* continues the previous search rule */
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen if (ctx->rule_idx == array_count(&ctx->mbox->backend_boxes)) {
bcdb6c0bd2e7dbb34b306d3d8c2383a7d7654612Timo Sirainen /* if there is no rule yet, it means we want the previous mailboxes
bcdb6c0bd2e7dbb34b306d3d8c2383a7d7654612Timo Sirainen to use the rule that comes later */
bcdb6c0bd2e7dbb34b306d3d8c2383a7d7654612Timo Sirainen if (virtual_config_add_rule(ctx, error_r) < 0)
fb297df915b623e8d83632abcd42182cbd86174aTimo Sirainen *error_r = t_strdup_printf("Mailbox name not UTF-8: %s",
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen /* new mailbox. the search args are added to it later. */
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen bbox = p_new(ctx->pool, struct virtual_backend_box, 1);
c115c742f730e312d6b6ab5064595cd0d8b4e26eTimo Sirainen /* save messages here */
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen /* [+-!]/metadata entry:value */
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen *error_r = "':' separator missing between metadata entry name and value";
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen bbox->metadata_entry = p_strdup_until(ctx->pool, bbox->name, p++);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen if (!imap_metadata_verify_entry_name(bbox->metadata_entry, error_r))
28d6a9ec6b055ad6141f0961fe971543f781d4a6Timo Sirainen bbox->glob = imap_match_init(ctx->pool, bbox->name, TRUE, ctx->sep);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen /* now that the prefix characters have been processed,
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen find the namespace */
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen bbox->ns = strcasecmp(bbox->name, "INBOX") == 0 ?
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen mail_namespace_find(user->namespaces, bbox->name);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen *error_r = t_strdup_printf("Namespace not found for %s",
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen if (strcmp(bbox->name, ctx->mbox->box.vname) == 0) {
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen *error_r = "Virtual mailbox can't point to itself";
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen array_append(&ctx->mbox->backend_boxes, &bbox, 1);
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainenvirtual_mailbox_get_list_patterns(struct virtual_parse_context *ctx)
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainen unsigned int i, count;
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainen bboxes = array_get_modifiable(&mbox->backend_boxes, &count);
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainen p_array_init(&mbox->list_include_patterns, ctx->pool, count);
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainen p_array_init(&mbox->list_exclude_patterns, ctx->pool, count);
3852872e6954b7132e637294132005e86b8ebd4aTimo Sirainen for (i = 0; i < count; i++) {
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainenseparate_wildcard_mailboxes(struct virtual_mailbox *mbox,
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen ARRAY_TYPE(virtual_backend_box) *wildcard_boxes,
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen ARRAY_TYPE(virtual_backend_box) *metadata_boxes)
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen unsigned int i, count;
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen bboxes = array_get_modifiable(&mbox->backend_boxes, &count);
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen t_array_init(wildcard_boxes, I_MIN(16, count));
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen for (i = 0; i < count;) {
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen bboxes = array_get_modifiable(&mbox->backend_boxes,
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainenstatic void virtual_config_copy_expanded(struct virtual_parse_context *ctx,
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen bbox = p_new(ctx->pool, struct virtual_backend_box, 1);
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen array_append(&ctx->mbox->backend_boxes, &bbox, 1);
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainenstatic bool virtual_ns_match(struct mail_namespace *config_ns,
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainen /* we match only one namespace for each pattern, except with shared
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainen namespaces match also autocreated children */
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainen (config_ns->flags & NAMESPACE_FLAG_AUTOCREATED) == 0 &&
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainen (iter_ns->flags & NAMESPACE_FLAG_AUTOCREATED) != 0)
762d8af0b3fee4aef634f413ec61baccab827b37Timo Sirainen if ((iter_ns->flags & NAMESPACE_FLAG_INBOX_USER) != 0 &&
762d8af0b3fee4aef634f413ec61baccab827b37Timo Sirainen (config_ns->flags & NAMESPACE_FLAG_AUTOCREATED) != 0 &&
762d8af0b3fee4aef634f413ec61baccab827b37Timo Sirainen /* prefix="" namespace was autocreated, so e.g. "*" would match
762d8af0b3fee4aef634f413ec61baccab827b37Timo Sirainen only that empty namespace. but we want "*" to also match
762d8af0b3fee4aef634f413ec61baccab827b37Timo Sirainen the inbox=yes namespace, so check it here separately. */
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainenstatic bool virtual_config_match(const struct mailbox_info *info,
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen unsigned int *idx_r)
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen unsigned int i, count;
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen boxes = array_get_modifiable(boxes_arr, &count);
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen for (i = 0; i < count; i++) {
77d20bf99719739c8a3d1157ccc28f37f6032f94Timo Sirainen if (virtual_ns_match(boxes[i]->ns, info->ns) &&
77a2367051db01c6fc8cc575242d8a7f5b2c1d42Timo Sirainen if (strcmp(boxes[i]->name, info->vname) == 0) {
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainenstatic int virtual_config_box_metadata_match(struct mailbox *box,
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen const char **error_r)
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen imtrans = imap_metadata_transaction_begin(box);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen ret = imap_metadata_get(imtrans, bbox->metadata_entry, &value);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen *error_r = t_strdup(imap_metadata_transaction_get_last_error(imtrans, NULL));
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen ret = wildcard_match(value.value, bbox->metadata_value) ? 1 : 0;
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen (void)imap_metadata_transaction_commit(&imtrans, NULL, NULL);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainenvirtual_config_metadata_match(const struct mailbox_info *info,
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen const char **error_r)
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen unsigned int i, count;
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen boxes = array_get_modifiable(boxes_arr, &count);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen box = mailbox_alloc(info->ns->list, info->vname, MAILBOX_FLAG_READONLY);
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen for (i = 0; i < count; i++) {
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen if ((ret = virtual_config_box_metadata_match(box, boxes[i], error_r)) <= 0)
a5056d1e9dd4c430390f8b1dc874a95a2fa16380Timo Sirainenstatic int virtual_config_expand_wildcards(struct virtual_parse_context *ctx,
a5056d1e9dd4c430390f8b1dc874a95a2fa16380Timo Sirainen const char **error_r)
3e0bae44b65f5c46989fcef3d1e07203f496327eTimo Sirainen const enum mail_namespace_type iter_ns_types =
de4d9f77d6378a416c9963963eac5ac18b75ec0bTimo Sirainen const enum mailbox_list_iter_flags iter_flags =
2615df45a8027948a474abe5e817b34b0499c171Timo Sirainen struct mail_user *user = ctx->mbox->storage->storage.user;
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen ARRAY_TYPE(virtual_backend_box) wildcard_boxes, neg_boxes, metadata_boxes;
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen unsigned int i, j, count;
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen separate_wildcard_mailboxes(ctx->mbox, &wildcard_boxes,
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen /* get patterns we want to list */
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen wboxes = array_get_modifiable(&wildcard_boxes, &count);
5e203e846133e28d0e36ca70ef1c30e72a922c14Timo Sirainen /* only negative wildcards - doesn't really make sense.
5e203e846133e28d0e36ca70ef1c30e72a922c14Timo Sirainen just ignore. */
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen for (i = 0; i < count; i++)
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen /* match listed mailboxes to wildcards */
d23c747de9d33966483fbdd41f08ad7766da7c5cTimo Sirainen iter = mailbox_list_iter_init_namespaces(user->namespaces, patterns,
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen while ((info = mailbox_list_iter_next(iter)) != NULL) {
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen /* skip non-selectable mailboxes (especially mbox
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen directories) */
676a42c1de72aaa6149d1ffd1d26c862951798a3Timo Sirainen if (strcmp(info->vname, ctx->mbox->box.vname) == 0) {
676a42c1de72aaa6149d1ffd1d26c862951798a3Timo Sirainen /* don't allow virtual folder to point to itself */
834f2b9f60d93e4c7dfc6992e692f5b7213a1b11Timo Sirainen if (virtual_config_match(info, &wildcard_boxes, &i) &&
107f6e87c6edcb29cf87195357144dea3fdda9afTimo Sirainen !virtual_config_match(info, &neg_boxes, &j) &&
27f174f3b836b18cb81cd1e6534031f1f3355348Timo Sirainen ret = virtual_config_metadata_match(info, &metadata_boxes, error_r);
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen for (i = 0; i < count; i++)
111a7dda02defa4d612468cfc3c40da5240645afTimo Sirainen mail_search_args_unref(&wboxes[i]->search_args);
a5056d1e9dd4c430390f8b1dc874a95a2fa16380Timo Sirainen *error_r = mailbox_list_get_last_error(user->namespaces->list, NULL);
3b1bf68d26c9f2fe4a649f40cf375d52acffc81cTimo Sirainenstatic void virtual_config_search_args_dup(struct virtual_mailbox *mbox)
3b1bf68d26c9f2fe4a649f40cf375d52acffc81cTimo Sirainen unsigned int i, count;
3b1bf68d26c9f2fe4a649f40cf375d52acffc81cTimo Sirainen bboxes = array_get_modifiable(&mbox->backend_boxes, &count);
3b1bf68d26c9f2fe4a649f40cf375d52acffc81cTimo Sirainen for (i = 0; i < count; i++) {
3b1bf68d26c9f2fe4a649f40cf375d52acffc81cTimo Sirainen bboxes[i]->search_args = mail_search_args_dup(old_args);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainenint virtual_config_read(struct virtual_mailbox *mbox)
722957a2f5974a4b38bebc89a1886badf2697cdcTimo Sirainen struct mail_storage *storage = mbox->box.storage;
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen unsigned int linenum = 0;
ca98892a6b8a30ffc1fe26fcf02c7d59e3204e7eTimo Sirainen path = t_strconcat(box_path, "/"VIRTUAL_CONFIG_FNAME, NULL);
722957a2f5974a4b38bebc89a1886badf2697cdcTimo Sirainen mail_storage_set_error(storage, MAIL_ERROR_NOTFOUND,
bdb026e2dc8a7c77585ed5ba489f0056df8074d4Timo Sirainen T_MAIL_ERR_MAILBOX_NOT_FOUND(mbox->box.vname));
722957a2f5974a4b38bebc89a1886badf2697cdcTimo Sirainen ctx.sep = mail_namespaces_get_root_sep(storage->user->namespaces);
e93184a9055c2530366dfe617e07199603c399ddMartti Rannanjärvi ctx.input = i_stream_create_fd(fd, (size_t)-1);
d4854db53e9c141db3d02821ed857bea101b1cc2Timo Sirainen i_stream_set_return_partial_line(ctx.input, TRUE);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen while ((line = i_stream_read_next_line(ctx.input)) != NULL) {
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen ret = virtual_config_parse_line(&ctx, line, &error);
24e5e4526d8f5cbc056ab97fd0d154d0936d7a5eTimo Sirainen "%s: Error at line %u: %s",
867990944f0bda3a5bd70895d5a5ebfa611d0505Timo Sirainen "%s: Error at line %u: %s",
a5056d1e9dd4c430390f8b1dc874a95a2fa16380Timo Sirainen ret = virtual_config_expand_wildcards(&ctx, &error);
a5056d1e9dd4c430390f8b1dc874a95a2fa16380Timo Sirainen mail_storage_set_critical(storage, "%s: %s", path, error);
db0735f9b388c5bcfb781b1b25015e898d63d953Timo Sirainenvoid virtual_config_free(struct virtual_mailbox *mbox)
db0735f9b388c5bcfb781b1b25015e898d63d953Timo Sirainen unsigned int i, count;
9ec13676a657d974f6aaf85c6720c27f29ef8eb9Timo Sirainen if (!array_is_created(&mbox->backend_boxes)) {
9ec13676a657d974f6aaf85c6720c27f29ef8eb9Timo Sirainen /* mailbox wasn't opened */
db0735f9b388c5bcfb781b1b25015e898d63d953Timo Sirainen bboxes = array_get_modifiable(&mbox->backend_boxes, &count);
66c0f96d704f09c88dd03b0ee13a3e9711ffe593Timo Sirainen for (i = 0; i < count; i++) {