cli: replace use of g_mime_message_get_recipients
[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                          notmuch_bool_t 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     GMimeDataWrapper *wrapper;
276     const char *charset;
277
278     if (! g_mime_content_type_is_type (content_type, "text", "*"))
279         INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
280                         g_mime_content_type_to_string (content_type));
281
282     if (stream_out == NULL)
283         return;
284
285     stream_filter = g_mime_stream_filter_new (stream_out);
286     crlf_filter = g_mime_filter_crlf_new (FALSE, FALSE);
287     g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
288                              crlf_filter);
289     g_object_unref (crlf_filter);
290
291     charset = g_mime_object_get_content_type_parameter (part, "charset");
292     if (charset) {
293         GMimeFilter *charset_filter;
294         charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
295         /* This result can be NULL for things like "unknown-8bit".
296          * Don't set a NULL filter as that makes GMime print
297          * annoying assertion-failure messages on stderr. */
298         if (charset_filter) {
299             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
300                                       charset_filter);
301             g_object_unref (charset_filter);
302         }
303
304     }
305
306     if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
307         GMimeFilter *reply_filter;
308         reply_filter = g_mime_filter_reply_new (TRUE);
309         if (reply_filter) {
310             g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
311                                       reply_filter);
312             g_object_unref (reply_filter);
313         }
314     }
315
316     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
317     if (wrapper && stream_filter)
318         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
319     if (stream_filter)
320         g_object_unref(stream_filter);
321 }
322
323 /* Get signature status string (GMime 2.6) */
324 static const char*
325 signature_status_to_string (GMimeSignatureStatus x)
326 {
327     switch (x) {
328     case GMIME_SIGNATURE_STATUS_GOOD:
329         return "good";
330     case GMIME_SIGNATURE_STATUS_BAD:
331         return "bad";
332     case GMIME_SIGNATURE_STATUS_ERROR:
333         return "error";
334     }
335     return "unknown";
336 }
337
338
339 /* Print signature flags */
340 struct key_map_struct {
341     GMimeSignatureError bit;
342     const char * string;
343 };
344
345 static void
346 do_format_signature_errors (sprinter_t *sp, struct key_map_struct *key_map,
347                             unsigned int array_map_len, GMimeSignatureError errors) {
348     sp->map_key (sp, "errors");
349     sp->begin_map (sp);
350
351     for (unsigned int i = 0; i < array_map_len; i++) {
352         if (errors & key_map[i].bit) {
353             sp->map_key (sp, key_map[i].string);
354             sp->boolean (sp, TRUE);
355         }
356     }
357
358     sp->end (sp);
359 }
360
361 static void
362 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
363 {
364     GMimeSignatureError errors = g_mime_signature_get_errors (signature);
365
366     if (errors == GMIME_SIGNATURE_ERROR_NONE)
367         return;
368
369     struct key_map_struct key_map[] = {
370         { GMIME_SIGNATURE_ERROR_EXPSIG, "sig-expired" },
371         { GMIME_SIGNATURE_ERROR_NO_PUBKEY, "key-missing"},
372         { GMIME_SIGNATURE_ERROR_EXPKEYSIG, "key-expired"},
373         { GMIME_SIGNATURE_ERROR_REVKEYSIG, "key-revoked"},
374         { GMIME_SIGNATURE_ERROR_UNSUPP_ALGO, "alg-unsupported"},
375     };
376
377     do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
378 }
379
380 /* Signature status sprinter (GMime 2.6) */
381 static void
382 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
383 {
384     /* Any changes to the JSON or S-Expression format should be
385      * reflected in the file devel/schemata. */
386
387     GMimeSignatureList *siglist = node->sig_list;
388
389     sp->begin_list (sp);
390
391     if (!siglist) {
392         sp->end (sp);
393         return;
394     }
395
396     int i;
397     for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
398         GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
399
400         sp->begin_map (sp);
401
402         /* status */
403         GMimeSignatureStatus status = g_mime_signature_get_status (signature);
404         sp->map_key (sp, "status");
405         sp->string (sp, signature_status_to_string (status));
406
407         GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
408         if (status == GMIME_SIGNATURE_STATUS_GOOD) {
409             if (certificate) {
410                 sp->map_key (sp, "fingerprint");
411                 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
412             }
413             /* these dates are seconds since the epoch; should we
414              * provide a more human-readable format string? */
415             time_t created = g_mime_signature_get_created (signature);
416             if (created != -1) {
417                 sp->map_key (sp, "created");
418                 sp->integer (sp, created);
419             }
420             time_t expires = g_mime_signature_get_expires (signature);
421             if (expires > 0) {
422                 sp->map_key (sp, "expires");
423                 sp->integer (sp, expires);
424             }
425             /* output user id only if validity is FULL or ULTIMATE. */
426             /* note that gmime is using the term "trust" here, which
427              * is WRONG.  It's actually user id "validity". */
428             if (certificate) {
429                 const char *name = g_mime_certificate_get_name (certificate);
430                 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
431                 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
432                     sp->map_key (sp, "userid");
433                     sp->string (sp, name);
434                 }
435             }
436         } else if (certificate) {
437             const char *key_id = g_mime_certificate_get_key_id (certificate);
438             if (key_id) {
439                 sp->map_key (sp, "keyid");
440                 sp->string (sp, key_id);
441             }
442         }
443
444         if (notmuch_format_version <= 3) {
445             GMimeSignatureError errors = g_mime_signature_get_errors (signature);
446             if (errors != GMIME_SIGNATURE_ERROR_NONE) {
447                 sp->map_key (sp, "errors");
448                 sp->integer (sp, errors);
449             }
450         } else {
451             format_signature_errors (sp, signature);
452         }
453
454         sp->end (sp);
455      }
456
457     sp->end (sp);
458 }
459
460 static notmuch_status_t
461 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
462                   int indent, const notmuch_show_params_t *params)
463 {
464     /* The disposition and content-type metadata are associated with
465      * the envelope for message parts */
466     GMimeObject *meta = node->envelope_part ?
467         GMIME_OBJECT (node->envelope_part) : node->part;
468     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
469     const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
470     GMimeStream *stream = params->out_stream;
471     const char *part_type;
472     int i;
473
474     if (node->envelope_file) {
475         notmuch_message_t *message = node->envelope_file;
476
477         part_type = "message";
478         g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
479                               part_type,
480                               notmuch_message_get_message_id (message),
481                               indent,
482                               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
483                               notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
484                               notmuch_message_get_filename (message));
485     } else {
486         char *content_string;
487         const char *disposition = _get_disposition (meta);
488         const char *cid = g_mime_object_get_content_id (meta);
489         const char *filename = leaf ?
490             g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
491
492         if (disposition &&
493             strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
494             part_type = "attachment";
495         else
496             part_type = "part";
497
498         g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
499         if (filename)
500             g_mime_stream_printf (stream, ", Filename: %s", filename);
501         if (cid)
502             g_mime_stream_printf (stream, ", Content-id: %s", cid);
503
504         content_string = g_mime_content_type_to_string (content_type);
505         g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
506         g_free (content_string);
507     }
508
509     if (GMIME_IS_MESSAGE (node->part)) {
510         GMimeMessage *message = GMIME_MESSAGE (node->part);
511         char *recipients_string;
512         char *date_string;
513
514         g_mime_stream_printf (stream, "\fheader{\n");
515         if (node->envelope_file)
516             g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
517         g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
518         g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
519         recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
520         if (recipients_string)
521             g_mime_stream_printf (stream, "To: %s\n", recipients_string);
522         g_free (recipients_string);
523         recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
524         if (recipients_string)
525             g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
526         g_free (recipients_string);
527         date_string = g_mime_message_get_date_string (node, message);
528         g_mime_stream_printf (stream, "Date: %s\n", date_string);
529         g_mime_stream_printf (stream, "\fheader}\n");
530
531         g_mime_stream_printf (stream, "\fbody{\n");
532     }
533
534     if (leaf) {
535         if (g_mime_content_type_is_type (content_type, "text", "*") &&
536             !g_mime_content_type_is_type (content_type, "text", "html"))
537         {
538             show_text_part_content (node->part, stream, 0);
539         } else {
540             char *content_string = g_mime_content_type_to_string (content_type);
541             g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
542             g_free (content_string);
543         }
544     }
545
546     for (i = 0; i < node->nchildren; i++)
547         format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
548
549     if (GMIME_IS_MESSAGE (node->part))
550         g_mime_stream_printf (stream, "\fbody}\n");
551
552     g_mime_stream_printf (stream, "\f%s}\n", part_type);
553
554     return NOTMUCH_STATUS_SUCCESS;
555 }
556
557 static void
558 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
559 {
560     const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
561     const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
562     GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
563     GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
564     ssize_t content_length = g_mime_stream_length (stream);
565
566     if (content_charset != NULL) {
567         sp->map_key (sp, "content-charset");
568         sp->string (sp, content_charset);
569     }
570     if (cte != NULL) {
571         sp->map_key (sp, "content-transfer-encoding");
572         sp->string (sp, cte);
573     }
574     if (content_length >= 0) {
575         sp->map_key (sp, "content-length");
576         sp->integer (sp, content_length);
577     }
578 }
579
580 void
581 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
582                       notmuch_bool_t first, notmuch_bool_t output_body,
583                       notmuch_bool_t include_html)
584 {
585     /* Any changes to the JSON or S-Expression format should be
586      * reflected in the file devel/schemata. */
587
588     if (node->envelope_file) {
589         sp->begin_map (sp);
590         format_message_sprinter (sp, node->envelope_file);
591
592         sp->map_key (sp, "headers");
593         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
594
595         if (output_body) {
596             sp->map_key (sp, "body");
597             sp->begin_list (sp);
598             format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
599             sp->end (sp);
600         }
601         sp->end (sp);
602         return;
603     }
604
605     /* The disposition and content-type metadata are associated with
606      * the envelope for message parts */
607     GMimeObject *meta = node->envelope_part ?
608         GMIME_OBJECT (node->envelope_part) : node->part;
609     GMimeContentType *content_type = g_mime_object_get_content_type (meta);
610     char *content_string;
611     const char *disposition = _get_disposition (meta);
612     const char *cid = g_mime_object_get_content_id (meta);
613     const char *filename = GMIME_IS_PART (node->part) ?
614         g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
615     int nclose = 0;
616     int i;
617
618     sp->begin_map (sp);
619
620     sp->map_key (sp, "id");
621     sp->integer (sp, node->part_num);
622
623     if (node->decrypt_attempted) {
624         sp->map_key (sp, "encstatus");
625         sp->begin_list (sp);
626         sp->begin_map (sp);
627         sp->map_key (sp, "status");
628         sp->string (sp, node->decrypt_success ? "good" : "bad");
629         sp->end (sp);
630         sp->end (sp);
631     }
632
633     if (node->verify_attempted) {
634         sp->map_key (sp, "sigstatus");
635         format_part_sigstatus_sprinter (sp, node);
636     }
637
638     sp->map_key (sp, "content-type");
639     content_string = g_mime_content_type_to_string (content_type);
640     sp->string (sp, content_string);
641     g_free (content_string);
642
643     if (disposition) {
644         sp->map_key (sp, "content-disposition");
645         sp->string (sp, disposition);
646     }
647
648     if (cid) {
649         sp->map_key (sp, "content-id");
650         sp->string (sp, cid);
651     }
652
653     if (filename) {
654         sp->map_key (sp, "filename");
655         sp->string (sp, filename);
656     }
657
658     if (GMIME_IS_PART (node->part)) {
659         /* For non-HTML text parts, we include the content in the
660          * JSON. Since JSON must be Unicode, we handle charset
661          * decoding here and do not report a charset to the caller.
662          * For text/html parts, we do not include the content unless
663          * the --include-html option has been passed. If a html part
664          * is not included, it can be requested directly. This makes
665          * charset decoding the responsibility on the caller so we
666          * report the charset for text/html parts.
667          */
668         if (g_mime_content_type_is_type (content_type, "text", "*") &&
669             (include_html ||
670              ! g_mime_content_type_is_type (content_type, "text", "html")))
671         {
672             GMimeStream *stream_memory = g_mime_stream_mem_new ();
673             GByteArray *part_content;
674             show_text_part_content (node->part, stream_memory, 0);
675             part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
676             sp->map_key (sp, "content");
677             sp->string_len (sp, (char *) part_content->data, part_content->len);
678             g_object_unref (stream_memory);
679         } else {
680             format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
681         }
682     } else if (GMIME_IS_MULTIPART (node->part)) {
683         sp->map_key (sp, "content");
684         sp->begin_list (sp);
685         nclose = 1;
686     } else if (GMIME_IS_MESSAGE (node->part)) {
687         sp->map_key (sp, "content");
688         sp->begin_list (sp);
689         sp->begin_map (sp);
690
691         sp->map_key (sp, "headers");
692         format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
693
694         sp->map_key (sp, "body");
695         sp->begin_list (sp);
696         nclose = 3;
697     }
698
699     for (i = 0; i < node->nchildren; i++)
700         format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
701
702     /* Close content structures */
703     for (i = 0; i < nclose; i++)
704         sp->end (sp);
705     /* Close part map */
706     sp->end (sp);
707 }
708
709 static notmuch_status_t
710 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
711                             mime_node_t *node, unused (int indent),
712                             const notmuch_show_params_t *params)
713 {
714     format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
715
716     return NOTMUCH_STATUS_SUCCESS;
717 }
718
719 /* Print a message in "mboxrd" format as documented, for example,
720  * here:
721  *
722  * http://qmail.org/qmail-manual-html/man5/mbox.html
723  */
724 static notmuch_status_t
725 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
726                   unused (int indent),
727                   unused (const notmuch_show_params_t *params))
728 {
729     notmuch_message_t *message = node->envelope_file;
730
731     const char *filename;
732     FILE *file;
733     const char *from;
734
735     time_t date;
736     struct tm date_gmtime;
737     char date_asctime[26];
738
739     char *line = NULL;
740     size_t line_size;
741     ssize_t line_len;
742
743     if (!message)
744         INTERNAL_ERROR ("format_part_mbox requires a root part");
745
746     filename = notmuch_message_get_filename (message);
747     file = fopen (filename, "r");
748     if (file == NULL) {
749         fprintf (stderr, "Failed to open %s: %s\n",
750                  filename, strerror (errno));
751         return NOTMUCH_STATUS_FILE_ERROR;
752     }
753
754     from = notmuch_message_get_header (message, "from");
755     from = _extract_email_address (ctx, from);
756
757     date = notmuch_message_get_date (message);
758     gmtime_r (&date, &date_gmtime);
759     asctime_r (&date_gmtime, date_asctime);
760
761     printf ("From %s %s", from, date_asctime);
762
763     while ((line_len = getline (&line, &line_size, file)) != -1 ) {
764         if (_is_from_line (line))
765             putchar ('>');
766         printf ("%s", line);
767     }
768
769     printf ("\n");
770
771     fclose (file);
772
773     return NOTMUCH_STATUS_SUCCESS;
774 }
775
776 static notmuch_status_t
777 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
778                  mime_node_t *node, unused (int indent),
779                  const notmuch_show_params_t *params)
780 {
781     if (node->envelope_file) {
782         /* Special case the entire message to avoid MIME parsing. */
783         const char *filename;
784         FILE *file;
785         size_t size;
786         char buf[4096];
787
788         filename = notmuch_message_get_filename (node->envelope_file);
789         if (filename == NULL) {
790             fprintf (stderr, "Error: Cannot get message filename.\n");
791             return NOTMUCH_STATUS_FILE_ERROR;
792         }
793
794         file = fopen (filename, "r");
795         if (file == NULL) {
796             fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
797             return NOTMUCH_STATUS_FILE_ERROR;
798         }
799
800         while (!feof (file)) {
801             size = fread (buf, 1, sizeof (buf), file);
802             if (ferror (file)) {
803                 fprintf (stderr, "Error: Read failed from %s\n", filename);
804                 fclose (file);
805                 return NOTMUCH_STATUS_FILE_ERROR;
806             }
807
808             if (fwrite (buf, size, 1, stdout) != 1) {
809                 fprintf (stderr, "Error: Write failed\n");
810                 fclose (file);
811                 return NOTMUCH_STATUS_FILE_ERROR;
812             }
813         }
814
815         fclose (file);
816         return NOTMUCH_STATUS_SUCCESS;
817     }
818
819     GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
820
821     if (GMIME_IS_PART (node->part)) {
822         /* For leaf parts, we emit only the transfer-decoded
823          * body. */
824         GMimeDataWrapper *wrapper;
825         wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
826
827         if (wrapper && stream_filter)
828             g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
829     } else {
830         /* Write out the whole part.  For message parts (the root
831          * part and embedded message parts), this will be the
832          * message including its headers (but not the
833          * encapsulating part's headers).  For multipart parts,
834          * this will include the headers. */
835         if (stream_filter)
836             g_mime_object_write_to_stream (node->part, stream_filter);
837     }
838
839     if (stream_filter)
840         g_object_unref (stream_filter);
841
842     return NOTMUCH_STATUS_SUCCESS;
843 }
844
845 static notmuch_status_t
846 show_message (void *ctx,
847               const notmuch_show_format_t *format,
848               sprinter_t *sp,
849               notmuch_message_t *message,
850               int indent,
851               notmuch_show_params_t *params)
852 {
853     void *local = talloc_new (ctx);
854     mime_node_t *root, *part;
855     notmuch_status_t status;
856
857     status = mime_node_open (local, message, &(params->crypto), &root);
858     if (status)
859         goto DONE;
860     part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
861     if (part)
862         status = format->part (local, sp, part, indent, params);
863   DONE:
864     talloc_free (local);
865     return status;
866 }
867
868 static notmuch_status_t
869 show_messages (void *ctx,
870                const notmuch_show_format_t *format,
871                sprinter_t *sp,
872                notmuch_messages_t *messages,
873                int indent,
874                notmuch_show_params_t *params)
875 {
876     notmuch_message_t *message;
877     notmuch_bool_t match;
878     notmuch_bool_t excluded;
879     int next_indent;
880     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
881
882     sp->begin_list (sp);
883
884     for (;
885          notmuch_messages_valid (messages);
886          notmuch_messages_move_to_next (messages))
887     {
888         sp->begin_list (sp);
889
890         message = notmuch_messages_get (messages);
891
892         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
893         excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
894
895         next_indent = indent;
896
897         if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
898             status = show_message (ctx, format, sp, message, indent, params);
899             if (status && !res)
900                 res = status;
901             next_indent = indent + 1;
902         } else {
903             sp->null (sp);
904         }
905
906         status = show_messages (ctx,
907                                 format, sp,
908                                 notmuch_message_get_replies (message),
909                                 next_indent,
910                                 params);
911         if (status && !res)
912             res = status;
913
914         notmuch_message_destroy (message);
915
916         sp->end (sp);
917     }
918
919     sp->end (sp);
920
921     return res;
922 }
923
924 /* Formatted output of single message */
925 static int
926 do_show_single (void *ctx,
927                 notmuch_query_t *query,
928                 const notmuch_show_format_t *format,
929                 sprinter_t *sp,
930                 notmuch_show_params_t *params)
931 {
932     notmuch_messages_t *messages;
933     notmuch_message_t *message;
934     notmuch_status_t status;
935     unsigned int count;
936
937     status = notmuch_query_count_messages (query, &count);
938     if (print_status_query ("notmuch show", query, status))
939         return 1;
940
941     if (count != 1) {
942         fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
943         return 1;
944     }
945
946     status = notmuch_query_search_messages (query, &messages);
947     if (print_status_query ("notmuch show", query, status))
948         return 1;
949
950     message = notmuch_messages_get (messages);
951
952     if (message == NULL) {
953         fprintf (stderr, "Error: Cannot find matching message.\n");
954         return 1;
955     }
956
957     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
958
959     return show_message (ctx, format, sp, message, 0, params)
960         != NOTMUCH_STATUS_SUCCESS;
961 }
962
963 /* Formatted output of threads */
964 static int
965 do_show (void *ctx,
966          notmuch_query_t *query,
967          const notmuch_show_format_t *format,
968          sprinter_t *sp,
969          notmuch_show_params_t *params)
970 {
971     notmuch_threads_t *threads;
972     notmuch_thread_t *thread;
973     notmuch_messages_t *messages;
974     notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
975
976     status= notmuch_query_search_threads (query, &threads);
977     if (print_status_query ("notmuch show", query, status))
978         return 1;
979
980     sp->begin_list (sp);
981
982     for ( ;
983          notmuch_threads_valid (threads);
984          notmuch_threads_move_to_next (threads))
985     {
986         thread = notmuch_threads_get (threads);
987
988         messages = notmuch_thread_get_toplevel_messages (thread);
989
990         if (messages == NULL)
991             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
992                             notmuch_thread_get_thread_id (thread));
993
994         status = show_messages (ctx, format, sp, messages, 0, params);
995         if (status && !res)
996             res = status;
997
998         notmuch_thread_destroy (thread);
999
1000     }
1001
1002     sp->end (sp);
1003
1004     return res != NOTMUCH_STATUS_SUCCESS;
1005 }
1006
1007 enum {
1008     NOTMUCH_FORMAT_NOT_SPECIFIED,
1009     NOTMUCH_FORMAT_JSON,
1010     NOTMUCH_FORMAT_SEXP,
1011     NOTMUCH_FORMAT_TEXT,
1012     NOTMUCH_FORMAT_MBOX,
1013     NOTMUCH_FORMAT_RAW
1014 };
1015
1016 static const notmuch_show_format_t format_json = {
1017     .new_sprinter = sprinter_json_create,
1018     .part = format_part_sprinter_entry,
1019 };
1020
1021 static const notmuch_show_format_t format_sexp = {
1022     .new_sprinter = sprinter_sexp_create,
1023     .part = format_part_sprinter_entry,
1024 };
1025
1026 static const notmuch_show_format_t format_text = {
1027     .new_sprinter = sprinter_text_create,
1028     .part = format_part_text,
1029 };
1030
1031 static const notmuch_show_format_t format_mbox = {
1032     .new_sprinter = sprinter_text_create,
1033     .part = format_part_mbox,
1034 };
1035
1036 static const notmuch_show_format_t format_raw = {
1037     .new_sprinter = sprinter_text_create,
1038     .part = format_part_raw,
1039 };
1040
1041 static const notmuch_show_format_t *formatters[] = {
1042     [NOTMUCH_FORMAT_JSON] = &format_json,
1043     [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1044     [NOTMUCH_FORMAT_TEXT] = &format_text,
1045     [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1046     [NOTMUCH_FORMAT_RAW] = &format_raw,
1047 };
1048
1049 int
1050 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1051 {
1052     notmuch_database_t *notmuch;
1053     notmuch_query_t *query;
1054     char *query_string;
1055     int opt_index, ret;
1056     const notmuch_show_format_t *formatter;
1057     sprinter_t *sprinter;
1058     notmuch_show_params_t params = {
1059         .part = -1,
1060         .omit_excluded = TRUE,
1061         .output_body = TRUE,
1062     };
1063     int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1064     int exclude = TRUE;
1065
1066     /* This value corresponds to neither true nor false being passed
1067      * on the command line */
1068     int entire_thread = -1;
1069     notmuch_bool_t single_message;
1070
1071     notmuch_opt_desc_t options[] = {
1072         { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
1073           (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1074                                   { "text", NOTMUCH_FORMAT_TEXT },
1075                                   { "sexp", NOTMUCH_FORMAT_SEXP },
1076                                   { "mbox", NOTMUCH_FORMAT_MBOX },
1077                                   { "raw", NOTMUCH_FORMAT_RAW },
1078                                   { 0, 0 } } },
1079         { NOTMUCH_OPT_INT, &notmuch_format_version, "format-version", 0, 0 },
1080         { NOTMUCH_OPT_BOOLEAN, &exclude, "exclude", 'x', 0 },
1081         { NOTMUCH_OPT_BOOLEAN, &entire_thread, "entire-thread", 't', 0 },
1082         { NOTMUCH_OPT_INT, &params.part, "part", 'p', 0 },
1083         { NOTMUCH_OPT_BOOLEAN, &params.crypto.decrypt, "decrypt", 'd', 0 },
1084         { NOTMUCH_OPT_BOOLEAN, &params.crypto.verify, "verify", 'v', 0 },
1085         { NOTMUCH_OPT_BOOLEAN, &params.output_body, "body", 'b', 0 },
1086         { NOTMUCH_OPT_BOOLEAN, &params.include_html, "include-html", 0, 0 },
1087         { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
1088         { 0, 0, 0, 0, 0 }
1089     };
1090
1091     opt_index = parse_arguments (argc, argv, options, 1);
1092     if (opt_index < 0)
1093         return EXIT_FAILURE;
1094
1095     notmuch_process_shared_options (argv[0]);
1096
1097     /* decryption implies verification */
1098     if (params.crypto.decrypt)
1099         params.crypto.verify = TRUE;
1100
1101     /* specifying a part implies single message display */
1102     single_message = params.part >= 0;
1103
1104     if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1105         /* if part was requested and format was not specified, use format=raw */
1106         if (params.part >= 0)
1107             format = NOTMUCH_FORMAT_RAW;
1108         else
1109             format = NOTMUCH_FORMAT_TEXT;
1110     }
1111
1112     if (format == NOTMUCH_FORMAT_MBOX) {
1113         if (params.part > 0) {
1114             fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1115             return EXIT_FAILURE;
1116         }
1117     } else if (format == NOTMUCH_FORMAT_RAW) {
1118         /* raw format only supports single message display */
1119         single_message = TRUE;
1120     }
1121
1122     notmuch_exit_if_unsupported_format ();
1123
1124     /* Default is entire-thread = FALSE except for format=json and
1125      * format=sexp. */
1126     if (entire_thread != FALSE && entire_thread != TRUE) {
1127         if (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP)
1128             params.entire_thread = TRUE;
1129         else
1130             params.entire_thread = FALSE;
1131     } else {
1132         params.entire_thread = entire_thread;
1133     }
1134
1135     if (!params.output_body) {
1136         if (params.part > 0) {
1137             fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1138             params.output_body = TRUE;
1139         } else {
1140             if (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)
1141                 fprintf (stderr,
1142                          "Warning: --body=false only implemented for format=json and format=sexp\n");
1143         }
1144     }
1145
1146     if (params.include_html &&
1147         (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1148         fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1149     }
1150
1151     query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1152     if (query_string == NULL) {
1153         fprintf (stderr, "Out of memory\n");
1154         return EXIT_FAILURE;
1155     }
1156
1157     if (*query_string == '\0') {
1158         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1159         return EXIT_FAILURE;
1160     }
1161
1162     params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1163
1164     if (notmuch_database_open (notmuch_config_get_database_path (config),
1165                                NOTMUCH_DATABASE_MODE_READ_ONLY, &notmuch))
1166         return EXIT_FAILURE;
1167
1168     notmuch_exit_if_unmatched_db_uuid (notmuch);
1169
1170     query = notmuch_query_create (notmuch, query_string);
1171     if (query == NULL) {
1172         fprintf (stderr, "Out of memory\n");
1173         return EXIT_FAILURE;
1174     }
1175
1176     /* Create structure printer. */
1177     formatter = formatters[format];
1178     sprinter = formatter->new_sprinter(config, stdout);
1179
1180     params.out_stream = g_mime_stream_stdout_new ();
1181
1182     /* If a single message is requested we do not use search_excludes. */
1183     if (single_message) {
1184         ret = do_show_single (config, query, formatter, sprinter, &params);
1185     } else {
1186         /* We always apply set the exclude flag. The
1187          * exclude=true|false option controls whether or not we return
1188          * threads that only match in an excluded message */
1189         const char **search_exclude_tags;
1190         size_t search_exclude_tags_length;
1191         unsigned int i;
1192         notmuch_status_t status;
1193
1194         search_exclude_tags = notmuch_config_get_search_exclude_tags
1195             (config, &search_exclude_tags_length);
1196
1197         for (i = 0; i < search_exclude_tags_length; i++) {
1198             status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1199             if (status && status != NOTMUCH_STATUS_IGNORED) {
1200                 print_status_query ("notmuch show", query, status);
1201                 ret = -1;
1202                 goto DONE;
1203             }
1204         }
1205
1206         if (exclude == FALSE) {
1207             notmuch_query_set_omit_excluded (query, FALSE);
1208             params.omit_excluded = FALSE;
1209         }
1210
1211         ret = do_show (config, query, formatter, sprinter, &params);
1212     }
1213
1214  DONE:
1215     g_mime_stream_flush (params.out_stream);
1216     g_object_unref (params.out_stream);
1217
1218     notmuch_crypto_cleanup (&params.crypto);
1219     notmuch_query_destroy (query);
1220     notmuch_database_destroy (notmuch);
1221
1222     return ret ? EXIT_FAILURE : EXIT_SUCCESS;
1223 }