X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-show.c;h=2cec339a129539963bc7b54d1c5ecfa17bfdd199;hp=05d51b2716d9abc96815d317253a73abd6e410e1;hb=1232584040491186d5d95e8112f019fb823ddd63;hpb=7a1beb9e7c7fdf8971a60d810ae24e58c2d09673 diff --git a/notmuch-show.c b/notmuch-show.c index 05d51b27..2cec339a 100644 --- a/notmuch-show.c +++ b/notmuch-show.c @@ -13,76 +13,55 @@ * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License - * along with this program. If not, see http://www.gnu.org/licenses/ . + * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Carl Worth */ #include "notmuch-client.h" +#include "gmime-filter-reply.h" +#include "sprinter.h" -static void -format_headers_message_part_text (GMimeMessage *message); - -static void -format_part_text (const void *ctx, mime_node_t *node, +static notmuch_status_t +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 void -format_part_json_entry (const void *ctx, mime_node_t *node, - int indent, const notmuch_show_params_t *params); +static notmuch_status_t +format_part_sprinter_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 = { - .message_set_start = "[", - .part = format_part_json_entry, - .message_set_sep = ", ", - .message_set_end = "]" + .new_sprinter = sprinter_json_create, + .part = format_part_sprinter_entry, }; -static void -format_message_mbox (const void *ctx, - notmuch_message_t *message, - unused (int indent)); +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); static const notmuch_show_format_t format_mbox = { - "", NULL, - "", format_message_mbox, - "", NULL, NULL, "", - "", - NULL, - NULL, - NULL, - NULL, - NULL, - "", - "", - "", "", - "" + .new_sprinter = sprinter_text_create, + .part = format_part_mbox, }; -static void -format_part_content_raw (GMimeObject *part); +static notmuch_status_t +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 = { - "", NULL, - "", NULL, - "", NULL, format_headers_message_part_text, "\n", - "", - NULL, - NULL, - NULL, - format_part_content_raw, - NULL, - "", - "", - "", "", - "" + .new_sprinter = sprinter_text_create, + .part = format_part_raw, }; static const char * @@ -131,35 +110,72 @@ _get_one_line_summary (const void *ctx, notmuch_message_t *message) from, relative_date, tags); } +static const char *_get_disposition(GMimeObject *meta) +{ + GMimeContentDisposition *disposition; + + disposition = g_mime_object_get_content_disposition (meta); + if (!disposition) + return NULL; + + return g_mime_content_disposition_get_disposition (disposition); +} + +/* Emit a sequence of key/value pairs for the metadata of message. + * The caller should begin a map before calling this. */ static void -format_message_json (const void *ctx, notmuch_message_t *message) +format_message_sprinter (sprinter_t *sp, notmuch_message_t *message) { + /* 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; - int first = 1; - void *ctx_quote = talloc_new (ctx); time_t date; const char *relative_date; + sp->map_key (sp, "id"); + sp->string (sp, notmuch_message_get_message_id (message)); + + sp->map_key (sp, "match"); + sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH)); + + sp->map_key (sp, "excluded"); + sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED)); + + sp->map_key (sp, "filename"); + if (notmuch_format_version >= 3) { + notmuch_filenames_t *filenames; + + sp->begin_list (sp); + for (filenames = notmuch_message_get_filenames (message); + notmuch_filenames_valid (filenames); + notmuch_filenames_move_to_next (filenames)) { + sp->string (sp, notmuch_filenames_get (filenames)); + } + notmuch_filenames_destroy (filenames); + sp->end (sp); + } else { + sp->string (sp, notmuch_message_get_filename (message)); + } + + sp->map_key (sp, "timestamp"); date = notmuch_message_get_date (message); - relative_date = notmuch_time_relative_date (ctx, date); + sp->integer (sp, date); - 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); + sp->map_key (sp, "date_relative"); + relative_date = notmuch_time_relative_date (local, date); + sp->string (sp, relative_date); + sp->map_key (sp, "tags"); + sp->begin_list (sp); for (tags = notmuch_message_get_tags (message); notmuch_tags_valid (tags); notmuch_tags_move_to_next (tags)) - { - printf("%s%s", first ? "" : ",", - json_quote_str (ctx_quote, notmuch_tags_get (tags))); - first = 0; - } - printf("], "); - talloc_free (ctx_quote); + sp->string (sp, notmuch_tags_get (tags)); + sp->end (sp); + + talloc_free (local); } /* Extract just the email address from the contents of a From: @@ -220,118 +236,79 @@ _is_from_line (const char *line) return 0; } -/* Print a message in "mboxrd" format as documented, for example, - * here: - * - * http://qmail.org/qmail-manual-html/man5/mbox.html - */ -static void -format_message_mbox (const void *ctx, - notmuch_message_t *message, - unused (int indent)) +void +format_headers_sprinter (sprinter_t *sp, GMimeMessage *message, + notmuch_bool_t reply) { - const char *filename; - FILE *file; - const char *from; - - time_t date; - struct tm date_gmtime; - char date_asctime[26]; + /* Any changes to the JSON or S-Expression format should be + * reflected in the file devel/schemata. */ - char *line = NULL; - size_t line_size; - ssize_t line_len; - - filename = notmuch_message_get_filename (message); - file = fopen (filename, "r"); - if (file == NULL) { - fprintf (stderr, "Failed to open %s: %s\n", - filename, strerror (errno)); - return; - } - - from = notmuch_message_get_header (message, "from"); - from = _extract_email_address (ctx, from); - - date = notmuch_message_get_date (message); - gmtime_r (&date, &date_gmtime); - asctime_r (&date_gmtime, date_asctime); - - printf ("From %s %s", from, date_asctime); - - while ((line_len = getline (&line, &line_size, file)) != -1 ) { - if (_is_from_line (line)) - putchar ('>'); - printf ("%s", line); - } + InternetAddressList *recipients; + const char *recipients_string; + const char *reply_to_string; - printf ("\n"); + sp->begin_map (sp); - fclose (file); -} + sp->map_key (sp, "Subject"); + sp->string (sp, g_mime_message_get_subject (message)); -static void -format_headers_message_part_text (GMimeMessage *message) -{ - InternetAddressList *recipients; - const char *recipients_string; + sp->map_key (sp, "From"); + sp->string (sp, g_mime_message_get_sender (message)); - printf ("Subject: %s\n", g_mime_message_get_subject (message)); - printf ("From: %s\n", 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 ("To: %s\n", - 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 ("Cc: %s\n", - recipients_string); - printf ("Date: %s\n", g_mime_message_get_date_as_string (message)); -} - -static void -format_headers_json (const void *ctx, GMimeMessage *message) -{ - void *local = talloc_new (ctx); - InternetAddressList *recipients; - const char *recipients_string; + if (recipients_string) { + sp->map_key (sp, "Cc"); + sp->string (sp, 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))); - 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)); - recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC); + recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC); 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)); - printf (", %s: %s}", - json_quote_str (local, "Date"), - json_quote_str (local, g_mime_message_get_date_as_string (message))); + if (recipients_string) { + sp->map_key (sp, "Bcc"); + sp->string (sp, recipients_string); + } - talloc_free (local); + reply_to_string = g_mime_message_get_reply_to (message); + if (reply_to_string) { + sp->map_key (sp, "Reply-To"); + sp->string (sp, reply_to_string); + } + + if (reply) { + sp->map_key (sp, "In-reply-to"); + sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to")); + + sp->map_key (sp, "References"); + sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References")); + } else { + sp->map_key (sp, "Date"); + sp->string (sp, g_mime_message_get_date_as_string (message)); + } + + sp->end (sp); } /* Write a MIME text part out to the given stream. + * + * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to + * each output line. * * Both line-ending conversion (CRLF->LF) and charset conversion ( -> * UTF-8) will be performed, so it is inappropriate to call this * function with a non-text part. Doing so will trigger an internal * error. */ -static void -show_text_part_content (GMimeObject *part, GMimeStream *stream_out) +void +show_text_part_content (GMimeObject *part, GMimeStream *stream_out, + notmuch_show_text_part_flags flags) { GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part)); GMimeStream *stream_filter = NULL; @@ -364,6 +341,16 @@ show_text_part_content (GMimeObject *part, GMimeStream *stream_out) } + if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) { + GMimeFilter *reply_filter; + reply_filter = g_mime_filter_reply_new (TRUE); + if (reply_filter) { + g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter), + reply_filter); + g_object_unref (reply_filter); + } + } + wrapper = g_mime_part_get_content_object (GMIME_PART (part)); if (wrapper && stream_filter) g_mime_data_wrapper_write_to_stream (wrapper, stream_filter); @@ -371,7 +358,7 @@ show_text_part_content (GMimeObject *part, GMimeStream *stream_out) g_object_unref(stream_filter); } -#ifdef GMIME_ATLEAST_26 +/* Get signature status string (GMime 2.6) */ static const char* signature_status_to_string (GMimeSignatureStatus x) { @@ -385,186 +372,85 @@ 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_json (mime_node_t *node) +format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node) { + /* Any changes to the JSON or S-Expression format should be + * reflected in the file devel/schemata. */ + GMimeSignatureList *siglist = node->sig_list; - printf ("["); + sp->begin_list (sp); if (!siglist) { - printf ("]"); + sp->end (sp); return; } - void *ctx_quote = talloc_new (NULL); int i; for (i = 0; i < g_mime_signature_list_length (siglist); i++) { GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i); - if (i > 0) - printf (", "); - - printf ("{"); + sp->begin_map (sp); /* status */ GMimeSignatureStatus status = g_mime_signature_get_status (signature); - printf ("\"status\": %s", - json_quote_str (ctx_quote, - signature_status_to_string (status))); + sp->map_key (sp, "status"); + sp->string (sp, signature_status_to_string (status)); GMimeCertificate *certificate = g_mime_signature_get_certificate (signature); if (status == GMIME_SIGNATURE_STATUS_GOOD) { - if (certificate) - printf (", \"fingerprint\": %s", json_quote_str (ctx_quote, g_mime_certificate_get_fingerprint (certificate))); + if (certificate) { + sp->map_key (sp, "fingerprint"); + sp->string (sp, g_mime_certificate_get_fingerprint (certificate)); + } /* these dates are seconds since the epoch; should we * provide a more human-readable format string? */ time_t created = g_mime_signature_get_created (signature); - if (created != -1) - printf (", \"created\": %d", (int) created); + if (created != -1) { + sp->map_key (sp, "created"); + sp->integer (sp, created); + } time_t expires = g_mime_signature_get_expires (signature); - if (expires > 0) - printf (", \"expires\": %d", (int) expires); + if (expires > 0) { + sp->map_key (sp, "expires"); + sp->integer (sp, expires); + } /* output user id only if validity is FULL or ULTIMATE. */ /* note that gmime is using the term "trust" here, which * is WRONG. It's actually user id "validity". */ if (certificate) { const char *name = g_mime_certificate_get_name (certificate); GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate); - if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) - printf (", \"userid\": %s", json_quote_str (ctx_quote, name)); + if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) { + sp->map_key (sp, "userid"); + sp->string (sp, name); + } } } else if (certificate) { const char *key_id = g_mime_certificate_get_key_id (certificate); - if (key_id) - printf (", \"keyid\": %s", json_quote_str (ctx_quote, key_id)); + if (key_id) { + sp->map_key (sp, "keyid"); + sp->string (sp, key_id); + } } GMimeSignatureError errors = g_mime_signature_get_errors (signature); if (errors != GMIME_SIGNATURE_ERROR_NONE) { - printf (", \"errors\": %d", errors); + sp->map_key (sp, "errors"); + sp->integer (sp, errors); } - printf ("}"); + sp->end (sp); } - printf ("]"); - - talloc_free (ctx_quote); -} -#else -static void -format_part_sigstatus_json (mime_node_t *node) -{ - const GMimeSignatureValidity* validity = node->sig_validity; - - printf ("["); - - if (!validity) { - printf ("]"); - return; - } - - const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity); - int first = 1; - void *ctx_quote = talloc_new (NULL); - - while (signer) { - if (first) - first = 0; - else - printf (", "); - - printf ("{"); - - /* status */ - printf ("\"status\": %s", - json_quote_str (ctx_quote, - signer_status_to_string (signer->status))); - - if (signer->status == GMIME_SIGNER_STATUS_GOOD) - { - if (signer->fingerprint) - printf (", \"fingerprint\": %s", json_quote_str (ctx_quote, signer->fingerprint)); - /* these dates are seconds since the epoch; should we - * provide a more human-readable format string? */ - if (signer->created) - printf (", \"created\": %d", (int) signer->created); - if (signer->expires) - printf (", \"expires\": %d", (int) signer->expires); - /* output user id only if validity is FULL or ULTIMATE. */ - /* note that gmime is using the term "trust" here, which - * is WRONG. It's actually user id "validity". */ - if ((signer->name) && (signer->trust)) { - if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE)) - printf (", \"userid\": %s", json_quote_str (ctx_quote, signer->name)); - } - } else { - if (signer->keyid) - printf (", \"keyid\": %s", json_quote_str (ctx_quote, signer->keyid)); - } - if (signer->errors != GMIME_SIGNER_ERROR_NONE) { - printf (", \"errors\": %d", signer->errors); - } - - printf ("}"); - signer = signer->next; - } - - printf ("]"); - - talloc_free (ctx_quote); + sp->end (sp); } -#endif -static void -format_part_content_raw (GMimeObject *part) -{ - if (! GMIME_IS_PART (part)) - return; - - GMimeStream *stream_stdout; - GMimeStream *stream_filter = NULL; - GMimeDataWrapper *wrapper; - - stream_stdout = g_mime_stream_file_new (stdout); - g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE); - - stream_filter = g_mime_stream_filter_new (stream_stdout); - - wrapper = g_mime_part_get_content_object (GMIME_PART (part)); - - if (wrapper && stream_filter) - g_mime_data_wrapper_write_to_stream (wrapper, stream_filter); - - if (stream_filter) - g_object_unref (stream_filter); - - if (stream_stdout) - g_object_unref(stream_stdout); -} - -static void -format_part_text (const void *ctx, mime_node_t *node, +static notmuch_status_t +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 @@ -588,13 +474,13 @@ format_part_text (const void *ctx, mime_node_t *node, 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); + const char *disposition = _get_disposition (meta); const char *cid = g_mime_object_get_content_id (meta); const char *filename = leaf ? g_mime_part_get_filename (GMIME_PART (node->part)) : NULL; if (disposition && - strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0) + strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0) part_type = "attachment"; else part_type = "part"; @@ -637,7 +523,7 @@ format_part_text (const void *ctx, mime_node_t *node, { GMimeStream *stream_stdout = g_mime_stream_file_new (stdout); g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE); - show_text_part_content (node->part, stream_stdout); + show_text_part_content (node->part, stream_stdout, 0); g_object_unref(stream_stdout); } else { printf ("Non-text part: %s\n", @@ -646,212 +532,387 @@ 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"); printf ("\f%s}\n", part_type); + + return NOTMUCH_STATUS_SUCCESS; } static void -format_part_json (const void *ctx, mime_node_t *node, notmuch_bool_t first) +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 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) { - printf ("{"); - format_message_json (ctx, node->envelope_file); + sp->begin_map (sp); + format_message_sprinter (sp, node->envelope_file); - printf ("\"headers\": "); - format_headers_json (ctx, GMIME_MESSAGE (node->part)); + sp->map_key (sp, "headers"); + format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE); - printf (", \"body\": ["); - format_part_json (ctx, mime_node_child (node, 0), first); - - printf ("]}"); + if (output_body) { + sp->map_key (sp, "body"); + sp->begin_list (sp); + format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html); + sp->end (sp); + } + sp->end (sp); 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 *disposition = _get_disposition (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 nclose = 0; int i; - if (!first) - printf (", "); + sp->begin_map (sp); - printf ("{\"id\": %d", node->part_num); + sp->map_key (sp, "id"); + sp->integer (sp, node->part_num); - if (node->decrypt_attempted) - printf (", \"encstatus\": [{\"status\": \"%s\"}]", - node->decrypt_success ? "good" : "bad"); + if (node->decrypt_attempted) { + sp->map_key (sp, "encstatus"); + sp->begin_list (sp); + sp->begin_map (sp); + sp->map_key (sp, "status"); + sp->string (sp, node->decrypt_success ? "good" : "bad"); + sp->end (sp); + sp->end (sp); + } if (node->verify_attempted) { - printf (", \"sigstatus\": "); - format_part_sigstatus_json (node); + sp->map_key (sp, "sigstatus"); + format_part_sigstatus_sprinter (sp, node); } - printf (", \"content-type\": %s", - json_quote_str (local, g_mime_content_type_to_string (content_type))); + sp->map_key (sp, "content-type"); + sp->string (sp, g_mime_content_type_to_string (content_type)); + + if (disposition) { + sp->map_key (sp, "content-disposition"); + sp->string (sp, disposition); + } - if (cid) - printf (", \"content-id\": %s", json_quote_str (local, cid)); + if (cid) { + sp->map_key (sp, "content-id"); + sp->string (sp, cid); + } - if (filename) - printf (", \"filename\": %s", json_quote_str (local, filename)); + if (filename) { + sp->map_key (sp, "filename"); + sp->string (sp, 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 + * 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) - printf (", \"content-charset\": %s", json_quote_str (local, 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); + show_text_part_content (node->part, stream_memory, 0); 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)); + 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)) { - printf (", \"content\": ["); - terminator = "]"; + sp->map_key (sp, "content"); + sp->begin_list (sp); + nclose = 1; } else if (GMIME_IS_MESSAGE (node->part)) { - printf (", \"content\": [{"); - printf ("\"headers\": "); - format_headers_json (local, GMIME_MESSAGE (node->part)); + sp->map_key (sp, "content"); + sp->begin_list (sp); + sp->begin_map (sp); - printf (", \"body\": ["); - terminator = "]}]"; - } + sp->map_key (sp, "headers"); + format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE); - talloc_free (local); + sp->map_key (sp, "body"); + sp->begin_list (sp); + nclose = 3; + } for (i = 0; i < node->nchildren; i++) - format_part_json (ctx, mime_node_child (node, i), i == 0); + format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html); - printf ("%s}", terminator); + /* Close content structures */ + for (i = 0; i < nclose; i++) + sp->end (sp); + /* Close part map */ + sp->end (sp); } -static void -format_part_json_entry (const void *ctx, mime_node_t *node, unused (int indent), - unused (const notmuch_show_params_t *params)) +static notmuch_status_t +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_json (ctx, node, TRUE); + format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html); + + return NOTMUCH_STATUS_SUCCESS; } -static void -show_message (void *ctx, - const notmuch_show_format_t *format, - notmuch_message_t *message, - int indent, - notmuch_show_params_t *params) +/* Print a message in "mboxrd" format as documented, for example, + * here: + * + * http://qmail.org/qmail-manual-html/man5/mbox.html + */ +static notmuch_status_t +format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node, + unused (int indent), + unused (const notmuch_show_params_t *params)) { - if (format->part) { - void *local = talloc_new (ctx); - mime_node_t *root, *part; - - if (mime_node_open (local, message, params->cryptoctx, params->decrypt, - &root) == NOTMUCH_STATUS_SUCCESS && - (part = mime_node_seek_dfs (root, (params->part < 0 ? - 0 : params->part)))) - format->part (local, part, indent, params); - talloc_free (local); - return; + notmuch_message_t *message = node->envelope_file; + + const char *filename; + FILE *file; + const char *from; + + time_t date; + struct tm date_gmtime; + char date_asctime[26]; + + char *line = NULL; + size_t line_size; + ssize_t line_len; + + if (!message) + INTERNAL_ERROR ("format_part_mbox requires a root part"); + + filename = notmuch_message_get_filename (message); + file = fopen (filename, "r"); + if (file == NULL) { + fprintf (stderr, "Failed to open %s: %s\n", + filename, strerror (errno)); + return NOTMUCH_STATUS_FILE_ERROR; } - if (params->part <= 0) { - fputs (format->message_start, stdout); - if (format->message) - format->message(ctx, message, indent); + from = notmuch_message_get_header (message, "from"); + from = _extract_email_address (ctx, from); + + date = notmuch_message_get_date (message); + gmtime_r (&date, &date_gmtime); + asctime_r (&date_gmtime, date_asctime); - fputs (format->header_start, stdout); - if (format->header) - format->header(ctx, message); - fputs (format->header_end, stdout); + printf ("From %s %s", from, date_asctime); - fputs (format->body_start, stdout); + while ((line_len = getline (&line, &line_size, file)) != -1 ) { + if (_is_from_line (line)) + putchar ('>'); + printf ("%s", line); } - if (format->part_content) - show_message_body (message, format, params); + printf ("\n"); + + fclose (file); - if (params->part <= 0) { - fputs (format->body_end, stdout); + return NOTMUCH_STATUS_SUCCESS; +} - fputs (format->message_end, stdout); +static notmuch_status_t +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) { + /* Special case the entire message to avoid MIME parsing. */ + const char *filename; + FILE *file; + size_t size; + char buf[4096]; + + filename = notmuch_message_get_filename (node->envelope_file); + if (filename == NULL) { + fprintf (stderr, "Error: Cannot get message filename.\n"); + return NOTMUCH_STATUS_FILE_ERROR; + } + + file = fopen (filename, "r"); + if (file == NULL) { + fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno)); + return NOTMUCH_STATUS_FILE_ERROR; + } + + while (!feof (file)) { + size = fread (buf, 1, sizeof (buf), file); + if (ferror (file)) { + fprintf (stderr, "Error: Read failed from %s\n", filename); + fclose (file); + return NOTMUCH_STATUS_FILE_ERROR; + } + + if (fwrite (buf, size, 1, stdout) != 1) { + fprintf (stderr, "Error: Write failed\n"); + fclose (file); + return NOTMUCH_STATUS_FILE_ERROR; + } + } + + fclose (file); + return NOTMUCH_STATUS_SUCCESS; + } + + GMimeStream *stream_stdout; + GMimeStream *stream_filter = NULL; + + stream_stdout = g_mime_stream_file_new (stdout); + g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE); + + stream_filter = g_mime_stream_filter_new (stream_stdout); + + if (GMIME_IS_PART (node->part)) { + /* For leaf parts, we emit only the transfer-decoded + * body. */ + GMimeDataWrapper *wrapper; + wrapper = g_mime_part_get_content_object (GMIME_PART (node->part)); + + if (wrapper && stream_filter) + g_mime_data_wrapper_write_to_stream (wrapper, stream_filter); + } else { + /* Write out the whole part. For message parts (the root + * part and embedded message parts), this will be the + * message including its headers (but not the + * encapsulating part's headers). For multipart parts, + * this will include the headers. */ + if (stream_filter) + g_mime_object_write_to_stream (node->part, stream_filter); } + + if (stream_filter) + g_object_unref (stream_filter); + + if (stream_stdout) + g_object_unref(stream_stdout); + + return NOTMUCH_STATUS_SUCCESS; } -static void +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) +{ + void *local = talloc_new (ctx); + mime_node_t *root, *part; + notmuch_status_t status; + + 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; - int first_set = 1; + notmuch_bool_t excluded; int next_indent; + notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; - fputs (format->message_set_start, stdout); + sp->begin_list (sp); for (; notmuch_messages_valid (messages); notmuch_messages_move_to_next (messages)) { - if (!first_set) - fputs (format->message_set_sep, stdout); - first_set = 0; - - fputs (format->message_set_start, stdout); + sp->begin_list (sp); 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) { - 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; - - fputs (format->message_set_sep, stdout); + } else { + sp->null (sp); } - show_messages (ctx, - format, - notmuch_message_get_replies (message), - next_indent, - params); + status = show_messages (ctx, + format, sp, + notmuch_message_get_replies (message), + next_indent, + params); + if (status && !res) + res = status; notmuch_message_destroy (message); - fputs (format->message_set_end, stdout); + sp->end (sp); } - fputs (format->message_set_end, stdout); + sp->end (sp); + + return res; } /* Formatted output of single message */ @@ -859,17 +920,27 @@ 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; notmuch_message_t *message; + notmuch_status_t status; + unsigned int count; + + status = notmuch_query_count_messages_st (query, &count); + if (print_status_query ("notmuch show", query, status)) + return 1; - if (notmuch_query_count_messages (query) != 1) { - fprintf (stderr, "Error: search term did not match precisely one message.\n"); + if (count != 1) { + fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count); return 1; } - messages = notmuch_query_search_messages (query); + status = notmuch_query_search_messages_st (query, &messages); + if (print_status_query ("notmuch show", query, status)) + return 1; + message = notmuch_messages_get (messages); if (message == NULL) { @@ -879,50 +950,8 @@ do_show_single (void *ctx, notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1); - /* Special case for --format=raw of full single message, just cat out file */ - if (params->raw && 0 == params->part) { - - const char *filename; - FILE *file; - size_t size; - char buf[4096]; - - filename = notmuch_message_get_filename (message); - if (filename == NULL) { - fprintf (stderr, "Error: Cannot message filename.\n"); - return 1; - } - - file = fopen (filename, "r"); - if (file == NULL) { - fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno)); - return 1; - } - - while (!feof (file)) { - size = fread (buf, 1, sizeof (buf), file); - if (ferror (file)) { - fprintf (stderr, "Error: Read failed from %s\n", filename); - fclose (file); - return 1; - } - - if (fwrite (buf, size, 1, stdout) != 1) { - fprintf (stderr, "Error: Write failed\n"); - fclose (file); - return 1; - } - } - - fclose (file); - - } else { - - show_message (ctx, format, message, 0, params); - - } - - return 0; + return show_message (ctx, format, sp, message, 0, params) + != NOTMUCH_STATUS_SUCCESS; } /* Formatted output of threads */ @@ -930,16 +959,21 @@ 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; notmuch_thread_t *thread; notmuch_messages_t *messages; - int first_toplevel = 1; + notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; - fputs (format->message_set_start, stdout); + status= notmuch_query_search_threads_st (query, &threads); + if (print_status_query ("notmuch show", query, status)) + return 1; + + sp->begin_list (sp); - for (threads = notmuch_query_search_threads (query); + for ( ; notmuch_threads_valid (threads); notmuch_threads_move_to_next (threads)) { @@ -951,63 +985,104 @@ do_show (void *ctx, INTERNAL_ERROR ("Thread %s has no toplevel messages.\n", notmuch_thread_get_thread_id (thread)); - if (!first_toplevel) - fputs (format->message_set_sep, stdout); - first_toplevel = 0; - - show_messages (ctx, format, messages, 0, params); + status = show_messages (ctx, format, sp, messages, 0, params); + if (status && !res) + res = status; notmuch_thread_destroy (thread); } - fputs (format->message_set_end, stdout); + sp->end (sp); - return 0; + return res != NOTMUCH_STATUS_SUCCESS; } enum { NOTMUCH_FORMAT_NOT_SPECIFIED, NOTMUCH_FORMAT_JSON, + NOTMUCH_FORMAT_SEXP, NOTMUCH_FORMAT_TEXT, NOTMUCH_FORMAT_MBOX, 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[])) +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; 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, + .gpgpath = NULL + }, + .include_html = 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_bool_t single_message; notmuch_opt_desc_t options[] = { { 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, ¬much_format_version, "format-version", 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 }, + { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 }, + { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 }, { 0, 0, 0, 0, 0 } }; opt_index = parse_arguments (argc, argv, options, 1); - if (opt_index < 0) { - /* diagnostics already printed */ - return 1; - } + if (opt_index < 0) + return EXIT_FAILURE; + + notmuch_process_shared_options (argv[0]); + + /* decryption implies verification */ + if (params.crypto.decrypt) + params.crypto.verify = TRUE; + + /* specifying a part implies single message display */ + single_message = params.part >= 0; if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) { /* if part was requested and format was not specified, use format=raw */ @@ -1020,102 +1095,117 @@ 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; 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"); - return 1; + return EXIT_FAILURE; } 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; + /* raw format only supports single message display */ + single_message = TRUE; 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); + 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_sel == NOTMUCH_FORMAT_JSON || + format_sel == NOTMUCH_FORMAT_SEXP) + 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_sel != NOTMUCH_FORMAT_JSON && + format_sel != NOTMUCH_FORMAT_SEXP) + fprintf (stderr, + "Warning: --body=false only implemented for format=json and format=sexp\n"); } -#ifndef GMIME_ATLEAST_26 - g_object_unref (session); -#endif } - config = notmuch_config_open (ctx, NULL, NULL); - if (config == NULL) - return 1; + 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; - 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; + return EXIT_FAILURE; } if (*query_string == '\0') { fprintf (stderr, "Error: notmuch show requires at least one search term.\n"); - return 1; + return EXIT_FAILURE; } - notmuch = notmuch_database_open (notmuch_config_get_database_path (config), - NOTMUCH_DATABASE_MODE_READ_ONLY); - if (notmuch == NULL) - return 1; + params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config); + + if (notmuch_database_open (notmuch_config_get_database_path (config), + NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much)) + return EXIT_FAILURE; + + notmuch_exit_if_unmatched_db_uuid (notmuch); query = notmuch_query_create (notmuch, query_string); if (query == NULL) { fprintf (stderr, "Out of memory\n"); - return 1; + return EXIT_FAILURE; } - /* 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(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, ¶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]); + if (single_message) { + ret = do_show_single (config, query, format, sprinter, ¶ms); + } else { + /* 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 (config, 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; + return ret ? EXIT_FAILURE : EXIT_SUCCESS; }