From a5a6859197fb0b9cea7d75c4ec9377b9fc7d7285 Mon Sep 17 00:00:00 2001 From: Michal Sojka Date: Wed, 5 Nov 2014 01:25:58 +0100 Subject: [PATCH] cli: address: Add --output=count This output prints how many times was each address encountered during search. --- completion/notmuch-completion.bash | 2 +- completion/notmuch-completion.zsh | 2 +- doc/man1/notmuch-address.rst | 11 ++++++- notmuch-search.c | 49 +++++++++++++++++++++++++----- test/T095-address.sh | 49 ++++++++++++++++++++++++++++++ 5 files changed, 103 insertions(+), 10 deletions(-) diff --git a/completion/notmuch-completion.bash b/completion/notmuch-completion.bash index 94ea2d56..db152f35 100644 --- a/completion/notmuch-completion.bash +++ b/completion/notmuch-completion.bash @@ -332,7 +332,7 @@ _notmuch_address() return ;; --output) - COMPREPLY=( $( compgen -W "sender recipients" -- "${cur}" ) ) + COMPREPLY=( $( compgen -W "sender recipients count" -- "${cur}" ) ) return ;; --sort) diff --git a/completion/notmuch-completion.zsh b/completion/notmuch-completion.zsh index c606b751..89685620 100644 --- a/completion/notmuch-completion.zsh +++ b/completion/notmuch-completion.zsh @@ -61,7 +61,7 @@ _notmuch_address() { _arguments -s : \ '--sort=[sort results]:sorting:((newest-first\:"reverse chronological order" oldest-first\:"chronological order"))' \ - '--output=[select what to output]:output:((sender recipients))' + '--output=[select what to output]:output:((sender recipients count))' } _notmuch() diff --git a/doc/man1/notmuch-address.rst b/doc/man1/notmuch-address.rst index 01eb811e..359616e0 100644 --- a/doc/man1/notmuch-address.rst +++ b/doc/man1/notmuch-address.rst @@ -29,7 +29,7 @@ Supported options for **address** include intended for programs that invoke **notmuch(1)** internally. If omitted, the latest supported version will be used. - ``--output=(sender|recipients)`` + ``--output=(sender|recipients|count)`` Controls which information appears in the output. This option can be given multiple times to combine different outputs. @@ -48,6 +48,13 @@ Supported options for **address** include Output all addresses from the *To*, *Cc* and *Bcc* headers. + **count** + Print the count of how many times was the address + encountered during search. + + Note: With this option, addresses are printed only after + the whole search is finished. This may take long time. + ``--sort=``\ (**newest-first**\ \|\ **oldest-first**) This option can be used to present results in either chronological order (**oldest-first**) or reverse chronological @@ -56,6 +63,8 @@ Supported options for **address** include By default, results will be displayed in reverse chronological order, (that is, the newest results will be displayed first). + This option has no effect when used with --output=count. + ``--exclude=(true|false)`` A message is called "excluded" if it matches at least one tag in search.tag\_exclude that does not appear explicitly in the diff --git a/notmuch-search.c b/notmuch-search.c index 86d54ba0..5036d8e4 100644 --- a/notmuch-search.c +++ b/notmuch-search.c @@ -33,6 +33,7 @@ typedef enum { /* Address command */ OUTPUT_SENDER = 1 << 5, OUTPUT_RECIPIENTS = 1 << 6, + OUTPUT_COUNT = 1 << 7, } output_t; typedef enum { @@ -59,6 +60,7 @@ typedef struct { typedef struct { const char *name; const char *addr; + int count; } mailbox_t; /* Return two stable query strings that identify exactly the matched @@ -248,17 +250,24 @@ is_duplicate (const search_context_t *ctx, const char *name, const char *addr) { notmuch_bool_t duplicate; char *key; + mailbox_t *mailbox; key = talloc_asprintf (ctx->format, "%s <%s>", name, addr); if (! key) return FALSE; - duplicate = g_hash_table_lookup_extended (ctx->addresses, key, NULL, NULL); + duplicate = g_hash_table_lookup_extended (ctx->addresses, key, NULL, (gpointer)&mailbox); - if (! duplicate) - g_hash_table_insert (ctx->addresses, key, NULL); - else + if (! duplicate) { + mailbox = talloc (ctx->format, mailbox_t); + mailbox->name = talloc_strdup (mailbox, name); + mailbox->addr = talloc_strdup (mailbox, addr); + mailbox->count = 1; + g_hash_table_insert (ctx->addresses, key, mailbox); + } else { + mailbox->count++; talloc_free (key); + } return duplicate; } @@ -268,6 +277,7 @@ print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox) { const char *name = mailbox->name; const char *addr = mailbox->addr; + int count = mailbox->count; sprinter_t *format = ctx->format; InternetAddress *ia = internet_address_mailbox_new (name, addr); char *name_addr; @@ -277,6 +287,10 @@ print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox) name_addr = internet_address_to_string (ia, FALSE); if (format->is_text_printer) { + if (count > 0) { + format->integer (format, count); + format->string (format, "\t"); + } format->string (format, name_addr); format->separator (format); } else { @@ -287,6 +301,10 @@ print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox) format->string (format, addr); format->map_key (format, "name-addr"); format->string (format, name_addr); + if (count > 0) { + format->map_key (format, "count"); + format->integer (format, count); + } format->end (format); format->separator (format); } @@ -295,7 +313,7 @@ print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox) g_free (name_addr); } -/* Print addresses from InternetAddressList. */ +/* Print or prepare for printing addresses from InternetAddressList. */ static void process_address_list (const search_context_t *ctx, InternetAddressList *list) @@ -320,17 +338,21 @@ process_address_list (const search_context_t *ctx, mailbox_t mbx = { .name = internet_address_get_name (address), .addr = internet_address_mailbox_get_addr (mailbox), + .count = 0, }; if (is_duplicate (ctx, mbx.name, mbx.addr)) continue; + if (ctx->output & OUTPUT_COUNT) + continue; + print_mailbox (ctx, &mbx); } } } -/* Print addresses from a message header. */ +/* Print or prepare for printing addresses from a message header. */ static void process_address_header (const search_context_t *ctx, const char *value) { @@ -355,6 +377,15 @@ _talloc_free_for_g_hash (void *ptr) talloc_free (ptr); } +static void +print_hash_value (unused (gpointer key), gpointer value, gpointer user_data) +{ + const mailbox_t *mailbox = value; + search_context_t *ctx = user_data; + + print_mailbox (ctx, mailbox); +} + static int _count_filenames (notmuch_message_t *message) { @@ -450,6 +481,9 @@ do_search_messages (search_context_t *ctx) notmuch_message_destroy (message); } + if (ctx->addresses && ctx->output & OUTPUT_COUNT) + g_hash_table_foreach (ctx->addresses, print_hash_value, ctx); + notmuch_messages_destroy (messages); format->end (format); @@ -687,6 +721,7 @@ notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]) { NOTMUCH_OPT_KEYWORD_FLAGS, &ctx->output, "output", 'o', (notmuch_keyword_t []){ { "sender", OUTPUT_SENDER }, { "recipients", OUTPUT_RECIPIENTS }, + { "count", OUTPUT_COUNT }, { 0, 0 } } }, { NOTMUCH_OPT_KEYWORD, &ctx->exclude, "exclude", 'x', (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE }, @@ -708,7 +743,7 @@ notmuch_address_command (notmuch_config_t *config, int argc, char *argv[]) return EXIT_FAILURE; ctx->addresses = g_hash_table_new_full (g_str_hash, g_str_equal, - _talloc_free_for_g_hash, NULL); + _talloc_free_for_g_hash, _talloc_free_for_g_hash); ret = do_search_messages (ctx); diff --git a/test/T095-address.sh b/test/T095-address.sh index 0d47c0d9..033d0f4f 100755 --- a/test/T095-address.sh +++ b/test/T095-address.sh @@ -96,4 +96,53 @@ notmuch address '*' >OUTPUT # Use EXPECTED from previous subtest test_expect_equal_file OUTPUT EXPECTED +test_begin_subtest "--output=sender --output=count" +notmuch address --output=sender --output=count '*' | sort -n >OUTPUT +cat <EXPECTED +1 Adrian Perez de Castro +1 Aron Griffis +1 Chris Wilson +1 François Boulogne +1 Ingmar Vanhassel +1 Israel Herraiz +1 Olivier Berger +1 Rolland Santimano +2 Alex Botero-Lowry +2 Jjgod Jiang +3 Stewart Smith +4 Alexander Botero-Lowry +4 Jan Janak +5 Lars Kellogg-Stedman +5 Mikhail Gusarov +7 Keith Packard +12 Carl Worth +EOF +test_expect_equal_file OUTPUT EXPECTED + +test_begin_subtest "--output=sender --output=count --format=json" +# Since the iteration order of GHashTable is not specified, we +# preprocess and sort the results to keep the order stable here. +notmuch address --output=sender --output=count --format=json '*' | \ + sed -e 's/^\[//' -e 's/]$//' -e 's/,$//' | sort >OUTPUT +cat <EXPECTED +{"name": "Adrian Perez de Castro", "address": "aperez@igalia.com", "name-addr": "Adrian Perez de Castro ", "count": 1} +{"name": "Alex Botero-Lowry", "address": "alex.boterolowry@gmail.com", "name-addr": "Alex Botero-Lowry ", "count": 2} +{"name": "Alexander Botero-Lowry", "address": "alex.boterolowry@gmail.com", "name-addr": "Alexander Botero-Lowry ", "count": 4} +{"name": "Aron Griffis", "address": "agriffis@n01se.net", "name-addr": "Aron Griffis ", "count": 1} +{"name": "Carl Worth", "address": "cworth@cworth.org", "name-addr": "Carl Worth ", "count": 12} +{"name": "Chris Wilson", "address": "chris@chris-wilson.co.uk", "name-addr": "Chris Wilson ", "count": 1} +{"name": "François Boulogne", "address": "boulogne.f@gmail.com", "name-addr": "François Boulogne ", "count": 1} +{"name": "Ingmar Vanhassel", "address": "ingmar@exherbo.org", "name-addr": "Ingmar Vanhassel ", "count": 1} +{"name": "Israel Herraiz", "address": "isra@herraiz.org", "name-addr": "Israel Herraiz ", "count": 1} +{"name": "Jan Janak", "address": "jan@ryngle.com", "name-addr": "Jan Janak ", "count": 4} +{"name": "Jjgod Jiang", "address": "gzjjgod@gmail.com", "name-addr": "Jjgod Jiang ", "count": 2} +{"name": "Keith Packard", "address": "keithp@keithp.com", "name-addr": "Keith Packard ", "count": 7} +{"name": "Lars Kellogg-Stedman", "address": "lars@seas.harvard.edu", "name-addr": "Lars Kellogg-Stedman ", "count": 5} +{"name": "Mikhail Gusarov", "address": "dottedmag@dottedmag.net", "name-addr": "Mikhail Gusarov ", "count": 5} +{"name": "Olivier Berger", "address": "olivier.berger@it-sudparis.eu", "name-addr": "Olivier Berger ", "count": 1} +{"name": "Rolland Santimano", "address": "rollandsantimano@yahoo.com", "name-addr": "Rolland Santimano ", "count": 1} +{"name": "Stewart Smith", "address": "stewart@flamingspork.com", "name-addr": "Stewart Smith ", "count": 3} +EOF +test_expect_equal_file OUTPUT EXPECTED + test_done