]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-search.c
test: Test upgrade to ghost messages feature
[notmuch] / notmuch-search.c
index 482c6e8ea8c061d7865728c857a30f1dfe31497a..bc9be4593ecc0a06b34e82bab62b9a034ffb9f40 100644 (file)
  */
 
 #include "notmuch-client.h"
-
-typedef struct search_format {
-    const char *results_start;
-    const char *thread_start;
-    void (*thread) (const void *ctx,
-                   const char *id,
-                   const time_t date,
-                   const int matched,
-                   const int total,
-                   const char *authors,
-                   const char *subject);
-    const char *tag_start;
-    const char *tag;
-    const char *tag_sep;
-    const char *tag_end;
-    const char *thread_sep;
-    const char *thread_end;
-    const char *results_end;
-} search_format_t;
-
-static void
-format_thread_text (const void *ctx,
-                   const char *id,
-                   const time_t date,
-                   const int matched,
-                   const int total,
-                   const char *authors,
-                   const char *subject);
-static const search_format_t format_text = {
-    "",
-       "",
-           format_thread_text,
-           " (",
-               "%s", " ",
-           ")", "",
-       "\n",
-    "",
-};
-
-static void
-format_thread_json (const void *ctx,
-                   const char *id,
-                   const time_t date,
-                   const int matched,
-                   const int total,
-                   const char *authors,
-                   const char *subject);
-static const search_format_t format_json = {
-    "[",
-       "{",
-           format_thread_json,
-           "\"tags\": [",
-               "\"%s\"", ", ",
-           "]", ",\n",
-       "}",
-    "]\n",
-};
-
-static void
-format_thread_text (const void *ctx,
-                   const char *id,
-                   const time_t date,
-                   const int matched,
-                   const int total,
-                   const char *authors,
-                   const char *subject)
+#include "sprinter.h"
+#include "string-util.h"
+
+typedef enum {
+    OUTPUT_SUMMARY,
+    OUTPUT_THREADS,
+    OUTPUT_MESSAGES,
+    OUTPUT_FILES,
+    OUTPUT_TAGS
+} output_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)
 {
-    printf ("thread:%s %12s [%d/%d] %s; %s",
-           id,
-           notmuch_time_relative_date (ctx, date),
-           matched,
-           total,
-           authors,
-           subject);
-}
+    notmuch_messages_t *messages;
+    char *escaped = NULL;
+    size_t escaped_len = 0;
 
-static void
-format_thread_json (const void *ctx,
-                   const char *id,
-                   const time_t date,
-                   const int matched,
-                   const int total,
-                   const char *authors,
-                   const char *subject)
-{
-    struct tm *tm;
-    char timestamp[40];
-    void *ctx_quote = talloc_new (ctx);
-
-    tm = gmtime (&date);
-    if (tm == NULL)
-       INTERNAL_ERROR ("gmtime failed on thread %s.", id);
-
-    if (strftime (timestamp, sizeof (timestamp), "%s", tm) == 0)
-       INTERNAL_ERROR ("strftime failed on thread %s.", id);
-
-    printf ("\"id\": %s,\n"
-           "\"timestamp\": %s,\n"
-           "\"matched\": %d,\n"
-           "\"total\": %d,\n"
-           "\"authors\": %s,\n"
-           "\"subject\": %s,\n",
-           json_quote_str (ctx_quote, id),
-           timestamp,
-           matched,
-           total,
-           json_quote_str (ctx_quote, authors),
-           json_quote_str (ctx_quote, subject));
-
-    talloc_free (ctx_quote);
+    *matched_out = *unmatched_out = NULL;
+
+    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;
+    }
+    talloc_free (escaped);
+    return 0;
 }
 
-static void
-do_search_threads (const void *ctx,
-                  const search_format_t *format,
+static int
+do_search_threads (sprinter_t *format,
                   notmuch_query_t *query,
-                  notmuch_sort_t sort)
+                  notmuch_sort_t sort,
+                  output_t output,
+                  int offset,
+                  int limit)
 {
     notmuch_thread_t *thread;
     notmuch_threads_t *threads;
     notmuch_tags_t *tags;
     time_t date;
-    int first_thread = 1;
+    int i;
 
-    fputs (format->results_start, stdout);
+    if (offset < 0) {
+       offset += notmuch_query_count_threads (query);
+       if (offset < 0)
+           offset = 0;
+    }
 
-    for (threads = notmuch_query_search_threads (query);
-        notmuch_threads_has_more (threads);
-        notmuch_threads_advance (threads))
-    {
-       int first_tag = 1;
+    threads = notmuch_query_search_threads (query);
+    if (threads == NULL)
+       return 1;
 
-       if (! first_thread)
-           fputs (format->thread_sep, stdout);
+    format->begin_list (format);
 
+    for (i = 0;
+        notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
+        notmuch_threads_move_to_next (threads), i++)
+    {
        thread = notmuch_threads_get (threads);
 
-       if (sort == NOTMUCH_SORT_OLDEST_FIRST)
-           date = notmuch_thread_get_oldest_date (thread);
-       else
-           date = notmuch_thread_get_newest_date (thread);
-
-       fputs (format->thread_start, stdout);
-
-       format->thread (ctx,
-                       notmuch_thread_get_thread_id (thread),
-                       date,
-                       notmuch_thread_get_matched_messages (thread),
-                       notmuch_thread_get_total_messages (thread),
-                       notmuch_thread_get_authors (thread),
-                       notmuch_thread_get_subject (thread));
-
-       fputs (format->tag_start, stdout);
-
-       for (tags = notmuch_thread_get_tags (thread);
-            notmuch_tags_has_more (tags);
-            notmuch_tags_advance (tags))
-       {
-           if (! first_tag)
-               fputs (format->tag_sep, stdout);
-           printf (format->tag, notmuch_tags_get (tags));
-           first_tag = 0;
+       if (i < offset) {
+           notmuch_thread_destroy (thread);
+           continue;
        }
 
-       fputs (format->tag_end, stdout);
-       fputs (format->thread_end, stdout);
+       if (output == OUTPUT_THREADS) {
+           format->set_prefix (format, "thread");
+           format->string (format,
+                           notmuch_thread_get_thread_id (thread));
+           format->separator (format);
+       } else { /* output == OUTPUT_SUMMARY */
+           void *ctx_quote = talloc_new (thread);
+           const char *authors = notmuch_thread_get_authors (thread);
+           const char *subject = notmuch_thread_get_subject (thread);
+           const char *thread_id = notmuch_thread_get_thread_id (thread);
+           int matched = notmuch_thread_get_matched_messages (thread);
+           int total = notmuch_thread_get_total_messages (thread);
+           const char *relative_date = NULL;
+           notmuch_bool_t first_tag = TRUE;
+
+           format->begin_map (format);
+
+           if (sort == NOTMUCH_SORT_OLDEST_FIRST)
+               date = notmuch_thread_get_oldest_date (thread);
+           else
+               date = notmuch_thread_get_newest_date (thread);
+
+           relative_date = notmuch_time_relative_date (ctx_quote, date);
+
+           if (format->is_text_printer) {
+                /* Special case for the text formatter */
+               printf ("thread:%s %12s [%d/%d] %s; %s (",
+                       thread_id,
+                       relative_date,
+                       matched,
+                       total,
+                       sanitize_string (ctx_quote, authors),
+                       sanitize_string (ctx_quote, subject));
+           } else { /* Structured Output */
+               format->map_key (format, "thread");
+               format->string (format, thread_id);
+               format->map_key (format, "timestamp");
+               format->integer (format, date);
+               format->map_key (format, "date_relative");
+               format->string (format, relative_date);
+               format->map_key (format, "matched");
+               format->integer (format, matched);
+               format->map_key (format, "total");
+               format->integer (format, total);
+               format->map_key (format, "authors");
+               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);
+
+           format->map_key (format, "tags");
+           format->begin_list (format);
+
+           for (tags = notmuch_thread_get_tags (thread);
+                notmuch_tags_valid (tags);
+                notmuch_tags_move_to_next (tags))
+           {
+               const char *tag = notmuch_tags_get (tags);
+
+               if (format->is_text_printer) {
+                  /* Special case for the text formatter */
+                   if (first_tag)
+                       first_tag = FALSE;
+                   else
+                       fputc (' ', stdout);
+                   fputs (tag, stdout);
+               } else { /* Structured Output */
+                   format->string (format, tag);
+               }
+           }
 
-       first_thread = 0;
+           if (format->is_text_printer)
+               printf (")");
+
+           format->end (format);
+           format->end (format);
+           format->separator (format);
+       }
 
        notmuch_thread_destroy (thread);
     }
 
-    fputs (format->results_end, stdout);
+    format->end (format);
+
+    return 0;
 }
 
-int
-notmuch_search_command (void *ctx, int argc, char *argv[])
+static int
+do_search_messages (sprinter_t *format,
+                   notmuch_query_t *query,
+                   output_t output,
+                   int offset,
+                   int limit,
+                   int dupe)
 {
-    notmuch_config_t *config;
-    notmuch_database_t *notmuch;
-    notmuch_query_t *query;
-    char *query_str;
-    char *opt;
-    notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
-    const search_format_t *format = &format_text;
+    notmuch_message_t *message;
+    notmuch_messages_t *messages;
+    notmuch_filenames_t *filenames;
     int i;
 
-    for (i = 0; i < argc && argv[i][0] == '-'; i++) {
-       if (strcmp (argv[i], "--") == 0) {
-           i++;
-           break;
-       }
-        if (STRNCMP_LITERAL (argv[i], "--sort=") == 0) {
-           opt = argv[i] + sizeof ("--sort=") - 1;
-           if (strcmp (opt, "oldest-first") == 0) {
-               sort = NOTMUCH_SORT_OLDEST_FIRST;
-           } else if (strcmp (opt, "newest-first") == 0) {
-               sort = NOTMUCH_SORT_NEWEST_FIRST;
-           } else {
-               fprintf (stderr, "Invalid value for --sort: %s\n", opt);
-               return 1;
-           }
-       } else if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
-           opt = argv[i] + sizeof ("--format=") - 1;
-           if (strcmp (opt, "text") == 0) {
-               format = &format_text;
-           } else if (strcmp (opt, "json") == 0) {
-               format = &format_json;
-           } else {
-               fprintf (stderr, "Invalid value for --format: %s\n", opt);
-               return 1;
+    if (offset < 0) {
+       offset += notmuch_query_count_messages (query);
+       if (offset < 0)
+           offset = 0;
+    }
+
+    messages = notmuch_query_search_messages (query);
+    if (messages == NULL)
+       return 1;
+
+    format->begin_list (format);
+
+    for (i = 0;
+        notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
+        notmuch_messages_move_to_next (messages), i++)
+    {
+       if (i < offset)
+           continue;
+
+       message = notmuch_messages_get (messages);
+
+       if (output == OUTPUT_FILES) {
+           int j;
+           filenames = notmuch_message_get_filenames (message);
+
+           for (j = 1;
+                notmuch_filenames_valid (filenames);
+                notmuch_filenames_move_to_next (filenames), j++)
+           {
+               if (dupe < 0 || dupe == j) {
+                   format->string (format, notmuch_filenames_get (filenames));
+                   format->separator (format);
+               }
            }
-       } else {
-           fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
-           return 1;
+           
+           notmuch_filenames_destroy( filenames );
+
+       } else { /* output == OUTPUT_MESSAGES */
+           format->set_prefix (format, "id");
+           format->string (format,
+                           notmuch_message_get_message_id (message));
+           format->separator (format);
        }
+
+       notmuch_message_destroy (message);
     }
 
-    argc -= i;
-    argv += i;
+    notmuch_messages_destroy (messages);
 
-    config = notmuch_config_open (ctx, NULL, NULL);
-    if (config == NULL)
-       return 1;
+    format->end (format);
 
-    notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
-                                    NOTMUCH_DATABASE_MODE_READ_ONLY);
-    if (notmuch == NULL)
+    return 0;
+}
+
+static int
+do_search_tags (notmuch_database_t *notmuch,
+               sprinter_t *format,
+               notmuch_query_t *query)
+{
+    notmuch_messages_t *messages = NULL;
+    notmuch_tags_t *tags;
+    const char *tag;
+
+    /* should the following only special case if no excluded terms
+     * specified? */
+
+    /* Special-case query of "*" for better performance. */
+    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)
+           return 1;
+
+       tags = notmuch_messages_collect_tags (messages);
+    }
+    if (tags == NULL)
        return 1;
 
-    query_str = query_string_from_args (ctx, argc, argv);
+    format->begin_list (format);
+
+    for (;
+        notmuch_tags_valid (tags);
+        notmuch_tags_move_to_next (tags))
+    {
+       tag = notmuch_tags_get (tags);
+
+       format->string (format, tag);
+       format->separator (format);
+
+    }
+
+    notmuch_tags_destroy (tags);
+
+    if (messages)
+       notmuch_messages_destroy (messages);
+
+    format->end (format);
+
+    return 0;
+}
+
+int
+notmuch_search_command (notmuch_config_t *config, int argc, char *argv[])
+{
+    notmuch_database_t *notmuch;
+    notmuch_query_t *query;
+    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 */
+    notmuch_exclude_t exclude = NOTMUCH_EXCLUDE_TRUE;
+    int dupe = -1;
+    unsigned int i;
+
+    enum {
+       NOTMUCH_FORMAT_JSON,
+       NOTMUCH_FORMAT_TEXT,
+       NOTMUCH_FORMAT_TEXT0,
+       NOTMUCH_FORMAT_SEXP
+    } format_sel = NOTMUCH_FORMAT_TEXT;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
+         (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
+                                 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_KEYWORD, &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, &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, &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, &offset, "offset", 'O', 0 },
+       { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0  },
+       { NOTMUCH_OPT_INT, &dupe, "duplicate", 'D', 0  },
+       { 0, 0, 0, 0, 0 }
+    };
+
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0)
+       return EXIT_FAILURE;
+
+    switch (format_sel) {
+    case NOTMUCH_FORMAT_TEXT:
+       format = sprinter_text_create (config, stdout);
+       break;
+    case NOTMUCH_FORMAT_TEXT0:
+       if (output == OUTPUT_SUMMARY) {
+           fprintf (stderr, "Error: --format=text0 is not compatible with --output=summary.\n");
+           return EXIT_FAILURE;
+       }
+       format = sprinter_text0_create (config, stdout);
+       break;
+    case NOTMUCH_FORMAT_JSON:
+       format = sprinter_json_create (config, stdout);
+       break;
+    case NOTMUCH_FORMAT_SEXP:
+       format = sprinter_sexp_create (config, stdout);
+       break;
+    default:
+       /* this should never happen */
+       INTERNAL_ERROR("no output format selected");
+    }
+
+    notmuch_exit_if_unsupported_format ();
+
+    if (notmuch_database_open (notmuch_config_get_database_path (config),
+                              NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
+       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) {
        fprintf (stderr, "Out of memory\n");
-       return 1;
+       return EXIT_FAILURE;
     }
 
     notmuch_query_set_sort (query, sort);
 
-    do_search_threads (ctx, format, query, sort);
+    if (exclude == NOTMUCH_EXCLUDE_FLAG && 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 = NOTMUCH_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]);
+       notmuch_query_set_omit_excluded (query, exclude);
+    }
+
+    switch (output) {
+    default:
+    case OUTPUT_SUMMARY:
+    case OUTPUT_THREADS:
+       ret = do_search_threads (format, query, sort, output, offset, limit);
+       break;
+    case OUTPUT_MESSAGES:
+    case OUTPUT_FILES:
+       ret = do_search_messages (format, query, output, offset, limit, dupe);
+       break;
+    case OUTPUT_TAGS:
+       ret = do_search_tags (notmuch, format, query);
+       break;
+    }
 
     notmuch_query_destroy (query);
-    notmuch_database_close (notmuch);
+    notmuch_database_destroy (notmuch);
 
-    return 0;
+    talloc_free (format);
+
+    return ret ? EXIT_FAILURE : EXIT_SUCCESS;
 }