]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-show.c
Merge branch 'release'
[notmuch] / notmuch-show.c
index 13a6f549ab00bccfa21a47080a2248647c167aed..05d51b2716d9abc96815d317253a73abd6e410e1 100644 (file)
@@ -35,50 +35,14 @@ static const notmuch_show_format_t format_text = {
 };
 
 static void
-format_message_json (const void *ctx,
-                    notmuch_message_t *message,
-                    unused (int indent));
-static void
-format_headers_json (const void *ctx,
-                    notmuch_message_t *message);
-
-static void
-format_headers_message_part_json (GMimeMessage *message);
-
-static void
-format_part_start_json (unused (GMimeObject *part),
-                       int *part_count);
-
-static void
-format_part_encstatus_json (int status);
-
-static void
-#ifdef GMIME_ATLEAST_26
-format_part_sigstatus_json (GMimeSignatureList* siglist);
-#else
-format_part_sigstatus_json (const GMimeSignatureValidity* validity);
-#endif
-
-static void
-format_part_content_json (GMimeObject *part);
-
-static void
-format_part_end_json (GMimeObject *part);
+format_part_json_entry (const void *ctx, mime_node_t *node,
+                       int indent, const notmuch_show_params_t *params);
 
 static const notmuch_show_format_t format_json = {
-    "[", NULL,
-       "{", format_message_json,
-           "\"headers\": {", format_headers_json, format_headers_message_part_json, "}",
-           ", \"body\": [",
-               format_part_start_json,
-               format_part_encstatus_json,
-               format_part_sigstatus_json,
-               format_part_content_json,
-               format_part_end_json,
-               ", ",
-           "]",
-       "}", ", ",
-    "]"
+    .message_set_start = "[",
+    .part = format_part_json_entry,
+    .message_set_sep = ", ",
+    .message_set_end = "]"
 };
 
 static void
@@ -168,7 +132,7 @@ _get_one_line_summary (const void *ctx, notmuch_message_t *message)
 }
 
 static void
-format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
+format_message_json (const void *ctx, notmuch_message_t *message)
 {
     notmuch_tags_t *tags;
     int first = 1;
@@ -179,9 +143,10 @@ format_message_json (const void *ctx, notmuch_message_t *message, unused (int in
     date = notmuch_message_get_date (message);
     relative_date = notmuch_time_relative_date (ctx, date);
 
-    printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
+    printf ("\"id\": %s, \"match\": %s, \"excluded\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
            json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
            notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
+           notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? "true" : "false",
            json_quote_str (ctx_quote, notmuch_message_get_filename (message)),
            date, relative_date);
 
@@ -327,66 +292,35 @@ format_headers_message_part_text (GMimeMessage *message)
 }
 
 static void
-format_headers_json (const void *ctx, notmuch_message_t *message)
-{
-    const char *headers[] = {
-       "Subject", "From", "To", "Cc", "Bcc", "Date"
-    };
-    const char *name, *value;
-    unsigned int i;
-    int first_header = 1;
-    void *ctx_quote = talloc_new (ctx);
-
-    for (i = 0; i < ARRAY_SIZE (headers); i++) {
-       name = headers[i];
-       value = notmuch_message_get_header (message, name);
-       if (value)
-       {
-           if (!first_header)
-               fputs (", ", stdout);
-           first_header = 0;
-
-           printf ("%s: %s",
-                   json_quote_str (ctx_quote, name),
-                   json_quote_str (ctx_quote, value));
-       }
-    }
-
-    talloc_free (ctx_quote);
-}
-
-static void
-format_headers_message_part_json (GMimeMessage *message)
+format_headers_json (const void *ctx, GMimeMessage *message)
 {
-    void *ctx = talloc_new (NULL);
-    void *ctx_quote = talloc_new (ctx);
+    void *local = talloc_new (ctx);
     InternetAddressList *recipients;
     const char *recipients_string;
 
-    printf ("%s: %s",
-           json_quote_str (ctx_quote, "From"),
-           json_quote_str (ctx_quote, g_mime_message_get_sender (message)));
+    printf ("{%s: %s",
+           json_quote_str (local, "Subject"),
+           json_quote_str (local, g_mime_message_get_subject (message)));
+    printf (", %s: %s",
+           json_quote_str (local, "From"),
+           json_quote_str (local, g_mime_message_get_sender (message)));
     recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
     recipients_string = internet_address_list_to_string (recipients, 0);
     if (recipients_string)
        printf (", %s: %s",
-               json_quote_str (ctx_quote, "To"),
-               json_quote_str (ctx_quote, recipients_string));
+               json_quote_str (local, "To"),
+               json_quote_str (local, recipients_string));
     recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
     recipients_string = internet_address_list_to_string (recipients, 0);
     if (recipients_string)
        printf (", %s: %s",
-               json_quote_str (ctx_quote, "Cc"),
-               json_quote_str (ctx_quote, recipients_string));
-    printf (", %s: %s",
-           json_quote_str (ctx_quote, "Subject"),
-           json_quote_str (ctx_quote, g_mime_message_get_subject (message)));
-    printf (", %s: %s",
-           json_quote_str (ctx_quote, "Date"),
-           json_quote_str (ctx_quote, g_mime_message_get_date_as_string (message)));
+               json_quote_str (local, "Cc"),
+               json_quote_str (local, recipients_string));
+    printf (", %s: %s}",
+           json_quote_str (local, "Date"),
+           json_quote_str (local, g_mime_message_get_date_as_string (message)));
 
-    talloc_free (ctx_quote);
-    talloc_free (ctx);
+    talloc_free (local);
 }
 
 /* Write a MIME text part out to the given stream.
@@ -469,29 +403,13 @@ signer_status_to_string (GMimeSignerStatus x)
 }
 #endif
 
-static void
-format_part_start_json (unused (GMimeObject *part), int *part_count)
-{
-    printf ("{\"id\": %d", *part_count);
-}
-
-static void
-format_part_encstatus_json (int status)
-{
-    printf (", \"encstatus\": [{\"status\": ");
-    if (status) {
-       printf ("\"good\"");
-    } else {
-       printf ("\"bad\"");
-    }
-    printf ("}]");
-}
-
 #ifdef GMIME_ATLEAST_26
 static void
-format_part_sigstatus_json (GMimeSignatureList *siglist)
+format_part_sigstatus_json (mime_node_t *node)
 {
-    printf (", \"sigstatus\": [");
+    GMimeSignatureList *siglist = node->sig_list;
+
+    printf ("[");
 
     if (!siglist) {
        printf ("]");
@@ -555,9 +473,11 @@ format_part_sigstatus_json (GMimeSignatureList *siglist)
 }
 #else
 static void
-format_part_sigstatus_json (const GMimeSignatureValidity* validity)
+format_part_sigstatus_json (mime_node_t *node)
 {
-    printf (", \"sigstatus\": [");
+    const GMimeSignatureValidity* validity = node->sig_validity;
+
+    printf ("[");
 
     if (!validity) {
        printf ("]");
@@ -616,81 +536,6 @@ format_part_sigstatus_json (const GMimeSignatureValidity* validity)
 }
 #endif
 
-static void
-format_part_content_json (GMimeObject *part)
-{
-    GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
-    GMimeStream *stream_memory = g_mime_stream_mem_new ();
-    const char *cid = g_mime_object_get_content_id (part);
-    void *ctx = talloc_new (NULL);
-    GByteArray *part_content;
-
-    printf (", \"content-type\": %s",
-           json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
-
-    if (cid != NULL)
-           printf(", \"content-id\": %s", json_quote_str (ctx, cid));
-
-    if (GMIME_IS_PART (part))
-    {
-       const char *filename = g_mime_part_get_filename (GMIME_PART (part));
-       if (filename)
-           printf (", \"filename\": %s", json_quote_str (ctx, filename));
-    }
-
-    if (g_mime_content_type_is_type (content_type, "text", "*"))
-    {
-       /* For non-HTML text parts, we include the content in the
-        * JSON. Since JSON must be Unicode, we handle charset
-        * decoding here and do not report a charset to the caller.
-        * For text/html parts, we do not include the content. If a
-        * caller is interested in text/html parts, it should retrieve
-        * them separately and they will not be decoded. Since this
-        * makes charset decoding the responsibility on the caller, we
-        * report the charset for text/html parts.
-        */
-       if (g_mime_content_type_is_type (content_type, "text", "html"))
-       {
-           const char *content_charset = g_mime_object_get_content_type_parameter (GMIME_OBJECT (part), "charset");
-
-           if (content_charset != NULL)
-               printf (", \"content-charset\": %s", json_quote_str (ctx, content_charset));
-       }
-       else
-       {
-           show_text_part_content (part, stream_memory);
-           part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
-
-           printf (", \"content\": %s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));
-       }
-    }
-    else if (g_mime_content_type_is_type (content_type, "multipart", "*"))
-    {
-       printf (", \"content\": [");
-    }
-    else if (g_mime_content_type_is_type (content_type, "message", "rfc822"))
-    {
-       printf (", \"content\": [{");
-    }
-
-    talloc_free (ctx);
-    if (stream_memory)
-       g_object_unref (stream_memory);
-}
-
-static void
-format_part_end_json (GMimeObject *part)
-{
-    GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
-
-    if (g_mime_content_type_is_type (content_type, "multipart", "*"))
-       printf ("]");
-    else if (g_mime_content_type_is_type (content_type, "message", "rfc822"))
-       printf ("}]");
-
-    printf ("}");
-}
-
 static void
 format_part_content_raw (GMimeObject *part)
 {
@@ -735,11 +580,12 @@ format_part_text (const void *ctx, mime_node_t *node,
        notmuch_message_t *message = node->envelope_file;
 
        part_type = "message";
-       printf ("\f%s{ id:%s depth:%d match:%d filename:%s\n",
+       printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
                part_type,
                notmuch_message_get_message_id (message),
                indent,
-               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
+               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
+               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
                notmuch_message_get_filename (message));
     } else {
        GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
@@ -808,6 +654,112 @@ format_part_text (const void *ctx, mime_node_t *node,
     printf ("\f%s}\n", part_type);
 }
 
+static void
+format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first)
+{
+    /* Any changes to the JSON format should be reflected in the file
+     * devel/schemata. */
+
+    if (node->envelope_file) {
+       printf ("{");
+       format_message_json (ctx, node->envelope_file);
+
+       printf ("\"headers\": ");
+       format_headers_json (ctx, GMIME_MESSAGE (node->part));
+
+       printf (", \"body\": [");
+       format_part_json (ctx, mime_node_child (node, 0), first);
+
+       printf ("]}");
+       return;
+    }
+
+    void *local = talloc_new (ctx);
+    /* The disposition and content-type metadata are associated with
+     * the envelope for message parts */
+    GMimeObject *meta = node->envelope_part ?
+       GMIME_OBJECT (node->envelope_part) : node->part;
+    GMimeContentType *content_type = g_mime_object_get_content_type (meta);
+    const char *cid = g_mime_object_get_content_id (meta);
+    const char *filename = GMIME_IS_PART (node->part) ?
+       g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
+    const char *terminator = "";
+    int i;
+
+    if (!first)
+       printf (", ");
+
+    printf ("{\"id\": %d", node->part_num);
+
+    if (node->decrypt_attempted)
+       printf (", \"encstatus\": [{\"status\": \"%s\"}]",
+               node->decrypt_success ? "good" : "bad");
+
+    if (node->verify_attempted) {
+       printf (", \"sigstatus\": ");
+       format_part_sigstatus_json (node);
+    }
+
+    printf (", \"content-type\": %s",
+           json_quote_str (local, g_mime_content_type_to_string (content_type)));
+
+    if (cid)
+       printf (", \"content-id\": %s", json_quote_str (local, cid));
+
+    if (filename)
+       printf (", \"filename\": %s", json_quote_str (local, filename));
+
+    if (GMIME_IS_PART (node->part)) {
+       /* For non-HTML text parts, we include the content in the
+        * JSON. Since JSON must be Unicode, we handle charset
+        * decoding here and do not report a charset to the caller.
+        * For text/html parts, we do not include the content. If a
+        * caller is interested in text/html parts, it should retrieve
+        * them separately and they will not be decoded. Since this
+        * makes charset decoding the responsibility on the caller, we
+        * report the charset for text/html parts.
+        */
+       if (g_mime_content_type_is_type (content_type, "text", "html")) {
+           const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
+
+           if (content_charset != NULL)
+               printf (", \"content-charset\": %s", json_quote_str (local, content_charset));
+       } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
+           GMimeStream *stream_memory = g_mime_stream_mem_new ();
+           GByteArray *part_content;
+           show_text_part_content (node->part, stream_memory);
+           part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
+
+           printf (", \"content\": %s", json_quote_chararray (local, (char *) part_content->data, part_content->len));
+           g_object_unref (stream_memory);
+       }
+    } else if (GMIME_IS_MULTIPART (node->part)) {
+       printf (", \"content\": [");
+       terminator = "]";
+    } else if (GMIME_IS_MESSAGE (node->part)) {
+       printf (", \"content\": [{");
+       printf ("\"headers\": ");
+       format_headers_json (local, GMIME_MESSAGE (node->part));
+
+       printf (", \"body\": [");
+       terminator = "]}]";
+    }
+
+    talloc_free (local);
+
+    for (i = 0; i < node->nchildren; i++)
+       format_part_json (ctx, mime_node_child (node, i), i == 0);
+
+    printf ("%s}", terminator);
+}
+
+static void
+format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent),
+                       unused (const notmuch_show_params_t *params))
+{
+    format_part_json (ctx, node, TRUE);
+}
+
 static void
 show_message (void *ctx,
              const notmuch_show_format_t *format,
@@ -1014,6 +966,14 @@ do_show (void *ctx,
     return 0;
 }
 
+enum {
+    NOTMUCH_FORMAT_NOT_SPECIFIED,
+    NOTMUCH_FORMAT_JSON,
+    NOTMUCH_FORMAT_TEXT,
+    NOTMUCH_FORMAT_MBOX,
+    NOTMUCH_FORMAT_RAW
+};
+
 int
 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
 {
@@ -1021,92 +981,97 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     notmuch_database_t *notmuch;
     notmuch_query_t *query;
     char *query_string;
-    char *opt;
+    int opt_index, ret;
     const notmuch_show_format_t *format = &format_text;
-    notmuch_show_params_t params;
-    int mbox = 0;
-    int format_specified = 0;
-    int i;
+    notmuch_show_params_t params = { .part = -1 };
+    int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
+    notmuch_bool_t verify = FALSE;
+    notmuch_bool_t no_exclude = FALSE;
+
+    notmuch_opt_desc_t options[] = {
+       { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
+         (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
+                                 { "text", NOTMUCH_FORMAT_TEXT },
+                                 { "mbox", NOTMUCH_FORMAT_MBOX },
+                                 { "raw", NOTMUCH_FORMAT_RAW },
+                                 { 0, 0 } } },
+       { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &params.entire_thread, "entire-thread", 't', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &params.decrypt, "decrypt", 'd', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 },
+       { 0, 0, 0, 0, 0 }
+    };
 
-    params.entire_thread = FALSE;
-    params.raw = FALSE;
-    params.part = -1;
-    params.cryptoctx = NULL;
-    params.decrypt = FALSE;
+    opt_index = parse_arguments (argc, argv, options, 1);
+    if (opt_index < 0) {
+       /* diagnostics already printed */
+       return 1;
+    }
 
-    argc--; argv++; /* skip subcommand argument */
+    if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
+       /* if part was requested and format was not specified, use format=raw */
+       if (params.part >= 0)
+           format_sel = NOTMUCH_FORMAT_RAW;
+       else
+           format_sel = NOTMUCH_FORMAT_TEXT;
+    }
 
-    for (i = 0; i < argc && argv[i][0] == '-'; i++) {
-       if (strcmp (argv[i], "--") == 0) {
-           i++;
-           break;
+    switch (format_sel) {
+    case NOTMUCH_FORMAT_JSON:
+       format = &format_json;
+       params.entire_thread = TRUE;
+       break;
+    case NOTMUCH_FORMAT_TEXT:
+       format = &format_text;
+       break;
+    case NOTMUCH_FORMAT_MBOX:
+       if (params.part > 0) {
+           fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
+           return 1;
        }
-       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;
-               params.entire_thread = TRUE;
-           } else if (strcmp (opt, "mbox") == 0) {
-               format = &format_mbox;
-               mbox = 1;
-           } else if (strcmp (opt, "raw") == 0) {
-               format = &format_raw;
-               params.raw = TRUE;
-           } else {
-               fprintf (stderr, "Invalid value for --format: %s\n", opt);
-               return 1;
-           }
-           format_specified = 1;
-       } else if (STRNCMP_LITERAL (argv[i], "--part=") == 0) {
-           params.part = atoi(argv[i] + sizeof ("--part=") - 1);
-       } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
-           params.entire_thread = TRUE;
-       } else if ((STRNCMP_LITERAL (argv[i], "--verify") == 0) ||
-                  (STRNCMP_LITERAL (argv[i], "--decrypt") == 0)) {
-           if (params.cryptoctx == NULL) {
+
+       format = &format_mbox;
+       break;
+    case NOTMUCH_FORMAT_RAW:
+       format = &format_raw;
+       /* If --format=raw specified without specifying part, we can only
+        * output single message, so set part=0 */
+       if (params.part < 0)
+           params.part = 0;
+       params.raw = TRUE;
+       break;
+    }
+
+    if (params.decrypt || verify) {
 #ifdef GMIME_ATLEAST_26
-               /* TODO: GMimePasswordRequestFunc */
-               if (NULL == (params.cryptoctx = g_mime_gpg_context_new(NULL, "gpg")))
+       /* TODO: GMimePasswordRequestFunc */
+       params.cryptoctx = g_mime_gpg_context_new (NULL, "gpg");
 #else
-               GMimeSession* session = g_object_new(g_mime_session_get_type(), NULL);
-               if (NULL == (params.cryptoctx = g_mime_gpg_context_new(session, "gpg")))
+       GMimeSession* session = g_object_new (g_mime_session_get_type(), NULL);
+       params.cryptoctx = g_mime_gpg_context_new (session, "gpg");
 #endif
-                   fprintf (stderr, "Failed to construct gpg context.\n");
-               else
-                   g_mime_gpg_context_set_always_trust((GMimeGpgContext*)params.cryptoctx, FALSE);
-#ifndef GMIME_ATLEAST_26
-               g_object_unref (session);
-               session = NULL;
-#endif
-           }
-           if (STRNCMP_LITERAL (argv[i], "--decrypt") == 0)
-               params.decrypt = TRUE;
+       if (params.cryptoctx) {
+           g_mime_gpg_context_set_always_trust ((GMimeGpgContext*) params.cryptoctx, FALSE);
        } else {
-           fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
-           return 1;
+           params.decrypt = FALSE;
+           fprintf (stderr, "Failed to construct gpg context.\n");
        }
+#ifndef GMIME_ATLEAST_26
+       g_object_unref (session);
+#endif
     }
 
-    argc -= i;
-    argv += i;
-
     config = notmuch_config_open (ctx, NULL, NULL);
     if (config == NULL)
        return 1;
 
-    query_string = query_string_from_args (ctx, argc, argv);
+    query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
     if (query_string == NULL) {
        fprintf (stderr, "Out of memory\n");
        return 1;
     }
 
-    if (mbox && params.part > 0) {
-       fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
-       return 1;
-    }
-
     if (*query_string == '\0') {
        fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
        return 1;
@@ -1123,19 +1088,28 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        return 1;
     }
 
-    /* if part was requested and format was not specified, use format=raw */
-    if (params.part >= 0 && !format_specified)
-       format = &format_raw;
-
-    /* If --format=raw specified without specifying part, we can only
-     * output single message, so set part=0 */
-    if (params.raw && params.part < 0)
-       params.part = 0;
+    /* if format=mbox then we can not output excluded messages as
+     * there is no way to make the exclude flag available */
+    if (format_sel == NOTMUCH_FORMAT_MBOX)
+       notmuch_query_set_omit_excluded_messages (query, TRUE);
 
+    /* If a single message is requested we do not use search_excludes. */
     if (params.part >= 0)
-       return do_show_single (ctx, query, format, &params);
-    else
-       return do_show (ctx, query, format, &params);
+       ret = do_show_single (ctx, query, format, &params);
+    else {
+       if (!no_exclude) {
+           const char **search_exclude_tags;
+           size_t search_exclude_tags_length;
+           unsigned int i;
+
+           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]);
+       }
+       ret = do_show (ctx, query, format, &params);
+    }
+
 
     notmuch_query_destroy (query);
     notmuch_database_close (notmuch);
@@ -1143,5 +1117,5 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     if (params.cryptoctx)
        g_object_unref(params.cryptoctx);
 
-    return 0;
+    return ret;
 }