imap-search.c revision c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391
e59faf65ce864fe95dc00f5d52b8323cdbd0608aTimo Sirainen/* Copyright (c) 2002-2010 Dovecot authors, see the included COPYING file */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic int imap_search_deinit(struct imap_search_context *ctx);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenimap_partial_range_parse(struct imap_search_context *ctx, const char *str)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->partial1 = ctx->partial1 * 10 + *str-'0';
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen for (str++; *str >= '0' && *str <= '9'; str++)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->partial2 = ctx->partial2 * 10 + *str-'0';
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainensearch_parse_return_options(struct imap_search_context *ctx,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct client_command_context *cmd = ctx->cmd;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen unsigned int idx;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen "SEARCH return options contain non-atoms.");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen "PARTIAL can be used only once.");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen "PARTIAL range missing.");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen "PARTIAL range broken.");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen "Unknown SEARCH return option");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_UPDATE) != 0 &&
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen client_search_update_lookup(cmd->client, cmd->tag, &idx) != NULL) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen client_send_command_error(cmd, "Duplicate search update tag");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_PARTIAL) != 0 &&
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen (ctx->return_options & SEARCH_RETURN_ALL) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen client_send_command_error(cmd, "PARTIAL conflicts with ALL");
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void imap_search_args_check(struct imap_search_context *ctx,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen imap_search_args_check(ctx, sargs->value.subargs);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void imap_search_result_save(struct imap_search_context *ctx)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (!array_is_created(&client->search_updates))
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen else if (array_count(&client->search_updates) >=
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* too many updates */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen imap_quote_append_string(str, ctx->cmd->tag, FALSE);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen result = mailbox_search_result_save(ctx->search_ctx,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen update = array_append_space(&client->search_updates);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void imap_search_send_result_standard(struct imap_search_context *ctx)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen str_append(str, ctx->sorting ? "* SORT" : "* SEARCH");
7bd72e4deca3cbf757dd1ea298486d9f3bc24226Timo Sirainen for (seq = range->seq1; seq <= range->seq2; seq++)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen (unsigned long long)ctx->highest_seen_modseq);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenimap_search_send_partial(struct imap_search_context *ctx, string_t *str)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen str_printfa(str, " PARTIAL (%u:%u ", ctx->partial1, ctx->partial2);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* we need to be able to handle non-sorted seq ranges, so do this
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ourself instead of using seq_range_array_*() functions. */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen range = array_get_modifiable(&ctx->result, &count);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen for (i = n = 0; i < count; i++) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen range[i].seq2 = range[i].seq1 + (ctx->partial2 - n);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen array_delete(&ctx->result, i + 1, count-(i+1));
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* no results (in range) */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void imap_search_send_result(struct imap_search_context *ctx)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen unsigned int count;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_ESEARCH) == 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen (SEARCH_RETURN_ESEARCH | SEARCH_RETURN_SAVE)) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* we only wanted to save the result, don't return
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ESEARCH result. */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen imap_quote_append_string(str, ctx->cmd->tag, FALSE);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_MIN) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_MAX) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen str_printfa(str, " MAX %u", range[count-1].seq2);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_ALL) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_PARTIAL) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_COUNT) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen str_printfa(str, " COUNT %u", ctx->result_count);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen (unsigned long long)ctx->highest_seen_modseq);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen o_stream_send(client->output, str_data(str), str_len(str));
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void search_update_mail(struct imap_search_context *ctx)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_MODSEQ) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_SAVE) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen seq_range_array_add(&ctx->cmd->client->search_saved_uidset,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void search_add_result_id(struct imap_search_context *ctx, uint32_t id)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen unsigned int count;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* only append the data. this is especially important when we're
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen returning a sort result. */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen range = array_get_modifiable(&ctx->result, &count);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (count > 0 && id == range[count-1].seq2 + 1) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic bool cmd_search_more(struct client_command_context *cmd)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct imap_search_context *ctx = cmd->context;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen enum search_return_options opts = ctx->return_options;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen unsigned int count;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen minmax = (opts & (SEARCH_RETURN_MIN | SEARCH_RETURN_MAX)) != 0 &&
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen while (mailbox_search_next_nonblock(ctx->search_ctx, ctx->mail,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen id = cmd->uid ? ctx->mail->uid : ctx->mail->seq;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* we only care about min/max */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (id_min == 0 && (opts & SEARCH_RETURN_MIN) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* return option updates are delayed until
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen we know the actual min/max values */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* we only want to count (and get modseqs) */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (minmax && array_count(&ctx->result) > 0 &&
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen (opts & (SEARCH_RETURN_MODSEQ | SEARCH_RETURN_SAVE)) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* handle MIN/MAX modseq/save updates */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen lost_data = mailbox_search_seen_lost_data(ctx->search_ctx);
7ef3553585e556f35d5919589cfdc1de3329e4bbTimo Sirainen time_msecs = timeval_diff_msecs(&end_time, &ctx->start_time);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ok_reply = t_strdup_printf("OK %s%s completed (%d.%03d secs).",
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen lost_data ? "["IMAP_RESP_CODE_EXPUNGEISSUED"] " : "",
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen return cmd_sync(cmd, sync_flags, 0, ok_reply);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void cmd_search_more_callback(struct client_command_context *cmd)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenint cmd_search_parse_return_if_found(struct imap_search_context *ctx,
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen const struct imap_arg *list_args, *args = *_args;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct client_command_context *cmd = ctx->cmd;
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen if (!imap_arg_atom_equals(&args[0], "RETURN") ||
c2fbbf7515aa419dc8b2d62a3c2bb0471d51a391Timo Sirainen if (!search_parse_return_options(ctx, list_args))
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_SAVE) != 0) {
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* wait if there is another SEARCH SAVE command running. */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* make sure the search result gets cleared if SEARCH fails */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (array_is_created(&cmd->client->search_saved_uidset))
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen array_clear(&cmd->client->search_saved_uidset);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen i_array_init(&cmd->client->search_saved_uidset, 128);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic void wanted_fields_get(struct mailbox *box,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct mailbox_header_lookup_ctx **headers_ctx_r)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen *headers_ctx_r = mailbox_header_lookup_init(box, headers);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenbool imap_search_start(struct imap_search_context *ctx,
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct client_command_context *cmd = ctx->cmd;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen struct mailbox_header_lookup_ctx *wanted_headers;
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen client_enable(cmd->client, MAILBOX_FEATURE_CONDSTORE);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->trans = mailbox_transaction_begin(ctx->box, 0);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->search_ctx = mailbox_search_init(ctx->trans, sargs, sort_program);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->mail = mail_alloc(ctx->trans, wanted_fields, wanted_headers);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_UPDATE) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* we may have moved onto syncing by now */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen ctx->to = timeout_add(0, cmd_search_more_callback, cmd);
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainenstatic int imap_search_deinit(struct imap_search_context *ctx)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if (mailbox_search_deinit(&ctx->search_ctx) < 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen /* search failed */
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen if ((ctx->return_options & SEARCH_RETURN_SAVE) != 0)
d43bed2d458520fd01c28229ce2b178a4593a4a7Timo Sirainen array_clear(&ctx->cmd->client->search_saved_uidset);