From c6a80bf628c12555d6b4d01b7005619dab567262 Mon Sep 17 00:00:00 2001 From: Tomi Ollila Date: Mon, 13 Oct 2014 22:00:58 +0300 Subject: [PATCH] Re: [PATCH v3 3/4] cli: Extend the search command for --output={sender, recipients} --- 41/cb0adafb6d355dd27849bdd99a791637f044af | 309 ++++++++++++++++++++++ 1 file changed, 309 insertions(+) create mode 100644 41/cb0adafb6d355dd27849bdd99a791637f044af diff --git a/41/cb0adafb6d355dd27849bdd99a791637f044af b/41/cb0adafb6d355dd27849bdd99a791637f044af new file mode 100644 index 000000000..c33e2ef61 --- /dev/null +++ b/41/cb0adafb6d355dd27849bdd99a791637f044af @@ -0,0 +1,309 @@ +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 49148431FAF + for ; Mon, 13 Oct 2014 12:01:24 -0700 (PDT) +X-Virus-Scanned: Debian amavisd-new at olra.theworths.org +X-Spam-Flag: NO +X-Spam-Score: 0 +X-Spam-Level: +X-Spam-Status: No, score=0 tagged_above=-999 required=5 tests=[none] + 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 1xQpcXesZ2EW for ; + Mon, 13 Oct 2014 12:01:20 -0700 (PDT) +Received: from guru.guru-group.fi (guru.guru-group.fi [46.183.73.34]) + by olra.theworths.org (Postfix) with ESMTP id DB1EC431FAE + for ; Mon, 13 Oct 2014 12:01:19 -0700 (PDT) +Received: from guru.guru-group.fi (localhost [IPv6:::1]) + by guru.guru-group.fi (Postfix) with ESMTP id 148DB100090; + Mon, 13 Oct 2014 22:00:59 +0300 (EEST) +From: Tomi Ollila +To: Michal Sojka , notmuch@notmuchmail.org +Subject: Re: [PATCH v3 3/4] cli: Extend the search command for + --output={sender, recipients} +In-Reply-To: <1413150093-8383-4-git-send-email-sojkam1@fel.cvut.cz> +References: <87zjd51phx.fsf@steelpick.2x.cz> + <1413150093-8383-1-git-send-email-sojkam1@fel.cvut.cz> + <1413150093-8383-4-git-send-email-sojkam1@fel.cvut.cz> +User-Agent: Notmuch/0.18.1+130~ga61922f (http://notmuchmail.org) Emacs/24.3.1 + (x86_64-unknown-linux-gnu) +X-Face: HhBM'cA~ +MIME-Version: 1.0 +Content-Type: text/plain +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: Mon, 13 Oct 2014 19:01:24 -0000 + +On Mon, Oct 13 2014, Michal Sojka wrote: + +> The new outputs allow printing senders, recipients or both of matching +> messages. The --output option is converted from "keyword" argument to +> "flags" argument, which means that the user can use --output=sender and +> --output=recipients simultaneously, to print both. Other combinations +> produce an error. +> +> This code based on a patch from Jani Nikula. +> --- +> completion/notmuch-completion.bash | 2 +- +> completion/notmuch-completion.zsh | 3 +- +> doc/man1/notmuch-search.rst | 22 +++++++- +> notmuch-search.c | 110 ++++++++++++++++++++++++++++++++++--- +> test/T090-search-output.sh | 64 +++++++++++++++++++++ +> 5 files changed, 189 insertions(+), 12 deletions(-) +> +> diff --git a/completion/notmuch-completion.bash b/completion/notmuch-completion.bash +> index 0571dc9..cfbd389 100644 +> --- a/completion/notmuch-completion.bash +> +++ b/completion/notmuch-completion.bash +> @@ -294,7 +294,7 @@ _notmuch_search() +> return +> ;; +> --output) +> - COMPREPLY=( $( compgen -W "summary threads messages files tags" -- "${cur}" ) ) +> + COMPREPLY=( $( compgen -W "summary threads messages files tags sender recipients" -- "${cur}" ) ) +> return +> ;; +> --sort) +> diff --git a/completion/notmuch-completion.zsh b/completion/notmuch-completion.zsh +> index 67a9aba..3e52a00 100644 +> --- a/completion/notmuch-completion.zsh +> +++ b/completion/notmuch-completion.zsh +> @@ -52,7 +52,8 @@ _notmuch_search() +> _arguments -s : \ +> '--max-threads=[display only the first x threads from the search results]:number of threads to show: ' \ +> '--first=[omit the first x threads from the search results]:number of threads to omit: ' \ +> - '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' +> + '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \ +> + '--output=[select what to output]:output:((summary threads messages files tags sender recipients))' +> } +> +> _notmuch() +> diff --git a/doc/man1/notmuch-search.rst b/doc/man1/notmuch-search.rst +> index 90160f2..c9d38b1 100644 +> --- a/doc/man1/notmuch-search.rst +> +++ b/doc/man1/notmuch-search.rst +> @@ -35,7 +35,7 @@ Supported options for **search** include +> intended for programs that invoke **notmuch(1)** internally. If +> omitted, the latest supported version will be used. +> +> - ``--output=(summary|threads|messages|files|tags)`` +> + ``--output=(summary|threads|messages|files|tags|sender|recipients)`` +> +> **summary** +> Output a summary of each thread with any message matching +> @@ -78,6 +78,26 @@ Supported options for **search** include +> by null characters (--format=text0), as a JSON array +> (--format=json), or as an S-Expression list (--format=sexp). +> +> + **sender** +> + Output all addresses from the *From* header that appear on +> + any message matching the search terms, either one per line +> + (--format=text), separated by null characters +> + (--format=text0), as a JSON array (--format=json), or as +> + an S-Expression list (--format=sexp). +> + +> + Note: Searching for **sender** should be much faster than +> + searching for **recipients**, because sender addresses are +> + cached directly in the database whereas other addresses +> + need to be fetched from message files. +> + +> + **recipients** +> + Like **sender** but for addresses from *To*, *Cc* and +> + *Bcc* headers. +> + +> + This option can be given multiple times to combine different +> + outputs. Curently, this is only supported for **sender** and +> + **recipients** outputs. +> + +> ``--sort=``\ (**newest-first**\ \|\ **oldest-first**) +> This option can be used to present results in either +> chronological order (**oldest-first**) or reverse chronological +> diff --git a/notmuch-search.c b/notmuch-search.c +> index 5ac2a26..74588f8 100644 +> --- a/notmuch-search.c +> +++ b/notmuch-search.c +> @@ -23,11 +23,14 @@ +> #include "string-util.h" +> +> typedef enum { +> - OUTPUT_SUMMARY, +> - OUTPUT_THREADS, +> - OUTPUT_MESSAGES, +> - OUTPUT_FILES, +> - OUTPUT_TAGS +> + OUTPUT_SUMMARY = 1 << 0, +> + OUTPUT_THREADS = 1 << 1, +> + OUTPUT_MESSAGES = 1 << 2, +> + OUTPUT_FILES = 1 << 3, +> + OUTPUT_TAGS = 1 << 4, +> + OUTPUT_SENDER = 1 << 5, +> + OUTPUT_RECIPIENTS = 1 << 6, +> + OUTPUT_ADDRESSES = OUTPUT_SENDER | OUTPUT_RECIPIENTS, + +leftover, like mentioned below (this comment added just before sending) + +> } output_t; +> +> typedef struct { +> @@ -220,6 +223,67 @@ do_search_threads (search_options_t *o) +> return 0; +> } +> +> +static void +> +print_address_list (const search_options_t *o, InternetAddressList *list) +> +{ +> + InternetAddress *address; +> + int i; +> + +> + for (i = 0; i < internet_address_list_length (list); i++) { +> + address = internet_address_list_get_address (list, i); +> + if (INTERNET_ADDRESS_IS_GROUP (address)) { +> + InternetAddressGroup *group; +> + InternetAddressList *group_list; +> + +> + group = INTERNET_ADDRESS_GROUP (address); +> + group_list = internet_address_group_get_members (group); +> + if (group_list == NULL) +> + continue; +> + +> + print_address_list (o, group_list); +> + } else { +> + InternetAddressMailbox *mailbox; +> + const char *name; +> + const char *addr; +> + char *full_address; +> + +> + mailbox = INTERNET_ADDRESS_MAILBOX (address); +> + +> + name = internet_address_get_name (address); +> + addr = internet_address_mailbox_get_addr (mailbox); +> + +> + if (name && *name) +> + full_address = talloc_asprintf (o->format, "%s <%s>", name, addr); +> + else +> + full_address = talloc_strdup (o->format, addr); +> + +> + if (!full_address) { + +Apart from minor style issue like space after ! and the leftover ADDRESSES +parts (w/o that I would not have commented about !) the first 3 +patches look pretty good to me. I have not tested those yet. + +But we keep to have some disagreement w/ unique/duplicate/filter-by +handling ;/ + +I (currently) rest the case of first/last/most common handling to just +how the --sort=(newest-first|oldest-first) affects the order... + +Let's consider the following list of output if no /deduplication/ is done: + + John Doe + Dr. John Doe + John Doe + John Doe + Dr. John Doe + John Doe + John Doe + Dr. John Doe + Dr. John Doe + Dr. John Doe + John Doe + John Doe + +To stir the pool a little more, this could be the output when +--duplicate=all (the default) is given. + +With --duplicate=none the output could be (first match by unique +case-insensitive address): + + John Doe + John Doe + John Doe + +(many people may have the same name, but email address is unique per person +-- therefore I think 'none' limiting that just to John Doe +would be too little) + +and with --duplicate=address + + John Doe + Dr. John Doe + John Doe + Dr. John Doe + John Doe + +(from this output user can choose how the recipient is to be called +(like "pseudonyms" mentioned in id:20141010113202.GE28601@TP_L520.localdomain ) +when sending email) + +and --duplicate=address-casesensitive + + John Doe + Dr. John Doe + John Doe + John Doe + Dr. John Doe + John Doe + John Doe + +This reuse of --duplicate was thought out after Jani's irc mention of it. +This scheme would leave no room tho the filter-by=name suggestion -- for +completeness that would make this look: + + John Doe + Dr. John Doe + +This doesn't look too bad in this particular case but not having ability to +see all potential addresses (perhaps the only working address is now +hidden) isn't not much for general use. Well, maybe for some specific use +--duplicate=no-unique-addresses could be useful :O + +Ok, this took an hour to get written to (w/ some interruptions). Healthy +criticism appreciated :D + +Tomi + +// stuff deleted before some 'ADDRESSES' leftover... + +> @@ -455,18 +542,23 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[]) +> } +> +> switch (o.output) { +> - default: +> case OUTPUT_SUMMARY: +> case OUTPUT_THREADS: +> ret = do_search_threads (&o); +> break; +> case OUTPUT_MESSAGES: +> + case OUTPUT_SENDER: +> + case OUTPUT_RECIPIENTS: +> + case OUTPUT_ADDRESSES: +> case OUTPUT_FILES: +> ret = do_search_messages (&o); +> break; +> case OUTPUT_TAGS: +> ret = do_search_tags (notmuch, o.format, o.query); +> break; +> + default: +> + fprintf (stderr, "Error: the combination of outputs is not supported.\n"); +> + ret = 1; +> } +> +> notmuch_query_destroy (o.query); -- 2.26.2