X-Git-Url: https://git.notmuchmail.org/git?a=blobdiff_plain;ds=sidebyside;f=notmuch-show.c;h=9852119f77338f3a8a2190b1ed838449f25d3f28;hb=7018fc58b4ebf6e2c52102c0443169f8120db261;hp=0bf5e219c86d7a79823400a5ef8bbeacb40a1be7;hpb=ea4fd50f45b0bc0888070125c632ea2326eb18f7;p=notmuch diff --git a/notmuch-show.c b/notmuch-show.c index 0bf5e219..9852119f 100644 --- a/notmuch-show.c +++ b/notmuch-show.c @@ -20,50 +20,47 @@ #include "notmuch-client.h" #include "gmime-filter-reply.h" +#include "sprinter.h" static notmuch_status_t -format_part_text (const void *ctx, mime_node_t *node, +format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node, int indent, const notmuch_show_params_t *params); static const notmuch_show_format_t format_text = { - .message_set_start = "", + .new_sprinter = sprinter_text_create, .part = format_part_text, - .message_set_sep = "", - .message_set_end = "" }; static notmuch_status_t -format_part_json_entry (const void *ctx, mime_node_t *node, +format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node, int indent, const notmuch_show_params_t *params); static const notmuch_show_format_t format_json = { + .new_sprinter = sprinter_json_create, .message_set_start = "[", .part = format_part_json_entry, .message_set_sep = ", ", - .message_set_end = "]" + .message_set_end = "]", + .null_message = "null" }; static notmuch_status_t -format_part_mbox (const void *ctx, mime_node_t *node, +format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node, int indent, const notmuch_show_params_t *params); static const notmuch_show_format_t format_mbox = { - .message_set_start = "", + .new_sprinter = sprinter_text_create, .part = format_part_mbox, - .message_set_sep = "", - .message_set_end = "" }; static notmuch_status_t -format_part_raw (unused (const void *ctx), mime_node_t *node, +format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node, unused (int indent), unused (const notmuch_show_params_t *params)); static const notmuch_show_format_t format_raw = { - .message_set_start = "", + .new_sprinter = sprinter_text_create, .part = format_part_raw, - .message_set_sep = "", - .message_set_end = "" }; static const char * @@ -202,48 +199,46 @@ _is_from_line (const char *line) } void -format_headers_json (const void *ctx, GMimeMessage *message, notmuch_bool_t reply) +format_headers_json (sprinter_t *sp, GMimeMessage *message, + notmuch_bool_t reply) { - void *local = talloc_new (ctx); InternetAddressList *recipients; const char *recipients_string; - 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))); + sp->begin_map (sp); + + sp->map_key (sp, "Subject"); + sp->string (sp, g_mime_message_get_subject (message)); + + sp->map_key (sp, "From"); + sp->string (sp, 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 (local, "To"), - json_quote_str (local, recipients_string)); + if (recipients_string) { + sp->map_key (sp, "To"); + sp->string (sp, 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 (local, "Cc"), - json_quote_str (local, recipients_string)); + if (recipients_string) { + sp->map_key (sp, "Cc"); + sp->string (sp, recipients_string); + } if (reply) { - printf (", %s: %s", - json_quote_str (local, "In-reply-to"), - json_quote_str (local, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"))); + sp->map_key (sp, "In-reply-to"); + sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to")); - printf (", %s: %s", - json_quote_str (local, "References"), - json_quote_str (local, g_mime_object_get_header (GMIME_OBJECT (message), "References"))); + sp->map_key (sp, "References"); + sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References")); } else { - printf (", %s: %s", - json_quote_str (local, "Date"), - json_quote_str (local, g_mime_message_get_date_as_string (message))); + sp->map_key (sp, "Date"); + sp->string (sp, g_mime_message_get_date_as_string (message)); } - printf ("}"); - - talloc_free (local); + sp->end (sp); } /* Write a MIME text part out to the given stream. @@ -474,7 +469,7 @@ format_part_sigstatus_json (mime_node_t *node) #endif static notmuch_status_t -format_part_text (const void *ctx, mime_node_t *node, +format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node, int indent, const notmuch_show_params_t *params) { /* The disposition and content-type metadata are associated with @@ -556,7 +551,7 @@ format_part_text (const void *ctx, mime_node_t *node, } for (i = 0; i < node->nchildren; i++) - format_part_text (ctx, mime_node_child (node, i), indent, params); + format_part_text (ctx, sp, mime_node_child (node, i), indent, params); if (GMIME_IS_MESSAGE (node->part)) printf ("\fbody}\n"); @@ -567,7 +562,8 @@ format_part_text (const void *ctx, mime_node_t *node, } void -format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) +format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node, + notmuch_bool_t first, notmuch_bool_t output_body) { /* Any changes to the JSON format should be reflected in the file * devel/schemata. */ @@ -577,12 +573,14 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) format_message_json (ctx, node->envelope_file); printf ("\"headers\": "); - format_headers_json (ctx, GMIME_MESSAGE (node->part), FALSE); + format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE); - printf (", \"body\": ["); - format_part_json (ctx, mime_node_child (node, 0), first); - - printf ("]}"); + if (output_body) { + printf (", \"body\": ["); + format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE); + printf ("]"); + } + printf ("}"); return; } @@ -651,7 +649,7 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) } else if (GMIME_IS_MESSAGE (node->part)) { printf (", \"content\": [{"); printf ("\"headers\": "); - format_headers_json (local, GMIME_MESSAGE (node->part), FALSE); + format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE); printf (", \"body\": ["); terminator = "]}]"; @@ -660,16 +658,17 @@ format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) talloc_free (local); for (i = 0; i < node->nchildren; i++) - format_part_json (ctx, mime_node_child (node, i), i == 0); + format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE); printf ("%s}", terminator); } static notmuch_status_t -format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent), - unused (const notmuch_show_params_t *params)) +format_part_json_entry (const void *ctx, sprinter_t *sp, + mime_node_t *node, unused (int indent), + const notmuch_show_params_t *params) { - format_part_json (ctx, node, TRUE); + format_part_json (ctx, sp, node, TRUE, params->output_body); return NOTMUCH_STATUS_SUCCESS; } @@ -680,7 +679,8 @@ format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent), * http://qmail.org/qmail-manual-html/man5/mbox.html */ static notmuch_status_t -format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent), +format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node, + unused (int indent), unused (const notmuch_show_params_t *params)) { notmuch_message_t *message = node->envelope_file; @@ -731,8 +731,8 @@ format_part_mbox (const void *ctx, mime_node_t *node, unused (int indent), } static notmuch_status_t -format_part_raw (unused (const void *ctx), mime_node_t *node, - unused (int indent), +format_part_raw (unused (const void *ctx), unused (sprinter_t *sp), + mime_node_t *node, unused (int indent), unused (const notmuch_show_params_t *params)) { if (node->envelope_file) { @@ -808,98 +808,88 @@ format_part_raw (unused (const void *ctx), mime_node_t *node, return NOTMUCH_STATUS_SUCCESS; } +static notmuch_status_t +show_null_message (const notmuch_show_format_t *format) +{ + /* Output a null message. Currently empty for all formats except Json */ + if (format->null_message) + printf ("%s", format->null_message); + return NOTMUCH_STATUS_SUCCESS; +} + static notmuch_status_t show_message (void *ctx, const notmuch_show_format_t *format, + sprinter_t *sp, notmuch_message_t *message, int indent, notmuch_show_params_t *params) { - if (format->part) { - void *local = talloc_new (ctx); - mime_node_t *root, *part; - notmuch_status_t status; - - status = mime_node_open (local, message, params->cryptoctx, - params->decrypt, &root); - if (status) - goto DONE; - part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part)); - if (part) - status = format->part (local, part, indent, params); - DONE: - talloc_free (local); - return status; - } - - if (params->part <= 0) { - fputs (format->message_start, stdout); - if (format->message) - format->message(ctx, message, indent); - - fputs (format->header_start, stdout); - if (format->header) - format->header(ctx, message); - fputs (format->header_end, stdout); - - fputs (format->body_start, stdout); - } - - if (format->part_content) - show_message_body (message, format, params); - - if (params->part <= 0) { - fputs (format->body_end, stdout); - - fputs (format->message_end, stdout); - } + void *local = talloc_new (ctx); + mime_node_t *root, *part; + notmuch_status_t status; - return NOTMUCH_STATUS_SUCCESS; + status = mime_node_open (local, message, &(params->crypto), &root); + if (status) + goto DONE; + part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part)); + if (part) + status = format->part (local, sp, part, indent, params); + DONE: + talloc_free (local); + return status; } static notmuch_status_t show_messages (void *ctx, const notmuch_show_format_t *format, + sprinter_t *sp, notmuch_messages_t *messages, int indent, notmuch_show_params_t *params) { notmuch_message_t *message; notmuch_bool_t match; + notmuch_bool_t excluded; int first_set = 1; int next_indent; notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; - fputs (format->message_set_start, stdout); + if (format->message_set_start) + fputs (format->message_set_start, stdout); for (; notmuch_messages_valid (messages); notmuch_messages_move_to_next (messages)) { - if (!first_set) + if (!first_set && format->message_set_sep) fputs (format->message_set_sep, stdout); first_set = 0; - fputs (format->message_set_start, stdout); + if (format->message_set_start) + fputs (format->message_set_start, stdout); message = notmuch_messages_get (messages); match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH); + excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED); next_indent = indent; - if (match || params->entire_thread) { - status = show_message (ctx, format, message, indent, params); + if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) { + status = show_message (ctx, format, sp, message, indent, params); if (status && !res) res = status; next_indent = indent + 1; - - if (!status) - fputs (format->message_set_sep, stdout); + } else { + status = show_null_message (format); } + if (!status && format->message_set_sep) + fputs (format->message_set_sep, stdout); + status = show_messages (ctx, - format, + format, sp, notmuch_message_get_replies (message), next_indent, params); @@ -908,10 +898,12 @@ show_messages (void *ctx, notmuch_message_destroy (message); - fputs (format->message_set_end, stdout); + if (format->message_set_end) + fputs (format->message_set_end, stdout); } - fputs (format->message_set_end, stdout); + if (format->message_set_end) + fputs (format->message_set_end, stdout); return res; } @@ -921,6 +913,7 @@ static int do_show_single (void *ctx, notmuch_query_t *query, const notmuch_show_format_t *format, + sprinter_t *sp, notmuch_show_params_t *params) { notmuch_messages_t *messages; @@ -941,7 +934,8 @@ do_show_single (void *ctx, notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1); - return show_message (ctx, format, message, 0, params) != NOTMUCH_STATUS_SUCCESS; + return show_message (ctx, format, sp, message, 0, params) + != NOTMUCH_STATUS_SUCCESS; } /* Formatted output of threads */ @@ -949,6 +943,7 @@ static int do_show (void *ctx, notmuch_query_t *query, const notmuch_show_format_t *format, + sprinter_t *sp, notmuch_show_params_t *params) { notmuch_threads_t *threads; @@ -957,7 +952,8 @@ do_show (void *ctx, int first_toplevel = 1; notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; - fputs (format->message_set_start, stdout); + if (format->message_set_start) + fputs (format->message_set_start, stdout); for (threads = notmuch_query_search_threads (query); notmuch_threads_valid (threads); @@ -971,11 +967,11 @@ do_show (void *ctx, INTERNAL_ERROR ("Thread %s has no toplevel messages.\n", notmuch_thread_get_thread_id (thread)); - if (!first_toplevel) + if (!first_toplevel && format->message_set_sep) fputs (format->message_set_sep, stdout); first_toplevel = 0; - status = show_messages (ctx, format, messages, 0, params); + status = show_messages (ctx, format, sp, messages, 0, params); if (status && !res) res = status; @@ -983,7 +979,8 @@ do_show (void *ctx, } - fputs (format->message_set_end, stdout); + if (format->message_set_end) + fputs (format->message_set_end, stdout); return res != NOTMUCH_STATUS_SUCCESS; } @@ -996,6 +993,18 @@ enum { NOTMUCH_FORMAT_RAW }; +enum { + ENTIRE_THREAD_DEFAULT, + ENTIRE_THREAD_TRUE, + ENTIRE_THREAD_FALSE, +}; + +/* The following is to allow future options to be added more easily */ +enum { + EXCLUDE_TRUE, + EXCLUDE_FALSE, +}; + int notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) { @@ -1005,10 +1014,19 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) char *query_string; int opt_index, ret; const notmuch_show_format_t *format = &format_text; - notmuch_show_params_t params = { .part = -1 }; + sprinter_t *sprinter; + notmuch_show_params_t params = { + .part = -1, + .omit_excluded = TRUE, + .output_body = TRUE, + .crypto = { + .verify = FALSE, + .decrypt = FALSE + } + }; int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED; - notmuch_bool_t verify = FALSE; - notmuch_bool_t no_exclude = FALSE; + int exclude = EXCLUDE_TRUE; + int entire_thread = ENTIRE_THREAD_DEFAULT; notmuch_opt_desc_t options[] = { { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f', @@ -1017,11 +1035,19 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) { "mbox", NOTMUCH_FORMAT_MBOX }, { "raw", NOTMUCH_FORMAT_RAW }, { 0, 0 } } }, + { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x', + (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE }, + { "false", EXCLUDE_FALSE }, + { 0, 0 } } }, + { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't', + (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE }, + { "false", ENTIRE_THREAD_FALSE }, + { "", ENTIRE_THREAD_TRUE }, + { 0, 0 } } }, { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 }, - { NOTMUCH_OPT_BOOLEAN, ¶ms.entire_thread, "entire-thread", 't', 0 }, - { NOTMUCH_OPT_BOOLEAN, ¶ms.decrypt, "decrypt", 'd', 0 }, - { NOTMUCH_OPT_BOOLEAN, &verify, "verify", 'v', 0 }, - { NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'n', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 }, { 0, 0, 0, 0, 0 } }; @@ -1031,6 +1057,10 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) return 1; } + /* decryption implies verification */ + if (params.crypto.decrypt) + params.crypto.verify = TRUE; + if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) { /* if part was requested and format was not specified, use format=raw */ if (params.part >= 0) @@ -1042,7 +1072,6 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) switch (format_sel) { case NOTMUCH_FORMAT_JSON: format = &format_json; - params.entire_thread = TRUE; break; case NOTMUCH_FORMAT_TEXT: format = &format_text; @@ -1065,25 +1094,29 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) break; } - if (params.decrypt || verify) { -#ifdef GMIME_ATLEAST_26 - /* TODO: GMimePasswordRequestFunc */ - params.cryptoctx = g_mime_gpg_context_new (NULL, "gpg"); -#else - GMimeSession* session = g_object_new (g_mime_session_get_type(), NULL); - params.cryptoctx = g_mime_gpg_context_new (session, "gpg"); -#endif - if (params.cryptoctx) { - g_mime_gpg_context_set_always_trust ((GMimeGpgContext*) params.cryptoctx, FALSE); + /* Default is entire-thread = FALSE except for format=json. */ + if (entire_thread == ENTIRE_THREAD_DEFAULT) { + if (format == &format_json) + entire_thread = ENTIRE_THREAD_TRUE; + else + entire_thread = ENTIRE_THREAD_FALSE; + } + + if (!params.output_body) { + if (params.part > 0) { + fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n"); + params.output_body = TRUE; } else { - params.decrypt = FALSE; - fprintf (stderr, "Failed to construct gpg context.\n"); + if (format != &format_json) + fprintf (stderr, "Warning: --body=false only implemented for format=json\n"); } -#ifndef GMIME_ATLEAST_26 - g_object_unref (session); -#endif } + 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; @@ -1099,9 +1132,8 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) return 1; } - notmuch = notmuch_database_open (notmuch_config_get_database_path (config), - NOTMUCH_DATABASE_MODE_READ_ONLY); - if (notmuch == NULL) + if (notmuch_database_open (notmuch_config_get_database_path (config), + NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much)) return 1; query = notmuch_query_create (notmuch, query_string); @@ -1110,34 +1142,36 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) return 1; } - /* 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); + /* Create structure printer. */ + sprinter = format->new_sprinter(ctx, stdout); /* If a single message is requested we do not use search_excludes. */ if (params.part >= 0) - ret = do_show_single (ctx, query, format, ¶ms); + ret = do_show_single (ctx, query, format, sprinter, ¶ms); 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]); + /* We always apply set the exclude flag. The + * exclude=true|false option controls whether or not we return + * threads that only match in an excluded message */ + 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]); + + if (exclude == EXCLUDE_FALSE) { + notmuch_query_set_omit_excluded (query, FALSE); + params.omit_excluded = FALSE; } - ret = do_show (ctx, query, format, ¶ms); - } + ret = do_show (ctx, query, format, sprinter, ¶ms); + } + notmuch_crypto_cleanup (¶ms.crypto); notmuch_query_destroy (query); - notmuch_database_close (notmuch); - - if (params.cryptoctx) - g_object_unref(params.cryptoctx); + notmuch_database_destroy (notmuch); return ret; }