From 79e8b563190e736287136f71f863bd810aec4752 Mon Sep 17 00:00:00 2001 From: markwalters1009 Date: Sat, 24 Nov 2012 13:20:55 +0000 Subject: [PATCH] [PATCH v2 6/7] cli: allow search mode to include msg-ids with JSON output --- 40/83d8704b89f6de996db3300ecd4617418b3cae | 256 ++++++++++++++++++++++ 1 file changed, 256 insertions(+) create mode 100644 40/83d8704b89f6de996db3300ecd4617418b3cae diff --git a/40/83d8704b89f6de996db3300ecd4617418b3cae b/40/83d8704b89f6de996db3300ecd4617418b3cae new file mode 100644 index 000000000..465ca39b0 --- /dev/null +++ b/40/83d8704b89f6de996db3300ecd4617418b3cae @@ -0,0 +1,256 @@ +Return-Path: +X-Original-To: notmuch@notmuchmail.org +Delivered-To: notmuch@notmuchmail.org +Received: from localhost (localhost [127.0.0.1]) + by olra.theworths.org (Postfix) with ESMTP id 6BB2B431FBD + for ; Sat, 24 Nov 2012 05:21:18 -0800 (PST) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0.201 +X-Spam-Level: +X-Spam-Status: No, score=0.201 tagged_above=-999 required=5 + tests=[DKIM_SIGNED=0.1, DKIM_VALID=-0.1, DKIM_VALID_AU=-0.1, + FREEMAIL_ENVFROM_END_DIGIT=1, FREEMAIL_FROM=0.001, + RCVD_IN_DNSWL_LOW=-0.7] autolearn=disabled +Received: from olra.theworths.org ([127.0.0.1]) + by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024) + with ESMTP id lUhXcg7esj4v for ; + Sat, 24 Nov 2012 05:21:16 -0800 (PST) +Received: from mail-wg0-f45.google.com (mail-wg0-f45.google.com + [74.125.82.45]) (using TLSv1 with cipher RC4-SHA (128/128 bits)) (No client + certificate requested) by olra.theworths.org (Postfix) with ESMTPS id + 0F303431FAF for ; Sat, 24 Nov 2012 05:21:15 -0800 + (PST) +Received: by mail-wg0-f45.google.com with SMTP id dq11so3973532wgb.2 + for ; Sat, 24 Nov 2012 05:21:15 -0800 (PST) +DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20120113; + h=from:to:cc:subject:date:message-id:x-mailer:in-reply-to:references; + bh=fVtRUudxpPp9qg10ROX/1HSFdBG9fBa+e0lHY46xMUE=; + b=AsCAuZGpCYh73jZdYWopFkZJFACI7uEC5+bsbtaEIlKKXQ1uBsWY3oTLknxVWCxqz5 + IftB7iE54FOmIOwAdgZk/FTiuejizmGN71588qeYjeY02fNvUXfPHvYl79W7TgRG9I4b + ASO2fPn33M2/OLoRBh7OSkGbAqlsVhcV5ZtX2Os28wM9lbErIznBMPSeWdcoCmIDkJPd + V5K9qm0zBxHsPkDYc7fyKibynFIE3LZwdTIYE+lf0EaFvQYYF9HjJ/EpzoLM81NLvS2R + yIgNNC9ZkyNSK0hP1LQ++w2m/notz0qMBRlpMIUoux+Q70OeOc9pMwtKH6rYb8aRzVp4 + VSSg== +Received: by 10.180.90.70 with SMTP id bu6mr13655680wib.20.1353763275642; + Sat, 24 Nov 2012 05:21:15 -0800 (PST) +Received: from localhost (93-97-24-31.zone5.bethere.co.uk. [93.97.24.31]) + by mx.google.com with ESMTPS id i2sm12683344wiw.3.2012.11.24.05.21.14 + (version=TLSv1/SSLv3 cipher=OTHER); + Sat, 24 Nov 2012 05:21:14 -0800 (PST) +From: markwalters1009 +To: notmuch@notmuchmail.org +Subject: [PATCH v2 6/7] cli: allow search mode to include msg-ids with JSON + output +Date: Sat, 24 Nov 2012 13:20:55 +0000 +Message-Id: <1353763256-32336-7-git-send-email-markwalters1009@gmail.com> +X-Mailer: git-send-email 1.7.9.1 +In-Reply-To: <1353763256-32336-1-git-send-email-markwalters1009@gmail.com> +References: <1353763256-32336-1-git-send-email-markwalters1009@gmail.com> +X-BeenThere: notmuch@notmuchmail.org +X-Mailman-Version: 2.1.13 +Precedence: list +List-Id: "Use and development of the notmuch mail system." + +List-Unsubscribe: , + +List-Archive: +List-Post: +List-Help: +List-Subscribe: , + +X-List-Received-Date: Sat, 24 Nov 2012 13:21:18 -0000 + +From: Mark Walters + +This adds a --queries=true option which modifies the summary output of +notmuch search by including two extra query strings with each result: +one query string specifies all matching messages and one query string +all non-matching messages. Currently these are just lists of message +ids joined with " or " but that could change in future. + +Currently this is not implemented for text format. +--- + notmuch-search.c | 95 ++++++++++++++++++++++++++++++++++++++++++++++++++--- + 1 files changed, 89 insertions(+), 6 deletions(-) + +diff --git a/notmuch-search.c b/notmuch-search.c +index 830c4e4..c8fc9a6 100644 +--- a/notmuch-search.c ++++ b/notmuch-search.c +@@ -26,7 +26,8 @@ typedef enum { + OUTPUT_THREADS, + OUTPUT_MESSAGES, + OUTPUT_FILES, +- OUTPUT_TAGS ++ OUTPUT_TAGS, ++ OUTPUT_SUMMARY_WITH_QUERIES + } output_t; + + static char * +@@ -46,6 +47,57 @@ sanitize_string (const void *ctx, const char *str) + return out; + } + ++/* This function takes a message id and returns an escaped string ++ * which can be used as a Xapian query. This involves prefixing with ++ * `id:', putting the id inside double quotes, and doubling any ++ * occurence of a double quote in the message id itself.*/ ++static char * ++xapian_escape_id (const void *ctx, ++ const char *msg_id) ++{ ++ const char *c; ++ char *escaped_msg_id; ++ escaped_msg_id = talloc_strdup (ctx, "id:\""); ++ for (c=msg_id; *c; c++) ++ if (*c == '"') ++ escaped_msg_id = talloc_asprintf_append (escaped_msg_id, "\"\""); ++ else ++ escaped_msg_id = talloc_asprintf_append (escaped_msg_id, "%c", *c); ++ escaped_msg_id = talloc_asprintf_append (escaped_msg_id, "\""); ++ return escaped_msg_id; ++} ++ ++static char * ++output_msg_query (const void *ctx, ++ sprinter_t *format, ++ notmuch_bool_t matching, ++ notmuch_bool_t first, ++ notmuch_messages_t *messages) ++{ ++ notmuch_message_t *message; ++ char *query, *escaped_msg_id; ++ query = talloc_strdup (ctx, ""); ++ for (; ++ notmuch_messages_valid (messages); ++ notmuch_messages_move_to_next (messages)) ++ { ++ message = notmuch_messages_get (messages); ++ if (notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) == matching) { ++ escaped_msg_id = xapian_escape_id (ctx, notmuch_message_get_message_id (message)); ++ if (first) { ++ query = talloc_asprintf_append (query, "%s", escaped_msg_id); ++ first = FALSE; ++ } ++ else ++ query = talloc_asprintf_append (query, " or %s", escaped_msg_id); ++ talloc_free (escaped_msg_id); ++ } ++ /* output_msg_query already starts with an ` or' */ ++ query = talloc_asprintf_append (query, "%s", output_msg_query (ctx, format, matching, first, notmuch_message_get_replies (message))); ++ } ++ return query; ++} ++ + static int + do_search_threads (sprinter_t *format, + notmuch_query_t *query, +@@ -88,7 +140,7 @@ do_search_threads (sprinter_t *format, + format->string (format, + notmuch_thread_get_thread_id (thread)); + format->separator (format); +- } else { /* output == OUTPUT_SUMMARY */ ++ } else { /* output == OUTPUT_SUMMARY or OUTPUT_SUMMARY_WITH_QUERIES */ + void *ctx_quote = talloc_new (thread); + const char *authors = notmuch_thread_get_authors (thread); + const char *subject = notmuch_thread_get_subject (thread); +@@ -108,7 +160,7 @@ do_search_threads (sprinter_t *format, + relative_date = notmuch_time_relative_date (ctx_quote, date); + + if (format->is_text_printer) { +- /* Special case for the text formatter */ ++ /* Special case for the text formatter */ + printf ("thread:%s %12s [%d/%d] %s; %s (", + thread_id, + relative_date, +@@ -133,8 +185,6 @@ do_search_threads (sprinter_t *format, + format->string (format, subject); + } + +- talloc_free (ctx_quote); +- + format->map_key (format, "tags"); + format->begin_list (format); + +@@ -145,7 +195,7 @@ do_search_threads (sprinter_t *format, + const char *tag = notmuch_tags_get (tags); + + if (format->is_text_printer) { +- /* Special case for the text formatter */ ++ /* Special case for the text formatter */ + if (first_tag) + first_tag = FALSE; + else +@@ -160,8 +210,25 @@ do_search_threads (sprinter_t *format, + printf (")"); + + format->end (format); ++ ++ if (output == OUTPUT_SUMMARY_WITH_QUERIES) { ++ char *query; ++ query = output_msg_query (ctx_quote, format, TRUE, TRUE, notmuch_thread_get_toplevel_messages (thread)); ++ if (strlen (query)) { ++ format->map_key (format, "matching_msg_query"); ++ format->string (format, query); ++ } ++ query = output_msg_query (ctx_quote, format, FALSE, TRUE, notmuch_thread_get_toplevel_messages (thread)); ++ if (strlen (query)) { ++ format->map_key (format, "nonmatching_msg_query"); ++ format->string (format, query); ++ } ++ } ++ + format->end (format); + format->separator (format); ++ ++ talloc_free (ctx_quote); + } + + notmuch_thread_destroy (thread); +@@ -303,6 +370,7 @@ notmuch_search_command (void *ctx, int argc, char *argv[]) + int offset = 0; + int limit = -1; /* unlimited */ + int exclude = EXCLUDE_TRUE; ++ notmuch_bool_t with_queries = FALSE; + unsigned int i; + + enum { NOTMUCH_FORMAT_JSON, NOTMUCH_FORMAT_TEXT } +@@ -323,12 +391,14 @@ notmuch_search_command (void *ctx, int argc, char *argv[]) + { "messages", OUTPUT_MESSAGES }, + { "files", OUTPUT_FILES }, + { "tags", OUTPUT_TAGS }, ++ { "with-queries", OUTPUT_SUMMARY_WITH_QUERIES }, + { 0, 0 } } }, + { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x', + (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE }, + { "false", EXCLUDE_FALSE }, + { "flag", EXCLUDE_FLAG }, + { 0, 0 } } }, ++ { NOTMUCH_OPT_BOOLEAN, &with_queries, "queries", 'b', 0 }, + { NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 }, + { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0 }, + { 0, 0, 0, 0, 0 } +@@ -398,6 +468,19 @@ notmuch_search_command (void *ctx, int argc, char *argv[]) + notmuch_query_set_omit_excluded (query, FALSE); + } + ++ if (with_queries) { ++ if (format_sel == NOTMUCH_FORMAT_TEXT) { ++ fprintf (stderr, "Warning: --queries=true not implemented for text format.\n"); ++ with_queries = FALSE; ++ } ++ if (output != OUTPUT_SUMMARY) { ++ fprintf (stderr, "Warning: --queries=true only implemented for --output=summary.\n"); ++ with_queries = FALSE; ++ } ++ } ++ ++ if (with_queries) output = OUTPUT_SUMMARY_WITH_QUERIES; ++ + switch (output) { + default: + case OUTPUT_SUMMARY: +-- +1.7.9.1 + -- 2.26.2