diff options
Diffstat (limited to 'src/imap/cmd-store.c')
| -rw-r--r-- | src/imap/cmd-store.c | 261 |
1 files changed, 261 insertions, 0 deletions
diff --git a/src/imap/cmd-store.c b/src/imap/cmd-store.c new file mode 100644 index 0000000..126c042 --- /dev/null +++ b/src/imap/cmd-store.c @@ -0,0 +1,261 @@ +/* Copyright (c) 2002-2018 Dovecot authors, see the included COPYING file */ + +#include "imap-common.h" +#include "seq-range-array.h" +#include "str.h" +#include "imap-commands.h" +#include "imap-search-args.h" +#include "imap-util.h" + + +struct imap_store_context { + struct client_command_context *cmd; + uint64_t max_modseq; + + enum mail_flags flags; + struct mail_keywords *keywords; + + enum modify_type modify_type; + bool silent; +}; + +static bool +get_modify_type(struct imap_store_context *ctx, const char *type) +{ + if (*type == '+') { + ctx->modify_type = MODIFY_ADD; + type++; + } else if (*type == '-') { + ctx->modify_type = MODIFY_REMOVE; + type++; + } else { + ctx->modify_type = MODIFY_REPLACE; + } + + if (strncasecmp(type, "FLAGS", 5) != 0) + return FALSE; + + ctx->silent = strcasecmp(type+5, ".SILENT") == 0; + if (!ctx->silent && type[5] != '\0') + return FALSE; + return TRUE; +} + +static bool +store_parse_modifiers(struct imap_store_context *ctx, + const struct imap_arg *args) +{ + const char *name, *value; + + for (; !IMAP_ARG_IS_EOL(args); args += 2) { + if (!imap_arg_get_atom(&args[0], &name) || + !imap_arg_get_atom(&args[1], &value)) { + client_send_command_error(ctx->cmd, + "Invalid STORE modifiers."); + return FALSE; + } + + if (strcasecmp(name, "UNCHANGEDSINCE") == 0) { + if (ctx->cmd->client->nonpermanent_modseqs) { + client_send_command_error(ctx->cmd, + "STORE UNCHANGEDSINCE can't be used with non-permanent modseqs"); + return FALSE; + } + if (str_to_uint64(value, &ctx->max_modseq) < 0) { + client_send_command_error(ctx->cmd, + "Invalid modseq"); + return FALSE; + } + client_enable(ctx->cmd->client, imap_feature_condstore); + } else { + client_send_command_error(ctx->cmd, + "Unknown STORE modifier"); + return FALSE; + } + } + return TRUE; +} + +static bool +store_parse_args(struct imap_store_context *ctx, const struct imap_arg *args) +{ + struct client_command_context *cmd = ctx->cmd; + const struct imap_arg *list_args; + const char *type; + const char *const *keywords_list = NULL; + + ctx->max_modseq = (uint64_t)-1; + if (imap_arg_get_list(args, &list_args)) { + if (!store_parse_modifiers(ctx, list_args)) + return FALSE; + args++; + } + + if (!imap_arg_get_astring(args, &type) || + !get_modify_type(ctx, type)) { + client_send_command_error(cmd, "Invalid arguments."); + return FALSE; + } + args++; + + if (imap_arg_get_list(args, &list_args)) { + if (!client_parse_mail_flags(cmd, list_args, + &ctx->flags, &keywords_list)) + return FALSE; + } else { + if (!client_parse_mail_flags(cmd, args, + &ctx->flags, &keywords_list)) + return FALSE; + } + + if (keywords_list != NULL || ctx->modify_type == MODIFY_REPLACE) { + if (mailbox_keywords_create(cmd->client->mailbox, keywords_list, + &ctx->keywords) < 0) { + /* invalid keywords */ + client_send_box_error(cmd, cmd->client->mailbox); + return FALSE; + } + } + return TRUE; +} + +bool cmd_store(struct client_command_context *cmd) +{ + struct client *client = cmd->client; + const struct imap_arg *args; + struct mail_search_args *search_args; + struct mail_search_context *search_ctx; + struct mailbox_transaction_context *t; + struct mail *mail; + struct imap_store_context ctx; + ARRAY_TYPE(seq_range) modified_set, uids; + enum mailbox_transaction_flags flags = 0; + enum imap_sync_flags imap_sync_flags = 0; + const char *set, *reply, *tagged_reply; + string_t *str; + int ret; + bool update_deletes; + unsigned int deleted_count; + + if (!client_read_args(cmd, 0, 0, &args)) + return FALSE; + + if (!client_verify_open_mailbox(cmd)) + return TRUE; + + if (!imap_arg_get_atom(args, &set)) { + client_send_command_error(cmd, "Invalid arguments."); + return TRUE; + } + ret = imap_search_get_seqset(cmd, set, cmd->uid, &search_args); + if (ret <= 0) + return ret < 0; + + i_zero(&ctx); + ctx.cmd = cmd; + if (!store_parse_args(&ctx, ++args)) { + mail_search_args_unref(&search_args); + return TRUE; + } + + if (client->mailbox_examined) { + mail_search_args_unref(&search_args); + if (ctx.max_modseq < (uint64_t)-1) + reply = "NO CONDSTORE failed: Mailbox is read-only."; + else + reply = "OK Store ignored with read-only mailbox."; + return cmd_sync(cmd, MAILBOX_SYNC_FLAG_FAST | + (cmd->uid ? 0 : MAILBOX_SYNC_FLAG_NO_EXPUNGES), + 0, reply); + } + + if (ctx.silent) + flags |= MAILBOX_TRANSACTION_FLAG_HIDE; + if (ctx.max_modseq < (uint64_t)-1) { + /* update modseqs so we can check them early */ + flags |= MAILBOX_TRANSACTION_FLAG_REFRESH; + } + + t = mailbox_transaction_begin(client->mailbox, flags, + imap_client_command_get_reason(cmd)); + + search_ctx = mailbox_search_init(t, search_args, NULL, + MAIL_FETCH_FLAGS, NULL); + mail_search_args_unref(&search_args); + + i_array_init(&modified_set, 64); + if (ctx.max_modseq < (uint64_t)-1) { + /* STORE UNCHANGEDSINCE is being used */ + mailbox_transaction_set_max_modseq(t, ctx.max_modseq, + &modified_set); + } + + update_deletes = (ctx.flags & MAIL_DELETED) != 0 && + ctx.modify_type != MODIFY_REMOVE; + deleted_count = 0; + while (mailbox_search_next(search_ctx, &mail)) { + if (ctx.max_modseq < (uint64_t)-1) { + /* check early so there's less work for transaction + commit if something has to be cancelled */ + if (mail_get_modseq(mail) > ctx.max_modseq) { + seq_range_array_add(&modified_set, mail->seq); + continue; + } + } + if (update_deletes) { + if ((mail_get_flags(mail) & MAIL_DELETED) == 0) + deleted_count++; + } + if (ctx.modify_type == MODIFY_REPLACE || ctx.flags != 0) + mail_update_flags(mail, ctx.modify_type, ctx.flags); + if (ctx.modify_type == MODIFY_REPLACE || ctx.keywords != NULL) { + mail_update_keywords(mail, ctx.modify_type, + ctx.keywords); + } + } + + if (ctx.keywords != NULL) + mailbox_keywords_unref(&ctx.keywords); + + ret = mailbox_search_deinit(&search_ctx); + if (ret < 0) + mailbox_transaction_rollback(&t); + else + ret = mailbox_transaction_commit(&t); + if (ret < 0) { + array_free(&modified_set); + client_send_box_error(cmd, client->mailbox); + return TRUE; + } + client->deleted_count += deleted_count; + + if (array_count(&modified_set) == 0) + tagged_reply = "OK Store completed."; + else { + if (cmd->uid) { + i_array_init(&uids, array_count(&modified_set)*2); + mailbox_get_uid_range(client->mailbox, &modified_set, + &uids); + array_free(&modified_set); + modified_set = uids; + } + str = str_new(cmd->pool, 256); + str_append(str, "OK [MODIFIED "); + imap_write_seq_range(str, &modified_set); + str_append(str, "] Conditional store failed."); + tagged_reply = str_c(str); + } + array_free(&modified_set); + + /* With UID STORE we have to return UID for the flags as well. + Unfortunately we don't have the ability to separate those + flag changes that were caused by UID STORE and those that + came externally, so we'll just send the UID for all flag + changes that we see. */ + if (cmd->uid && (!ctx.silent || + client_has_enabled(client, imap_feature_condstore))) + imap_sync_flags |= IMAP_SYNC_FLAG_SEND_UID; + + return cmd_sync(cmd, (cmd->uid ? 0 : MAILBOX_SYNC_FLAG_NO_EXPUNGES), + imap_sync_flags, tagged_reply); +} |