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,
201 /* Any changes to the JSON or S-Expression format should be
202 * reflected in the file devel/schemata. */
204 char *recipients_string;
205 const char *reply_to_string;
206 void *local = talloc_new (sp);
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_from_string (message));
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);
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);
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);
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);
244 sp->map_key (sp, "In-reply-to");
245 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
247 sp->map_key (sp, "References");
248 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
250 sp->map_key (sp, "Date");
251 sp->string (sp, g_mime_message_get_date_string (sp, message));
258 /* Write a MIME text part out to the given stream.
260 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
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
269 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
270 notmuch_show_text_part_flags flags)
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;
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));
283 if (stream_out == NULL)
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;
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),
299 g_mime_data_wrapper_write_to_stream (wrapper, null_stream_filter);
300 charset = g_mime_filter_windows_real_charset(
301 (GMimeFilterWindows *) windows_filter);
303 if (null_stream_filter)
304 g_object_unref (null_stream_filter);
306 g_object_unref (null_stream);
307 /* Keep a reference to windows_filter in order to prevent the
308 * charset string from deallocation. */
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),
315 g_object_unref (crlf_filter);
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),
326 g_object_unref (charset_filter);
331 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
332 GMimeFilter *reply_filter;
333 reply_filter = g_mime_filter_reply_new (true);
335 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
337 g_object_unref (reply_filter);
341 if (wrapper && stream_filter)
342 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
344 g_object_unref(stream_filter);
346 g_object_unref (windows_filter);
350 signature_status_to_string (GMimeSignatureStatus status)
352 if (g_mime_signature_status_bad (status))
355 if (g_mime_signature_status_error (status))
358 if (g_mime_signature_status_good (status))
364 /* Print signature flags */
365 struct key_map_struct {
366 GMimeSignatureError bit;
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");
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);
387 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
389 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
391 if (!(errors & GMIME_SIGNATURE_STATUS_ERROR_MASK))
394 struct key_map_struct key_map[] = {
395 { GMIME_SIGNATURE_STATUS_KEY_REVOKED, "key-revoked"},
396 { GMIME_SIGNATURE_STATUS_KEY_EXPIRED, "key-expired"},
397 { GMIME_SIGNATURE_STATUS_SIG_EXPIRED, "sig-expired" },
398 { GMIME_SIGNATURE_STATUS_KEY_MISSING, "key-missing"},
399 { GMIME_SIGNATURE_STATUS_CRL_MISSING, "crl-missing"},
400 { GMIME_SIGNATURE_STATUS_CRL_TOO_OLD, "crl-too-old"},
401 { GMIME_SIGNATURE_STATUS_BAD_POLICY, "bad-policy"},
402 { GMIME_SIGNATURE_STATUS_SYS_ERROR, "sys-error"},
403 { GMIME_SIGNATURE_STATUS_TOFU_CONFLICT, "tofu-conflict"},
406 do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
409 /* Signature status sprinter */
411 format_part_sigstatus_sprinter (sprinter_t *sp, GMimeSignatureList *siglist)
413 /* Any changes to the JSON or S-Expression format should be
414 * reflected in the file devel/schemata. */
424 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
425 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
430 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
431 sp->map_key (sp, "status");
432 sp->string (sp, signature_status_to_string (status));
434 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
435 if (g_mime_signature_status_good (status)) {
437 sp->map_key (sp, "fingerprint");
438 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
440 /* these dates are seconds since the epoch; should we
441 * provide a more human-readable format string? */
442 time_t created = g_mime_signature_get_created (signature);
444 sp->map_key (sp, "created");
445 sp->integer (sp, created);
447 time_t expires = g_mime_signature_get_expires (signature);
449 sp->map_key (sp, "expires");
450 sp->integer (sp, expires);
453 const char *uid = g_mime_certificate_get_valid_userid (certificate);
455 sp->map_key (sp, "userid");
456 sp->string (sp, uid);
459 } else if (certificate) {
460 const char *key_id = g_mime_certificate_get_fpr16 (certificate);
462 sp->map_key (sp, "keyid");
463 sp->string (sp, key_id);
467 if (notmuch_format_version <= 3) {
468 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
469 if (g_mime_signature_status_error (errors)) {
470 sp->map_key (sp, "errors");
471 sp->integer (sp, errors);
474 format_signature_errors (sp, signature);
483 static notmuch_status_t
484 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
485 int indent, const notmuch_show_params_t *params)
487 /* The disposition and content-type metadata are associated with
488 * the envelope for message parts */
489 GMimeObject *meta = node->envelope_part ?
490 GMIME_OBJECT (node->envelope_part) : node->part;
491 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
492 const bool leaf = GMIME_IS_PART (node->part);
493 GMimeStream *stream = params->out_stream;
494 const char *part_type;
497 if (node->envelope_file) {
498 notmuch_message_t *message = node->envelope_file;
500 part_type = "message";
501 g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
503 notmuch_message_get_message_id (message),
505 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
506 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
507 notmuch_message_get_filename (message));
509 char *content_string;
510 const char *disposition = _get_disposition (meta);
511 const char *cid = g_mime_object_get_content_id (meta);
512 const char *filename = leaf ?
513 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
516 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
517 part_type = "attachment";
521 g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
523 g_mime_stream_printf (stream, ", Filename: %s", filename);
525 g_mime_stream_printf (stream, ", Content-id: %s", cid);
527 content_string = g_mime_content_type_to_string (content_type);
528 g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
529 g_free (content_string);
532 if (GMIME_IS_MESSAGE (node->part)) {
533 GMimeMessage *message = GMIME_MESSAGE (node->part);
534 char *recipients_string;
537 g_mime_stream_printf (stream, "\fheader{\n");
538 if (node->envelope_file)
539 g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
540 g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
541 g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
542 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
543 if (recipients_string)
544 g_mime_stream_printf (stream, "To: %s\n", recipients_string);
545 g_free (recipients_string);
546 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
547 if (recipients_string)
548 g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
549 g_free (recipients_string);
550 date_string = g_mime_message_get_date_string (node, message);
551 g_mime_stream_printf (stream, "Date: %s\n", date_string);
552 g_mime_stream_printf (stream, "\fheader}\n");
554 if (!params->output_body)
556 g_mime_stream_printf (stream, "\f%s}\n", part_type);
557 return NOTMUCH_STATUS_SUCCESS;
559 g_mime_stream_printf (stream, "\fbody{\n");
563 if (g_mime_content_type_is_type (content_type, "text", "*") &&
564 (params->include_html ||
565 ! g_mime_content_type_is_type (content_type, "text", "html")))
567 show_text_part_content (node->part, stream, 0);
569 char *content_string = g_mime_content_type_to_string (content_type);
570 g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
571 g_free (content_string);
575 for (i = 0; i < node->nchildren; i++)
576 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
578 if (GMIME_IS_MESSAGE (node->part))
579 g_mime_stream_printf (stream, "\fbody}\n");
581 g_mime_stream_printf (stream, "\f%s}\n", part_type);
583 return NOTMUCH_STATUS_SUCCESS;
587 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
589 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
590 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
591 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
592 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
593 ssize_t content_length = g_mime_stream_length (stream);
595 if (content_charset != NULL) {
596 sp->map_key (sp, "content-charset");
597 sp->string (sp, content_charset);
600 sp->map_key (sp, "content-transfer-encoding");
601 sp->string (sp, cte);
603 if (content_length >= 0) {
604 sp->map_key (sp, "content-length");
605 sp->integer (sp, content_length);
610 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
614 /* Any changes to the JSON or S-Expression format should be
615 * reflected in the file devel/schemata. */
617 if (node->envelope_file) {
619 format_message_sprinter (sp, node->envelope_file);
621 sp->map_key (sp, "headers");
622 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
625 sp->map_key (sp, "body");
627 format_part_sprinter (ctx, sp, mime_node_child (node, 0), true, include_html);
634 /* The disposition and content-type metadata are associated with
635 * the envelope for message parts */
636 GMimeObject *meta = node->envelope_part ?
637 GMIME_OBJECT (node->envelope_part) : node->part;
638 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
639 char *content_string;
640 const char *disposition = _get_disposition (meta);
641 const char *cid = g_mime_object_get_content_id (meta);
642 const char *filename = GMIME_IS_PART (node->part) ?
643 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
649 sp->map_key (sp, "id");
650 sp->integer (sp, node->part_num);
652 if (node->decrypt_attempted) {
653 sp->map_key (sp, "encstatus");
656 sp->map_key (sp, "status");
657 sp->string (sp, node->decrypt_success ? "good" : "bad");
662 if (node->verify_attempted) {
663 sp->map_key (sp, "sigstatus");
664 format_part_sigstatus_sprinter (sp, node->sig_list);
667 sp->map_key (sp, "content-type");
668 content_string = g_mime_content_type_to_string (content_type);
669 sp->string (sp, content_string);
670 g_free (content_string);
673 sp->map_key (sp, "content-disposition");
674 sp->string (sp, disposition);
678 sp->map_key (sp, "content-id");
679 sp->string (sp, cid);
683 sp->map_key (sp, "filename");
684 sp->string (sp, filename);
687 if (GMIME_IS_PART (node->part)) {
688 /* For non-HTML text parts, we include the content in the
689 * JSON. Since JSON must be Unicode, we handle charset
690 * decoding here and do not report a charset to the caller.
691 * For text/html parts, we do not include the content unless
692 * the --include-html option has been passed. If a html part
693 * is not included, it can be requested directly. This makes
694 * charset decoding the responsibility on the caller so we
695 * report the charset for text/html parts.
697 if (g_mime_content_type_is_type (content_type, "text", "*") &&
699 ! g_mime_content_type_is_type (content_type, "text", "html")))
701 GMimeStream *stream_memory = g_mime_stream_mem_new ();
702 GByteArray *part_content;
703 show_text_part_content (node->part, stream_memory, 0);
704 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
705 sp->map_key (sp, "content");
706 sp->string_len (sp, (char *) part_content->data, part_content->len);
707 g_object_unref (stream_memory);
709 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
711 } else if (GMIME_IS_MULTIPART (node->part)) {
712 sp->map_key (sp, "content");
715 } else if (GMIME_IS_MESSAGE (node->part)) {
716 sp->map_key (sp, "content");
720 sp->map_key (sp, "headers");
721 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
723 sp->map_key (sp, "body");
728 for (i = 0; i < node->nchildren; i++)
729 format_part_sprinter (ctx, sp, mime_node_child (node, i), true, include_html);
731 /* Close content structures */
732 for (i = 0; i < nclose; i++)
738 static notmuch_status_t
739 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
740 mime_node_t *node, unused (int indent),
741 const notmuch_show_params_t *params)
743 format_part_sprinter (ctx, sp, node, params->output_body, params->include_html);
745 return NOTMUCH_STATUS_SUCCESS;
748 /* Print a message in "mboxrd" format as documented, for example,
751 * http://qmail.org/qmail-manual-html/man5/mbox.html
753 static notmuch_status_t
754 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
756 unused (const notmuch_show_params_t *params))
758 notmuch_message_t *message = node->envelope_file;
760 const char *filename;
765 struct tm date_gmtime;
766 char date_asctime[26];
773 INTERNAL_ERROR ("format_part_mbox requires a root part");
775 filename = notmuch_message_get_filename (message);
776 file = fopen (filename, "r");
778 fprintf (stderr, "Failed to open %s: %s\n",
779 filename, strerror (errno));
780 return NOTMUCH_STATUS_FILE_ERROR;
783 from = notmuch_message_get_header (message, "from");
784 from = _extract_email_address (ctx, from);
786 date = notmuch_message_get_date (message);
787 gmtime_r (&date, &date_gmtime);
788 asctime_r (&date_gmtime, date_asctime);
790 printf ("From %s %s", from, date_asctime);
792 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
793 if (_is_from_line (line))
802 return NOTMUCH_STATUS_SUCCESS;
805 static notmuch_status_t
806 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
807 mime_node_t *node, unused (int indent),
808 const notmuch_show_params_t *params)
810 if (node->envelope_file) {
811 /* Special case the entire message to avoid MIME parsing. */
812 const char *filename;
817 filename = notmuch_message_get_filename (node->envelope_file);
818 if (filename == NULL) {
819 fprintf (stderr, "Error: Cannot get message filename.\n");
820 return NOTMUCH_STATUS_FILE_ERROR;
823 file = fopen (filename, "r");
825 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
826 return NOTMUCH_STATUS_FILE_ERROR;
829 while (!feof (file)) {
830 size = fread (buf, 1, sizeof (buf), file);
832 fprintf (stderr, "Error: Read failed from %s\n", filename);
834 return NOTMUCH_STATUS_FILE_ERROR;
837 if (fwrite (buf, size, 1, stdout) != 1) {
838 fprintf (stderr, "Error: Write failed\n");
840 return NOTMUCH_STATUS_FILE_ERROR;
845 return NOTMUCH_STATUS_SUCCESS;
848 GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
850 if (GMIME_IS_PART (node->part)) {
851 /* For leaf parts, we emit only the transfer-decoded
853 GMimeDataWrapper *wrapper;
854 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
856 if (wrapper && stream_filter)
857 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
859 /* Write out the whole part. For message parts (the root
860 * part and embedded message parts), this will be the
861 * message including its headers (but not the
862 * encapsulating part's headers). For multipart parts,
863 * this will include the headers. */
865 g_mime_object_write_to_stream (node->part, stream_filter);
869 g_object_unref (stream_filter);
871 return NOTMUCH_STATUS_SUCCESS;
874 static notmuch_status_t
875 show_message (void *ctx,
876 const notmuch_show_format_t *format,
878 notmuch_message_t *message,
880 notmuch_show_params_t *params)
882 void *local = talloc_new (ctx);
883 mime_node_t *root, *part;
884 notmuch_status_t status;
885 unsigned int session_keys = 0;
886 notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
888 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
889 session_key_count_error = notmuch_message_count_properties (message, "session-key", &session_keys);
891 status = mime_node_open (local, message, &(params->crypto), &root);
894 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
896 status = format->part (local, sp, part, indent, params);
897 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error == NOTMUCH_STATUS_SUCCESS) {
898 unsigned int new_session_keys = 0;
899 if (notmuch_message_count_properties (message, "session-key", &new_session_keys) == NOTMUCH_STATUS_SUCCESS &&
900 new_session_keys > session_keys) {
901 /* try a quiet re-indexing */
902 notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch_message_get_database (message));
904 notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
905 print_status_message ("Error re-indexing message with --decrypt=stash",
906 message, notmuch_message_reindex (message, indexopts));
915 static notmuch_status_t
916 show_messages (void *ctx,
917 const notmuch_show_format_t *format,
919 notmuch_messages_t *messages,
921 notmuch_show_params_t *params)
923 notmuch_message_t *message;
927 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
932 notmuch_messages_valid (messages);
933 notmuch_messages_move_to_next (messages))
937 message = notmuch_messages_get (messages);
939 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
940 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
942 next_indent = indent;
944 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
945 status = show_message (ctx, format, sp, message, indent, params);
948 next_indent = indent + 1;
953 status = show_messages (ctx,
955 notmuch_message_get_replies (message),
961 notmuch_message_destroy (message);
971 /* Formatted output of single message */
973 do_show_single (void *ctx,
974 notmuch_query_t *query,
975 const notmuch_show_format_t *format,
977 notmuch_show_params_t *params)
979 notmuch_messages_t *messages;
980 notmuch_message_t *message;
981 notmuch_status_t status;
984 status = notmuch_query_count_messages (query, &count);
985 if (print_status_query ("notmuch show", query, status))
989 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
993 status = notmuch_query_search_messages (query, &messages);
994 if (print_status_query ("notmuch show", query, status))
997 message = notmuch_messages_get (messages);
999 if (message == NULL) {
1000 fprintf (stderr, "Error: Cannot find matching message.\n");
1004 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
1006 return show_message (ctx, format, sp, message, 0, params)
1007 != NOTMUCH_STATUS_SUCCESS;
1010 /* Formatted output of threads */
1013 notmuch_query_t *query,
1014 const notmuch_show_format_t *format,
1016 notmuch_show_params_t *params)
1018 notmuch_threads_t *threads;
1019 notmuch_thread_t *thread;
1020 notmuch_messages_t *messages;
1021 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1023 status= notmuch_query_search_threads (query, &threads);
1024 if (print_status_query ("notmuch show", query, status))
1027 sp->begin_list (sp);
1030 notmuch_threads_valid (threads);
1031 notmuch_threads_move_to_next (threads))
1033 thread = notmuch_threads_get (threads);
1035 messages = notmuch_thread_get_toplevel_messages (thread);
1037 if (messages == NULL)
1038 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
1039 notmuch_thread_get_thread_id (thread));
1041 status = show_messages (ctx, format, sp, messages, 0, params);
1045 notmuch_thread_destroy (thread);
1051 return res != NOTMUCH_STATUS_SUCCESS;
1055 NOTMUCH_FORMAT_NOT_SPECIFIED,
1056 NOTMUCH_FORMAT_JSON,
1057 NOTMUCH_FORMAT_SEXP,
1058 NOTMUCH_FORMAT_TEXT,
1059 NOTMUCH_FORMAT_MBOX,
1063 static const notmuch_show_format_t format_json = {
1064 .new_sprinter = sprinter_json_create,
1065 .part = format_part_sprinter_entry,
1068 static const notmuch_show_format_t format_sexp = {
1069 .new_sprinter = sprinter_sexp_create,
1070 .part = format_part_sprinter_entry,
1073 static const notmuch_show_format_t format_text = {
1074 .new_sprinter = sprinter_text_create,
1075 .part = format_part_text,
1078 static const notmuch_show_format_t format_mbox = {
1079 .new_sprinter = sprinter_text_create,
1080 .part = format_part_mbox,
1083 static const notmuch_show_format_t format_raw = {
1084 .new_sprinter = sprinter_text_create,
1085 .part = format_part_raw,
1088 static const notmuch_show_format_t *formatters[] = {
1089 [NOTMUCH_FORMAT_JSON] = &format_json,
1090 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1091 [NOTMUCH_FORMAT_TEXT] = &format_text,
1092 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1093 [NOTMUCH_FORMAT_RAW] = &format_raw,
1097 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1099 notmuch_database_t *notmuch;
1100 notmuch_query_t *query;
1103 const notmuch_show_format_t *formatter;
1104 sprinter_t *sprinter;
1105 notmuch_show_params_t params = {
1107 .omit_excluded = true,
1108 .output_body = true,
1109 .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
1111 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1112 bool exclude = true;
1113 bool entire_thread_set = false;
1114 bool single_message;
1116 notmuch_opt_desc_t options[] = {
1117 { .opt_keyword = &format, .name = "format", .keywords =
1118 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1119 { "text", NOTMUCH_FORMAT_TEXT },
1120 { "sexp", NOTMUCH_FORMAT_SEXP },
1121 { "mbox", NOTMUCH_FORMAT_MBOX },
1122 { "raw", NOTMUCH_FORMAT_RAW },
1124 { .opt_int = ¬much_format_version, .name = "format-version" },
1125 { .opt_bool = &exclude, .name = "exclude" },
1126 { .opt_bool = ¶ms.entire_thread, .name = "entire-thread",
1127 .present = &entire_thread_set },
1128 { .opt_int = ¶ms.part, .name = "part" },
1129 { .opt_keyword = (int*)(¶ms.crypto.decrypt), .name = "decrypt",
1130 .keyword_no_arg_value = "true", .keywords =
1131 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
1132 { "auto", NOTMUCH_DECRYPT_AUTO },
1133 { "true", NOTMUCH_DECRYPT_NOSTASH },
1134 { "stash", NOTMUCH_DECRYPT_TRUE },
1136 { .opt_bool = ¶ms.crypto.verify, .name = "verify" },
1137 { .opt_bool = ¶ms.output_body, .name = "body" },
1138 { .opt_bool = ¶ms.include_html, .name = "include-html" },
1139 { .opt_inherit = notmuch_shared_options },
1143 opt_index = parse_arguments (argc, argv, options, 1);
1145 return EXIT_FAILURE;
1147 notmuch_process_shared_options (argv[0]);
1149 /* explicit decryption implies verification */
1150 if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
1151 params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1152 params.crypto.verify = true;
1154 /* specifying a part implies single message display */
1155 single_message = params.part >= 0;
1157 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1158 /* if part was requested and format was not specified, use format=raw */
1159 if (params.part >= 0)
1160 format = NOTMUCH_FORMAT_RAW;
1162 format = NOTMUCH_FORMAT_TEXT;
1165 if (format == NOTMUCH_FORMAT_MBOX) {
1166 if (params.part > 0) {
1167 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1168 return EXIT_FAILURE;
1170 } else if (format == NOTMUCH_FORMAT_RAW) {
1171 /* raw format only supports single message display */
1172 single_message = true;
1175 notmuch_exit_if_unsupported_format ();
1177 /* Default is entire-thread = false except for format=json and
1179 if (! entire_thread_set &&
1180 (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
1181 params.entire_thread = true;
1183 if (!params.output_body) {
1184 if (params.part > 0) {
1185 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1186 params.output_body = true;
1188 if (format != NOTMUCH_FORMAT_TEXT &&
1189 format != NOTMUCH_FORMAT_JSON &&
1190 format != NOTMUCH_FORMAT_SEXP)
1192 "Warning: --body=false only implemented for format=text, format=json and format=sexp\n");
1196 if (params.include_html &&
1197 (format != NOTMUCH_FORMAT_TEXT &&
1198 format != NOTMUCH_FORMAT_JSON &&
1199 format != NOTMUCH_FORMAT_SEXP)) {
1200 fprintf (stderr, "Warning: --include-html only implemented for format=text, format=json and format=sexp\n");
1203 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1204 if (query_string == NULL) {
1205 fprintf (stderr, "Out of memory\n");
1206 return EXIT_FAILURE;
1209 if (*query_string == '\0') {
1210 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1211 return EXIT_FAILURE;
1214 notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1215 if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1216 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
1217 if (notmuch_database_open (notmuch_config_get_database_path (config),
1219 return EXIT_FAILURE;
1221 notmuch_exit_if_unmatched_db_uuid (notmuch);
1223 query = notmuch_query_create (notmuch, query_string);
1224 if (query == NULL) {
1225 fprintf (stderr, "Out of memory\n");
1226 return EXIT_FAILURE;
1229 /* Create structure printer. */
1230 formatter = formatters[format];
1231 sprinter = formatter->new_sprinter(config, stdout);
1233 params.out_stream = g_mime_stream_stdout_new ();
1235 /* If a single message is requested we do not use search_excludes. */
1236 if (single_message) {
1237 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1239 /* We always apply set the exclude flag. The
1240 * exclude=true|false option controls whether or not we return
1241 * threads that only match in an excluded message */
1242 const char **search_exclude_tags;
1243 size_t search_exclude_tags_length;
1245 notmuch_status_t status;
1247 search_exclude_tags = notmuch_config_get_search_exclude_tags
1248 (config, &search_exclude_tags_length);
1250 for (i = 0; i < search_exclude_tags_length; i++) {
1251 status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1252 if (status && status != NOTMUCH_STATUS_IGNORED) {
1253 print_status_query ("notmuch show", query, status);
1259 if (exclude == false) {
1260 notmuch_query_set_omit_excluded (query, false);
1261 params.omit_excluded = false;
1264 ret = do_show (config, query, formatter, sprinter, ¶ms);
1268 g_mime_stream_flush (params.out_stream);
1269 g_object_unref (params.out_stream);
1271 _notmuch_crypto_cleanup (¶ms.crypto);
1272 notmuch_query_destroy (query);
1273 notmuch_database_destroy (notmuch);
1275 return ret ? EXIT_FAILURE : EXIT_SUCCESS;