]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-show.c
cli: add --include-html option to notmuch show
[notmuch] / notmuch-show.c
index d3f08bcdf30e58b1c2f7c98a42bcbb002870988d..c07f8871aefe4eab1313ea795d7476cb854d7e04 100644 (file)
@@ -40,6 +40,11 @@ static const notmuch_show_format_t format_json = {
     .part = format_part_sprinter_entry,
 };
 
+static const notmuch_show_format_t format_sexp = {
+    .new_sprinter = sprinter_sexp_create,
+    .part = format_part_sprinter_entry,
+};
+
 static notmuch_status_t
 format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
                  int indent, const notmuch_show_params_t *params);
@@ -110,8 +115,8 @@ _get_one_line_summary (const void *ctx, notmuch_message_t *message)
 static void
 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
 {
-    /* Any changes to the JSON format should be reflected in the file
-     * devel/schemata. */
+    /* Any changes to the JSON or S-Expression format should be
+     * reflected in the file devel/schemata. */
 
     void *local = talloc_new (NULL);
     notmuch_tags_t *tags;
@@ -211,8 +216,8 @@ void
 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
                         notmuch_bool_t reply)
 {
-    /* Any changes to the JSON format should be reflected in the file
-     * devel/schemata. */
+    /* Any changes to the JSON or S-Expression format should be
+     * reflected in the file devel/schemata. */
 
     InternetAddressList *recipients;
     const char *recipients_string;
@@ -330,6 +335,8 @@ show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
 }
 
 #ifdef GMIME_ATLEAST_26
+
+/* Get signature status string (GMime 2.6) */
 static const char*
 signature_status_to_string (GMimeSignatureStatus x)
 {
@@ -343,30 +350,13 @@ signature_status_to_string (GMimeSignatureStatus x)
     }
     return "unknown";
 }
-#else
-static const char*
-signer_status_to_string (GMimeSignerStatus x)
-{
-    switch (x) {
-    case GMIME_SIGNER_STATUS_NONE:
-       return "none";
-    case GMIME_SIGNER_STATUS_GOOD:
-       return "good";
-    case GMIME_SIGNER_STATUS_BAD:
-       return "bad";
-    case GMIME_SIGNER_STATUS_ERROR:
-       return "error";
-    }
-    return "unknown";
-}
-#endif
 
-#ifdef GMIME_ATLEAST_26
+/* Signature status sprinter (GMime 2.6) */
 static void
 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
 {
-    /* Any changes to the JSON format should be reflected in the file
-     * devel/schemata. */
+    /* Any changes to the JSON or S-Expression format should be
+     * reflected in the file devel/schemata. */
 
     GMimeSignatureList *siglist = node->sig_list;
 
@@ -436,7 +426,27 @@ format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
 
     sp->end (sp);
 }
-#else
+
+#else /* GMIME_ATLEAST_26 */
+
+/* Get signature status string (GMime 2.4) */
+static const char*
+signer_status_to_string (GMimeSignerStatus x)
+{
+    switch (x) {
+    case GMIME_SIGNER_STATUS_NONE:
+       return "none";
+    case GMIME_SIGNER_STATUS_GOOD:
+       return "good";
+    case GMIME_SIGNER_STATUS_BAD:
+       return "bad";
+    case GMIME_SIGNER_STATUS_ERROR:
+       return "error";
+    }
+    return "unknown";
+}
+
+/* Signature status sprinter (GMime 2.4) */
 static void
 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
 {
@@ -499,7 +509,8 @@ format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
 
     sp->end (sp);
 }
-#endif
+
+#endif /* GMIME_ATLEAST_26 */
 
 static notmuch_status_t
 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
@@ -594,12 +605,36 @@ format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
     return NOTMUCH_STATUS_SUCCESS;
 }
 
+static void
+format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
+{
+    const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
+    const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
+    GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
+    GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
+    ssize_t content_length = g_mime_stream_length (stream);
+
+    if (content_charset != NULL) {
+       sp->map_key (sp, "content-charset");
+       sp->string (sp, content_charset);
+    }
+    if (cte != NULL) {
+       sp->map_key (sp, "content-transfer-encoding");
+       sp->string (sp, cte);
+    }
+    if (content_length >= 0) {
+       sp->map_key (sp, "content-length");
+       sp->integer (sp, content_length);
+    }
+}
+
 void
 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
-                     notmuch_bool_t first, notmuch_bool_t output_body)
+                     notmuch_bool_t first, notmuch_bool_t output_body,
+                     notmuch_bool_t include_html)
 {
-    /* Any changes to the JSON format should be reflected in the file
-     * devel/schemata. */
+    /* Any changes to the JSON or S-Expression format should be
+     * reflected in the file devel/schemata. */
 
     if (node->envelope_file) {
        sp->begin_map (sp);
@@ -611,7 +646,7 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
        if (output_body) {
            sp->map_key (sp, "body");
            sp->begin_list (sp);
-           format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE);
+           format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
            sp->end (sp);
        }
        sp->end (sp);
@@ -666,20 +701,16 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
        /* 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
+        * For text/html parts, we do not include the content unless
+        * the --include-html option has been passed. If a html part
+        * is not included, it can be requested directly. This makes
+        * charset decoding the responsibility on the caller so 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) {
-               sp->map_key (sp, "content-charset");
-               sp->string (sp, content_charset);
-           }
-       } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
+       if (g_mime_content_type_is_type (content_type, "text", "*") &&
+           (include_html ||
+            ! g_mime_content_type_is_type (content_type, "text", "html")))
+       {
            GMimeStream *stream_memory = g_mime_stream_mem_new ();
            GByteArray *part_content;
            show_text_part_content (node->part, stream_memory, 0);
@@ -687,6 +718,8 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
            sp->map_key (sp, "content");
            sp->string_len (sp, (char *) part_content->data, part_content->len);
            g_object_unref (stream_memory);
+       } else {
+           format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
        }
     } else if (GMIME_IS_MULTIPART (node->part)) {
        sp->map_key (sp, "content");
@@ -706,7 +739,7 @@ format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
     }
 
     for (i = 0; i < node->nchildren; i++)
-       format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
+       format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
 
     /* Close content structures */
     for (i = 0; i < nclose; i++)
@@ -720,7 +753,7 @@ format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
                            mime_node_t *node, unused (int indent),
                            const notmuch_show_params_t *params)
 {
-    format_part_sprinter (ctx, sp, node, TRUE, params->output_body);
+    format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
 
     return NOTMUCH_STATUS_SUCCESS;
 }
@@ -1012,6 +1045,7 @@ do_show (void *ctx,
 enum {
     NOTMUCH_FORMAT_NOT_SPECIFIED,
     NOTMUCH_FORMAT_JSON,
+    NOTMUCH_FORMAT_SEXP,
     NOTMUCH_FORMAT_TEXT,
     NOTMUCH_FORMAT_MBOX,
     NOTMUCH_FORMAT_RAW
@@ -1030,9 +1064,8 @@ enum {
 };
 
 int
-notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
+notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
 {
-    notmuch_config_t *config;
     notmuch_database_t *notmuch;
     notmuch_query_t *query;
     char *query_string;
@@ -1046,7 +1079,8 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        .crypto = {
            .verify = FALSE,
            .decrypt = FALSE
-       }
+       },
+       .include_html = FALSE
     };
     int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
     int exclude = EXCLUDE_TRUE;
@@ -1056,9 +1090,11 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
          (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
                                  { "text", NOTMUCH_FORMAT_TEXT },
+                                 { "sexp", NOTMUCH_FORMAT_SEXP },
                                  { "mbox", NOTMUCH_FORMAT_MBOX },
                                  { "raw", NOTMUCH_FORMAT_RAW },
                                  { 0, 0 } } },
+       { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
        { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
          (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
                                  { "false", EXCLUDE_FALSE },
@@ -1072,6 +1108,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        { NOTMUCH_OPT_BOOLEAN, &params.crypto.decrypt, "decrypt", 'd', 0 },
        { NOTMUCH_OPT_BOOLEAN, &params.crypto.verify, "verify", 'v', 0 },
        { NOTMUCH_OPT_BOOLEAN, &params.output_body, "body", 'b', 0 },
+       { NOTMUCH_OPT_BOOLEAN, &params.include_html, "include-html", 0, 0 },
        { 0, 0, 0, 0, 0 }
     };
 
@@ -1100,6 +1137,9 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     case NOTMUCH_FORMAT_TEXT:
        format = &format_text;
        break;
+    case NOTMUCH_FORMAT_SEXP:
+       format = &format_sexp;
+       break;
     case NOTMUCH_FORMAT_MBOX:
        if (params.part > 0) {
            fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
@@ -1118,9 +1158,12 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
        break;
     }
 
-    /* Default is entire-thread = FALSE except for format=json. */
+    notmuch_exit_if_unsupported_format ();
+
+    /* Default is entire-thread = FALSE except for format=json and
+     * format=sexp. */
     if (entire_thread == ENTIRE_THREAD_DEFAULT) {
-       if (format == &format_json)
+       if (format == &format_json || format == &format_sexp)
            entire_thread = ENTIRE_THREAD_TRUE;
        else
            entire_thread = ENTIRE_THREAD_FALSE;
@@ -1131,21 +1174,23 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
            fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
            params.output_body = TRUE;
        } else {
-           if (format != &format_json)
-               fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
+           if (format != &format_json && format != &format_sexp)
+               fprintf (stderr,
+                        "Warning: --body=false only implemented for format=json and format=sexp\n");
        }
     }
 
+    if (params.include_html &&
+        (format_sel != NOTMUCH_FORMAT_JSON && format_sel != NOTMUCH_FORMAT_SEXP)) {
+       fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
+    }
+
     if (entire_thread == ENTIRE_THREAD_TRUE)
        params.entire_thread = TRUE;
     else
        params.entire_thread = FALSE;
 
-    config = notmuch_config_open (ctx, NULL, NULL);
-    if (config == NULL)
-       return 1;
-
-    query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
+    query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
     if (query_string == NULL) {
        fprintf (stderr, "Out of memory\n");
        return 1;
@@ -1167,11 +1212,11 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
     }
 
     /* Create structure printer. */
-    sprinter = format->new_sprinter(ctx, stdout);
+    sprinter = format->new_sprinter(config, stdout);
 
     /* If a single message is requested we do not use search_excludes. */
     if (params.part >= 0)
-       ret = do_show_single (ctx, query, format, sprinter, &params);
+       ret = do_show_single (config, query, format, sprinter, &params);
     else {
        /* We always apply set the exclude flag. The
         * exclude=true|false option controls whether or not we return
@@ -1190,7 +1235,7 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
            params.omit_excluded = FALSE;
        }
 
-       ret = do_show (ctx, query, format, sprinter, &params);
+       ret = do_show (config, query, format, sprinter, &params);
     }
 
     notmuch_crypto_cleanup (&params.crypto);