]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-search.c
cli: search: Refactor passing of command line options
[notmuch] / notmuch-search.c
index a20791a18af11d35f3467d82e2ab719b7b33f7b5..0c3e9724163d863c7af9e622a00064f581644de8 100644 (file)
@@ -20,6 +20,7 @@
 
 #include "notmuch-client.h"
 #include "sprinter.h"
+#include "string-util.h"
 
 typedef enum {
     OUTPUT_SUMMARY,
@@ -29,61 +30,89 @@ typedef enum {
     OUTPUT_TAGS
 } output_t;
 
-static char *
-sanitize_string (const void *ctx, const char *str)
+typedef struct {
+    sprinter_t *format;
+    notmuch_query_t *query;
+    notmuch_sort_t sort;
+    output_t output;
+    int offset;
+    int limit;
+    int dupe;
+} search_options_t;
+
+/* Return two stable query strings that identify exactly the matched
+ * and unmatched messages currently in thread.  If there are no
+ * matched or unmatched messages, the returned buffers will be
+ * NULL. */
+static int
+get_thread_query (notmuch_thread_t *thread,
+                 char **matched_out, char **unmatched_out)
 {
-    char *out, *loop;
-
-    if (NULL == str)
-       return NULL;
+    notmuch_messages_t *messages;
+    char *escaped = NULL;
+    size_t escaped_len = 0;
 
-    loop = out = talloc_strdup (ctx, str);
+    *matched_out = *unmatched_out = NULL;
 
-    for (; *loop; loop++) {
-       if ((unsigned char)(*loop) < 32)
-           *loop = '?';
+    for (messages = notmuch_thread_get_messages (thread);
+        notmuch_messages_valid (messages);
+        notmuch_messages_move_to_next (messages))
+    {
+       notmuch_message_t *message = notmuch_messages_get (messages);
+       const char *mid = notmuch_message_get_message_id (message);
+       /* Determine which query buffer to extend */
+       char **buf = notmuch_message_get_flag (
+           message, NOTMUCH_MESSAGE_FLAG_MATCH) ? matched_out : unmatched_out;
+       /* Add this message's id: query.  Since "id" is an exclusive
+        * prefix, it is implicitly 'or'd together, so we only need to
+        * join queries with a space. */
+       if (make_boolean_term (thread, "id", mid, &escaped, &escaped_len) < 0)
+           return -1;
+       if (*buf)
+           *buf = talloc_asprintf_append_buffer (*buf, " %s", escaped);
+       else
+           *buf = talloc_strdup (thread, escaped);
+       if (!*buf)
+           return -1;
     }
-    return out;
+    talloc_free (escaped);
+    return 0;
 }
 
 static int
-do_search_threads (sprinter_t *format,
-                  notmuch_query_t *query,
-                  notmuch_sort_t sort,
-                  output_t output,
-                  int offset,
-                  int limit)
+do_search_threads (search_options_t *opt)
 {
     notmuch_thread_t *thread;
     notmuch_threads_t *threads;
     notmuch_tags_t *tags;
+    sprinter_t *format = opt->format;
     time_t date;
     int i;
 
-    if (offset < 0) {
-       offset += notmuch_query_count_threads (query);
-       if (offset < 0)
-           offset = 0;
+    if (opt->offset < 0) {
+       opt->offset += notmuch_query_count_threads (opt->query);
+       if (opt->offset < 0)
+           opt->offset = 0;
     }
 
-    threads = notmuch_query_search_threads (query);
+    threads = notmuch_query_search_threads (opt->query);
     if (threads == NULL)
        return 1;
 
     format->begin_list (format);
 
     for (i = 0;
-        notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
+        notmuch_threads_valid (threads) && (opt->limit < 0 || i < opt->offset + opt->limit);
         notmuch_threads_move_to_next (threads), i++)
     {
        thread = notmuch_threads_get (threads);
 
-       if (i < offset) {
+       if (i < opt->offset) {
            notmuch_thread_destroy (thread);
            continue;
        }
 
-       if (output == OUTPUT_THREADS) {
+       if (opt->output == OUTPUT_THREADS) {
            format->set_prefix (format, "thread");
            format->string (format,
                            notmuch_thread_get_thread_id (thread));
@@ -100,7 +129,7 @@ do_search_threads (sprinter_t *format,
 
            format->begin_map (format);
 
-           if (sort == NOTMUCH_SORT_OLDEST_FIRST)
+           if (opt->sort == NOTMUCH_SORT_OLDEST_FIRST)
                date = notmuch_thread_get_oldest_date (thread);
            else
                date = notmuch_thread_get_newest_date (thread);
@@ -131,6 +160,25 @@ do_search_threads (sprinter_t *format,
                format->string (format, authors);
                format->map_key (format, "subject");
                format->string (format, subject);
+               if (notmuch_format_version >= 2) {
+                   char *matched_query, *unmatched_query;
+                   if (get_thread_query (thread, &matched_query,
+                                         &unmatched_query) < 0) {
+                       fprintf (stderr, "Out of memory\n");
+                       return 1;
+                   }
+                   format->map_key (format, "query");
+                   format->begin_list (format);
+                   if (matched_query)
+                       format->string (format, matched_query);
+                   else
+                       format->null (format);
+                   if (unmatched_query)
+                       format->string (format, unmatched_query);
+                   else
+                       format->null (format);
+                   format->end (format);
+               }
            }
 
            talloc_free (ctx_quote);
@@ -173,47 +221,47 @@ do_search_threads (sprinter_t *format,
 }
 
 static int
-do_search_messages (sprinter_t *format,
-                   notmuch_query_t *query,
-                   output_t output,
-                   int offset,
-                   int limit)
+do_search_messages (search_options_t *opt)
 {
     notmuch_message_t *message;
     notmuch_messages_t *messages;
     notmuch_filenames_t *filenames;
+    sprinter_t *format = opt->format;
     int i;
 
-    if (offset < 0) {
-       offset += notmuch_query_count_messages (query);
-       if (offset < 0)
-           offset = 0;
+    if (opt->offset < 0) {
+       opt->offset += notmuch_query_count_messages (opt->query);
+       if (opt->offset < 0)
+           opt->offset = 0;
     }
 
-    messages = notmuch_query_search_messages (query);
+    messages = notmuch_query_search_messages (opt->query);
     if (messages == NULL)
        return 1;
 
     format->begin_list (format);
 
     for (i = 0;
-        notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
+        notmuch_messages_valid (messages) && (opt->limit < 0 || i < opt->offset + opt->limit);
         notmuch_messages_move_to_next (messages), i++)
     {
-       if (i < offset)
+       if (i < opt->offset)
            continue;
 
        message = notmuch_messages_get (messages);
 
-       if (output == OUTPUT_FILES) {
+       if (opt->output == OUTPUT_FILES) {
+           int j;
            filenames = notmuch_message_get_filenames (message);
 
-           for (;
+           for (j = 1;
                 notmuch_filenames_valid (filenames);
-                notmuch_filenames_move_to_next (filenames))
+                notmuch_filenames_move_to_next (filenames), j++)
            {
-               format->string (format, notmuch_filenames_get (filenames));
-               format->separator (format);
+               if (opt->dupe < 0 || opt->dupe == j) {
+                   format->string (format, notmuch_filenames_get (filenames));
+                   format->separator (format);
+               }
            }
            
            notmuch_filenames_destroy( filenames );
@@ -237,12 +285,13 @@ do_search_messages (sprinter_t *format,
 
 static int
 do_search_tags (notmuch_database_t *notmuch,
-               sprinter_t *format,
-               notmuch_query_t *query)
+               const search_options_t *opt)
 {
     notmuch_messages_t *messages = NULL;
     notmuch_tags_t *tags;
     const char *tag;
+    sprinter_t *format = opt->format;
+    notmuch_query_t *query = opt->query;
 
     /* should the following only special case if no excluded terms
      * specified? */
@@ -283,26 +332,20 @@ do_search_tags (notmuch_database_t *notmuch,
     return 0;
 }
 
-enum {
-    EXCLUDE_TRUE,
-    EXCLUDE_FALSE,
-    EXCLUDE_FLAG,
-    EXCLUDE_ALL
-};
-
 int
 notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
 {
     notmuch_database_t *notmuch;
-    notmuch_query_t *query;
+    search_options_t opt = {
+       .sort = NOTMUCH_SORT_NEWEST_FIRST,
+       .output = OUTPUT_SUMMARY,
+       .offset = 0,
+       .limit = -1, /* unlimited */
+       .dupe = -1,
+    };
     char *query_str;
-    notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
-    sprinter_t *format = NULL;
     int opt_index, ret;
-    output_t output = OUTPUT_SUMMARY;
-    int offset = 0;
-    int limit = -1; /* unlimited */
-    int exclude = EXCLUDE_TRUE;
+    notmuch_exclude_t exclude = NOTMUCH_EXCLUDE_TRUE;
     unsigned int i;
 
     enum {
@@ -313,7 +356,7 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
     } format_sel = NOTMUCH_FORMAT_TEXT;
 
     notmuch_opt_desc_t options[] = {
-       { NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
+       { NOTMUCH_OPT_KEYWORD, &opt.sort, "sort", 's',
          (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
                                  { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
                                  { 0, 0 } } },
@@ -324,7 +367,7 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
                                  { "text0", NOTMUCH_FORMAT_TEXT0 },
                                  { 0, 0 } } },
        { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
-       { NOTMUCH_OPT_KEYWORD, &output, "output", 'o',
+       { NOTMUCH_OPT_KEYWORD, &opt.output, "output", 'o',
          (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
                                  { "threads", OUTPUT_THREADS },
                                  { "messages", OUTPUT_MESSAGES },
@@ -332,38 +375,37 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
                                  { "tags", OUTPUT_TAGS },
                                  { 0, 0 } } },
         { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
-          (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
-                                  { "false", EXCLUDE_FALSE },
-                                  { "flag", EXCLUDE_FLAG },
-                                  { "all", EXCLUDE_ALL },
+          (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE },
+                                  { "false", NOTMUCH_EXCLUDE_FALSE },
+                                  { "flag", NOTMUCH_EXCLUDE_FLAG },
+                                  { "all", NOTMUCH_EXCLUDE_ALL },
                                   { 0, 0 } } },
-       { NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 },
-       { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0  },
+       { NOTMUCH_OPT_INT, &opt.offset, "offset", 'O', 0 },
+       { NOTMUCH_OPT_INT, &opt.limit, "limit", 'L', 0  },
+       { NOTMUCH_OPT_INT, &opt.dupe, "duplicate", 'D', 0  },
        { 0, 0, 0, 0, 0 }
     };
 
     opt_index = parse_arguments (argc, argv, options, 1);
-
-    if (opt_index < 0) {
-       return 1;
-    }
+    if (opt_index < 0)
+       return EXIT_FAILURE;
 
     switch (format_sel) {
     case NOTMUCH_FORMAT_TEXT:
-       format = sprinter_text_create (config, stdout);
+       opt.format = sprinter_text_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_TEXT0:
-       if (output == OUTPUT_SUMMARY) {
+       if (opt.output == OUTPUT_SUMMARY) {
            fprintf (stderr, "Error: --format=text0 is not compatible with --output=summary.\n");
-           return 1;
+           return EXIT_FAILURE;
        }
-       format = sprinter_text0_create (config, stdout);
+       opt.format = sprinter_text0_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_JSON:
-       format = sprinter_json_create (config, stdout);
+       opt.format = sprinter_json_create (config, stdout);
        break;
     case NOTMUCH_FORMAT_SEXP:
-       format = sprinter_sexp_create (config, stdout);
+       opt.format = sprinter_sexp_create (config, stdout);
        break;
     default:
        /* this should never happen */
@@ -374,67 +416,64 @@ notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
 
     if (notmuch_database_open (notmuch_config_get_database_path (config),
                               NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
-       return 1;
+       return EXIT_FAILURE;
 
     query_str = query_string_from_args (notmuch, argc-opt_index, argv+opt_index);
     if (query_str == NULL) {
        fprintf (stderr, "Out of memory.\n");
-       return 1;
+       return EXIT_FAILURE;
     }
     if (*query_str == '\0') {
        fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
-       return 1;
+       return EXIT_FAILURE;
     }
 
-    query = notmuch_query_create (notmuch, query_str);
-    if (query == NULL) {
+    opt.query = notmuch_query_create (notmuch, query_str);
+    if (opt.query == NULL) {
        fprintf (stderr, "Out of memory\n");
-       return 1;
+       return EXIT_FAILURE;
     }
 
-    notmuch_query_set_sort (query, sort);
+    notmuch_query_set_sort (opt.query, opt.sort);
 
-    if (exclude == EXCLUDE_FLAG && output != OUTPUT_SUMMARY) {
+    if (exclude == NOTMUCH_EXCLUDE_FLAG && opt.output != OUTPUT_SUMMARY) {
        /* If we are not doing summary output there is nowhere to
         * print the excluded flag so fall back on including the
         * excluded messages. */
        fprintf (stderr, "Warning: this output format cannot flag excluded messages.\n");
-       exclude = EXCLUDE_FALSE;
+       exclude = NOTMUCH_EXCLUDE_FALSE;
     }
 
-    if (exclude != EXCLUDE_FALSE) {
+    if (exclude != NOTMUCH_EXCLUDE_FALSE) {
        const char **search_exclude_tags;
        size_t search_exclude_tags_length;
 
        search_exclude_tags = notmuch_config_get_search_exclude_tags
            (config, &search_exclude_tags_length);
        for (i = 0; i < search_exclude_tags_length; i++)
-           notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
-       if (exclude == EXCLUDE_FLAG)
-           notmuch_query_set_omit_excluded (query, NOTMUCH_EXCLUDE_FLAG);
-       if (exclude == EXCLUDE_ALL)
-           notmuch_query_set_omit_excluded (query, NOTMUCH_EXCLUDE_ALL);
+           notmuch_query_add_tag_exclude (opt.query, search_exclude_tags[i]);
+       notmuch_query_set_omit_excluded (opt.query, exclude);
     }
 
-    switch (output) {
+    switch (opt.output) {
     default:
     case OUTPUT_SUMMARY:
     case OUTPUT_THREADS:
-       ret = do_search_threads (format, query, sort, output, offset, limit);
+       ret = do_search_threads (&opt);
        break;
     case OUTPUT_MESSAGES:
     case OUTPUT_FILES:
-       ret = do_search_messages (format, query, output, offset, limit);
+       ret = do_search_messages (&opt);
        break;
     case OUTPUT_TAGS:
-       ret = do_search_tags (notmuch, format, query);
+       ret = do_search_tags (notmuch, &opt);
        break;
     }
 
-    notmuch_query_destroy (query);
+    notmuch_query_destroy (opt.query);
     notmuch_database_destroy (notmuch);
 
-    talloc_free (format);
+    talloc_free (opt.format);
 
-    return ret;
+    return ret ? EXIT_FAILURE : EXIT_SUCCESS;
 }