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