1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
22 #include "gmime-filter-reply.h"
26 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
33 result = talloc_strdup (ctx, "");
37 for (tags = notmuch_message_get_tags (message);
38 notmuch_tags_valid (tags);
39 notmuch_tags_move_to_next (tags))
41 tag = notmuch_tags_get (tags);
43 result = talloc_asprintf_append (result, "%s%s",
44 first ? "" : " ", tag);
51 /* Get a nice, single-line summary of message. */
53 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
57 const char *relative_date;
60 from = notmuch_message_get_header (message, "from");
62 date = notmuch_message_get_date (message);
63 relative_date = notmuch_time_relative_date (ctx, date);
65 tags = _get_tags_as_string (ctx, message);
67 return talloc_asprintf (ctx, "%s (%s) (%s)",
68 from, relative_date, tags);
71 static const char *_get_disposition(GMimeObject *meta)
73 GMimeContentDisposition *disposition;
75 disposition = g_mime_object_get_content_disposition (meta);
79 return g_mime_content_disposition_get_disposition (disposition);
82 /* Emit a sequence of key/value pairs for the metadata of message.
83 * The caller should begin a map before calling this. */
85 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
87 /* Any changes to the JSON or S-Expression format should be
88 * reflected in the file devel/schemata. */
90 void *local = talloc_new (NULL);
93 const char *relative_date;
95 sp->map_key (sp, "id");
96 sp->string (sp, notmuch_message_get_message_id (message));
98 sp->map_key (sp, "match");
99 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
101 sp->map_key (sp, "excluded");
102 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
104 sp->map_key (sp, "filename");
105 if (notmuch_format_version >= 3) {
106 notmuch_filenames_t *filenames;
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));
114 notmuch_filenames_destroy (filenames);
117 sp->string (sp, notmuch_message_get_filename (message));
120 sp->map_key (sp, "timestamp");
121 date = notmuch_message_get_date (message);
122 sp->integer (sp, date);
124 sp->map_key (sp, "date_relative");
125 relative_date = notmuch_time_relative_date (local, date);
126 sp->string (sp, relative_date);
128 sp->map_key (sp, "tags");
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));
139 /* Extract just the email address from the contents of a From:
142 _extract_email_address (const void *ctx, const char *from)
144 InternetAddressList *addresses;
145 InternetAddress *address;
146 InternetAddressMailbox *mailbox;
147 const char *email = "MAILER-DAEMON";
149 addresses = internet_address_list_parse_string (from);
151 /* Bail if there is no address here. */
152 if (addresses == NULL || internet_address_list_length (addresses) < 1)
155 /* Otherwise, just use the first address. */
156 address = internet_address_list_get_address (addresses, 0);
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))
163 mailbox = INTERNET_ADDRESS_MAILBOX (address);
164 email = internet_address_mailbox_get_addr (mailbox);
165 email = talloc_strdup (ctx, email);
169 g_object_unref (addresses);
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.
178 * Any characters at all may appear after that in the line.
181 _is_from_line (const char *line)
183 const char *s = line;
191 if (STRNCMP_LITERAL (s, "From ") == 0)
198 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
199 notmuch_bool_t reply)
201 /* Any changes to the JSON or S-Expression format should be
202 * reflected in the file devel/schemata. */
204 InternetAddressList *recipients;
205 char *recipients_string;
206 const char *reply_to_string;
210 sp->map_key (sp, "Subject");
211 sp->string (sp, g_mime_message_get_subject (message));
213 sp->map_key (sp, "From");
214 sp->string (sp, g_mime_message_get_sender (message));
216 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
217 recipients_string = internet_address_list_to_string (recipients, 0);
218 if (recipients_string) {
219 sp->map_key (sp, "To");
220 sp->string (sp, recipients_string);
221 g_free (recipients_string);
224 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
225 recipients_string = internet_address_list_to_string (recipients, 0);
226 if (recipients_string) {
227 sp->map_key (sp, "Cc");
228 sp->string (sp, recipients_string);
229 g_free (recipients_string);
232 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
233 recipients_string = internet_address_list_to_string (recipients, 0);
234 if (recipients_string) {
235 sp->map_key (sp, "Bcc");
236 sp->string (sp, recipients_string);
237 g_free (recipients_string);
240 reply_to_string = g_mime_message_get_reply_to (message);
241 if (reply_to_string) {
242 sp->map_key (sp, "Reply-To");
243 sp->string (sp, reply_to_string);
247 sp->map_key (sp, "In-reply-to");
248 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
250 sp->map_key (sp, "References");
251 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
253 sp->map_key (sp, "Date");
254 sp->string (sp, g_mime_message_get_date_string (sp, message));
260 /* Write a MIME text part out to the given stream.
262 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
265 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
266 * UTF-8) will be performed, so it is inappropriate to call this
267 * function with a non-text part. Doing so will trigger an internal
271 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
272 notmuch_show_text_part_flags flags)
274 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
275 GMimeStream *stream_filter = NULL;
276 GMimeFilter *crlf_filter = NULL;
277 GMimeDataWrapper *wrapper;
280 if (! g_mime_content_type_is_type (content_type, "text", "*"))
281 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
282 g_mime_content_type_to_string (content_type));
284 if (stream_out == NULL)
287 stream_filter = g_mime_stream_filter_new (stream_out);
288 crlf_filter = g_mime_filter_crlf_new (FALSE, FALSE);
289 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
291 g_object_unref (crlf_filter);
293 charset = g_mime_object_get_content_type_parameter (part, "charset");
295 GMimeFilter *charset_filter;
296 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
297 /* This result can be NULL for things like "unknown-8bit".
298 * Don't set a NULL filter as that makes GMime print
299 * annoying assertion-failure messages on stderr. */
300 if (charset_filter) {
301 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
303 g_object_unref (charset_filter);
308 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
309 GMimeFilter *reply_filter;
310 reply_filter = g_mime_filter_reply_new (TRUE);
312 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
314 g_object_unref (reply_filter);
318 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
319 if (wrapper && stream_filter)
320 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
322 g_object_unref(stream_filter);
325 /* Get signature status string (GMime 2.6) */
327 signature_status_to_string (GMimeSignatureStatus x)
330 case GMIME_SIGNATURE_STATUS_GOOD:
332 case GMIME_SIGNATURE_STATUS_BAD:
334 case GMIME_SIGNATURE_STATUS_ERROR:
341 /* Print signature flags */
342 struct key_map_struct {
343 GMimeSignatureError bit;
348 do_format_signature_errors (sprinter_t *sp, struct key_map_struct *key_map,
349 unsigned int array_map_len, GMimeSignatureError errors) {
350 sp->map_key (sp, "errors");
353 for (unsigned int i = 0; i < array_map_len; i++) {
354 if (errors & key_map[i].bit) {
355 sp->map_key (sp, key_map[i].string);
356 sp->boolean (sp, TRUE);
364 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
366 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
368 if (errors == GMIME_SIGNATURE_ERROR_NONE)
371 struct key_map_struct key_map[] = {
372 { GMIME_SIGNATURE_ERROR_EXPSIG, "sig-expired" },
373 { GMIME_SIGNATURE_ERROR_NO_PUBKEY, "key-missing"},
374 { GMIME_SIGNATURE_ERROR_EXPKEYSIG, "key-expired"},
375 { GMIME_SIGNATURE_ERROR_REVKEYSIG, "key-revoked"},
376 { GMIME_SIGNATURE_ERROR_UNSUPP_ALGO, "alg-unsupported"},
379 do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
382 /* Signature status sprinter (GMime 2.6) */
384 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
386 /* Any changes to the JSON or S-Expression format should be
387 * reflected in the file devel/schemata. */
389 GMimeSignatureList *siglist = node->sig_list;
399 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
400 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
405 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
406 sp->map_key (sp, "status");
407 sp->string (sp, signature_status_to_string (status));
409 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
410 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
412 sp->map_key (sp, "fingerprint");
413 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
415 /* these dates are seconds since the epoch; should we
416 * provide a more human-readable format string? */
417 time_t created = g_mime_signature_get_created (signature);
419 sp->map_key (sp, "created");
420 sp->integer (sp, created);
422 time_t expires = g_mime_signature_get_expires (signature);
424 sp->map_key (sp, "expires");
425 sp->integer (sp, expires);
427 /* output user id only if validity is FULL or ULTIMATE. */
428 /* note that gmime is using the term "trust" here, which
429 * is WRONG. It's actually user id "validity". */
431 const char *name = g_mime_certificate_get_name (certificate);
432 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
433 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
434 sp->map_key (sp, "userid");
435 sp->string (sp, name);
438 } else if (certificate) {
439 const char *key_id = g_mime_certificate_get_key_id (certificate);
441 sp->map_key (sp, "keyid");
442 sp->string (sp, key_id);
446 if (notmuch_format_version <= 3) {
447 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
448 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
449 sp->map_key (sp, "errors");
450 sp->integer (sp, errors);
453 format_signature_errors (sp, signature);
462 static notmuch_status_t
463 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
464 int indent, const notmuch_show_params_t *params)
466 /* The disposition and content-type metadata are associated with
467 * the envelope for message parts */
468 GMimeObject *meta = node->envelope_part ?
469 GMIME_OBJECT (node->envelope_part) : node->part;
470 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
471 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
472 GMimeStream *stream = params->out_stream;
473 const char *part_type;
476 if (node->envelope_file) {
477 notmuch_message_t *message = node->envelope_file;
479 part_type = "message";
480 g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
482 notmuch_message_get_message_id (message),
484 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
485 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
486 notmuch_message_get_filename (message));
488 char *content_string;
489 const char *disposition = _get_disposition (meta);
490 const char *cid = g_mime_object_get_content_id (meta);
491 const char *filename = leaf ?
492 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
495 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
496 part_type = "attachment";
500 g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
502 g_mime_stream_printf (stream, ", Filename: %s", filename);
504 g_mime_stream_printf (stream, ", Content-id: %s", cid);
506 content_string = g_mime_content_type_to_string (content_type);
507 g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
508 g_free (content_string);
511 if (GMIME_IS_MESSAGE (node->part)) {
512 GMimeMessage *message = GMIME_MESSAGE (node->part);
513 InternetAddressList *recipients;
514 char *recipients_string;
517 g_mime_stream_printf (stream, "\fheader{\n");
518 if (node->envelope_file)
519 g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
520 g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
521 g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_sender (message));
522 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
523 recipients_string = internet_address_list_to_string (recipients, 0);
524 if (recipients_string)
525 g_mime_stream_printf (stream, "To: %s\n", recipients_string);
526 g_free (recipients_string);
527 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
528 recipients_string = internet_address_list_to_string (recipients, 0);
529 if (recipients_string)
530 g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
531 g_free (recipients_string);
532 date_string = g_mime_message_get_date_string (node, message);
533 g_mime_stream_printf (stream, "Date: %s\n", date_string);
534 g_mime_stream_printf (stream, "\fheader}\n");
536 g_mime_stream_printf (stream, "\fbody{\n");
540 if (g_mime_content_type_is_type (content_type, "text", "*") &&
541 !g_mime_content_type_is_type (content_type, "text", "html"))
543 show_text_part_content (node->part, stream, 0);
545 char *content_string = g_mime_content_type_to_string (content_type);
546 g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
547 g_free (content_string);
551 for (i = 0; i < node->nchildren; i++)
552 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
554 if (GMIME_IS_MESSAGE (node->part))
555 g_mime_stream_printf (stream, "\fbody}\n");
557 g_mime_stream_printf (stream, "\f%s}\n", part_type);
559 return NOTMUCH_STATUS_SUCCESS;
563 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
565 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
566 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
567 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
568 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
569 ssize_t content_length = g_mime_stream_length (stream);
571 if (content_charset != NULL) {
572 sp->map_key (sp, "content-charset");
573 sp->string (sp, content_charset);
576 sp->map_key (sp, "content-transfer-encoding");
577 sp->string (sp, cte);
579 if (content_length >= 0) {
580 sp->map_key (sp, "content-length");
581 sp->integer (sp, content_length);
586 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
587 notmuch_bool_t first, notmuch_bool_t output_body,
588 notmuch_bool_t include_html)
590 /* Any changes to the JSON or S-Expression format should be
591 * reflected in the file devel/schemata. */
593 if (node->envelope_file) {
595 format_message_sprinter (sp, node->envelope_file);
597 sp->map_key (sp, "headers");
598 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
601 sp->map_key (sp, "body");
603 format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
610 /* The disposition and content-type metadata are associated with
611 * the envelope for message parts */
612 GMimeObject *meta = node->envelope_part ?
613 GMIME_OBJECT (node->envelope_part) : node->part;
614 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
615 char *content_string;
616 const char *disposition = _get_disposition (meta);
617 const char *cid = g_mime_object_get_content_id (meta);
618 const char *filename = GMIME_IS_PART (node->part) ?
619 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
625 sp->map_key (sp, "id");
626 sp->integer (sp, node->part_num);
628 if (node->decrypt_attempted) {
629 sp->map_key (sp, "encstatus");
632 sp->map_key (sp, "status");
633 sp->string (sp, node->decrypt_success ? "good" : "bad");
638 if (node->verify_attempted) {
639 sp->map_key (sp, "sigstatus");
640 format_part_sigstatus_sprinter (sp, node);
643 sp->map_key (sp, "content-type");
644 content_string = g_mime_content_type_to_string (content_type);
645 sp->string (sp, content_string);
646 g_free (content_string);
649 sp->map_key (sp, "content-disposition");
650 sp->string (sp, disposition);
654 sp->map_key (sp, "content-id");
655 sp->string (sp, cid);
659 sp->map_key (sp, "filename");
660 sp->string (sp, filename);
663 if (GMIME_IS_PART (node->part)) {
664 /* For non-HTML text parts, we include the content in the
665 * JSON. Since JSON must be Unicode, we handle charset
666 * decoding here and do not report a charset to the caller.
667 * For text/html parts, we do not include the content unless
668 * the --include-html option has been passed. If a html part
669 * is not included, it can be requested directly. This makes
670 * charset decoding the responsibility on the caller so we
671 * report the charset for text/html parts.
673 if (g_mime_content_type_is_type (content_type, "text", "*") &&
675 ! g_mime_content_type_is_type (content_type, "text", "html")))
677 GMimeStream *stream_memory = g_mime_stream_mem_new ();
678 GByteArray *part_content;
679 show_text_part_content (node->part, stream_memory, 0);
680 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
681 sp->map_key (sp, "content");
682 sp->string_len (sp, (char *) part_content->data, part_content->len);
683 g_object_unref (stream_memory);
685 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
687 } else if (GMIME_IS_MULTIPART (node->part)) {
688 sp->map_key (sp, "content");
691 } else if (GMIME_IS_MESSAGE (node->part)) {
692 sp->map_key (sp, "content");
696 sp->map_key (sp, "headers");
697 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
699 sp->map_key (sp, "body");
704 for (i = 0; i < node->nchildren; i++)
705 format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
707 /* Close content structures */
708 for (i = 0; i < nclose; i++)
714 static notmuch_status_t
715 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
716 mime_node_t *node, unused (int indent),
717 const notmuch_show_params_t *params)
719 format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
721 return NOTMUCH_STATUS_SUCCESS;
724 /* Print a message in "mboxrd" format as documented, for example,
727 * http://qmail.org/qmail-manual-html/man5/mbox.html
729 static notmuch_status_t
730 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
732 unused (const notmuch_show_params_t *params))
734 notmuch_message_t *message = node->envelope_file;
736 const char *filename;
741 struct tm date_gmtime;
742 char date_asctime[26];
749 INTERNAL_ERROR ("format_part_mbox requires a root part");
751 filename = notmuch_message_get_filename (message);
752 file = fopen (filename, "r");
754 fprintf (stderr, "Failed to open %s: %s\n",
755 filename, strerror (errno));
756 return NOTMUCH_STATUS_FILE_ERROR;
759 from = notmuch_message_get_header (message, "from");
760 from = _extract_email_address (ctx, from);
762 date = notmuch_message_get_date (message);
763 gmtime_r (&date, &date_gmtime);
764 asctime_r (&date_gmtime, date_asctime);
766 printf ("From %s %s", from, date_asctime);
768 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
769 if (_is_from_line (line))
778 return NOTMUCH_STATUS_SUCCESS;
781 static notmuch_status_t
782 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
783 mime_node_t *node, unused (int indent),
784 const notmuch_show_params_t *params)
786 if (node->envelope_file) {
787 /* Special case the entire message to avoid MIME parsing. */
788 const char *filename;
793 filename = notmuch_message_get_filename (node->envelope_file);
794 if (filename == NULL) {
795 fprintf (stderr, "Error: Cannot get message filename.\n");
796 return NOTMUCH_STATUS_FILE_ERROR;
799 file = fopen (filename, "r");
801 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
802 return NOTMUCH_STATUS_FILE_ERROR;
805 while (!feof (file)) {
806 size = fread (buf, 1, sizeof (buf), file);
808 fprintf (stderr, "Error: Read failed from %s\n", filename);
810 return NOTMUCH_STATUS_FILE_ERROR;
813 if (fwrite (buf, size, 1, stdout) != 1) {
814 fprintf (stderr, "Error: Write failed\n");
816 return NOTMUCH_STATUS_FILE_ERROR;
821 return NOTMUCH_STATUS_SUCCESS;
824 GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
826 if (GMIME_IS_PART (node->part)) {
827 /* For leaf parts, we emit only the transfer-decoded
829 GMimeDataWrapper *wrapper;
830 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
832 if (wrapper && stream_filter)
833 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
835 /* Write out the whole part. For message parts (the root
836 * part and embedded message parts), this will be the
837 * message including its headers (but not the
838 * encapsulating part's headers). For multipart parts,
839 * this will include the headers. */
841 g_mime_object_write_to_stream (node->part, stream_filter);
845 g_object_unref (stream_filter);
847 return NOTMUCH_STATUS_SUCCESS;
850 static notmuch_status_t
851 show_message (void *ctx,
852 const notmuch_show_format_t *format,
854 notmuch_message_t *message,
856 notmuch_show_params_t *params)
858 void *local = talloc_new (ctx);
859 mime_node_t *root, *part;
860 notmuch_status_t status;
862 status = mime_node_open (local, message, &(params->crypto), &root);
865 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
867 status = format->part (local, sp, part, indent, params);
873 static notmuch_status_t
874 show_messages (void *ctx,
875 const notmuch_show_format_t *format,
877 notmuch_messages_t *messages,
879 notmuch_show_params_t *params)
881 notmuch_message_t *message;
882 notmuch_bool_t match;
883 notmuch_bool_t excluded;
885 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
890 notmuch_messages_valid (messages);
891 notmuch_messages_move_to_next (messages))
895 message = notmuch_messages_get (messages);
897 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
898 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
900 next_indent = indent;
902 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
903 status = show_message (ctx, format, sp, message, indent, params);
906 next_indent = indent + 1;
911 status = show_messages (ctx,
913 notmuch_message_get_replies (message),
919 notmuch_message_destroy (message);
929 /* Formatted output of single message */
931 do_show_single (void *ctx,
932 notmuch_query_t *query,
933 const notmuch_show_format_t *format,
935 notmuch_show_params_t *params)
937 notmuch_messages_t *messages;
938 notmuch_message_t *message;
939 notmuch_status_t status;
942 status = notmuch_query_count_messages (query, &count);
943 if (print_status_query ("notmuch show", query, status))
947 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
951 status = notmuch_query_search_messages (query, &messages);
952 if (print_status_query ("notmuch show", query, status))
955 message = notmuch_messages_get (messages);
957 if (message == NULL) {
958 fprintf (stderr, "Error: Cannot find matching message.\n");
962 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
964 return show_message (ctx, format, sp, message, 0, params)
965 != NOTMUCH_STATUS_SUCCESS;
968 /* Formatted output of threads */
971 notmuch_query_t *query,
972 const notmuch_show_format_t *format,
974 notmuch_show_params_t *params)
976 notmuch_threads_t *threads;
977 notmuch_thread_t *thread;
978 notmuch_messages_t *messages;
979 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
981 status= notmuch_query_search_threads (query, &threads);
982 if (print_status_query ("notmuch show", query, status))
988 notmuch_threads_valid (threads);
989 notmuch_threads_move_to_next (threads))
991 thread = notmuch_threads_get (threads);
993 messages = notmuch_thread_get_toplevel_messages (thread);
995 if (messages == NULL)
996 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
997 notmuch_thread_get_thread_id (thread));
999 status = show_messages (ctx, format, sp, messages, 0, params);
1003 notmuch_thread_destroy (thread);
1009 return res != NOTMUCH_STATUS_SUCCESS;
1013 NOTMUCH_FORMAT_NOT_SPECIFIED,
1014 NOTMUCH_FORMAT_JSON,
1015 NOTMUCH_FORMAT_SEXP,
1016 NOTMUCH_FORMAT_TEXT,
1017 NOTMUCH_FORMAT_MBOX,
1021 static const notmuch_show_format_t format_json = {
1022 .new_sprinter = sprinter_json_create,
1023 .part = format_part_sprinter_entry,
1026 static const notmuch_show_format_t format_sexp = {
1027 .new_sprinter = sprinter_sexp_create,
1028 .part = format_part_sprinter_entry,
1031 static const notmuch_show_format_t format_text = {
1032 .new_sprinter = sprinter_text_create,
1033 .part = format_part_text,
1036 static const notmuch_show_format_t format_mbox = {
1037 .new_sprinter = sprinter_text_create,
1038 .part = format_part_mbox,
1041 static const notmuch_show_format_t format_raw = {
1042 .new_sprinter = sprinter_text_create,
1043 .part = format_part_raw,
1046 static const notmuch_show_format_t *formatters[] = {
1047 [NOTMUCH_FORMAT_JSON] = &format_json,
1048 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1049 [NOTMUCH_FORMAT_TEXT] = &format_text,
1050 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1051 [NOTMUCH_FORMAT_RAW] = &format_raw,
1055 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1057 notmuch_database_t *notmuch;
1058 notmuch_query_t *query;
1061 const notmuch_show_format_t *formatter;
1062 sprinter_t *sprinter;
1063 notmuch_show_params_t params = {
1065 .omit_excluded = TRUE,
1066 .output_body = TRUE,
1068 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1071 /* This value corresponds to neither true nor false being passed
1072 * on the command line */
1073 int entire_thread = -1;
1074 notmuch_bool_t single_message;
1076 notmuch_opt_desc_t options[] = {
1077 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
1078 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1079 { "text", NOTMUCH_FORMAT_TEXT },
1080 { "sexp", NOTMUCH_FORMAT_SEXP },
1081 { "mbox", NOTMUCH_FORMAT_MBOX },
1082 { "raw", NOTMUCH_FORMAT_RAW },
1084 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
1085 { NOTMUCH_OPT_BOOLEAN, &exclude, "exclude", 'x', 0 },
1086 { NOTMUCH_OPT_BOOLEAN, &entire_thread, "entire-thread", 't', 0 },
1087 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1088 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1089 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1090 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1091 { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 },
1092 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
1096 opt_index = parse_arguments (argc, argv, options, 1);
1098 return EXIT_FAILURE;
1100 notmuch_process_shared_options (argv[0]);
1102 /* decryption implies verification */
1103 if (params.crypto.decrypt)
1104 params.crypto.verify = TRUE;
1106 /* specifying a part implies single message display */
1107 single_message = params.part >= 0;
1109 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1110 /* if part was requested and format was not specified, use format=raw */
1111 if (params.part >= 0)
1112 format = NOTMUCH_FORMAT_RAW;
1114 format = NOTMUCH_FORMAT_TEXT;
1117 if (format == NOTMUCH_FORMAT_MBOX) {
1118 if (params.part > 0) {
1119 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1120 return EXIT_FAILURE;
1122 } else if (format == NOTMUCH_FORMAT_RAW) {
1123 /* raw format only supports single message display */
1124 single_message = TRUE;
1127 notmuch_exit_if_unsupported_format ();
1129 /* Default is entire-thread = FALSE except for format=json and
1131 if (entire_thread != FALSE && entire_thread != TRUE) {
1132 if (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP)
1133 params.entire_thread = TRUE;
1135 params.entire_thread = FALSE;
1137 params.entire_thread = entire_thread;
1140 if (!params.output_body) {
1141 if (params.part > 0) {
1142 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1143 params.output_body = TRUE;
1145 if (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)
1147 "Warning: --body=false only implemented for format=json and format=sexp\n");
1151 if (params.include_html &&
1152 (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1153 fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1156 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1157 if (query_string == NULL) {
1158 fprintf (stderr, "Out of memory\n");
1159 return EXIT_FAILURE;
1162 if (*query_string == '\0') {
1163 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1164 return EXIT_FAILURE;
1167 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1169 if (notmuch_database_open (notmuch_config_get_database_path (config),
1170 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1171 return EXIT_FAILURE;
1173 notmuch_exit_if_unmatched_db_uuid (notmuch);
1175 query = notmuch_query_create (notmuch, query_string);
1176 if (query == NULL) {
1177 fprintf (stderr, "Out of memory\n");
1178 return EXIT_FAILURE;
1181 /* Create structure printer. */
1182 formatter = formatters[format];
1183 sprinter = formatter->new_sprinter(config, stdout);
1185 params.out_stream = g_mime_stream_stdout_new ();
1187 /* If a single message is requested we do not use search_excludes. */
1188 if (single_message) {
1189 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1191 /* We always apply set the exclude flag. The
1192 * exclude=true|false option controls whether or not we return
1193 * threads that only match in an excluded message */
1194 const char **search_exclude_tags;
1195 size_t search_exclude_tags_length;
1197 notmuch_status_t status;
1199 search_exclude_tags = notmuch_config_get_search_exclude_tags
1200 (config, &search_exclude_tags_length);
1202 for (i = 0; i < search_exclude_tags_length; i++) {
1203 status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1204 if (status && status != NOTMUCH_STATUS_IGNORED) {
1205 print_status_query ("notmuch show", query, status);
1211 if (exclude == FALSE) {
1212 notmuch_query_set_omit_excluded (query, FALSE);
1213 params.omit_excluded = FALSE;
1216 ret = do_show (config, query, formatter, sprinter, ¶ms);
1220 g_mime_stream_flush (params.out_stream);
1221 g_object_unref (params.out_stream);
1223 notmuch_crypto_cleanup (¶ms.crypto);
1224 notmuch_query_destroy (query);
1225 notmuch_database_destroy (notmuch);
1227 return ret ? EXIT_FAILURE : EXIT_SUCCESS;