[PATCH v3 3/4] cli: Extend the search command for --output={sender, recipients}
authorMichal Sojka <sojkam1@fel.cvut.cz>
Sun, 12 Oct 2014 21:41:32 +0000 (23:41 +0200)
committerW. Trevor King <wking@tremily.us>
Fri, 7 Nov 2014 18:05:13 +0000 (10:05 -0800)
b5/ff3270941cafc40ab4cd61f982bc7a934e118e [new file with mode: 0644]

diff --git a/b5/ff3270941cafc40ab4cd61f982bc7a934e118e b/b5/ff3270941cafc40ab4cd61f982bc7a934e118e
new file mode 100644 (file)
index 0000000..5e94d9d
--- /dev/null
@@ -0,0 +1,401 @@
+Return-Path: <sojkam1@fel.cvut.cz>\r
+X-Original-To: notmuch@notmuchmail.org\r
+Delivered-To: notmuch@notmuchmail.org\r
+Received: from localhost (localhost [127.0.0.1])\r
+       by olra.theworths.org (Postfix) with ESMTP id C87AF429E32\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 14:42:14 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -2.3\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-2.3 tagged_above=-999 required=5\r
+       tests=[RCVD_IN_DNSWL_MED=-2.3] autolearn=disabled\r
+Received: from olra.theworths.org ([127.0.0.1])\r
+       by localhost (olra.theworths.org [127.0.0.1]) (amavisd-new, port 10024)\r
+       with ESMTP id HMcAOEMOAeNd for <notmuch@notmuchmail.org>;\r
+       Sun, 12 Oct 2014 14:42:03 -0700 (PDT)\r
+Received: from max.feld.cvut.cz (max.feld.cvut.cz [147.32.192.36])\r
+       by olra.theworths.org (Postfix) with ESMTP id 1CCBD431E64\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 14:41:53 -0700 (PDT)\r
+Received: from localhost (unknown [192.168.200.7])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 9EDFE5CCF29\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 23:41:49 +0200 (CEST)\r
+X-Virus-Scanned: IMAP STYX AMAVIS\r
+Received: from max.feld.cvut.cz ([192.168.200.1])\r
+       by localhost (styx.feld.cvut.cz [192.168.200.7]) (amavisd-new,\r
+       port 10044) with ESMTP id zoBUWYNZpRwa for <notmuch@notmuchmail.org>;\r
+       Sun, 12 Oct 2014 23:41:46 +0200 (CEST)\r
+Received: from imap.feld.cvut.cz (imap.feld.cvut.cz [147.32.192.34])\r
+       by max.feld.cvut.cz (Postfix) with ESMTP id 48F545CCF24\r
+       for <notmuch@notmuchmail.org>; Sun, 12 Oct 2014 23:41:45 +0200 (CEST)\r
+Received: from wsh by steelpick.2x.cz with local (Exim 4.84)\r
+       (envelope-from <sojkam1@fel.cvut.cz>)\r
+       id 1XdQtb-0002CI-67; Sun, 12 Oct 2014 23:41:43 +0200\r
+From: Michal Sojka <sojkam1@fel.cvut.cz>\r
+To: notmuch@notmuchmail.org\r
+Subject: [PATCH v3 3/4] cli: Extend the search command for --output={sender,\r
+       recipients}\r
+Date: Sun, 12 Oct 2014 23:41:32 +0200\r
+Message-Id: <1413150093-8383-4-git-send-email-sojkam1@fel.cvut.cz>\r
+X-Mailer: git-send-email 2.1.1\r
+In-Reply-To: <1413150093-8383-1-git-send-email-sojkam1@fel.cvut.cz>\r
+References: <87zjd51phx.fsf@steelpick.2x.cz>\r
+       <1413150093-8383-1-git-send-email-sojkam1@fel.cvut.cz>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=UTF-8\r
+Content-Transfer-Encoding: 8bit\r
+X-BeenThere: notmuch@notmuchmail.org\r
+X-Mailman-Version: 2.1.13\r
+Precedence: list\r
+List-Id: "Use and development of the notmuch mail system."\r
+       <notmuch.notmuchmail.org>\r
+List-Unsubscribe: <http://notmuchmail.org/mailman/options/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=unsubscribe>\r
+List-Archive: <http://notmuchmail.org/pipermail/notmuch>\r
+List-Post: <mailto:notmuch@notmuchmail.org>\r
+List-Help: <mailto:notmuch-request@notmuchmail.org?subject=help>\r
+List-Subscribe: <http://notmuchmail.org/mailman/listinfo/notmuch>,\r
+       <mailto:notmuch-request@notmuchmail.org?subject=subscribe>\r
+X-List-Received-Date: Sun, 12 Oct 2014 21:42:15 -0000\r
+\r
+The new outputs allow printing senders, recipients or both of matching\r
+messages. The --output option is converted from "keyword" argument to\r
+"flags" argument, which means that the user can use --output=sender and\r
+--output=recipients simultaneously, to print both. Other combinations\r
+produce an error.\r
+\r
+This code based on a patch from Jani Nikula.\r
+---\r
+ completion/notmuch-completion.bash |   2 +-\r
+ completion/notmuch-completion.zsh  |   3 +-\r
+ doc/man1/notmuch-search.rst        |  22 +++++++-\r
+ notmuch-search.c                   | 110 ++++++++++++++++++++++++++++++++++---\r
+ test/T090-search-output.sh         |  64 +++++++++++++++++++++\r
+ 5 files changed, 189 insertions(+), 12 deletions(-)\r
+\r
+diff --git a/completion/notmuch-completion.bash b/completion/notmuch-completion.bash\r
+index 0571dc9..cfbd389 100644\r
+--- a/completion/notmuch-completion.bash\r
++++ b/completion/notmuch-completion.bash\r
+@@ -294,7 +294,7 @@ _notmuch_search()\r
+           return\r
+           ;;\r
+       --output)\r
+-          COMPREPLY=( $( compgen -W "summary threads messages files tags" -- "${cur}" ) )\r
++          COMPREPLY=( $( compgen -W "summary threads messages files tags sender recipients" -- "${cur}" ) )\r
+           return\r
+           ;;\r
+       --sort)\r
+diff --git a/completion/notmuch-completion.zsh b/completion/notmuch-completion.zsh\r
+index 67a9aba..3e52a00 100644\r
+--- a/completion/notmuch-completion.zsh\r
++++ b/completion/notmuch-completion.zsh\r
+@@ -52,7 +52,8 @@ _notmuch_search()\r
+   _arguments -s : \\r
+     '--max-threads=[display only the first x threads from the search results]:number of threads to show: ' \\r
+     '--first=[omit the first x threads from the search results]:number of threads to omit: ' \\r
+-    '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))'\r
++    '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \\r
++    '--output=[select what to output]:output:((summary threads messages files tags sender recipients))'\r
+ }\r
\r
+ _notmuch()\r
+diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst\r
+index 90160f2..c9d38b1 100644\r
+--- a/doc/man1/notmuch-search.rst\r
++++ b/doc/man1/notmuch-search.rst\r
+@@ -35,7 +35,7 @@ Supported options for **search** include\r
+         intended for programs that invoke **notmuch(1)** internally. If\r
+         omitted, the latest supported version will be used.\r
\r
+-    ``--output=(summary|threads|messages|files|tags)``\r
++    ``--output=(summary|threads|messages|files|tags|sender|recipients)``\r
\r
+         **summary**\r
+             Output a summary of each thread with any message matching\r
+@@ -78,6 +78,26 @@ Supported options for **search** include\r
+             by null characters (--format=text0), as a JSON array\r
+             (--format=json), or as an S-Expression list (--format=sexp).\r
\r
++      **sender**\r
++            Output all addresses from the *From* header that appear on\r
++            any message matching the search terms, either one per line\r
++            (--format=text), separated by null characters\r
++            (--format=text0), as a JSON array (--format=json), or as\r
++            an S-Expression list (--format=sexp).\r
++\r
++          Note: Searching for **sender** should be much faster than\r
++          searching for **recipients**, because sender addresses are\r
++          cached directly in the database whereas other addresses\r
++          need to be fetched from message files.\r
++\r
++      **recipients**\r
++            Like **sender** but for addresses from *To*, *Cc* and\r
++          *Bcc* headers.\r
++\r
++      This option can be given multiple times to combine different\r
++      outputs. Curently, this is only supported for **sender** and\r
++      **recipients** outputs.\r
++\r
+     ``--sort=``\ (**newest-first**\ \|\ **oldest-first**)\r
+         This option can be used to present results in either\r
+         chronological order (**oldest-first**) or reverse chronological\r
+diff --git a/notmuch-search.c b/notmuch-search.c\r
+index 5ac2a26..74588f8 100644\r
+--- a/notmuch-search.c\r
++++ b/notmuch-search.c\r
+@@ -23,11 +23,14 @@\r
+ #include "string-util.h"\r
\r
+ typedef enum {\r
+-    OUTPUT_SUMMARY,\r
+-    OUTPUT_THREADS,\r
+-    OUTPUT_MESSAGES,\r
+-    OUTPUT_FILES,\r
+-    OUTPUT_TAGS\r
++    OUTPUT_SUMMARY    = 1 << 0,\r
++    OUTPUT_THREADS    = 1 << 1,\r
++    OUTPUT_MESSAGES   = 1 << 2,\r
++    OUTPUT_FILES      = 1 << 3,\r
++    OUTPUT_TAGS               = 1 << 4,\r
++    OUTPUT_SENDER     = 1 << 5,\r
++    OUTPUT_RECIPIENTS = 1 << 6,\r
++    OUTPUT_ADDRESSES  = OUTPUT_SENDER | OUTPUT_RECIPIENTS,\r
+ } output_t;\r
\r
+ typedef struct {\r
+@@ -220,6 +223,67 @@ do_search_threads (search_options_t *o)\r
+     return 0;\r
+ }\r
\r
++static void\r
++print_address_list (const search_options_t *o, InternetAddressList *list)\r
++{\r
++    InternetAddress *address;\r
++    int i;\r
++\r
++    for (i = 0; i < internet_address_list_length (list); i++) {\r
++      address = internet_address_list_get_address (list, i);\r
++      if (INTERNET_ADDRESS_IS_GROUP (address)) {\r
++          InternetAddressGroup *group;\r
++          InternetAddressList *group_list;\r
++\r
++          group = INTERNET_ADDRESS_GROUP (address);\r
++          group_list = internet_address_group_get_members (group);\r
++          if (group_list == NULL)\r
++              continue;\r
++\r
++          print_address_list (o, group_list);\r
++      } else {\r
++          InternetAddressMailbox *mailbox;\r
++          const char *name;\r
++          const char *addr;\r
++          char *full_address;\r
++\r
++          mailbox = INTERNET_ADDRESS_MAILBOX (address);\r
++\r
++          name = internet_address_get_name (address);\r
++          addr = internet_address_mailbox_get_addr (mailbox);\r
++\r
++          if (name && *name)\r
++              full_address = talloc_asprintf (o->format, "%s <%s>", name, addr);\r
++          else\r
++              full_address = talloc_strdup (o->format, addr);\r
++\r
++          if (!full_address) {\r
++              fprintf (stderr, "Error: out of memory\n");\r
++              break;\r
++          }\r
++          o->format->string (o->format, full_address);\r
++          o->format->separator (o->format);\r
++\r
++          talloc_free (full_address);\r
++      }\r
++    }\r
++}\r
++\r
++static void\r
++print_address_string (const search_options_t *o, const char *recipients)\r
++{\r
++    InternetAddressList *list;\r
++\r
++    if (recipients == NULL)\r
++      return;\r
++\r
++    list = internet_address_list_parse_string (recipients);\r
++    if (list == NULL)\r
++      return;\r
++\r
++    print_address_list (o, list);\r
++}\r
++\r
+ static int\r
+ do_search_messages (search_options_t *o)\r
+ {\r
+@@ -266,11 +330,29 @@ do_search_messages (search_options_t *o)\r
+           \r
+           notmuch_filenames_destroy( filenames );\r
\r
+-      } else { /* output == OUTPUT_MESSAGES */\r
++      } else if (o->output == OUTPUT_MESSAGES) {\r
+           format->set_prefix (format, "id");\r
+           format->string (format,\r
+                           notmuch_message_get_message_id (message));\r
+           format->separator (format);\r
++      } else {\r
++          if (o->output & OUTPUT_SENDER) {\r
++              const char *addrs;\r
++\r
++              addrs = notmuch_message_get_header (message, "from");\r
++              print_address_string (o, addrs);\r
++          }\r
++\r
++          if (o->output & OUTPUT_RECIPIENTS) {\r
++              const char *hdrs[] = { "to", "cc", "bcc" };\r
++              const char *addrs;\r
++              size_t j;\r
++\r
++              for (j = 0; j < ARRAY_SIZE (hdrs); j++) {\r
++                  addrs = notmuch_message_get_header (message, hdrs[j]);\r
++                  print_address_string (o, addrs);\r
++              }\r
++          }\r
+       }\r
\r
+       notmuch_message_destroy (message);\r
+@@ -337,7 +419,7 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])\r
+     notmuch_database_t *notmuch;\r
+     search_options_t o = {\r
+       .sort = NOTMUCH_SORT_NEWEST_FIRST,\r
+-      .output = OUTPUT_SUMMARY,\r
++      .output = 0,\r
+       .offset = 0,\r
+       .limit = -1, /* unlimited */\r
+       .dupe = -1,\r
+@@ -366,10 +448,12 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])\r
+                                 { "text0", NOTMUCH_FORMAT_TEXT0 },\r
+                                 { 0, 0 } } },\r
+       { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },\r
+-      { NOTMUCH_OPT_KEYWORD, &o.output, "output", 'o',\r
++      { NOTMUCH_OPT_KEYWORD_FLAGS, &o.output, "output", 'o',\r
+         (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },\r
+                                 { "threads", OUTPUT_THREADS },\r
+                                 { "messages", OUTPUT_MESSAGES },\r
++                                { "sender", OUTPUT_SENDER },\r
++                                { "recipients", OUTPUT_RECIPIENTS },\r
+                                 { "files", OUTPUT_FILES },\r
+                                 { "tags", OUTPUT_TAGS },\r
+                                 { 0, 0 } } },\r
+@@ -389,6 +473,9 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])\r
+     if (opt_index < 0)\r
+       return EXIT_FAILURE;\r
\r
++    if (! o.output)\r
++      o.output = OUTPUT_SUMMARY;\r
++\r
+     switch (format_sel) {\r
+     case NOTMUCH_FORMAT_TEXT:\r
+       o.format = sprinter_text_create (config, stdout);\r
+@@ -455,18 +542,23 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])\r
+     }\r
\r
+     switch (o.output) {\r
+-    default:\r
+     case OUTPUT_SUMMARY:\r
+     case OUTPUT_THREADS:\r
+       ret = do_search_threads (&o);\r
+       break;\r
+     case OUTPUT_MESSAGES:\r
++    case OUTPUT_SENDER:\r
++    case OUTPUT_RECIPIENTS:\r
++    case OUTPUT_ADDRESSES:\r
+     case OUTPUT_FILES:\r
+       ret = do_search_messages (&o);\r
+       break;\r
+     case OUTPUT_TAGS:\r
+       ret = do_search_tags (notmuch, o.format, o.query);\r
+       break;\r
++    default:\r
++      fprintf (stderr, "Error: the combination of outputs is not supported.\n");\r
++      ret = 1;\r
+     }\r
\r
+     notmuch_query_destroy (o.query);\r
+diff --git a/test/T090-search-output.sh b/test/T090-search-output.sh\r
+index 947d572..e696c01 100755\r
+--- a/test/T090-search-output.sh\r
++++ b/test/T090-search-output.sh\r
+@@ -387,6 +387,70 @@ cat <<EOF >EXPECTED\r
+ EOF\r
+ test_expect_equal_file OUTPUT EXPECTED\r
\r
++test_begin_subtest "--output=sender"\r
++notmuch search --output=sender '*' | sort | uniq --count >OUTPUT\r
++cat <<EOF >EXPECTED\r
++      1 Adrian Perez de Castro <aperez@igalia.com>\r
++      2 Alex Botero-Lowry <alex.boterolowry@gmail.com>\r
++      4 Alexander Botero-Lowry <alex.boterolowry@gmail.com>\r
++      1 Aron Griffis <agriffis@n01se.net>\r
++     12 Carl Worth <cworth@cworth.org>\r
++      1 Chris Wilson <chris@chris-wilson.co.uk>\r
++      1 François Boulogne <boulogne.f@gmail.com>\r
++      1 Ingmar Vanhassel <ingmar@exherbo.org>\r
++      1 Israel Herraiz <isra@herraiz.org>\r
++      4 Jan Janak <jan@ryngle.com>\r
++      2 Jjgod Jiang <gzjjgod@gmail.com>\r
++      7 Keith Packard <keithp@keithp.com>\r
++      5 Lars Kellogg-Stedman <lars@seas.harvard.edu>\r
++      5 Mikhail Gusarov <dottedmag@dottedmag.net>\r
++      1 Olivier Berger <olivier.berger@it-sudparis.eu>\r
++      1 Rolland Santimano <rollandsantimano@yahoo.com>\r
++      3 Stewart Smith <stewart@flamingspork.com>\r
++EOF\r
++test_expect_equal_file OUTPUT EXPECTED\r
++\r
++test_begin_subtest "--output=recipients"\r
++notmuch search --output=recipients '*' | sort | uniq --count >OUTPUT\r
++cat <<EOF >EXPECTED\r
++      1 Allan McRae <allan@archlinux.org>\r
++      1 Discussion about the Arch User Repository (AUR) <aur-general@archlinux.org>\r
++      1 Keith Packard <keithp@keithp.com>\r
++      1 Mikhail Gusarov <dottedmag@dottedmag.net>\r
++      2 notmuch <notmuch@notmuchmail.org>\r
++     48 notmuch@notmuchmail.org\r
++      1 olivier.berger@it-sudparis.eu\r
++EOF\r
++test_expect_equal_file OUTPUT EXPECTED\r
++\r
++test_begin_subtest "--output=sender --output=recipients"\r
++notmuch search --output=sender --output=recipients '*' | sort | uniq --count >OUTPUT\r
++cat <<EOF >EXPECTED\r
++      1 Adrian Perez de Castro <aperez@igalia.com>\r
++      2 Alex Botero-Lowry <alex.boterolowry@gmail.com>\r
++      4 Alexander Botero-Lowry <alex.boterolowry@gmail.com>\r
++      1 Allan McRae <allan@archlinux.org>\r
++      1 Aron Griffis <agriffis@n01se.net>\r
++     12 Carl Worth <cworth@cworth.org>\r
++      1 Chris Wilson <chris@chris-wilson.co.uk>\r
++      1 Discussion about the Arch User Repository (AUR) <aur-general@archlinux.org>\r
++      1 François Boulogne <boulogne.f@gmail.com>\r
++      1 Ingmar Vanhassel <ingmar@exherbo.org>\r
++      1 Israel Herraiz <isra@herraiz.org>\r
++      4 Jan Janak <jan@ryngle.com>\r
++      2 Jjgod Jiang <gzjjgod@gmail.com>\r
++      8 Keith Packard <keithp@keithp.com>\r
++      5 Lars Kellogg-Stedman <lars@seas.harvard.edu>\r
++      6 Mikhail Gusarov <dottedmag@dottedmag.net>\r
++      1 Olivier Berger <olivier.berger@it-sudparis.eu>\r
++      1 Rolland Santimano <rollandsantimano@yahoo.com>\r
++      3 Stewart Smith <stewart@flamingspork.com>\r
++      2 notmuch <notmuch@notmuchmail.org>\r
++     48 notmuch@notmuchmail.org\r
++      1 olivier.berger@it-sudparis.eu\r
++EOF\r
++test_expect_equal_file OUTPUT EXPECTED\r
++\r
+ test_begin_subtest "sanitize output for quoted-printable line-breaks in author and subject"\r
+ add_message "[subject]='two =?ISO-8859-1?Q?line=0A_subject?=\r
+       headers'"\r
+-- \r
+2.1.1\r
+\r