X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch-show.c;h=8da3295e3cee204c7ac847928fbe477c1608b659;hp=a764e4438e678739a670625a42bb2de4a6a2a99b;hb=85caaaf861e976aa10d610db0b84ec34126816da;hpb=f379aa52845f5594aa6cc2e7cf131d5f57202bbf diff --git a/notmuch-show.c b/notmuch-show.c index a764e443..7630f49d 100644 --- a/notmuch-show.c +++ b/notmuch-show.c @@ -13,15 +13,59 @@ * 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 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 = { + .new_sprinter = sprinter_text_create, + .part = format_part_text, +}; + +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 = { + .new_sprinter = sprinter_json_create, + .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); + +static const notmuch_show_format_t format_mbox = { + .new_sprinter = sprinter_text_create, + .part = format_part_mbox, +}; + +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 = { + .new_sprinter = sprinter_text_create, + .part = format_part_raw, +}; static const char * -_get_tags_as_string (void *ctx, notmuch_message_t *message) +_get_tags_as_string (const void *ctx, notmuch_message_t *message) { notmuch_tags_t *tags; int first = 1; @@ -33,8 +77,8 @@ _get_tags_as_string (void *ctx, notmuch_message_t *message) return NULL; for (tags = notmuch_message_get_tags (message); - notmuch_tags_has_more (tags); - notmuch_tags_advance (tags)) + notmuch_tags_valid (tags); + notmuch_tags_move_to_next (tags)) { tag = notmuch_tags_get (tags); @@ -48,7 +92,7 @@ _get_tags_as_string (void *ctx, notmuch_message_t *message) /* Get a nice, single-line summary of message. */ static const char * -_get_one_line_summary (void *ctx, notmuch_message_t *message) +_get_one_line_summary (const void *ctx, notmuch_message_t *message) { const char *from; time_t date; @@ -66,18 +110,245 @@ _get_one_line_summary (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 -show_part_content (GMimeObject *part) +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; + 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); + sp->integer (sp, 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)) + sp->string (sp, notmuch_tags_get (tags)); + sp->end (sp); + + talloc_free (local); +} + +/* Extract just the email address from the contents of a From: + * header. */ +static const char * +_extract_email_address (const void *ctx, const char *from) { - GMimeStream *stream_stdout = g_mime_stream_file_new (stdout); + InternetAddressList *addresses; + InternetAddress *address; + InternetAddressMailbox *mailbox; + const char *email = "MAILER-DAEMON"; + + addresses = internet_address_list_parse_string (from); + + /* Bail if there is no address here. */ + if (addresses == NULL || internet_address_list_length (addresses) < 1) + goto DONE; + + /* Otherwise, just use the first address. */ + address = internet_address_list_get_address (addresses, 0); + + /* The From header should never contain an address group rather + * than a mailbox. So bail if it does. */ + if (! INTERNET_ADDRESS_IS_MAILBOX (address)) + goto DONE; + + mailbox = INTERNET_ADDRESS_MAILBOX (address); + email = internet_address_mailbox_get_addr (mailbox); + email = talloc_strdup (ctx, email); + + DONE: + if (addresses) + g_object_unref (addresses); + + return email; + } + +/* Return 1 if 'line' is an mbox From_ line---that is, a line + * beginning with zero or more '>' characters followed by the + * characters 'F', 'r', 'o', 'm', and space. + * + * Any characters at all may appear after that in the line. + */ +static int +_is_from_line (const char *line) +{ + const char *s = line; + + if (line == NULL) + return 0; + + while (*s == '>') + s++; + + if (STRNCMP_LITERAL (s, "From ") == 0) + return 1; + else + return 0; +} + +void +format_headers_sprinter (sprinter_t *sp, GMimeMessage *message, + notmuch_bool_t reply) +{ + /* Any changes to the JSON or S-Expression format should be + * reflected in the file devel/schemata. */ + + InternetAddressList *recipients; + const char *recipients_string; + const char *reply_to_string; + + 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) { + 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) { + sp->map_key (sp, "Cc"); + sp->string (sp, recipients_string); + } + + recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC); + recipients_string = internet_address_list_to_string (recipients, 0); + if (recipients_string) { + sp->map_key (sp, "Bcc"); + sp->string (sp, recipients_string); + } + + 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. + */ +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; GMimeDataWrapper *wrapper; + const char *charset; + + if (! g_mime_content_type_is_type (content_type, "text", "*")) + INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.", + g_mime_content_type_to_string (content_type)); + + if (stream_out == NULL) + return; + + stream_filter = g_mime_stream_filter_new (stream_out); + g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter), + g_mime_filter_crlf_new (FALSE, FALSE)); + + charset = g_mime_object_get_content_type_parameter (part, "charset"); + if (charset) { + GMimeFilter *charset_filter; + charset_filter = g_mime_filter_charset_new (charset, "UTF-8"); + /* This result can be NULL for things like "unknown-8bit". + * Don't set a NULL filter as that makes GMime print + * annoying assertion-failure messages on stderr. */ + if (charset_filter) { + g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter), + charset_filter); + g_object_unref (charset_filter); + } - if (stream_stdout) { - g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE); - stream_filter = g_mime_stream_filter_new(stream_stdout); - g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter), - g_mime_filter_crlf_new(FALSE, FALSE)); + } + + 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)); @@ -85,155 +356,620 @@ show_part_content (GMimeObject *part) 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); } +/* Get signature status string (GMime 2.6) */ +static const char* +signature_status_to_string (GMimeSignatureStatus x) +{ + switch (x) { + case GMIME_SIGNATURE_STATUS_GOOD: + return "good"; + case GMIME_SIGNATURE_STATUS_BAD: + return "bad"; + case GMIME_SIGNATURE_STATUS_ERROR: + return "error"; + } + return "unknown"; +} + +/* Signature status sprinter (GMime 2.6) */ static void -show_part (GMimeObject *part, int *part_count) +format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node) { - GMimeContentDisposition *disposition; - GMimeContentType *content_type; + /* Any changes to the JSON or S-Expression format should be + * reflected in the file devel/schemata. */ - disposition = g_mime_object_get_content_disposition (part); - if (disposition && - strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0) - { - const char *filename = g_mime_part_get_filename (GMIME_PART (part)); - content_type = g_mime_object_get_content_type (GMIME_OBJECT (part)); + GMimeSignatureList *siglist = node->sig_list; + + sp->begin_list (sp); + + if (!siglist) { + sp->end (sp); + return; + } + + int i; + for (i = 0; i < g_mime_signature_list_length (siglist); i++) { + GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i); + + sp->begin_map (sp); + + /* status */ + GMimeSignatureStatus status = g_mime_signature_get_status (signature); + 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) { + 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) { + sp->map_key (sp, "created"); + sp->integer (sp, created); + } + time_t expires = g_mime_signature_get_expires (signature); + 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)) { + 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) { + sp->map_key (sp, "keyid"); + sp->string (sp, key_id); + } + } + + GMimeSignatureError errors = g_mime_signature_get_errors (signature); + if (errors != GMIME_SIGNATURE_ERROR_NONE) { + sp->map_key (sp, "errors"); + sp->integer (sp, errors); + } + + sp->end (sp); + } + + sp->end (sp); +} + +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 + * 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 notmuch_bool_t leaf = GMIME_IS_PART (node->part); + const char *part_type; + int i; - printf ("\fattachment{ ID: %d, Content-type: %s\n", - *part_count, - g_mime_content_type_to_string (content_type)); - printf ("Attachment: %s (%s)\n", filename, - g_mime_content_type_to_string (content_type)); + if (node->envelope_file) { + notmuch_message_t *message = node->envelope_file; + part_type = "message"; + 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) ? 1 : 0, + notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0, + notmuch_message_get_filename (message)); + } else { + 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 && + strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0) + part_type = "attachment"; + else + part_type = "part"; + + printf ("\f%s{ ID: %d", part_type, node->part_num); + if (filename) + printf (", Filename: %s", filename); + if (cid) + printf (", Content-id: %s", cid); + printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type)); + } + + if (GMIME_IS_MESSAGE (node->part)) { + GMimeMessage *message = GMIME_MESSAGE (node->part); + InternetAddressList *recipients; + const char *recipients_string; + + printf ("\fheader{\n"); + if (node->envelope_file) + printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file)); + 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); + 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)); + printf ("\fheader}\n"); + + printf ("\fbody{\n"); + } + + if (leaf) { if (g_mime_content_type_is_type (content_type, "text", "*") && !g_mime_content_type_is_type (content_type, "text", "html")) { - show_part_content (part); + 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, 0); + g_object_unref(stream_stdout); + } else { + printf ("Non-text part: %s\n", + g_mime_content_type_to_string (content_type)); } + } + + for (i = 0; i < node->nchildren; i++) + 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_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); + } +} - printf ("\fattachment}\n"); +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 or S-Expression format should be + * reflected in the file devel/schemata. */ + if (node->envelope_file) { + sp->begin_map (sp); + format_message_sprinter (sp, node->envelope_file); + + sp->map_key (sp, "headers"); + format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE); + + 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; } - content_type = g_mime_object_get_content_type (GMIME_OBJECT (part)); + /* 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; + int nclose = 0; + int i; - printf ("\fpart{ ID: %d, Content-type: %s\n", - *part_count, - g_mime_content_type_to_string (content_type)); + sp->begin_map (sp); - if (g_mime_content_type_is_type (content_type, "text", "*") && - !g_mime_content_type_is_type (content_type, "text", "html")) - { - show_part_content (part); + sp->map_key (sp, "id"); + sp->integer (sp, node->part_num); + + 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); } - else - { - printf ("Non-text part: %s\n", - g_mime_content_type_to_string (content_type)); + + if (node->verify_attempted) { + sp->map_key (sp, "sigstatus"); + format_part_sigstatus_sprinter (sp, node); + } + + sp->map_key (sp, "content-type"); + sp->string (sp, g_mime_content_type_to_string (content_type)); + + if (cid) { + sp->map_key (sp, "content-id"); + sp->string (sp, cid); + } + + if (filename) { + sp->map_key (sp, "filename"); + sp->string (sp, filename); } - printf ("\fpart}\n"); + 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 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", "*") && + (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); + part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory)); + 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"); + sp->begin_list (sp); + nclose = 1; + } else if (GMIME_IS_MESSAGE (node->part)) { + sp->map_key (sp, "content"); + sp->begin_list (sp); + sp->begin_map (sp); + + sp->map_key (sp, "headers"); + format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE); + + sp->map_key (sp, "body"); + sp->begin_list (sp); + nclose = 3; + } + + for (i = 0; i < node->nchildren; i++) + format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html); + + /* Close content structures */ + for (i = 0; i < nclose; i++) + sp->end (sp); + /* Close part map */ + sp->end (sp); } -static void -show_message (void *ctx, notmuch_message_t *message, int indent) +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) { - const char *headers[] = { - "Subject", "From", "To", "Cc", "Bcc", "Date" - }; - const char *name, *value; - unsigned int i; + format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html); - printf ("\fmessage{ id:%s depth:%d filename:%s\n", - notmuch_message_get_message_id (message), - indent, - notmuch_message_get_filename (message)); + return NOTMUCH_STATUS_SUCCESS; +} + +/* 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)) +{ + 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]; - printf ("\fheader{\n"); + char *line = NULL; + size_t line_size; + ssize_t line_len; - printf ("%s\n", _get_one_line_summary (ctx, message)); + if (!message) + INTERNAL_ERROR ("format_part_mbox requires a root part"); - for (i = 0; i < ARRAY_SIZE (headers); i++) { - name = headers[i]; - value = notmuch_message_get_header (message, name); - if (value) - printf ("%s: %s\n", name, value); + 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; } - printf ("\fheader}\n"); - printf ("\fbody{\n"); + 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); - show_message_body (notmuch_message_get_filename (message), show_part); + 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); + } - printf ("\fbody}\n"); + printf ("\n"); - printf ("\fmessage}\n"); + fclose (file); + + return NOTMUCH_STATUS_SUCCESS; } +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]; -static void -show_messages (void *ctx, notmuch_messages_t *messages, int indent) + 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 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; + notmuch_bool_t excluded; + int next_indent; + notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; + + sp->begin_list (sp); for (; - notmuch_messages_has_more (messages); - notmuch_messages_advance (messages)) + notmuch_messages_valid (messages); + notmuch_messages_move_to_next (messages)) { + sp->begin_list (sp); + message = notmuch_messages_get (messages); - show_message (ctx, message, indent); + match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH); + excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED); - show_messages (ctx, notmuch_message_get_replies (message), indent + 1); + next_indent = indent; + + 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; + } else { + sp->null (sp); + } + + status = show_messages (ctx, + format, sp, + notmuch_message_get_replies (message), + next_indent, + params); + if (status && !res) + res = status; notmuch_message_destroy (message); + + sp->end (sp); } + + sp->end (sp); + + return res; } -int -notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) +/* Formatted output of single message */ +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_config_t *config; - notmuch_database_t *notmuch; - notmuch_query_t *query; - notmuch_threads_t *threads; - notmuch_thread_t *thread; notmuch_messages_t *messages; - char *query_string; + notmuch_message_t *message; + notmuch_status_t status; + unsigned int count; - config = notmuch_config_open (ctx, NULL, NULL); - if (config == NULL) + status = notmuch_query_count_messages_st (query, &count); + if (print_status_query ("notmuch show", query, status)) return 1; - query_string = query_string_from_args (ctx, argc, argv); - if (query_string == NULL) { - fprintf (stderr, "Out of memory\n"); + if (count != 1) { + fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count); return 1; } - if (*query_string == '\0') { - fprintf (stderr, "Error: notmuch show requires at least one search term.\n"); + status = notmuch_query_search_messages_st (query, &messages); + if (print_status_query ("notmuch show", query, status)) return 1; - } - notmuch = notmuch_database_open (notmuch_config_get_database_path (config), - NOTMUCH_DATABASE_MODE_READONLY); - if (notmuch == NULL) - return 1; + message = notmuch_messages_get (messages); - query = notmuch_query_create (notmuch, query_string); - if (query == NULL) { - fprintf (stderr, "Out of memory\n"); + if (message == NULL) { + fprintf (stderr, "Error: Cannot find matching message.\n"); return 1; } - for (threads = notmuch_query_search_threads (query, 0, -1); - notmuch_threads_has_more (threads); - notmuch_threads_advance (threads)) + notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1); + + return show_message (ctx, format, sp, message, 0, params) + != NOTMUCH_STATUS_SUCCESS; +} + +/* Formatted output of threads */ +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; + notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS; + + status= notmuch_query_search_threads_st (query, &threads); + if (print_status_query ("notmuch show", query, status)) + return 1; + + sp->begin_list (sp); + + for ( ; + notmuch_threads_valid (threads); + notmuch_threads_move_to_next (threads)) { thread = notmuch_threads_get (threads); @@ -243,13 +979,224 @@ notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[])) INTERNAL_ERROR ("Thread %s has no toplevel messages.\n", notmuch_thread_get_thread_id (thread)); - show_messages (ctx, messages, 0); + status = show_messages (ctx, format, sp, messages, 0, params); + if (status && !res) + res = status; notmuch_thread_destroy (thread); + + } + + sp->end (sp); + + 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 (notmuch_config_t *config, int argc, char *argv[]) +{ + notmuch_database_t *notmuch; + notmuch_query_t *query; + char *query_string; + int opt_index, ret; + const notmuch_show_format_t *format = &format_text; + 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; + int exclude = EXCLUDE_TRUE; + int entire_thread = ENTIRE_THREAD_DEFAULT; + + 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.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) + return EXIT_FAILURE; + + notmuch_process_shared_options (argv[0]); + + /* 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) + format_sel = NOTMUCH_FORMAT_RAW; + else + format_sel = NOTMUCH_FORMAT_TEXT; + } + + switch (format_sel) { + case NOTMUCH_FORMAT_JSON: + format = &format_json; + 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 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; + break; + } + + 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 || format == &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 { + 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; + + query_string = query_string_from_args (config, argc-opt_index, argv+opt_index); + if (query_string == NULL) { + fprintf (stderr, "Out of memory\n"); + return EXIT_FAILURE; + } + + if (*query_string == '\0') { + fprintf (stderr, "Error: notmuch show requires at least one search term.\n"); + return EXIT_FAILURE; + } + + 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 EXIT_FAILURE; + } + + /* 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 (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 (config, query, format, sprinter, ¶ms); } + notmuch_crypto_cleanup (¶ms.crypto); notmuch_query_destroy (query); - notmuch_database_close (notmuch); + notmuch_database_destroy (notmuch); - return 0; + return ret ? EXIT_FAILURE : EXIT_SUCCESS; }