]> git.notmuchmail.org Git - notmuch/blob - notmuch-show.c
42fe27cc99fca564f237f550c60db01d17408794
[notmuch] / notmuch-show.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
5  * This program is free software: you can redistribute it and/or modify
6  * it under the terms of the GNU General Public License as published by
7  * the Free Software Foundation, either version 3 of the License, or
8  * (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
13  * GNU General Public License for more details.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see https://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #include "notmuch-client.h"
22 #include "gmime-filter-reply.h"
23 #include "sprinter.h"
24
25 static const char *
26 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
27 {
28     notmuch_tags_t *tags;
29     int first = 1;
30     const char *tag;
31     char *result;
32
33     result = talloc_strdup (ctx, "");
34     if (result == NULL)
35         return NULL;
36
37     for (tags = notmuch_message_get_tags (message);
38          notmuch_tags_valid (tags);
39          notmuch_tags_move_to_next (tags))
40     {
41         tag = notmuch_tags_get (tags);
42
43         result = talloc_asprintf_append (result, "%s%s",
44                                          first ? "" : " ", tag);
45         first = 0;
46     }
47
48     return result;
49 }
50
51 /* Get a nice, single-line summary of message. */
52 static const char *
53 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
54 {
55     const char *from;
56     time_t date;
57     const char *relative_date;
58     const char *tags;
59
60     from = notmuch_message_get_header (message, "from");
61
62     date = notmuch_message_get_date (message);
63     relative_date = notmuch_time_relative_date (ctx, date);
64
65     tags = _get_tags_as_string (ctx, message);
66
67     return talloc_asprintf (ctx, "%s (%s) (%s)",
68                             from, relative_date, tags);
69 }
70
71 static const char *_get_disposition(GMimeObject *meta)
72 {
73     GMimeContentDisposition *disposition;
74
75     disposition = g_mime_object_get_content_disposition (meta);
76     if (!disposition)
77         return NULL;
78
79     return g_mime_content_disposition_get_disposition (disposition);
80 }
81
82 /* Emit a sequence of key/value pairs for the metadata of message.
83  * The caller should begin a map before calling this. */
84 static void
85 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
86 {
87     /* Any changes to the JSON or S-Expression format should be
88      * reflected in the file devel/schemata. */
89
90     void *local = talloc_new (NULL);
91     notmuch_tags_t *tags;
92     time_t date;
93     const char *relative_date;
94
95     sp->map_key (sp, "id");
96     sp->string (sp, notmuch_message_get_message_id (message));
97
98     sp->map_key (sp, "match");
99     sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
100
101     sp->map_key (sp, "excluded");
102     sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
103
104     sp->map_key (sp, "filename");
105     if (notmuch_format_version >= 3) {
106         notmuch_filenames_t *filenames;
107
108         sp->begin_list (sp);
109         for (filenames = notmuch_message_get_filenames (message);
110              notmuch_filenames_valid (filenames);
111              notmuch_filenames_move_to_next (filenames)) {
112             sp->string (sp, notmuch_filenames_get (filenames));
113         }
114         notmuch_filenames_destroy (filenames);
115         sp->end (sp);
116     } else {
117         sp->string (sp, notmuch_message_get_filename (message));
118     }
119
120     sp->map_key (sp, "timestamp");
121     date = notmuch_message_get_date (message);
122     sp->integer (sp, date);
123
124     sp->map_key (sp, "date_relative");
125     relative_date = notmuch_time_relative_date (local, date);
126     sp->string (sp, relative_date);
127
128     sp->map_key (sp, "tags");
129     sp->begin_list (sp);
130     for (tags = notmuch_message_get_tags (message);
131          notmuch_tags_valid (tags);
132          notmuch_tags_move_to_next (tags))
133         sp->string (sp, notmuch_tags_get (tags));
134     sp->end (sp);
135
136     talloc_free (local);
137 }
138
139 /* Extract just the email address from the contents of a From:
140  * header. */
141 static const char *
142 _extract_email_address (const void *ctx, const char *from)
143 {
144     InternetAddressList *addresses;
145     InternetAddress *address;
146     InternetAddressMailbox *mailbox;
147     const char *email = "MAILER-DAEMON";
148
149     addresses = internet_address_list_parse_string (from);
150
151     /* Bail if there is no address here. */
152     if (addresses == NULL || internet_address_list_length (addresses) < 1)
153         goto DONE;
154
155     /* Otherwise, just use the first address. */
156     address = internet_address_list_get_address (addresses, 0);
157
158     /* The From header should never contain an address group rather
159      * than a mailbox. So bail if it does. */
160     if (! INTERNET_ADDRESS_IS_MAILBOX (address))
161         goto DONE;
162
163     mailbox = INTERNET_ADDRESS_MAILBOX (address);
164     email = internet_address_mailbox_get_addr (mailbox);
165     email = talloc_strdup (ctx, email);
166
167   DONE:
168     if (addresses)
169         g_object_unref (addresses);
170
171     return email;
172    }
173
174 /* Return 1 if 'line' is an mbox From_ line---that is, a line
175  * beginning with zero or more '>' characters followed by the
176  * characters 'F', 'r', 'o', 'm', and space.
177  *
178  * Any characters at all may appear after that in the line.
179  */
180 static int
181 _is_from_line (const char *line)
182 {
183     const char *s = line;
184
185     if (line == NULL)
186         return 0;
187
188     while (*s == '>')
189         s++;
190
191     if (STRNCMP_LITERAL (s, "From ") == 0)
192         return 1;
193     else
194         return 0;
195 }
196
197 void
198 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
199                          bool reply)
200 {
201     /* Any changes to the JSON or S-Expression format should be
202      * reflected in the file devel/schemata. */
203
204     char *recipients_string;
205     const char *reply_to_string;
206     void *local = talloc_new (sp);
207
208     sp->begin_map (sp);
209
210     sp->map_key (sp, "Subject");
211     sp->string (sp, g_mime_message_get_subject (message));
212
213     sp->map_key (sp, "From");
214     sp->string (sp, g_mime_message_get_from_string (message));
215
216     recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
217     if (recipients_string) {
218         sp->map_key (sp, "To");
219         sp->string (sp, recipients_string);
220         g_free (recipients_string);
221     }
222
223     recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
224     if (recipients_string) {
225         sp->map_key (sp, "Cc");
226         sp->string (sp, recipients_string);
227         g_free (recipients_string);
228     }
229
230     recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_BCC);
231     if (recipients_string) {
232         sp->map_key (sp, "Bcc");
233         sp->string (sp, recipients_string);
234         g_free (recipients_string);
235     }
236
237     reply_to_string = g_mime_message_get_reply_to_string (local, message);
238     if (reply_to_string) {
239         sp->map_key (sp, "Reply-To");
240         sp->string (sp, reply_to_string);
241     }
242
243     if (reply) {
244         sp->map_key (sp, "In-reply-to");
245         sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
246
247         sp->map_key (sp, "References");
248         sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
249     } else {
250         sp->map_key (sp, "Date");
251         sp->string (sp, g_mime_message_get_date_string (sp, message));
252     }
253
254     sp->end (sp);
255     talloc_free (local);
256 }
257
258 /* Write a MIME text part out to the given stream.
259  *
260  * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
261  * each output line.
262  *
263  * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
264  * UTF-8) will be performed, so it is inappropriate to call this
265  * function with a non-text part. Doing so will trigger an internal
266  * error.
267  */
268 void
269 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
270                         notmuch_show_text_part_flags flags)
271 {
272     GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
273     GMimeStream *stream_filter = NULL;
274     GMimeFilter *crlf_filter = NULL;
275     GMimeFilter *windows_filter = NULL;
276     GMimeDataWrapper *wrapper;
277     const char *charset;
278
279     if (! g_mime_content_type_is_type (content_type, "text", "*"))
280         INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
281                         g_mime_content_type_to_string (content_type));
282
283     if (stream_out == NULL)
284         return;
285
286     charset = g_mime_object_get_content_type_parameter (part, "charset");
287     charset = charset ? g_mime_charset_canon_name (charset) : NULL;
288     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
289     if (wrapper && charset && !g_ascii_strncasecmp (charset, "iso-8859-", 9)) {
290         GMimeStream *null_stream = NULL;
291         GMimeStream *null_stream_filter = NULL;
292
293         /* Check for mislabeled Windows encoding */
294         null_stream = g_mime_stream_null_new ();
295         null_stream_filter = g_mime_stream_filter_new (null_stream);
296         windows_filter = g_mime_filter_windows_new (charset);
297         g_mime_stream_filter_add(GMIME_STREAM_FILTER (null_stream_filter),
298                                  windows_filter);
299         g_mime_data_wrapper_write_to_stream (wrapper, null_stream_filter);
300         charset = g_mime_filter_windows_real_charset(
301             (GMimeFilterWindows *) windows_filter);
302
303         if (null_stream_filter)
304             g_object_unref (null_stream_filter);
305         if (null_stream)
306             g_object_unref (null_stream);
307         /* Keep a reference to windows_filter in order to prevent the
308          * charset string from deallocation. */
309     }
310
311     stream_filter = g_mime_stream_filter_new (stream_out);
312     crlf_filter = g_mime_filter_crlf_new (false, false);
313     g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
314                              crlf_filter);
315     g_object_unref (crlf_filter);
316
317     if (charset) {
318         GMimeFilter *charset_filter;
319         charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
320         /* This result can be NULL for things like "unknown-8bit".
321          * Don't set a NULL filter as that makes GMime print
322          * annoying assertion-failure messages on stderr. */
323         if (charset_filter) {
324             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
325                                       charset_filter);
326             g_object_unref (charset_filter);
327         }
328
329     }
330
331     if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
332         GMimeFilter *reply_filter;
333         reply_filter = g_mime_filter_reply_new (true);
334         if (reply_filter) {
335             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
336                                       reply_filter);
337             g_object_unref (reply_filter);
338         }
339     }
340
341     if (wrapper && stream_filter)
342         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
343     if (stream_filter)
344         g_object_unref(stream_filter);
345     if (windows_filter)
346         g_object_unref (windows_filter);
347 }
348
349 static const char*
350 signature_status_to_string (GMimeSignatureStatus status)
351 {
352     if (g_mime_signature_status_bad (status))
353         return "bad";
354
355     if (g_mime_signature_status_error (status))
356         return "error";
357
358     if (g_mime_signature_status_good (status))
359         return "good";
360
361     return "unknown";
362 }
363
364 /* Print signature flags */
365 struct key_map_struct {
366     GMimeSignatureError bit;
367     const char * string;
368 };
369
370 static void
371 do_format_signature_errors (sprinter_t *sp, struct key_map_struct *key_map,
372                             unsigned int array_map_len, GMimeSignatureError errors) {
373     sp->map_key (sp, "errors");
374     sp->begin_map (sp);
375
376     for (unsigned int i = 0; i < array_map_len; i++) {
377         if (errors & key_map[i].bit) {
378             sp->map_key (sp, key_map[i].string);
379             sp->boolean (sp, true);
380         }
381     }
382
383     sp->end (sp);
384 }
385
386 #if (GMIME_MAJOR_VERSION < 3)
387 static void
388 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
389 {
390     GMimeSignatureError errors = g_mime_signature_get_errors (signature);
391
392     if (errors == GMIME_SIGNATURE_ERROR_NONE)
393         return;
394
395     struct key_map_struct key_map[] = {
396         { GMIME_SIGNATURE_ERROR_EXPSIG, "sig-expired" },
397         { GMIME_SIGNATURE_ERROR_NO_PUBKEY, "key-missing"},
398         { GMIME_SIGNATURE_ERROR_EXPKEYSIG, "key-expired"},
399         { GMIME_SIGNATURE_ERROR_REVKEYSIG, "key-revoked"},
400         { GMIME_SIGNATURE_ERROR_UNSUPP_ALGO, "alg-unsupported"},
401     };
402
403     do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
404 }
405 #else
406 static void
407 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
408 {
409     GMimeSignatureError errors = g_mime_signature_get_errors (signature);
410
411     if (!(errors & GMIME_SIGNATURE_STATUS_ERROR_MASK))
412         return;
413
414     struct key_map_struct key_map[] = {
415         { GMIME_SIGNATURE_STATUS_KEY_REVOKED, "key-revoked"},
416         { GMIME_SIGNATURE_STATUS_KEY_EXPIRED, "key-expired"},
417         { GMIME_SIGNATURE_STATUS_SIG_EXPIRED, "sig-expired" },
418         { GMIME_SIGNATURE_STATUS_KEY_MISSING, "key-missing"},
419         { GMIME_SIGNATURE_STATUS_CRL_MISSING, "crl-missing"},
420         { GMIME_SIGNATURE_STATUS_CRL_TOO_OLD, "crl-too-old"},
421         { GMIME_SIGNATURE_STATUS_BAD_POLICY, "bad-policy"},
422         { GMIME_SIGNATURE_STATUS_SYS_ERROR, "sys-error"},
423         { GMIME_SIGNATURE_STATUS_TOFU_CONFLICT, "tofu-conflict"},
424     };
425
426     do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
427 }
428 #endif
429
430 /* Signature status sprinter (GMime 2.6) */
431 static void
432 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
433 {
434     /* Any changes to the JSON or S-Expression format should be
435      * reflected in the file devel/schemata. */
436
437     GMimeSignatureList *siglist = node->sig_list;
438
439     sp->begin_list (sp);
440
441     if (!siglist) {
442         sp->end (sp);
443         return;
444     }
445
446     int i;
447     for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
448         GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
449
450         sp->begin_map (sp);
451
452         /* status */
453         GMimeSignatureStatus status = g_mime_signature_get_status (signature);
454         sp->map_key (sp, "status");
455         sp->string (sp, signature_status_to_string (status));
456
457         GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
458         if (g_mime_signature_status_good (status)) {
459             if (certificate) {
460                 sp->map_key (sp, "fingerprint");
461                 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
462             }
463             /* these dates are seconds since the epoch; should we
464              * provide a more human-readable format string? */
465             time_t created = g_mime_signature_get_created (signature);
466             if (created != -1) {
467                 sp->map_key (sp, "created");
468                 sp->integer (sp, created);
469             }
470             time_t expires = g_mime_signature_get_expires (signature);
471             if (expires > 0) {
472                 sp->map_key (sp, "expires");
473                 sp->integer (sp, expires);
474             }
475             if (certificate) {
476                 const char *uid = g_mime_certificate_get_valid_userid (certificate);
477                 if (uid) {
478                     sp->map_key (sp, "userid");
479                     sp->string (sp, uid);
480                 }
481             }
482         } else if (certificate) {
483             const char *key_id = g_mime_certificate_get_fpr16 (certificate);
484             if (key_id) {
485                 sp->map_key (sp, "keyid");
486                 sp->string (sp, key_id);
487             }
488         }
489
490         if (notmuch_format_version <= 3) {
491             GMimeSignatureError errors = g_mime_signature_get_errors (signature);
492             if (g_mime_signature_status_error (errors)) {
493                 sp->map_key (sp, "errors");
494                 sp->integer (sp, errors);
495             }
496         } else {
497             format_signature_errors (sp, signature);
498         }
499
500         sp->end (sp);
501      }
502
503     sp->end (sp);
504 }
505
506 static notmuch_status_t
507 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
508                   int indent, const notmuch_show_params_t *params)
509 {
510     /* The disposition and content-type metadata are associated with
511      * the envelope for message parts */
512     GMimeObject *meta = node->envelope_part ?
513         GMIME_OBJECT (node->envelope_part) : node->part;
514     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
515     const bool leaf = GMIME_IS_PART (node->part);
516     GMimeStream *stream = params->out_stream;
517     const char *part_type;
518     int i;
519
520     if (node->envelope_file) {
521         notmuch_message_t *message = node->envelope_file;
522
523         part_type = "message";
524         g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
525                               part_type,
526                               notmuch_message_get_message_id (message),
527                               indent,
528                               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
529                               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
530                               notmuch_message_get_filename (message));
531     } else {
532         char *content_string;
533         const char *disposition = _get_disposition (meta);
534         const char *cid = g_mime_object_get_content_id (meta);
535         const char *filename = leaf ?
536             g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
537
538         if (disposition &&
539             strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
540             part_type = "attachment";
541         else
542             part_type = "part";
543
544         g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
545         if (filename)
546             g_mime_stream_printf (stream, ", Filename: %s", filename);
547         if (cid)
548             g_mime_stream_printf (stream, ", Content-id: %s", cid);
549
550         content_string = g_mime_content_type_to_string (content_type);
551         g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
552         g_free (content_string);
553     }
554
555     if (GMIME_IS_MESSAGE (node->part)) {
556         GMimeMessage *message = GMIME_MESSAGE (node->part);
557         char *recipients_string;
558         char *date_string;
559
560         g_mime_stream_printf (stream, "\fheader{\n");
561         if (node->envelope_file)
562             g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
563         g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
564         g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
565         recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
566         if (recipients_string)
567             g_mime_stream_printf (stream, "To: %s\n", recipients_string);
568         g_free (recipients_string);
569         recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
570         if (recipients_string)
571             g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
572         g_free (recipients_string);
573         date_string = g_mime_message_get_date_string (node, message);
574         g_mime_stream_printf (stream, "Date: %s\n", date_string);
575         g_mime_stream_printf (stream, "\fheader}\n");
576
577         if (!params->output_body)
578         {
579             g_mime_stream_printf (stream, "\f%s}\n", part_type);
580             return NOTMUCH_STATUS_SUCCESS;
581         }
582         g_mime_stream_printf (stream, "\fbody{\n");
583     }
584
585     if (leaf) {
586         if (g_mime_content_type_is_type (content_type, "text", "*") &&
587             !g_mime_content_type_is_type (content_type, "text", "html"))
588         {
589             show_text_part_content (node->part, stream, 0);
590         } else {
591             char *content_string = g_mime_content_type_to_string (content_type);
592             g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
593             g_free (content_string);
594         }
595     }
596
597     for (i = 0; i < node->nchildren; i++)
598         format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
599
600     if (GMIME_IS_MESSAGE (node->part))
601         g_mime_stream_printf (stream, "\fbody}\n");
602
603     g_mime_stream_printf (stream, "\f%s}\n", part_type);
604
605     return NOTMUCH_STATUS_SUCCESS;
606 }
607
608 static void
609 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
610 {
611     const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
612     const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
613     GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
614     GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
615     ssize_t content_length = g_mime_stream_length (stream);
616
617     if (content_charset != NULL) {
618         sp->map_key (sp, "content-charset");
619         sp->string (sp, content_charset);
620     }
621     if (cte != NULL) {
622         sp->map_key (sp, "content-transfer-encoding");
623         sp->string (sp, cte);
624     }
625     if (content_length >= 0) {
626         sp->map_key (sp, "content-length");
627         sp->integer (sp, content_length);
628     }
629 }
630
631 void
632 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
633                       bool output_body,
634                       bool include_html)
635 {
636     /* Any changes to the JSON or S-Expression format should be
637      * reflected in the file devel/schemata. */
638
639     if (node->envelope_file) {
640         sp->begin_map (sp);
641         format_message_sprinter (sp, node->envelope_file);
642
643         sp->map_key (sp, "headers");
644         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
645
646         if (output_body) {
647             sp->map_key (sp, "body");
648             sp->begin_list (sp);
649             format_part_sprinter (ctx, sp, mime_node_child (node, 0), true, include_html);
650             sp->end (sp);
651         }
652         sp->end (sp);
653         return;
654     }
655
656     /* The disposition and content-type metadata are associated with
657      * the envelope for message parts */
658     GMimeObject *meta = node->envelope_part ?
659         GMIME_OBJECT (node->envelope_part) : node->part;
660     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
661     char *content_string;
662     const char *disposition = _get_disposition (meta);
663     const char *cid = g_mime_object_get_content_id (meta);
664     const char *filename = GMIME_IS_PART (node->part) ?
665         g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
666     int nclose = 0;
667     int i;
668
669     sp->begin_map (sp);
670
671     sp->map_key (sp, "id");
672     sp->integer (sp, node->part_num);
673
674     if (node->decrypt_attempted) {
675         sp->map_key (sp, "encstatus");
676         sp->begin_list (sp);
677         sp->begin_map (sp);
678         sp->map_key (sp, "status");
679         sp->string (sp, node->decrypt_success ? "good" : "bad");
680         sp->end (sp);
681         sp->end (sp);
682     }
683
684     if (node->verify_attempted) {
685         sp->map_key (sp, "sigstatus");
686         format_part_sigstatus_sprinter (sp, node);
687     }
688
689     sp->map_key (sp, "content-type");
690     content_string = g_mime_content_type_to_string (content_type);
691     sp->string (sp, content_string);
692     g_free (content_string);
693
694     if (disposition) {
695         sp->map_key (sp, "content-disposition");
696         sp->string (sp, disposition);
697     }
698
699     if (cid) {
700         sp->map_key (sp, "content-id");
701         sp->string (sp, cid);
702     }
703
704     if (filename) {
705         sp->map_key (sp, "filename");
706         sp->string (sp, filename);
707     }
708
709     if (GMIME_IS_PART (node->part)) {
710         /* For non-HTML text parts, we include the content in the
711          * JSON. Since JSON must be Unicode, we handle charset
712          * decoding here and do not report a charset to the caller.
713          * For text/html parts, we do not include the content unless
714          * the --include-html option has been passed. If a html part
715          * is not included, it can be requested directly. This makes
716          * charset decoding the responsibility on the caller so we
717          * report the charset for text/html parts.
718          */
719         if (g_mime_content_type_is_type (content_type, "text", "*") &&
720             (include_html ||
721              ! g_mime_content_type_is_type (content_type, "text", "html")))
722         {
723             GMimeStream *stream_memory = g_mime_stream_mem_new ();
724             GByteArray *part_content;
725             show_text_part_content (node->part, stream_memory, 0);
726             part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
727             sp->map_key (sp, "content");
728             sp->string_len (sp, (char *) part_content->data, part_content->len);
729             g_object_unref (stream_memory);
730         } else {
731             format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
732         }
733     } else if (GMIME_IS_MULTIPART (node->part)) {
734         sp->map_key (sp, "content");
735         sp->begin_list (sp);
736         nclose = 1;
737     } else if (GMIME_IS_MESSAGE (node->part)) {
738         sp->map_key (sp, "content");
739         sp->begin_list (sp);
740         sp->begin_map (sp);
741
742         sp->map_key (sp, "headers");
743         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
744
745         sp->map_key (sp, "body");
746         sp->begin_list (sp);
747         nclose = 3;
748     }
749
750     for (i = 0; i < node->nchildren; i++)
751         format_part_sprinter (ctx, sp, mime_node_child (node, i), true, include_html);
752
753     /* Close content structures */
754     for (i = 0; i < nclose; i++)
755         sp->end (sp);
756     /* Close part map */
757     sp->end (sp);
758 }
759
760 static notmuch_status_t
761 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
762                             mime_node_t *node, unused (int indent),
763                             const notmuch_show_params_t *params)
764 {
765     format_part_sprinter (ctx, sp, node, params->output_body, params->include_html);
766
767     return NOTMUCH_STATUS_SUCCESS;
768 }
769
770 /* Print a message in "mboxrd" format as documented, for example,
771  * here:
772  *
773  * http://qmail.org/qmail-manual-html/man5/mbox.html
774  */
775 static notmuch_status_t
776 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
777                   unused (int indent),
778                   unused (const notmuch_show_params_t *params))
779 {
780     notmuch_message_t *message = node->envelope_file;
781
782     const char *filename;
783     FILE *file;
784     const char *from;
785
786     time_t date;
787     struct tm date_gmtime;
788     char date_asctime[26];
789
790     char *line = NULL;
791     size_t line_size;
792     ssize_t line_len;
793
794     if (!message)
795         INTERNAL_ERROR ("format_part_mbox requires a root part");
796
797     filename = notmuch_message_get_filename (message);
798     file = fopen (filename, "r");
799     if (file == NULL) {
800         fprintf (stderr, "Failed to open %s: %s\n",
801                  filename, strerror (errno));
802         return NOTMUCH_STATUS_FILE_ERROR;
803     }
804
805     from = notmuch_message_get_header (message, "from");
806     from = _extract_email_address (ctx, from);
807
808     date = notmuch_message_get_date (message);
809     gmtime_r (&date, &date_gmtime);
810     asctime_r (&date_gmtime, date_asctime);
811
812     printf ("From %s %s", from, date_asctime);
813
814     while ((line_len = getline (&line, &line_size, file)) != -1 ) {
815         if (_is_from_line (line))
816             putchar ('>');
817         printf ("%s", line);
818     }
819
820     printf ("\n");
821
822     fclose (file);
823
824     return NOTMUCH_STATUS_SUCCESS;
825 }
826
827 static notmuch_status_t
828 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
829                  mime_node_t *node, unused (int indent),
830                  const notmuch_show_params_t *params)
831 {
832     if (node->envelope_file) {
833         /* Special case the entire message to avoid MIME parsing. */
834         const char *filename;
835         FILE *file;
836         size_t size;
837         char buf[4096];
838
839         filename = notmuch_message_get_filename (node->envelope_file);
840         if (filename == NULL) {
841             fprintf (stderr, "Error: Cannot get message filename.\n");
842             return NOTMUCH_STATUS_FILE_ERROR;
843         }
844
845         file = fopen (filename, "r");
846         if (file == NULL) {
847             fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
848             return NOTMUCH_STATUS_FILE_ERROR;
849         }
850
851         while (!feof (file)) {
852             size = fread (buf, 1, sizeof (buf), file);
853             if (ferror (file)) {
854                 fprintf (stderr, "Error: Read failed from %s\n", filename);
855                 fclose (file);
856                 return NOTMUCH_STATUS_FILE_ERROR;
857             }
858
859             if (fwrite (buf, size, 1, stdout) != 1) {
860                 fprintf (stderr, "Error: Write failed\n");
861                 fclose (file);
862                 return NOTMUCH_STATUS_FILE_ERROR;
863             }
864         }
865
866         fclose (file);
867         return NOTMUCH_STATUS_SUCCESS;
868     }
869
870     GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
871
872     if (GMIME_IS_PART (node->part)) {
873         /* For leaf parts, we emit only the transfer-decoded
874          * body. */
875         GMimeDataWrapper *wrapper;
876         wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
877
878         if (wrapper && stream_filter)
879             g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
880     } else {
881         /* Write out the whole part.  For message parts (the root
882          * part and embedded message parts), this will be the
883          * message including its headers (but not the
884          * encapsulating part's headers).  For multipart parts,
885          * this will include the headers. */
886         if (stream_filter)
887             g_mime_object_write_to_stream (node->part, stream_filter);
888     }
889
890     if (stream_filter)
891         g_object_unref (stream_filter);
892
893     return NOTMUCH_STATUS_SUCCESS;
894 }
895
896 static notmuch_status_t
897 show_message (void *ctx,
898               const notmuch_show_format_t *format,
899               sprinter_t *sp,
900               notmuch_message_t *message,
901               int indent,
902               notmuch_show_params_t *params)
903 {
904     void *local = talloc_new (ctx);
905     mime_node_t *root, *part;
906     notmuch_status_t status;
907     unsigned int session_keys = 0;
908     notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
909
910     if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
911         session_key_count_error = notmuch_message_count_properties (message, "session-key", &session_keys);
912
913     status = mime_node_open (local, message, &(params->crypto), &root);
914     if (status)
915         goto DONE;
916     part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
917     if (part)
918         status = format->part (local, sp, part, indent, params);
919 #if HAVE_GMIME_SESSION_KEYS
920     if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error == NOTMUCH_STATUS_SUCCESS) {
921         unsigned int new_session_keys = 0;
922         if (notmuch_message_count_properties (message, "session-key", &new_session_keys) == NOTMUCH_STATUS_SUCCESS &&
923             new_session_keys > session_keys) {
924             /* try a quiet re-indexing */
925             notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch_message_get_database (message));
926             if (indexopts) {
927                 notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
928                 print_status_message ("Error re-indexing message with --decrypt=stash",
929                                       message, notmuch_message_reindex (message, indexopts));
930             }
931         }
932     }
933 #endif
934   DONE:
935     talloc_free (local);
936     return status;
937 }
938
939 static notmuch_status_t
940 show_messages (void *ctx,
941                const notmuch_show_format_t *format,
942                sprinter_t *sp,
943                notmuch_messages_t *messages,
944                int indent,
945                notmuch_show_params_t *params)
946 {
947     notmuch_message_t *message;
948     bool match;
949     bool excluded;
950     int next_indent;
951     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
952
953     sp->begin_list (sp);
954
955     for (;
956          notmuch_messages_valid (messages);
957          notmuch_messages_move_to_next (messages))
958     {
959         sp->begin_list (sp);
960
961         message = notmuch_messages_get (messages);
962
963         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
964         excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
965
966         next_indent = indent;
967
968         if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
969             status = show_message (ctx, format, sp, message, indent, params);
970             if (status && !res)
971                 res = status;
972             next_indent = indent + 1;
973         } else {
974             sp->null (sp);
975         }
976
977         status = show_messages (ctx,
978                                 format, sp,
979                                 notmuch_message_get_replies (message),
980                                 next_indent,
981                                 params);
982         if (status && !res)
983             res = status;
984
985         notmuch_message_destroy (message);
986
987         sp->end (sp);
988     }
989
990     sp->end (sp);
991
992     return res;
993 }
994
995 /* Formatted output of single message */
996 static int
997 do_show_single (void *ctx,
998                 notmuch_query_t *query,
999                 const notmuch_show_format_t *format,
1000                 sprinter_t *sp,
1001                 notmuch_show_params_t *params)
1002 {
1003     notmuch_messages_t *messages;
1004     notmuch_message_t *message;
1005     notmuch_status_t status;
1006     unsigned int count;
1007
1008     status = notmuch_query_count_messages (query, &count);
1009     if (print_status_query ("notmuch show", query, status))
1010         return 1;
1011
1012     if (count != 1) {
1013         fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
1014         return 1;
1015     }
1016
1017     status = notmuch_query_search_messages (query, &messages);
1018     if (print_status_query ("notmuch show", query, status))
1019         return 1;
1020
1021     message = notmuch_messages_get (messages);
1022
1023     if (message == NULL) {
1024         fprintf (stderr, "Error: Cannot find matching message.\n");
1025         return 1;
1026     }
1027
1028     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
1029
1030     return show_message (ctx, format, sp, message, 0, params)
1031         != NOTMUCH_STATUS_SUCCESS;
1032 }
1033
1034 /* Formatted output of threads */
1035 static int
1036 do_show (void *ctx,
1037          notmuch_query_t *query,
1038          const notmuch_show_format_t *format,
1039          sprinter_t *sp,
1040          notmuch_show_params_t *params)
1041 {
1042     notmuch_threads_t *threads;
1043     notmuch_thread_t *thread;
1044     notmuch_messages_t *messages;
1045     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1046
1047     status= notmuch_query_search_threads (query, &threads);
1048     if (print_status_query ("notmuch show", query, status))
1049         return 1;
1050
1051     sp->begin_list (sp);
1052
1053     for ( ;
1054          notmuch_threads_valid (threads);
1055          notmuch_threads_move_to_next (threads))
1056     {
1057         thread = notmuch_threads_get (threads);
1058
1059         messages = notmuch_thread_get_toplevel_messages (thread);
1060
1061         if (messages == NULL)
1062             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
1063                             notmuch_thread_get_thread_id (thread));
1064
1065         status = show_messages (ctx, format, sp, messages, 0, params);
1066         if (status && !res)
1067             res = status;
1068
1069         notmuch_thread_destroy (thread);
1070
1071     }
1072
1073     sp->end (sp);
1074
1075     return res != NOTMUCH_STATUS_SUCCESS;
1076 }
1077
1078 enum {
1079     NOTMUCH_FORMAT_NOT_SPECIFIED,
1080     NOTMUCH_FORMAT_JSON,
1081     NOTMUCH_FORMAT_SEXP,
1082     NOTMUCH_FORMAT_TEXT,
1083     NOTMUCH_FORMAT_MBOX,
1084     NOTMUCH_FORMAT_RAW
1085 };
1086
1087 static const notmuch_show_format_t format_json = {
1088     .new_sprinter = sprinter_json_create,
1089     .part = format_part_sprinter_entry,
1090 };
1091
1092 static const notmuch_show_format_t format_sexp = {
1093     .new_sprinter = sprinter_sexp_create,
1094     .part = format_part_sprinter_entry,
1095 };
1096
1097 static const notmuch_show_format_t format_text = {
1098     .new_sprinter = sprinter_text_create,
1099     .part = format_part_text,
1100 };
1101
1102 static const notmuch_show_format_t format_mbox = {
1103     .new_sprinter = sprinter_text_create,
1104     .part = format_part_mbox,
1105 };
1106
1107 static const notmuch_show_format_t format_raw = {
1108     .new_sprinter = sprinter_text_create,
1109     .part = format_part_raw,
1110 };
1111
1112 static const notmuch_show_format_t *formatters[] = {
1113     [NOTMUCH_FORMAT_JSON] = &format_json,
1114     [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1115     [NOTMUCH_FORMAT_TEXT] = &format_text,
1116     [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1117     [NOTMUCH_FORMAT_RAW] = &format_raw,
1118 };
1119
1120 int
1121 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1122 {
1123     notmuch_database_t *notmuch;
1124     notmuch_query_t *query;
1125     char *query_string;
1126     int opt_index, ret;
1127     const notmuch_show_format_t *formatter;
1128     sprinter_t *sprinter;
1129     notmuch_show_params_t params = {
1130         .part = -1,
1131         .omit_excluded = true,
1132         .output_body = true,
1133         .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
1134     };
1135     int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1136     bool exclude = true;
1137     bool entire_thread_set = false;
1138     bool single_message;
1139
1140     notmuch_opt_desc_t options[] = {
1141         { .opt_keyword = &format, .name = "format", .keywords =
1142           (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1143                                   { "text", NOTMUCH_FORMAT_TEXT },
1144                                   { "sexp", NOTMUCH_FORMAT_SEXP },
1145                                   { "mbox", NOTMUCH_FORMAT_MBOX },
1146                                   { "raw", NOTMUCH_FORMAT_RAW },
1147                                   { 0, 0 } } },
1148         { .opt_int = &notmuch_format_version, .name = "format-version" },
1149         { .opt_bool = &exclude, .name = "exclude" },
1150         { .opt_bool = &params.entire_thread, .name = "entire-thread",
1151           .present = &entire_thread_set },
1152         { .opt_int = &params.part, .name = "part" },
1153         { .opt_keyword = (int*)(&params.crypto.decrypt), .name = "decrypt",
1154           .keyword_no_arg_value = "true", .keywords =
1155           (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
1156                                   { "auto", NOTMUCH_DECRYPT_AUTO },
1157                                   { "true", NOTMUCH_DECRYPT_NOSTASH },
1158                                   { "stash", NOTMUCH_DECRYPT_TRUE },
1159                                   { 0, 0 } } },
1160         { .opt_bool = &params.crypto.verify, .name = "verify" },
1161         { .opt_bool = &params.output_body, .name = "body" },
1162         { .opt_bool = &params.include_html, .name = "include-html" },
1163         { .opt_inherit = notmuch_shared_options },
1164         { }
1165     };
1166
1167     opt_index = parse_arguments (argc, argv, options, 1);
1168     if (opt_index < 0)
1169         return EXIT_FAILURE;
1170
1171     notmuch_process_shared_options (argv[0]);
1172
1173     /* explicit decryption implies verification */
1174     if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
1175         params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1176         params.crypto.verify = true;
1177
1178     /* specifying a part implies single message display */
1179     single_message = params.part >= 0;
1180
1181     if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1182         /* if part was requested and format was not specified, use format=raw */
1183         if (params.part >= 0)
1184             format = NOTMUCH_FORMAT_RAW;
1185         else
1186             format = NOTMUCH_FORMAT_TEXT;
1187     }
1188
1189     if (format == NOTMUCH_FORMAT_MBOX) {
1190         if (params.part > 0) {
1191             fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1192             return EXIT_FAILURE;
1193         }
1194     } else if (format == NOTMUCH_FORMAT_RAW) {
1195         /* raw format only supports single message display */
1196         single_message = true;
1197     }
1198
1199     notmuch_exit_if_unsupported_format ();
1200
1201     /* Default is entire-thread = false except for format=json and
1202      * format=sexp. */
1203     if (! entire_thread_set &&
1204         (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
1205         params.entire_thread = true;
1206
1207     if (!params.output_body) {
1208         if (params.part > 0) {
1209             fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1210             params.output_body = true;
1211         } else {
1212             if (format != NOTMUCH_FORMAT_TEXT &&
1213                 format != NOTMUCH_FORMAT_JSON &&
1214                 format != NOTMUCH_FORMAT_SEXP)
1215                 fprintf (stderr,
1216                          "Warning: --body=false only implemented for format=text, format=json and format=sexp\n");
1217         }
1218     }
1219
1220     if (params.include_html &&
1221         (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1222         fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1223     }
1224
1225     query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1226     if (query_string == NULL) {
1227         fprintf (stderr, "Out of memory\n");
1228         return EXIT_FAILURE;
1229     }
1230
1231     if (*query_string == '\0') {
1232         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1233         return EXIT_FAILURE;
1234     }
1235
1236 #if (GMIME_MAJOR_VERSION < 3)
1237     params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1238 #endif
1239
1240     notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1241     if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1242         mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
1243     if (notmuch_database_open (notmuch_config_get_database_path (config),
1244                                mode, &notmuch))
1245         return EXIT_FAILURE;
1246
1247     notmuch_exit_if_unmatched_db_uuid (notmuch);
1248
1249     query = notmuch_query_create (notmuch, query_string);
1250     if (query == NULL) {
1251         fprintf (stderr, "Out of memory\n");
1252         return EXIT_FAILURE;
1253     }
1254
1255     /* Create structure printer. */
1256     formatter = formatters[format];
1257     sprinter = formatter->new_sprinter(config, stdout);
1258
1259     params.out_stream = g_mime_stream_stdout_new ();
1260
1261     /* If a single message is requested we do not use search_excludes. */
1262     if (single_message) {
1263         ret = do_show_single (config, query, formatter, sprinter, &params);
1264     } else {
1265         /* We always apply set the exclude flag. The
1266          * exclude=true|false option controls whether or not we return
1267          * threads that only match in an excluded message */
1268         const char **search_exclude_tags;
1269         size_t search_exclude_tags_length;
1270         unsigned int i;
1271         notmuch_status_t status;
1272
1273         search_exclude_tags = notmuch_config_get_search_exclude_tags
1274             (config, &search_exclude_tags_length);
1275
1276         for (i = 0; i < search_exclude_tags_length; i++) {
1277             status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1278             if (status && status != NOTMUCH_STATUS_IGNORED) {
1279                 print_status_query ("notmuch show", query, status);
1280                 ret = -1;
1281                 goto DONE;
1282             }
1283         }
1284
1285         if (exclude == false) {
1286             notmuch_query_set_omit_excluded (query, false);
1287             params.omit_excluded = false;
1288         }
1289
1290         ret = do_show (config, query, formatter, sprinter, &params);
1291     }
1292
1293  DONE:
1294     g_mime_stream_flush (params.out_stream);
1295     g_object_unref (params.out_stream);
1296
1297     _notmuch_crypto_cleanup (&params.crypto);
1298     notmuch_query_destroy (query);
1299     notmuch_database_destroy (notmuch);
1300
1301     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
1302 }