]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-search.c
cli: change the data structure for notmuch address deduplication
[notmuch] / notmuch-search.c
index 6765a166357cb649ea64fb2d730448a170ed05b1..6cac0fcdc1dfa042a3c68bd8ffda4987acf01f05 100644 (file)
 #include "string-util.h"
 
 typedef enum {
+    /* Search command */
     OUTPUT_SUMMARY     = 1 << 0,
     OUTPUT_THREADS     = 1 << 1,
     OUTPUT_MESSAGES    = 1 << 2,
     OUTPUT_FILES       = 1 << 3,
     OUTPUT_TAGS                = 1 << 4,
+
+    /* Address command */
     OUTPUT_SENDER      = 1 << 5,
     OUTPUT_RECIPIENTS  = 1 << 6,
+    OUTPUT_COUNT       = 1 << 7,
 } output_t;
 
-#define OUTPUT_ADDRESS_FLAGS (OUTPUT_SENDER | OUTPUT_RECIPIENTS)
+typedef enum {
+    DEDUP_NONE,
+    DEDUP_MAILBOX,
+} dedup_t;
 
 typedef enum {
     NOTMUCH_FORMAT_JSON,
@@ -52,11 +59,14 @@ typedef struct {
     int offset;
     int limit;
     int dupe;
+    GHashTable *addresses;
+    dedup_t dedup;
 } search_context_t;
 
 typedef struct {
     const char *name;
     const char *addr;
+    int count;
 } mailbox_t;
 
 /* Return two stable query strings that identify exactly the matched
@@ -107,6 +117,7 @@ do_search_threads (search_context_t *ctx)
     sprinter_t *format = ctx->format;
     time_t date;
     int i;
+    notmuch_status_t status;
 
     if (ctx->offset < 0) {
        ctx->offset += notmuch_query_count_threads (ctx->query);
@@ -114,8 +125,8 @@ do_search_threads (search_context_t *ctx)
            ctx->offset = 0;
     }
 
-    threads = notmuch_query_search_threads (ctx->query);
-    if (threads == NULL)
+    status = notmuch_query_search_threads_st (ctx->query, &threads);
+    if (print_status_query("notmuch search", ctx->query, status))
        return 1;
 
     format->begin_list (format);
@@ -239,11 +250,95 @@ do_search_threads (search_context_t *ctx)
     return 0;
 }
 
+static mailbox_t *new_mailbox (void *ctx, const char *name, const char *addr)
+{
+    mailbox_t *mailbox;
+
+    mailbox = talloc (ctx, mailbox_t);
+    if (! mailbox)
+       return NULL;
+
+    mailbox->name = talloc_strdup (mailbox, name);
+    mailbox->addr = talloc_strdup (mailbox, addr);
+    mailbox->count = 1;
+
+    return mailbox;
+}
+
+static int mailbox_compare (const void *v1, const void *v2)
+{
+    const mailbox_t *m1 = v1, *m2 = v2;
+    int ret;
+
+    ret = strcmp_null (m1->name, m2->name);
+    if (! ret)
+       ret = strcmp (m1->addr, m2->addr);
+
+    return ret;
+}
+
+/* Returns TRUE iff name and addr is duplicate. If not, stores the
+ * name/addr pair in order to detect subsequent duplicates. */
+static notmuch_bool_t
+is_duplicate (const search_context_t *ctx, const char *name, const char *addr)
+{
+    char *key;
+    GList *list, *l;
+    mailbox_t *mailbox;
+
+    list = g_hash_table_lookup (ctx->addresses, addr);
+    if (list) {
+       mailbox_t find = {
+           .name = name,
+           .addr = addr,
+       };
+
+       l = g_list_find_custom (list, &find, mailbox_compare);
+       if (l) {
+           mailbox = l->data;
+           mailbox->count++;
+           return TRUE;
+       }
+
+       mailbox = new_mailbox (ctx->format, name, addr);
+       if (! mailbox)
+           return FALSE;
+
+       /*
+        * XXX: It would be more efficient to prepend to the list, but
+        * then we'd have to store the changed list head back to the
+        * hash table. This check is here just to avoid the compiler
+        * warning for unused result.
+        */
+       if (list != g_list_append (list, mailbox))
+           INTERNAL_ERROR ("appending to list changed list head\n");
+
+       return FALSE;
+    }
+
+    key = talloc_strdup (ctx->format, addr);
+    if (! key)
+       return FALSE;
+
+    mailbox = new_mailbox (ctx->format, name, addr);
+    if (! mailbox)
+       return FALSE;
+
+    list = g_list_append (NULL, mailbox);
+    if (! list)
+       return FALSE;
+
+    g_hash_table_insert (ctx->addresses, key, list);
+
+    return FALSE;
+}
+
 static void
 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;
@@ -253,6 +348,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 {
@@ -263,6 +362,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);
     }
@@ -271,9 +374,10 @@ 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)
+process_address_list (const search_context_t *ctx,
+                     InternetAddressList *list)
 {
     InternetAddress *address;
     int i;
@@ -295,14 +399,23 @@ process_address_list (const search_context_t *ctx, InternetAddressList *list)
            mailbox_t mbx = {
                .name = internet_address_get_name (address),
                .addr = internet_address_mailbox_get_addr (mailbox),
+               .count = 0,
            };
 
+           /* OUTPUT_COUNT only works with deduplication */
+           if (ctx->dedup != DEDUP_NONE &&
+               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)
 {
@@ -320,6 +433,31 @@ process_address_header (const search_context_t *ctx, const char *value)
     g_object_unref (list);
 }
 
+/* Destructor for talloc-allocated GHashTable keys and values. */
+static void
+_talloc_free_for_g_hash (void *ptr)
+{
+    talloc_free (ptr);
+}
+
+static void
+_list_free_for_g_hash (void *ptr)
+{
+    g_list_free_full (ptr, _talloc_free_for_g_hash);
+}
+
+static void
+print_list_value (void *mailbox, void *context)
+{
+    print_mailbox (context, mailbox);
+}
+
+static void
+print_hash_value (unused (void *key), void *list, void *context)
+{
+    g_list_foreach (list, print_list_value, context);
+}
+
 static int
 _count_filenames (notmuch_message_t *message)
 {
@@ -346,6 +484,7 @@ do_search_messages (search_context_t *ctx)
     notmuch_filenames_t *filenames;
     sprinter_t *format = ctx->format;
     int i;
+    notmuch_status_t status;
 
     if (ctx->offset < 0) {
        ctx->offset += notmuch_query_count_messages (ctx->query);
@@ -353,8 +492,8 @@ do_search_messages (search_context_t *ctx)
            ctx->offset = 0;
     }
 
-    messages = notmuch_query_search_messages (ctx->query);
-    if (messages == NULL)
+    status = notmuch_query_search_messages_st (ctx->query, &messages);
+    if (print_status_query ("notmuch search", ctx->query, status))
        return 1;
 
     format->begin_list (format);
@@ -415,6 +554,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);
@@ -439,8 +581,9 @@ do_search_tags (const search_context_t *ctx)
     if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
        tags = notmuch_database_get_all_tags (notmuch);
     } else {
-       messages = notmuch_query_search_messages (query);
-       if (messages == NULL)
+       notmuch_status_t status;
+       status = notmuch_query_search_messages_st (query, &messages);
+       if (print_status_query ("notmuch search", query, status))
            return 1;
 
        tags = notmuch_messages_collect_tags (messages);
@@ -471,68 +614,12 @@ do_search_tags (const search_context_t *ctx)
     return 0;
 }
 
-int
-notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
+static int
+_notmuch_search_prepare (search_context_t *ctx, notmuch_config_t *config, int argc, char *argv[])
 {
-    search_context_t search_context = {
-       .format_sel = NOTMUCH_FORMAT_TEXT,
-       .exclude = NOTMUCH_EXCLUDE_TRUE,
-       .sort = NOTMUCH_SORT_NEWEST_FIRST,
-       .output = 0,
-       .offset = 0,
-       .limit = -1, /* unlimited */
-       .dupe = -1,
-    };
-    search_context_t *ctx = &search_context;
     char *query_str;
-    int opt_index, ret;
     unsigned int i;
-
-    notmuch_opt_desc_t options[] = {
-       { NOTMUCH_OPT_KEYWORD, &ctx->sort, "sort", 's',
-         (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
-                                 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
-                                 { 0, 0 } } },
-       { NOTMUCH_OPT_KEYWORD, &ctx->format_sel, "format", 'f',
-         (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
-                                 { "sexp", NOTMUCH_FORMAT_SEXP },
-                                 { "text", NOTMUCH_FORMAT_TEXT },
-                                 { "text0", NOTMUCH_FORMAT_TEXT0 },
-                                 { 0, 0 } } },
-       { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
-       { NOTMUCH_OPT_KEYWORD_FLAGS, &ctx->output, "output", 'o',
-         (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
-                                 { "threads", OUTPUT_THREADS },
-                                 { "messages", OUTPUT_MESSAGES },
-                                 { "sender", OUTPUT_SENDER },
-                                 { "recipients", OUTPUT_RECIPIENTS },
-                                 { "files", OUTPUT_FILES },
-                                 { "tags", OUTPUT_TAGS },
-                                 { 0, 0 } } },
-        { NOTMUCH_OPT_KEYWORD, &ctx->exclude, "exclude", 'x',
-          (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
-                                  { "false", NOTMUCH_EXCLUDE_FALSE },
-                                  { "flag", NOTMUCH_EXCLUDE_FLAG },
-                                  { "all", NOTMUCH_EXCLUDE_ALL },
-                                  { 0, 0 } } },
-       { NOTMUCH_OPT_INT, &ctx->offset, "offset", 'O', 0 },
-       { NOTMUCH_OPT_INT, &ctx->limit, "limit", 'L', 0  },
-       { NOTMUCH_OPT_INT, &ctx->dupe, "duplicate", 'D', 0  },
-       { 0, 0, 0, 0, 0 }
-    };
-
-    opt_index = parse_arguments (argc, argv, options, 1);
-    if (opt_index < 0)
-       return EXIT_FAILURE;
-
-    if (! ctx->output)
-       ctx->output = OUTPUT_SUMMARY;
-
-    if (ctx->output != OUTPUT_FILES && ctx->output != OUTPUT_MESSAGES &&
-       ctx->dupe != -1) {
-        fprintf (stderr, "Error: --duplicate=N is only supported with --output=files and --output=messages.\n");
-        return EXIT_FAILURE;
-    }
+    char *status_string = NULL;
 
     switch (ctx->format_sel) {
     case NOTMUCH_FORMAT_TEXT:
@@ -558,11 +645,21 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
 
     notmuch_exit_if_unsupported_format ();
 
-    if (notmuch_database_open (notmuch_config_get_database_path (config),
-                              NOTMUCH_DATABASE_MODE_READ_ONLY, &ctx->notmuch))
+    if (notmuch_database_open_verbose (
+           notmuch_config_get_database_path (config),
+           NOTMUCH_DATABASE_MODE_READ_ONLY, &ctx->notmuch, &status_string)) {
+
+       if (status_string) {
+           fputs (status_string, stderr);
+           free (status_string);
+       }
+
        return EXIT_FAILURE;
+    }
+
+    notmuch_exit_if_unmatched_db_uuid (ctx->notmuch);
 
-    query_str = query_string_from_args (ctx->notmuch, argc-opt_index, argv+opt_index);
+    query_str = query_string_from_args (ctx->notmuch, argc, argv);
     if (query_str == NULL) {
        fprintf (stderr, "Out of memory.\n");
        return EXIT_FAILURE;
@@ -599,24 +696,163 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
        notmuch_query_set_omit_excluded (ctx->query, ctx->exclude);
     }
 
-    if (ctx->output == OUTPUT_SUMMARY ||
-       ctx->output == OUTPUT_THREADS)
+    return 0;
+}
+
+static void
+_notmuch_search_cleanup (search_context_t *ctx)
+{
+    notmuch_query_destroy (ctx->query);
+    notmuch_database_destroy (ctx->notmuch);
+
+    talloc_free (ctx->format);
+}
+
+static search_context_t search_context = {
+    .format_sel = NOTMUCH_FORMAT_TEXT,
+    .exclude = NOTMUCH_EXCLUDE_TRUE,
+    .sort = NOTMUCH_SORT_NEWEST_FIRST,
+    .output = 0,
+    .offset = 0,
+    .limit = -1, /* unlimited */
+    .dupe = -1,
+    .dedup = DEDUP_MAILBOX,
+};
+
+static const notmuch_opt_desc_t common_options[] = {
+    { NOTMUCH_OPT_KEYWORD, &search_context.sort, "sort", 's',
+      (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
+                             { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
+                             { 0, 0 } } },
+    { NOTMUCH_OPT_KEYWORD, &search_context.format_sel, "format", 'f',
+      (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
+                             { "sexp", NOTMUCH_FORMAT_SEXP },
+                             { "text", NOTMUCH_FORMAT_TEXT },
+                             { "text0", NOTMUCH_FORMAT_TEXT0 },
+                             { 0, 0 } } },
+    { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
+    { 0, 0, 0, 0, 0 }
+};
+
+int
+notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
+{
+    search_context_t *ctx = &search_context;
+    int opt_index, ret;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_KEYWORD, &ctx->output, "output", 'o',
+         (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
+                                 { "threads", OUTPUT_THREADS },
+                                 { "messages", OUTPUT_MESSAGES },
+                                 { "files", OUTPUT_FILES },
+                                 { "tags", OUTPUT_TAGS },
+                                 { 0, 0 } } },
+        { NOTMUCH_OPT_KEYWORD, &ctx->exclude, "exclude", 'x',
+          (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
+                                  { "false", NOTMUCH_EXCLUDE_FALSE },
+                                  { "flag", NOTMUCH_EXCLUDE_FLAG },
+                                  { "all", NOTMUCH_EXCLUDE_ALL },
+                                  { 0, 0 } } },
+       { NOTMUCH_OPT_INT, &ctx->offset, "offset", 'O', 0 },
+       { NOTMUCH_OPT_INT, &ctx->limit, "limit", 'L', 0  },
+       { NOTMUCH_OPT_INT, &ctx->dupe, "duplicate", 'D', 0  },
+       { NOTMUCH_OPT_INHERIT, (void *) &common_options, NULL, 0, 0 },
+       { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    ctx->output = OUTPUT_SUMMARY;
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    notmuch_process_shared_options (argv[0]);
+
+    if (ctx->output != OUTPUT_FILES && ctx->output != OUTPUT_MESSAGES &&
+       ctx->dupe != -1) {
+        fprintf (stderr, "Error: --duplicate=N is only supported with --output=files and --output=messages.\n");
+        return EXIT_FAILURE;
+    }
+
+    if (_notmuch_search_prepare (ctx, config,
+                                argc - opt_index, argv + opt_index))
+       return EXIT_FAILURE;
+
+    switch (ctx->output) {
+    case OUTPUT_SUMMARY:
+    case OUTPUT_THREADS:
        ret = do_search_threads (ctx);
-    else if (ctx->output == OUTPUT_MESSAGES ||
-            ctx->output == OUTPUT_FILES ||
-            (ctx->output & OUTPUT_ADDRESS_FLAGS && !(ctx->output & ~OUTPUT_ADDRESS_FLAGS)))
+       break;
+    case OUTPUT_MESSAGES:
+    case OUTPUT_FILES:
        ret = do_search_messages (ctx);
-    else if (ctx->output == OUTPUT_TAGS)
+       break;
+    case OUTPUT_TAGS:
        ret = do_search_tags (ctx);
-    else {
-       fprintf (stderr, "Error: the combination of outputs is not supported.\n");
-       ret = 1;
+       break;
+    default:
+       INTERNAL_ERROR ("Unexpected output");
     }
 
-    notmuch_query_destroy (ctx->query);
-    notmuch_database_destroy (ctx->notmuch);
+    _notmuch_search_cleanup (ctx);
 
-    talloc_free (ctx->format);
+    return ret ? EXIT_FAILURE : EXIT_SUCCESS;
+}
+
+int
+notmuch_address_command (notmuch_config_t *config, int argc, char *argv[])
+{
+    search_context_t *ctx = &search_context;
+    int opt_index, ret;
+
+    notmuch_opt_desc_t options[] = {
+       { 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 },
+                                 { "false", NOTMUCH_EXCLUDE_FALSE },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD, &ctx->dedup, "deduplicate", 'D',
+         (notmuch_keyword_t []){ { "no", DEDUP_NONE },
+                                 { "mailbox", DEDUP_MAILBOX },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_INHERIT, (void *) &common_options, NULL, 0, 0 },
+       { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    notmuch_process_shared_options (argv[0]);
+
+    if (! (ctx->output & (OUTPUT_SENDER | OUTPUT_RECIPIENTS)))
+       ctx->output |= OUTPUT_SENDER;
+
+    if (ctx->output & OUTPUT_COUNT && ctx->dedup == DEDUP_NONE) {
+       fprintf (stderr, "--output=count is not applicable with --deduplicate=no\n");
+       return EXIT_FAILURE;
+    }
+
+    if (_notmuch_search_prepare (ctx, config,
+                                argc - opt_index, argv + opt_index))
+       return EXIT_FAILURE;
+
+    ctx->addresses = g_hash_table_new_full (strcase_hash, strcase_equal,
+                                           _talloc_free_for_g_hash,
+                                           _list_free_for_g_hash);
+
+    ret = do_search_messages (ctx);
+
+    g_hash_table_unref (ctx->addresses);
+
+
+    _notmuch_search_cleanup (ctx);
 
     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
 }