07e9a5dbc8169e3618cea09bc1a7da8389b0040f
[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             (params->include_html ||
588              ! g_mime_content_type_is_type (content_type, "text", "html")))
589         {
590             show_text_part_content (node->part, stream, 0);
591         } else {
592             char *content_string = g_mime_content_type_to_string (content_type);
593             g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
594             g_free (content_string);
595         }
596     }
597
598     for (i = 0; i < node->nchildren; i++)
599         format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
600
601     if (GMIME_IS_MESSAGE (node->part))
602         g_mime_stream_printf (stream, "\fbody}\n");
603
604     g_mime_stream_printf (stream, "\f%s}\n", part_type);
605
606     return NOTMUCH_STATUS_SUCCESS;
607 }
608
609 static void
610 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
611 {
612     const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
613     const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
614     GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
615     GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
616     ssize_t content_length = g_mime_stream_length (stream);
617
618     if (content_charset != NULL) {
619         sp->map_key (sp, "content-charset");
620         sp->string (sp, content_charset);
621     }
622     if (cte != NULL) {
623         sp->map_key (sp, "content-transfer-encoding");
624         sp->string (sp, cte);
625     }
626     if (content_length >= 0) {
627         sp->map_key (sp, "content-length");
628         sp->integer (sp, content_length);
629     }
630 }
631
632 void
633 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
634                       bool output_body,
635                       bool include_html)
636 {
637     /* Any changes to the JSON or S-Expression format should be
638      * reflected in the file devel/schemata. */
639
640     if (node->envelope_file) {
641         sp->begin_map (sp);
642         format_message_sprinter (sp, node->envelope_file);
643
644         sp->map_key (sp, "headers");
645         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
646
647         if (output_body) {
648             sp->map_key (sp, "body");
649             sp->begin_list (sp);
650             format_part_sprinter (ctx, sp, mime_node_child (node, 0), true, include_html);
651             sp->end (sp);
652         }
653         sp->end (sp);
654         return;
655     }
656
657     /* The disposition and content-type metadata are associated with
658      * the envelope for message parts */
659     GMimeObject *meta = node->envelope_part ?
660         GMIME_OBJECT (node->envelope_part) : node->part;
661     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
662     char *content_string;
663     const char *disposition = _get_disposition (meta);
664     const char *cid = g_mime_object_get_content_id (meta);
665     const char *filename = GMIME_IS_PART (node->part) ?
666         g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
667     int nclose = 0;
668     int i;
669
670     sp->begin_map (sp);
671
672     sp->map_key (sp, "id");
673     sp->integer (sp, node->part_num);
674
675     if (node->decrypt_attempted) {
676         sp->map_key (sp, "encstatus");
677         sp->begin_list (sp);
678         sp->begin_map (sp);
679         sp->map_key (sp, "status");
680         sp->string (sp, node->decrypt_success ? "good" : "bad");
681         sp->end (sp);
682         sp->end (sp);
683     }
684
685     if (node->verify_attempted) {
686         sp->map_key (sp, "sigstatus");
687         format_part_sigstatus_sprinter (sp, node);
688     }
689
690     sp->map_key (sp, "content-type");
691     content_string = g_mime_content_type_to_string (content_type);
692     sp->string (sp, content_string);
693     g_free (content_string);
694
695     if (disposition) {
696         sp->map_key (sp, "content-disposition");
697         sp->string (sp, disposition);
698     }
699
700     if (cid) {
701         sp->map_key (sp, "content-id");
702         sp->string (sp, cid);
703     }
704
705     if (filename) {
706         sp->map_key (sp, "filename");
707         sp->string (sp, filename);
708     }
709
710     if (GMIME_IS_PART (node->part)) {
711         /* For non-HTML text parts, we include the content in the
712          * JSON. Since JSON must be Unicode, we handle charset
713          * decoding here and do not report a charset to the caller.
714          * For text/html parts, we do not include the content unless
715          * the --include-html option has been passed. If a html part
716          * is not included, it can be requested directly. This makes
717          * charset decoding the responsibility on the caller so we
718          * report the charset for text/html parts.
719          */
720         if (g_mime_content_type_is_type (content_type, "text", "*") &&
721             (include_html ||
722              ! g_mime_content_type_is_type (content_type, "text", "html")))
723         {
724             GMimeStream *stream_memory = g_mime_stream_mem_new ();
725             GByteArray *part_content;
726             show_text_part_content (node->part, stream_memory, 0);
727             part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
728             sp->map_key (sp, "content");
729             sp->string_len (sp, (char *) part_content->data, part_content->len);
730             g_object_unref (stream_memory);
731         } else {
732             format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
733         }
734     } else if (GMIME_IS_MULTIPART (node->part)) {
735         sp->map_key (sp, "content");
736         sp->begin_list (sp);
737         nclose = 1;
738     } else if (GMIME_IS_MESSAGE (node->part)) {
739         sp->map_key (sp, "content");
740         sp->begin_list (sp);
741         sp->begin_map (sp);
742
743         sp->map_key (sp, "headers");
744         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
745
746         sp->map_key (sp, "body");
747         sp->begin_list (sp);
748         nclose = 3;
749     }
750
751     for (i = 0; i < node->nchildren; i++)
752         format_part_sprinter (ctx, sp, mime_node_child (node, i), true, include_html);
753
754     /* Close content structures */
755     for (i = 0; i < nclose; i++)
756         sp->end (sp);
757     /* Close part map */
758     sp->end (sp);
759 }
760
761 static notmuch_status_t
762 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
763                             mime_node_t *node, unused (int indent),
764                             const notmuch_show_params_t *params)
765 {
766     format_part_sprinter (ctx, sp, node, params->output_body, params->include_html);
767
768     return NOTMUCH_STATUS_SUCCESS;
769 }
770
771 /* Print a message in "mboxrd" format as documented, for example,
772  * here:
773  *
774  * http://qmail.org/qmail-manual-html/man5/mbox.html
775  */
776 static notmuch_status_t
777 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
778                   unused (int indent),
779                   unused (const notmuch_show_params_t *params))
780 {
781     notmuch_message_t *message = node->envelope_file;
782
783     const char *filename;
784     FILE *file;
785     const char *from;
786
787     time_t date;
788     struct tm date_gmtime;
789     char date_asctime[26];
790
791     char *line = NULL;
792     size_t line_size;
793     ssize_t line_len;
794
795     if (!message)
796         INTERNAL_ERROR ("format_part_mbox requires a root part");
797
798     filename = notmuch_message_get_filename (message);
799     file = fopen (filename, "r");
800     if (file == NULL) {
801         fprintf (stderr, "Failed to open %s: %s\n",
802                  filename, strerror (errno));
803         return NOTMUCH_STATUS_FILE_ERROR;
804     }
805
806     from = notmuch_message_get_header (message, "from");
807     from = _extract_email_address (ctx, from);
808
809     date = notmuch_message_get_date (message);
810     gmtime_r (&date, &date_gmtime);
811     asctime_r (&date_gmtime, date_asctime);
812
813     printf ("From %s %s", from, date_asctime);
814
815     while ((line_len = getline (&line, &line_size, file)) != -1 ) {
816         if (_is_from_line (line))
817             putchar ('>');
818         printf ("%s", line);
819     }
820
821     printf ("\n");
822
823     fclose (file);
824
825     return NOTMUCH_STATUS_SUCCESS;
826 }
827
828 static notmuch_status_t
829 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
830                  mime_node_t *node, unused (int indent),
831                  const notmuch_show_params_t *params)
832 {
833     if (node->envelope_file) {
834         /* Special case the entire message to avoid MIME parsing. */
835         const char *filename;
836         FILE *file;
837         size_t size;
838         char buf[4096];
839
840         filename = notmuch_message_get_filename (node->envelope_file);
841         if (filename == NULL) {
842             fprintf (stderr, "Error: Cannot get message filename.\n");
843             return NOTMUCH_STATUS_FILE_ERROR;
844         }
845
846         file = fopen (filename, "r");
847         if (file == NULL) {
848             fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
849             return NOTMUCH_STATUS_FILE_ERROR;
850         }
851
852         while (!feof (file)) {
853             size = fread (buf, 1, sizeof (buf), file);
854             if (ferror (file)) {
855                 fprintf (stderr, "Error: Read failed from %s\n", filename);
856                 fclose (file);
857                 return NOTMUCH_STATUS_FILE_ERROR;
858             }
859
860             if (fwrite (buf, size, 1, stdout) != 1) {
861                 fprintf (stderr, "Error: Write failed\n");
862                 fclose (file);
863                 return NOTMUCH_STATUS_FILE_ERROR;
864             }
865         }
866
867         fclose (file);
868         return NOTMUCH_STATUS_SUCCESS;
869     }
870
871     GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
872
873     if (GMIME_IS_PART (node->part)) {
874         /* For leaf parts, we emit only the transfer-decoded
875          * body. */
876         GMimeDataWrapper *wrapper;
877         wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
878
879         if (wrapper && stream_filter)
880             g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
881     } else {
882         /* Write out the whole part.  For message parts (the root
883          * part and embedded message parts), this will be the
884          * message including its headers (but not the
885          * encapsulating part's headers).  For multipart parts,
886          * this will include the headers. */
887         if (stream_filter)
888             g_mime_object_write_to_stream (node->part, stream_filter);
889     }
890
891     if (stream_filter)
892         g_object_unref (stream_filter);
893
894     return NOTMUCH_STATUS_SUCCESS;
895 }
896
897 static notmuch_status_t
898 show_message (void *ctx,
899               const notmuch_show_format_t *format,
900               sprinter_t *sp,
901               notmuch_message_t *message,
902               int indent,
903               notmuch_show_params_t *params)
904 {
905     void *local = talloc_new (ctx);
906     mime_node_t *root, *part;
907     notmuch_status_t status;
908     unsigned int session_keys = 0;
909     notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
910
911     if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
912         session_key_count_error = notmuch_message_count_properties (message, "session-key", &session_keys);
913
914     status = mime_node_open (local, message, &(params->crypto), &root);
915     if (status)
916         goto DONE;
917     part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
918     if (part)
919         status = format->part (local, sp, part, indent, params);
920 #if HAVE_GMIME_SESSION_KEYS
921     if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error == NOTMUCH_STATUS_SUCCESS) {
922         unsigned int new_session_keys = 0;
923         if (notmuch_message_count_properties (message, "session-key", &new_session_keys) == NOTMUCH_STATUS_SUCCESS &&
924             new_session_keys > session_keys) {
925             /* try a quiet re-indexing */
926             notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch_message_get_database (message));
927             if (indexopts) {
928                 notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
929                 print_status_message ("Error re-indexing message with --decrypt=stash",
930                                       message, notmuch_message_reindex (message, indexopts));
931             }
932         }
933     }
934 #endif
935   DONE:
936     talloc_free (local);
937     return status;
938 }
939
940 static notmuch_status_t
941 show_messages (void *ctx,
942                const notmuch_show_format_t *format,
943                sprinter_t *sp,
944                notmuch_messages_t *messages,
945                int indent,
946                notmuch_show_params_t *params)
947 {
948     notmuch_message_t *message;
949     bool match;
950     bool excluded;
951     int next_indent;
952     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
953
954     sp->begin_list (sp);
955
956     for (;
957          notmuch_messages_valid (messages);
958          notmuch_messages_move_to_next (messages))
959     {
960         sp->begin_list (sp);
961
962         message = notmuch_messages_get (messages);
963
964         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
965         excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
966
967         next_indent = indent;
968
969         if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
970             status = show_message (ctx, format, sp, message, indent, params);
971             if (status && !res)
972                 res = status;
973             next_indent = indent + 1;
974         } else {
975             sp->null (sp);
976         }
977
978         status = show_messages (ctx,
979                                 format, sp,
980                                 notmuch_message_get_replies (message),
981                                 next_indent,
982                                 params);
983         if (status && !res)
984             res = status;
985
986         notmuch_message_destroy (message);
987
988         sp->end (sp);
989     }
990
991     sp->end (sp);
992
993     return res;
994 }
995
996 /* Formatted output of single message */
997 static int
998 do_show_single (void *ctx,
999                 notmuch_query_t *query,
1000                 const notmuch_show_format_t *format,
1001                 sprinter_t *sp,
1002                 notmuch_show_params_t *params)
1003 {
1004     notmuch_messages_t *messages;
1005     notmuch_message_t *message;
1006     notmuch_status_t status;
1007     unsigned int count;
1008
1009     status = notmuch_query_count_messages (query, &count);
1010     if (print_status_query ("notmuch show", query, status))
1011         return 1;
1012
1013     if (count != 1) {
1014         fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
1015         return 1;
1016     }
1017
1018     status = notmuch_query_search_messages (query, &messages);
1019     if (print_status_query ("notmuch show", query, status))
1020         return 1;
1021
1022     message = notmuch_messages_get (messages);
1023
1024     if (message == NULL) {
1025         fprintf (stderr, "Error: Cannot find matching message.\n");
1026         return 1;
1027     }
1028
1029     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
1030
1031     return show_message (ctx, format, sp, message, 0, params)
1032         != NOTMUCH_STATUS_SUCCESS;
1033 }
1034
1035 /* Formatted output of threads */
1036 static int
1037 do_show (void *ctx,
1038          notmuch_query_t *query,
1039          const notmuch_show_format_t *format,
1040          sprinter_t *sp,
1041          notmuch_show_params_t *params)
1042 {
1043     notmuch_threads_t *threads;
1044     notmuch_thread_t *thread;
1045     notmuch_messages_t *messages;
1046     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1047
1048     status= notmuch_query_search_threads (query, &threads);
1049     if (print_status_query ("notmuch show", query, status))
1050         return 1;
1051
1052     sp->begin_list (sp);
1053
1054     for ( ;
1055          notmuch_threads_valid (threads);
1056          notmuch_threads_move_to_next (threads))
1057     {
1058         thread = notmuch_threads_get (threads);
1059
1060         messages = notmuch_thread_get_toplevel_messages (thread);
1061
1062         if (messages == NULL)
1063             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
1064                             notmuch_thread_get_thread_id (thread));
1065
1066         status = show_messages (ctx, format, sp, messages, 0, params);
1067         if (status && !res)
1068             res = status;
1069
1070         notmuch_thread_destroy (thread);
1071
1072     }
1073
1074     sp->end (sp);
1075
1076     return res != NOTMUCH_STATUS_SUCCESS;
1077 }
1078
1079 enum {
1080     NOTMUCH_FORMAT_NOT_SPECIFIED,
1081     NOTMUCH_FORMAT_JSON,
1082     NOTMUCH_FORMAT_SEXP,
1083     NOTMUCH_FORMAT_TEXT,
1084     NOTMUCH_FORMAT_MBOX,
1085     NOTMUCH_FORMAT_RAW
1086 };
1087
1088 static const notmuch_show_format_t format_json = {
1089     .new_sprinter = sprinter_json_create,
1090     .part = format_part_sprinter_entry,
1091 };
1092
1093 static const notmuch_show_format_t format_sexp = {
1094     .new_sprinter = sprinter_sexp_create,
1095     .part = format_part_sprinter_entry,
1096 };
1097
1098 static const notmuch_show_format_t format_text = {
1099     .new_sprinter = sprinter_text_create,
1100     .part = format_part_text,
1101 };
1102
1103 static const notmuch_show_format_t format_mbox = {
1104     .new_sprinter = sprinter_text_create,
1105     .part = format_part_mbox,
1106 };
1107
1108 static const notmuch_show_format_t format_raw = {
1109     .new_sprinter = sprinter_text_create,
1110     .part = format_part_raw,
1111 };
1112
1113 static const notmuch_show_format_t *formatters[] = {
1114     [NOTMUCH_FORMAT_JSON] = &format_json,
1115     [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1116     [NOTMUCH_FORMAT_TEXT] = &format_text,
1117     [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1118     [NOTMUCH_FORMAT_RAW] = &format_raw,
1119 };
1120
1121 int
1122 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1123 {
1124     notmuch_database_t *notmuch;
1125     notmuch_query_t *query;
1126     char *query_string;
1127     int opt_index, ret;
1128     const notmuch_show_format_t *formatter;
1129     sprinter_t *sprinter;
1130     notmuch_show_params_t params = {
1131         .part = -1,
1132         .omit_excluded = true,
1133         .output_body = true,
1134         .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
1135     };
1136     int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1137     bool exclude = true;
1138     bool entire_thread_set = false;
1139     bool single_message;
1140
1141     notmuch_opt_desc_t options[] = {
1142         { .opt_keyword = &format, .name = "format", .keywords =
1143           (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1144                                   { "text", NOTMUCH_FORMAT_TEXT },
1145                                   { "sexp", NOTMUCH_FORMAT_SEXP },
1146                                   { "mbox", NOTMUCH_FORMAT_MBOX },
1147                                   { "raw", NOTMUCH_FORMAT_RAW },
1148                                   { 0, 0 } } },
1149         { .opt_int = &notmuch_format_version, .name = "format-version" },
1150         { .opt_bool = &exclude, .name = "exclude" },
1151         { .opt_bool = &params.entire_thread, .name = "entire-thread",
1152           .present = &entire_thread_set },
1153         { .opt_int = &params.part, .name = "part" },
1154         { .opt_keyword = (int*)(&params.crypto.decrypt), .name = "decrypt",
1155           .keyword_no_arg_value = "true", .keywords =
1156           (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
1157                                   { "auto", NOTMUCH_DECRYPT_AUTO },
1158                                   { "true", NOTMUCH_DECRYPT_NOSTASH },
1159                                   { "stash", NOTMUCH_DECRYPT_TRUE },
1160                                   { 0, 0 } } },
1161         { .opt_bool = &params.crypto.verify, .name = "verify" },
1162         { .opt_bool = &params.output_body, .name = "body" },
1163         { .opt_bool = &params.include_html, .name = "include-html" },
1164         { .opt_inherit = notmuch_shared_options },
1165         { }
1166     };
1167
1168     opt_index = parse_arguments (argc, argv, options, 1);
1169     if (opt_index < 0)
1170         return EXIT_FAILURE;
1171
1172     notmuch_process_shared_options (argv[0]);
1173
1174     /* explicit decryption implies verification */
1175     if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
1176         params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1177         params.crypto.verify = true;
1178
1179     /* specifying a part implies single message display */
1180     single_message = params.part >= 0;
1181
1182     if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1183         /* if part was requested and format was not specified, use format=raw */
1184         if (params.part >= 0)
1185             format = NOTMUCH_FORMAT_RAW;
1186         else
1187             format = NOTMUCH_FORMAT_TEXT;
1188     }
1189
1190     if (format == NOTMUCH_FORMAT_MBOX) {
1191         if (params.part > 0) {
1192             fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1193             return EXIT_FAILURE;
1194         }
1195     } else if (format == NOTMUCH_FORMAT_RAW) {
1196         /* raw format only supports single message display */
1197         single_message = true;
1198     }
1199
1200     notmuch_exit_if_unsupported_format ();
1201
1202     /* Default is entire-thread = false except for format=json and
1203      * format=sexp. */
1204     if (! entire_thread_set &&
1205         (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
1206         params.entire_thread = true;
1207
1208     if (!params.output_body) {
1209         if (params.part > 0) {
1210             fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1211             params.output_body = true;
1212         } else {
1213             if (format != NOTMUCH_FORMAT_TEXT &&
1214                 format != NOTMUCH_FORMAT_JSON &&
1215                 format != NOTMUCH_FORMAT_SEXP)
1216                 fprintf (stderr,
1217                          "Warning: --body=false only implemented for format=text, format=json and format=sexp\n");
1218         }
1219     }
1220
1221     if (params.include_html &&
1222         (format != NOTMUCH_FORMAT_TEXT &&
1223          format != NOTMUCH_FORMAT_JSON &&
1224          format != NOTMUCH_FORMAT_SEXP)) {
1225         fprintf (stderr, "Warning: --include-html only implemented for format=text, format=json and format=sexp\n");
1226     }
1227
1228     query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1229     if (query_string == NULL) {
1230         fprintf (stderr, "Out of memory\n");
1231         return EXIT_FAILURE;
1232     }
1233
1234     if (*query_string == '\0') {
1235         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1236         return EXIT_FAILURE;
1237     }
1238
1239 #if (GMIME_MAJOR_VERSION < 3)
1240     params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1241 #endif
1242
1243     notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1244     if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1245         mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
1246     if (notmuch_database_open (notmuch_config_get_database_path (config),
1247                                mode, &notmuch))
1248         return EXIT_FAILURE;
1249
1250     notmuch_exit_if_unmatched_db_uuid (notmuch);
1251
1252     query = notmuch_query_create (notmuch, query_string);
1253     if (query == NULL) {
1254         fprintf (stderr, "Out of memory\n");
1255         return EXIT_FAILURE;
1256     }
1257
1258     /* Create structure printer. */
1259     formatter = formatters[format];
1260     sprinter = formatter->new_sprinter(config, stdout);
1261
1262     params.out_stream = g_mime_stream_stdout_new ();
1263
1264     /* If a single message is requested we do not use search_excludes. */
1265     if (single_message) {
1266         ret = do_show_single (config, query, formatter, sprinter, &params);
1267     } else {
1268         /* We always apply set the exclude flag. The
1269          * exclude=true|false option controls whether or not we return
1270          * threads that only match in an excluded message */
1271         const char **search_exclude_tags;
1272         size_t search_exclude_tags_length;
1273         unsigned int i;
1274         notmuch_status_t status;
1275
1276         search_exclude_tags = notmuch_config_get_search_exclude_tags
1277             (config, &search_exclude_tags_length);
1278
1279         for (i = 0; i < search_exclude_tags_length; i++) {
1280             status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1281             if (status && status != NOTMUCH_STATUS_IGNORED) {
1282                 print_status_query ("notmuch show", query, status);
1283                 ret = -1;
1284                 goto DONE;
1285             }
1286         }
1287
1288         if (exclude == false) {
1289             notmuch_query_set_omit_excluded (query, false);
1290             params.omit_excluded = false;
1291         }
1292
1293         ret = do_show (config, query, formatter, sprinter, &params);
1294     }
1295
1296  DONE:
1297     g_mime_stream_flush (params.out_stream);
1298     g_object_unref (params.out_stream);
1299
1300     _notmuch_crypto_cleanup (&params.crypto);
1301     notmuch_query_destroy (query);
1302     notmuch_database_destroy (notmuch);
1303
1304     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
1305 }