--- /dev/null
+Return-Path: <m.walters@qmul.ac.uk>\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 2F15E431FD4\r
+ for <notmuch@notmuchmail.org>; Thu, 23 Oct 2014 02:42:17 -0700 (PDT)\r
+X-Virus-Scanned: Debian amavisd-new at olra.theworths.org\r
+X-Spam-Flag: NO\r
+X-Spam-Score: -1.098\r
+X-Spam-Level: \r
+X-Spam-Status: No, score=-1.098 tagged_above=-999 required=5\r
+ tests=[DKIM_ADSP_CUSTOM_MED=0.001, FREEMAIL_FROM=0.001,\r
+ NML_ADSP_CUSTOM_MED=1.2, 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 7KeBc8Jb473c for <notmuch@notmuchmail.org>;\r
+ Thu, 23 Oct 2014 02:42:08 -0700 (PDT)\r
+Received: from mail2.qmul.ac.uk (mail2.qmul.ac.uk [138.37.6.6])\r
+ (using TLSv1 with cipher DHE-RSA-AES256-SHA (256/256 bits))\r
+ (No client certificate requested)\r
+ by olra.theworths.org (Postfix) with ESMTPS id 10684431FBD\r
+ for <notmuch@notmuchmail.org>; Thu, 23 Oct 2014 02:42:08 -0700 (PDT)\r
+Received: from smtp.qmul.ac.uk ([138.37.6.40])\r
+ by mail2.qmul.ac.uk with esmtp (Exim 4.71)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1XhEtt-0006Yv-CS; Thu, 23 Oct 2014 10:42:05 +0100\r
+Received: from [176.12.107.132] (helo=localhost)\r
+ by smtp.qmul.ac.uk with esmtpsa (TLSv1:AES128-SHA:128) (Exim 4.71)\r
+ (envelope-from <m.walters@qmul.ac.uk>)\r
+ id 1XhEts-0002EQ-Kw; Thu, 23 Oct 2014 10:41:45 +0100\r
+From: Mark Walters <markwalters1009@gmail.com>\r
+To: Michal Sojka <sojkam1@fel.cvut.cz>, notmuch@notmuchmail.org\r
+Subject: Re: [PATCH v3 3/4] cli: Extend the search command for\r
+ --output={sender, recipients}\r
+In-Reply-To: <1413150093-8383-4-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
+ <1413150093-8383-4-git-send-email-sojkam1@fel.cvut.cz>\r
+User-Agent: Notmuch/0.18.1+86~gef5e66a (http://notmuchmail.org) Emacs/23.4.1\r
+ (x86_64-pc-linux-gnu)\r
+Date: Thu, 23 Oct 2014 10:41:43 +0100\r
+Message-ID: <87egtzazs8.fsf@qmul.ac.uk>\r
+MIME-Version: 1.0\r
+Content-Type: text/plain; charset=utf-8\r
+Content-Transfer-Encoding: quoted-printable\r
+X-QM-SPAM-Info: 176.12.107.132 is in Janet mirror of Spamhaus XBL;\r
+ see http://www.spamhaus.org/xbl/\r
+X-Sender-Host-Address: 176.12.107.132\r
+X-QM-Geographic: According to ripencc,\r
+ this message was delivered by a machine in Britain (UK) (GB).\r
+X-QM-SPAM-Info: Sender has good ham record. :)\r
+X-QM-Body-MD5: c1ab82be0d0946d1fd7d9ee277360059 (of first 20000 bytes)\r
+X-SpamAssassin-Score: 0.0\r
+X-SpamAssassin-SpamBar: /\r
+X-SpamAssassin-Report: The QM spam filters have analysed this message to\r
+ determine if it is\r
+ spam. We require at least 5.0 points to mark a message as spam.\r
+ This message scored 0.0 points. Summary of the scoring: \r
+ * 0.0 FREEMAIL_FROM Sender email is commonly abused enduser mail\r
+ provider * (markwalters1009[at]gmail.com)\r
+X-QM-Scan-Virus: ClamAV says the message is clean\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: Thu, 23 Oct 2014 09:42:17 -0000\r
+\r
+On Sun, 12 Oct 2014, Michal Sojka <sojkam1@fel.cvut.cz> wrote:\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=3Dsender and\r
+> --output=3Drecipients 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
++++---\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-comp=\r
+letion.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=3D( $( compgen -W "summary threads messages files tags" -=\r
+- "${cur}" ) )\r
+> + COMPREPLY=3D( $( compgen -W "summary threads messages files tags se=\r
+nder recipients" -- "${cur}" ) )\r
+> return\r
+> ;;\r
+> --sort)\r
+> diff --git a/completion/notmuch-completion.zsh b/completion/notmuch-compl=\r
+etion.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=3D[display only the first x threads from the search r=\r
+esults]:number of threads to show: ' \\r
+> '--first=3D[omit the first x threads from the search results]:number=\r
+ of threads to omit: ' \\r
+> - '--sort=3D[sort results]:sorting:((newest-first\:"reverse chronologi=\r
+cal order" oldest-first\:"chronological order"))'\r
+> + '--sort=3D[sort results]:sorting:((newest-first\:"reverse chronologi=\r
+cal order" oldest-first\:"chronological order"))' \\r
+> + '--output=3D[select what to output]:output:((summary threads message=\r
+s files tags sender recipients))'\r
+> }\r
+>=20=20\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
+>=20=20\r
+> - ``--output=3D(summary|threads|messages|files|tags)``\r
+> + ``--output=3D(summary|threads|messages|files|tags|sender|recipients)=\r
+``\r
+>=20=20\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=3Dtext0), as a JSON array\r
+> (--format=3Djson), or as an S-Expression list (--format=3Dse=\r
+xp).\r
+>=20=20\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=3Dtext), separated by null characters\r
+> + (--format=3Dtext0), as a JSON array (--format=3Djson), or as\r
+> + an S-Expression list (--format=3Dsexp).\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=3D``\ (**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
+>=20=20\r
+> typedef enum {\r
+> - OUTPUT_SUMMARY,\r
+> - OUTPUT_THREADS,\r
+> - OUTPUT_MESSAGES,\r
+> - OUTPUT_FILES,\r
+> - OUTPUT_TAGS\r
+> + OUTPUT_SUMMARY =3D 1 << 0,\r
+> + OUTPUT_THREADS =3D 1 << 1,\r
+> + OUTPUT_MESSAGES =3D 1 << 2,\r
+> + OUTPUT_FILES =3D 1 << 3,\r
+> + OUTPUT_TAGS =3D 1 << 4,\r
+> + OUTPUT_SENDER =3D 1 << 5,\r
+> + OUTPUT_RECIPIENTS =3D 1 << 6,\r
+> + OUTPUT_ADDRESSES =3D OUTPUT_SENDER | OUTPUT_RECIPIENTS,\r
+> } output_t;\r
+>=20=20\r
+> typedef struct {\r
+> @@ -220,6 +223,67 @@ do_search_threads (search_options_t *o)\r
+> return 0;\r
+> }\r
+>=20=20\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 =3D 0; i < internet_address_list_length (list); i++) {\r
+> + address =3D internet_address_list_get_address (list, i);\r
+> + if (INTERNET_ADDRESS_IS_GROUP (address)) {\r
+> + InternetAddressGroup *group;\r
+> + InternetAddressList *group_list;\r
+> +\r
+> + group =3D INTERNET_ADDRESS_GROUP (address);\r
+> + group_list =3D internet_address_group_get_members (group);\r
+> + if (group_list =3D=3D 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 =3D INTERNET_ADDRESS_MAILBOX (address);\r
+> +\r
+> + name =3D internet_address_get_name (address);\r
+> + addr =3D internet_address_mailbox_get_addr (mailbox);\r
+> +\r
+> + if (name && *name)\r
+> + full_address =3D talloc_asprintf (o->format, "%s <%s>", name, addr);\r
+> + else\r
+> + full_address =3D 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
+Thinking about this some more how about printing the name and address as\r
+a structured pair/map (at least for all cases except text/text0 output):\r
+something like (in JSON)\r
+[name: "John Doe" address: "john.doe@example.com"]\r
+\r
+It seems wrong to me to go to the effort of separating them in the C and\r
+then combining them in the output.\r
+\r
+This could also help with the questions about uniqueness. If the client\r
+can get the data ready parsed into name/address then it can deal with\r
+much of the uniqueness itself.\r
+\r
+My preference would be for the default to print one line for each\r
+distinct full_address, and then any filter-by options to refine from\r
+there.\r
+\r
+One other advantage of structuring the output is that it is extensible:\r
+for example, at some later stage, we could include a "count" in the map\r
+allowing the client can pick the most popular variant.\r
+\r
+Best wishes\r
+\r
+Mark\r
+\r
+\r
+\r
+\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 =3D=3D NULL)\r
+> + return;\r
+> +\r
+> + list =3D internet_address_list_parse_string (recipients);\r
+> + if (list =3D=3D 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
+>=20=20=09=20=20=20=20\r
+> notmuch_filenames_destroy( filenames );\r
+>=20=20\r
+> - } else { /* output =3D=3D OUTPUT_MESSAGES */\r
+> + } else if (o->output =3D=3D 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 =3D notmuch_message_get_header (message, "from");\r
+> + print_address_string (o, addrs);\r
+> + }\r
+> +\r
+> + if (o->output & OUTPUT_RECIPIENTS) {\r
+> + const char *hdrs[] =3D { "to", "cc", "bcc" };\r
+> + const char *addrs;\r
+> + size_t j;\r
+> +\r
+> + for (j =3D 0; j < ARRAY_SIZE (hdrs); j++) {\r
+> + addrs =3D notmuch_message_get_header (message, hdrs[j]);\r
+> + print_address_string (o, addrs);\r
+> + }\r
+> + }\r
+> }\r
+>=20=20\r
+> notmuch_message_destroy (message);\r
+> @@ -337,7 +419,7 @@ notmuch_search_command (notmuch_config_t *config, int=\r
+ argc, char *argv[])\r
+> notmuch_database_t *notmuch;\r
+> search_options_t o =3D {\r
+> .sort =3D NOTMUCH_SORT_NEWEST_FIRST,\r
+> - .output =3D OUTPUT_SUMMARY,\r
+> + .output =3D 0,\r
+> .offset =3D 0,\r
+> .limit =3D -1, /* unlimited */\r
+> .dupe =3D -1,\r
+> @@ -366,10 +448,12 @@ notmuch_search_command (notmuch_config_t *config, i=\r
+nt argc, char *argv[])\r
+> { "text0", NOTMUCH_FORMAT_TEXT0 },\r
+> { 0, 0 } } },\r
+> { NOTMUCH_OPT_INT, ¬much_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=\r
+ argc, char *argv[])\r
+> if (opt_index < 0)\r
+> return EXIT_FAILURE;\r
+>=20=20\r
+> + if (! o.output)\r
+> + o.output =3D OUTPUT_SUMMARY;\r
+> +\r
+> switch (format_sel) {\r
+> case NOTMUCH_FORMAT_TEXT:\r
+> o.format =3D sprinter_text_create (config, stdout);\r
+> @@ -455,18 +542,23 @@ notmuch_search_command (notmuch_config_t *config, i=\r
+nt argc, char *argv[])\r
+> }\r
+>=20=20\r
+> switch (o.output) {\r
+> - default:\r
+> case OUTPUT_SUMMARY:\r
+> case OUTPUT_THREADS:\r
+> ret =3D 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 =3D do_search_messages (&o);\r
+> break;\r
+> case OUTPUT_TAGS:\r
+> ret =3D 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
+");\r
+> + ret =3D 1;\r
+> }\r
+>=20=20\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
+>=20=20\r
+> +test_begin_subtest "--output=3Dsender"\r
+> +notmuch search --output=3Dsender '*' | 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=C3=A7ois 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=3Drecipients"\r
+> +notmuch search --output=3Drecipients '*' | 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@arc=\r
+hlinux.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=3Dsender --output=3Drecipients"\r
+> +notmuch search --output=3Dsender --output=3Drecipients '*' | sort | uniq=\r
+ --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@arc=\r
+hlinux.org>\r
+> + 1 Fran=C3=A7ois 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 =\r
+author and subject"\r
+> add_message "[subject]=3D'two =3D?ISO-8859-1?Q?line=3D0A_subject?=3D\r
+> headers'"\r
+> --=20\r
+> 2.1.1\r
+>\r
+> _______________________________________________\r
+> notmuch mailing list\r
+> notmuch@notmuchmail.org\r
+> http://notmuchmail.org/mailman/listinfo/notmuch\r
projects / notmuch-archives.git / commitdiff