Sanitize "Subject:" and "Author:" fields to not contain control characters in notmuch...

[notmuch] / notmuch-search.c

diff --git a/notmuch-search.c b/notmuch-search.c
index 93724dd2994422cfd0365eff0ebe7d9fe70bbe4d..530cecc343b9f928517176a830d1662874609574 100644 (file)
--- a/notmuch-search.c
+++ b/notmuch-search.c
@@ -24,6 +24,7 @@ typedef enum {
     OUTPUT_SUMMARY,
     OUTPUT_THREADS,
     OUTPUT_MESSAGES,
+    OUTPUT_FILES,
     OUTPUT_TAGS
 } output_t;
 
@@ -47,6 +48,7 @@ typedef struct search_format {
     const char *item_sep;
     const char *item_end;
     const char *results_end;
+    const char *results_null;
 } search_format_t;
 
 static void
@@ -72,6 +74,7 @@ static const search_format_t format_text = {
            ")", "\n",
        "",
     "\n",
+    "",
 };
 
 static void
@@ -97,6 +100,7 @@ static const search_format_t format_json = {
            "]", ",\n",
        "}",
     "]\n",
+    "]\n",
 };
 
 static void
@@ -107,6 +111,20 @@ format_item_id_text (unused (const void *ctx),
     printf ("%s%s", item_type, item_id);
 }
 
+static char *
+sanitize_string (const void *ctx, const char *str)
+{
+    char *out, *loop;
+
+    loop = out = talloc_strdup (ctx, str);
+
+    for (; *loop; loop++) {
+       if ((unsigned char)(*loop) < 32)
+           *loop = '?';
+    }
+    return out;
+}
+
 static void
 format_thread_text (const void *ctx,
                    const char *thread_id,
@@ -116,13 +134,17 @@ format_thread_text (const void *ctx,
                    const char *authors,
                    const char *subject)
 {
+    void *ctx_quote = talloc_new (ctx);
+
     printf ("thread:%s %12s [%d/%d] %s; %s",
            thread_id,
            notmuch_time_relative_date (ctx, date),
            matched,
            total,
-           authors,
-           subject);
+           sanitize_string (ctx_quote, authors),
+           sanitize_string (ctx_quote, subject));
+
+    talloc_free (ctx_quote);
 }
 
 static void
@@ -166,8 +188,7 @@ format_thread_json (const void *ctx,
 }
 
 static int
-do_search_threads (const void *ctx,
-                  const search_format_t *format,
+do_search_threads (const search_format_t *format,
                   notmuch_query_t *query,
                   notmuch_sort_t sort,
                   output_t output)
@@ -182,6 +203,8 @@ do_search_threads (const void *ctx,
     if (threads == NULL)
        return 1;
 
+    fputs (format->results_start, stdout);
+
     for (;
         notmuch_threads_valid (threads);
         notmuch_threads_move_to_next (threads))
@@ -194,7 +217,7 @@ do_search_threads (const void *ctx,
        thread = notmuch_threads_get (threads);
 
        if (output == OUTPUT_THREADS) {
-           format->item_id (ctx, "thread:",
+           format->item_id (thread, "thread:",
                             notmuch_thread_get_thread_id (thread));
        } else { /* output == OUTPUT_SUMMARY */
            fputs (format->item_start, stdout);
@@ -204,7 +227,7 @@ do_search_threads (const void *ctx,
            else
                date = notmuch_thread_get_newest_date (thread);
 
-           format->thread_summary (ctx,
+           format->thread_summary (thread,
                                    notmuch_thread_get_thread_id (thread),
                                    date,
                                    notmuch_thread_get_matched_messages (thread),
@@ -234,13 +257,18 @@ do_search_threads (const void *ctx,
        notmuch_thread_destroy (thread);
     }
 
+    if (first_thread)
+       fputs (format->results_null, stdout);
+    else
+       fputs (format->results_end, stdout);
+
     return 0;
 }
 
 static int
-do_search_messages (const void *ctx,
-                   const search_format_t *format,
-                   notmuch_query_t *query)
+do_search_messages (const search_format_t *format,
+                   notmuch_query_t *query,
+                   output_t output)
 {
     notmuch_message_t *message;
     notmuch_messages_t *messages;
@@ -250,6 +278,8 @@ do_search_messages (const void *ctx,
     if (messages == NULL)
        return 1;
 
+    fputs (format->results_start, stdout);
+
     for (;
         notmuch_messages_valid (messages);
         notmuch_messages_move_to_next (messages))
@@ -259,7 +289,13 @@ do_search_messages (const void *ctx,
        if (! first_message)
            fputs (format->item_sep, stdout);
 
-       format->item_id (ctx, "id:", notmuch_message_get_message_id (message));
+       if (output == OUTPUT_FILES) {
+           format->item_id (message, "",
+                            notmuch_message_get_filename (message));
+       } else { /* output == OUTPUT_MESSAGES */
+           format->item_id (message, "id:",
+                            notmuch_message_get_message_id (message));
+       }
 
        first_message = 0;
 
@@ -268,12 +304,16 @@ do_search_messages (const void *ctx,
 
     notmuch_messages_destroy (messages);
 
+    if (first_message)
+       fputs (format->results_null, stdout);
+    else
+       fputs (format->results_end, stdout);
+
     return 0;
 }
 
 static int
-do_search_tags (const void *ctx,
-               notmuch_database_t *notmuch,
+do_search_tags (notmuch_database_t *notmuch,
                const search_format_t *format,
                notmuch_query_t *query)
 {
@@ -295,6 +335,8 @@ do_search_tags (const void *ctx,
     if (tags == NULL)
        return 1;
 
+    fputs (format->results_start, stdout);
+
     for (;
         notmuch_tags_valid (tags);
         notmuch_tags_move_to_next (tags))
@@ -304,7 +346,7 @@ do_search_tags (const void *ctx,
        if (! first_tag)
            fputs (format->item_sep, stdout);
 
-       format->item_id (ctx, "", tag);
+       format->item_id (tags, "", tag);
 
        first_tag = 0;
     }
@@ -314,6 +356,11 @@ do_search_tags (const void *ctx,
     if (messages)
        notmuch_messages_destroy (messages);
 
+    if (first_tag)
+       fputs (format->results_null, stdout);
+    else
+       fputs (format->results_end, stdout);
+
     return 0;
 }
 
@@ -363,6 +410,8 @@ notmuch_search_command (void *ctx, int argc, char *argv[])
                output = OUTPUT_THREADS;
            } else if (strcmp (opt, "messages") == 0) {
                output = OUTPUT_MESSAGES;
+           } else if (strcmp (opt, "files") == 0) {
+               output = OUTPUT_FILES;
            } else if (strcmp (opt, "tags") == 0) {
                output = OUTPUT_TAGS;
            } else {
@@ -387,7 +436,7 @@ notmuch_search_command (void *ctx, int argc, char *argv[])
     if (notmuch == NULL)
        return 1;
 
-    query_str = query_string_from_args (ctx, argc, argv);
+    query_str = query_string_from_args (notmuch, argc, argv);
     if (query_str == NULL) {
        fprintf (stderr, "Out of memory.\n");
        return 1;
@@ -405,24 +454,21 @@ notmuch_search_command (void *ctx, int argc, char *argv[])
 
     notmuch_query_set_sort (query, sort);
 
-    fputs (format->results_start, stdout);
-
     switch (output) {
     default:
     case OUTPUT_SUMMARY:
     case OUTPUT_THREADS:
-       ret = do_search_threads (ctx, format, query, sort, output);
+       ret = do_search_threads (format, query, sort, output);
        break;
     case OUTPUT_MESSAGES:
-       ret = do_search_messages (ctx, format, query);
+    case OUTPUT_FILES:
+       ret = do_search_messages (format, query, output);
        break;
     case OUTPUT_TAGS:
-       ret = do_search_tags (ctx, notmuch, format, query);
+       ret = do_search_tags (notmuch, format, query);
        break;
     }
 
-    fputs (format->results_end, stdout);
-
     notmuch_query_destroy (query);
     notmuch_database_close (notmuch);