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);
386 #if (GMIME_MAJOR_VERSION < 3)
388 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
390 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
392 if (errors == GMIME_SIGNATURE_ERROR_NONE)
395 struct key_map_struct key_map[] = {
396 { GMIME_SIGNATURE_ERROR_EXPSIG, "sig-expired" },
397 { GMIME_SIGNATURE_ERROR_NO_PUBKEY, "key-missing"},
398 { GMIME_SIGNATURE_ERROR_EXPKEYSIG, "key-expired"},
399 { GMIME_SIGNATURE_ERROR_REVKEYSIG, "key-revoked"},
400 { GMIME_SIGNATURE_ERROR_UNSUPP_ALGO, "alg-unsupported"},
403 do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
407 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
409 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
411 if (!(errors & GMIME_SIGNATURE_STATUS_ERROR_MASK))
414 struct key_map_struct key_map[] = {
415 { GMIME_SIGNATURE_STATUS_KEY_REVOKED, "key-revoked"},
416 { GMIME_SIGNATURE_STATUS_KEY_EXPIRED, "key-expired"},
417 { GMIME_SIGNATURE_STATUS_SIG_EXPIRED, "sig-expired" },
418 { GMIME_SIGNATURE_STATUS_KEY_MISSING, "key-missing"},
419 { GMIME_SIGNATURE_STATUS_CRL_MISSING, "crl-missing"},
420 { GMIME_SIGNATURE_STATUS_CRL_TOO_OLD, "crl-too-old"},
421 { GMIME_SIGNATURE_STATUS_BAD_POLICY, "bad-policy"},
422 { GMIME_SIGNATURE_STATUS_SYS_ERROR, "sys-error"},
423 { GMIME_SIGNATURE_STATUS_TOFU_CONFLICT, "tofu-conflict"},
426 do_format_signature_errors (sp, key_map, ARRAY_SIZE(key_map), errors);
430 /* Signature status sprinter (GMime 2.6) */
432 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
434 /* Any changes to the JSON or S-Expression format should be
435 * reflected in the file devel/schemata. */
437 GMimeSignatureList *siglist = node->sig_list;
447 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
448 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
453 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
454 sp->map_key (sp, "status");
455 sp->string (sp, signature_status_to_string (status));
457 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
458 if (g_mime_signature_status_good (status)) {
460 sp->map_key (sp, "fingerprint");
461 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
463 /* these dates are seconds since the epoch; should we
464 * provide a more human-readable format string? */
465 time_t created = g_mime_signature_get_created (signature);
467 sp->map_key (sp, "created");
468 sp->integer (sp, created);
470 time_t expires = g_mime_signature_get_expires (signature);
472 sp->map_key (sp, "expires");
473 sp->integer (sp, expires);
476 const char *uid = g_mime_certificate_get_valid_userid (certificate);
478 sp->map_key (sp, "userid");
479 sp->string (sp, uid);
482 } else if (certificate) {
483 const char *key_id = g_mime_certificate_get_fpr16 (certificate);
485 sp->map_key (sp, "keyid");
486 sp->string (sp, key_id);
490 if (notmuch_format_version <= 3) {
491 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
492 if (g_mime_signature_status_error (errors)) {
493 sp->map_key (sp, "errors");
494 sp->integer (sp, errors);
497 format_signature_errors (sp, signature);
506 static notmuch_status_t
507 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
508 int indent, const notmuch_show_params_t *params)
510 /* The disposition and content-type metadata are associated with
511 * the envelope for message parts */
512 GMimeObject *meta = node->envelope_part ?
513 GMIME_OBJECT (node->envelope_part) : node->part;
514 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
515 const bool leaf = GMIME_IS_PART (node->part);
516 GMimeStream *stream = params->out_stream;
517 const char *part_type;
520 if (node->envelope_file) {
521 notmuch_message_t *message = node->envelope_file;
523 part_type = "message";
524 g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
526 notmuch_message_get_message_id (message),
528 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
529 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
530 notmuch_message_get_filename (message));
532 char *content_string;
533 const char *disposition = _get_disposition (meta);
534 const char *cid = g_mime_object_get_content_id (meta);
535 const char *filename = leaf ?
536 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
539 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
540 part_type = "attachment";
544 g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
546 g_mime_stream_printf (stream, ", Filename: %s", filename);
548 g_mime_stream_printf (stream, ", Content-id: %s", cid);
550 content_string = g_mime_content_type_to_string (content_type);
551 g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
552 g_free (content_string);
555 if (GMIME_IS_MESSAGE (node->part)) {
556 GMimeMessage *message = GMIME_MESSAGE (node->part);
557 char *recipients_string;
560 g_mime_stream_printf (stream, "\fheader{\n");
561 if (node->envelope_file)
562 g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
563 g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
564 g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
565 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
566 if (recipients_string)
567 g_mime_stream_printf (stream, "To: %s\n", recipients_string);
568 g_free (recipients_string);
569 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
570 if (recipients_string)
571 g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
572 g_free (recipients_string);
573 date_string = g_mime_message_get_date_string (node, message);
574 g_mime_stream_printf (stream, "Date: %s\n", date_string);
575 g_mime_stream_printf (stream, "\fheader}\n");
577 g_mime_stream_printf (stream, "\fbody{\n");
581 if (g_mime_content_type_is_type (content_type, "text", "*") &&
582 !g_mime_content_type_is_type (content_type, "text", "html"))
584 show_text_part_content (node->part, stream, 0);
586 char *content_string = g_mime_content_type_to_string (content_type);
587 g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
588 g_free (content_string);
592 for (i = 0; i < node->nchildren; i++)
593 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
595 if (GMIME_IS_MESSAGE (node->part))
596 g_mime_stream_printf (stream, "\fbody}\n");
598 g_mime_stream_printf (stream, "\f%s}\n", part_type);
600 return NOTMUCH_STATUS_SUCCESS;
604 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
606 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
607 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
608 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
609 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
610 ssize_t content_length = g_mime_stream_length (stream);
612 if (content_charset != NULL) {
613 sp->map_key (sp, "content-charset");
614 sp->string (sp, content_charset);
617 sp->map_key (sp, "content-transfer-encoding");
618 sp->string (sp, cte);
620 if (content_length >= 0) {
621 sp->map_key (sp, "content-length");
622 sp->integer (sp, content_length);
627 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
631 /* Any changes to the JSON or S-Expression format should be
632 * reflected in the file devel/schemata. */
634 if (node->envelope_file) {
636 format_message_sprinter (sp, node->envelope_file);
638 sp->map_key (sp, "headers");
639 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
642 sp->map_key (sp, "body");
644 format_part_sprinter (ctx, sp, mime_node_child (node, 0), true, include_html);
651 /* The disposition and content-type metadata are associated with
652 * the envelope for message parts */
653 GMimeObject *meta = node->envelope_part ?
654 GMIME_OBJECT (node->envelope_part) : node->part;
655 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
656 char *content_string;
657 const char *disposition = _get_disposition (meta);
658 const char *cid = g_mime_object_get_content_id (meta);
659 const char *filename = GMIME_IS_PART (node->part) ?
660 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
666 sp->map_key (sp, "id");
667 sp->integer (sp, node->part_num);
669 if (node->decrypt_attempted) {
670 sp->map_key (sp, "encstatus");
673 sp->map_key (sp, "status");
674 sp->string (sp, node->decrypt_success ? "good" : "bad");
679 if (node->verify_attempted) {
680 sp->map_key (sp, "sigstatus");
681 format_part_sigstatus_sprinter (sp, node);
684 sp->map_key (sp, "content-type");
685 content_string = g_mime_content_type_to_string (content_type);
686 sp->string (sp, content_string);
687 g_free (content_string);
690 sp->map_key (sp, "content-disposition");
691 sp->string (sp, disposition);
695 sp->map_key (sp, "content-id");
696 sp->string (sp, cid);
700 sp->map_key (sp, "filename");
701 sp->string (sp, filename);
704 if (GMIME_IS_PART (node->part)) {
705 /* For non-HTML text parts, we include the content in the
706 * JSON. Since JSON must be Unicode, we handle charset
707 * decoding here and do not report a charset to the caller.
708 * For text/html parts, we do not include the content unless
709 * the --include-html option has been passed. If a html part
710 * is not included, it can be requested directly. This makes
711 * charset decoding the responsibility on the caller so we
712 * report the charset for text/html parts.
714 if (g_mime_content_type_is_type (content_type, "text", "*") &&
716 ! g_mime_content_type_is_type (content_type, "text", "html")))
718 GMimeStream *stream_memory = g_mime_stream_mem_new ();
719 GByteArray *part_content;
720 show_text_part_content (node->part, stream_memory, 0);
721 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
722 sp->map_key (sp, "content");
723 sp->string_len (sp, (char *) part_content->data, part_content->len);
724 g_object_unref (stream_memory);
726 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
728 } else if (GMIME_IS_MULTIPART (node->part)) {
729 sp->map_key (sp, "content");
732 } else if (GMIME_IS_MESSAGE (node->part)) {
733 sp->map_key (sp, "content");
737 sp->map_key (sp, "headers");
738 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false);
740 sp->map_key (sp, "body");
745 for (i = 0; i < node->nchildren; i++)
746 format_part_sprinter (ctx, sp, mime_node_child (node, i), true, include_html);
748 /* Close content structures */
749 for (i = 0; i < nclose; i++)
755 static notmuch_status_t
756 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
757 mime_node_t *node, unused (int indent),
758 const notmuch_show_params_t *params)
760 format_part_sprinter (ctx, sp, node, params->output_body, params->include_html);
762 return NOTMUCH_STATUS_SUCCESS;
765 /* Print a message in "mboxrd" format as documented, for example,
768 * http://qmail.org/qmail-manual-html/man5/mbox.html
770 static notmuch_status_t
771 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
773 unused (const notmuch_show_params_t *params))
775 notmuch_message_t *message = node->envelope_file;
777 const char *filename;
782 struct tm date_gmtime;
783 char date_asctime[26];
790 INTERNAL_ERROR ("format_part_mbox requires a root part");
792 filename = notmuch_message_get_filename (message);
793 file = fopen (filename, "r");
795 fprintf (stderr, "Failed to open %s: %s\n",
796 filename, strerror (errno));
797 return NOTMUCH_STATUS_FILE_ERROR;
800 from = notmuch_message_get_header (message, "from");
801 from = _extract_email_address (ctx, from);
803 date = notmuch_message_get_date (message);
804 gmtime_r (&date, &date_gmtime);
805 asctime_r (&date_gmtime, date_asctime);
807 printf ("From %s %s", from, date_asctime);
809 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
810 if (_is_from_line (line))
819 return NOTMUCH_STATUS_SUCCESS;
822 static notmuch_status_t
823 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
824 mime_node_t *node, unused (int indent),
825 const notmuch_show_params_t *params)
827 if (node->envelope_file) {
828 /* Special case the entire message to avoid MIME parsing. */
829 const char *filename;
834 filename = notmuch_message_get_filename (node->envelope_file);
835 if (filename == NULL) {
836 fprintf (stderr, "Error: Cannot get message filename.\n");
837 return NOTMUCH_STATUS_FILE_ERROR;
840 file = fopen (filename, "r");
842 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
843 return NOTMUCH_STATUS_FILE_ERROR;
846 while (!feof (file)) {
847 size = fread (buf, 1, sizeof (buf), file);
849 fprintf (stderr, "Error: Read failed from %s\n", filename);
851 return NOTMUCH_STATUS_FILE_ERROR;
854 if (fwrite (buf, size, 1, stdout) != 1) {
855 fprintf (stderr, "Error: Write failed\n");
857 return NOTMUCH_STATUS_FILE_ERROR;
862 return NOTMUCH_STATUS_SUCCESS;
865 GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
867 if (GMIME_IS_PART (node->part)) {
868 /* For leaf parts, we emit only the transfer-decoded
870 GMimeDataWrapper *wrapper;
871 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
873 if (wrapper && stream_filter)
874 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
876 /* Write out the whole part. For message parts (the root
877 * part and embedded message parts), this will be the
878 * message including its headers (but not the
879 * encapsulating part's headers). For multipart parts,
880 * this will include the headers. */
882 g_mime_object_write_to_stream (node->part, stream_filter);
886 g_object_unref (stream_filter);
888 return NOTMUCH_STATUS_SUCCESS;
891 static notmuch_status_t
892 show_message (void *ctx,
893 const notmuch_show_format_t *format,
895 notmuch_message_t *message,
897 notmuch_show_params_t *params)
899 void *local = talloc_new (ctx);
900 mime_node_t *root, *part;
901 notmuch_status_t status;
902 unsigned int session_keys = 0;
903 notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
905 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
906 session_key_count_error = notmuch_message_count_properties (message, "session-key", &session_keys);
908 status = mime_node_open (local, message, &(params->crypto), &root);
911 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
913 status = format->part (local, sp, part, indent, params);
914 #if HAVE_GMIME_SESSION_KEYS
915 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error == NOTMUCH_STATUS_SUCCESS) {
916 unsigned int new_session_keys = 0;
917 if (notmuch_message_count_properties (message, "session-key", &new_session_keys) == NOTMUCH_STATUS_SUCCESS &&
918 new_session_keys > session_keys) {
919 /* try a quiet re-indexing */
920 notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch_message_get_database (message));
922 notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
923 print_status_message ("Error re-indexing message with --decrypt=stash",
924 message, notmuch_message_reindex (message, indexopts));
934 static notmuch_status_t
935 show_messages (void *ctx,
936 const notmuch_show_format_t *format,
938 notmuch_messages_t *messages,
940 notmuch_show_params_t *params)
942 notmuch_message_t *message;
946 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
951 notmuch_messages_valid (messages);
952 notmuch_messages_move_to_next (messages))
956 message = notmuch_messages_get (messages);
958 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
959 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
961 next_indent = indent;
963 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
964 status = show_message (ctx, format, sp, message, indent, params);
967 next_indent = indent + 1;
972 status = show_messages (ctx,
974 notmuch_message_get_replies (message),
980 notmuch_message_destroy (message);
990 /* Formatted output of single message */
992 do_show_single (void *ctx,
993 notmuch_query_t *query,
994 const notmuch_show_format_t *format,
996 notmuch_show_params_t *params)
998 notmuch_messages_t *messages;
999 notmuch_message_t *message;
1000 notmuch_status_t status;
1003 status = notmuch_query_count_messages (query, &count);
1004 if (print_status_query ("notmuch show", query, status))
1008 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
1012 status = notmuch_query_search_messages (query, &messages);
1013 if (print_status_query ("notmuch show", query, status))
1016 message = notmuch_messages_get (messages);
1018 if (message == NULL) {
1019 fprintf (stderr, "Error: Cannot find matching message.\n");
1023 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
1025 return show_message (ctx, format, sp, message, 0, params)
1026 != NOTMUCH_STATUS_SUCCESS;
1029 /* Formatted output of threads */
1032 notmuch_query_t *query,
1033 const notmuch_show_format_t *format,
1035 notmuch_show_params_t *params)
1037 notmuch_threads_t *threads;
1038 notmuch_thread_t *thread;
1039 notmuch_messages_t *messages;
1040 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1042 status= notmuch_query_search_threads (query, &threads);
1043 if (print_status_query ("notmuch show", query, status))
1046 sp->begin_list (sp);
1049 notmuch_threads_valid (threads);
1050 notmuch_threads_move_to_next (threads))
1052 thread = notmuch_threads_get (threads);
1054 messages = notmuch_thread_get_toplevel_messages (thread);
1056 if (messages == NULL)
1057 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
1058 notmuch_thread_get_thread_id (thread));
1060 status = show_messages (ctx, format, sp, messages, 0, params);
1064 notmuch_thread_destroy (thread);
1070 return res != NOTMUCH_STATUS_SUCCESS;
1074 NOTMUCH_FORMAT_NOT_SPECIFIED,
1075 NOTMUCH_FORMAT_JSON,
1076 NOTMUCH_FORMAT_SEXP,
1077 NOTMUCH_FORMAT_TEXT,
1078 NOTMUCH_FORMAT_MBOX,
1082 static const notmuch_show_format_t format_json = {
1083 .new_sprinter = sprinter_json_create,
1084 .part = format_part_sprinter_entry,
1087 static const notmuch_show_format_t format_sexp = {
1088 .new_sprinter = sprinter_sexp_create,
1089 .part = format_part_sprinter_entry,
1092 static const notmuch_show_format_t format_text = {
1093 .new_sprinter = sprinter_text_create,
1094 .part = format_part_text,
1097 static const notmuch_show_format_t format_mbox = {
1098 .new_sprinter = sprinter_text_create,
1099 .part = format_part_mbox,
1102 static const notmuch_show_format_t format_raw = {
1103 .new_sprinter = sprinter_text_create,
1104 .part = format_part_raw,
1107 static const notmuch_show_format_t *formatters[] = {
1108 [NOTMUCH_FORMAT_JSON] = &format_json,
1109 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1110 [NOTMUCH_FORMAT_TEXT] = &format_text,
1111 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1112 [NOTMUCH_FORMAT_RAW] = &format_raw,
1116 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1118 notmuch_database_t *notmuch;
1119 notmuch_query_t *query;
1122 const notmuch_show_format_t *formatter;
1123 sprinter_t *sprinter;
1124 notmuch_show_params_t params = {
1126 .omit_excluded = true,
1127 .output_body = true,
1128 .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
1130 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1131 bool exclude = true;
1132 bool entire_thread_set = false;
1133 bool single_message;
1135 notmuch_opt_desc_t options[] = {
1136 { .opt_keyword = &format, .name = "format", .keywords =
1137 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1138 { "text", NOTMUCH_FORMAT_TEXT },
1139 { "sexp", NOTMUCH_FORMAT_SEXP },
1140 { "mbox", NOTMUCH_FORMAT_MBOX },
1141 { "raw", NOTMUCH_FORMAT_RAW },
1143 { .opt_int = ¬much_format_version, .name = "format-version" },
1144 { .opt_bool = &exclude, .name = "exclude" },
1145 { .opt_bool = ¶ms.entire_thread, .name = "entire-thread",
1146 .present = &entire_thread_set },
1147 { .opt_int = ¶ms.part, .name = "part" },
1148 { .opt_keyword = (int*)(¶ms.crypto.decrypt), .name = "decrypt",
1149 .keyword_no_arg_value = "true", .keywords =
1150 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
1151 { "auto", NOTMUCH_DECRYPT_AUTO },
1152 { "true", NOTMUCH_DECRYPT_NOSTASH },
1153 { "stash", NOTMUCH_DECRYPT_TRUE },
1155 { .opt_bool = ¶ms.crypto.verify, .name = "verify" },
1156 { .opt_bool = ¶ms.output_body, .name = "body" },
1157 { .opt_bool = ¶ms.include_html, .name = "include-html" },
1158 { .opt_inherit = notmuch_shared_options },
1162 opt_index = parse_arguments (argc, argv, options, 1);
1164 return EXIT_FAILURE;
1166 notmuch_process_shared_options (argv[0]);
1168 /* explicit decryption implies verification */
1169 if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
1170 params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1171 params.crypto.verify = true;
1173 /* specifying a part implies single message display */
1174 single_message = params.part >= 0;
1176 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1177 /* if part was requested and format was not specified, use format=raw */
1178 if (params.part >= 0)
1179 format = NOTMUCH_FORMAT_RAW;
1181 format = NOTMUCH_FORMAT_TEXT;
1184 if (format == NOTMUCH_FORMAT_MBOX) {
1185 if (params.part > 0) {
1186 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1187 return EXIT_FAILURE;
1189 } else if (format == NOTMUCH_FORMAT_RAW) {
1190 /* raw format only supports single message display */
1191 single_message = true;
1194 notmuch_exit_if_unsupported_format ();
1196 /* Default is entire-thread = false except for format=json and
1198 if (! entire_thread_set &&
1199 (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
1200 params.entire_thread = true;
1202 if (!params.output_body) {
1203 if (params.part > 0) {
1204 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1205 params.output_body = true;
1207 if (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)
1209 "Warning: --body=false only implemented for format=json and format=sexp\n");
1213 if (params.include_html &&
1214 (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1215 fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1218 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1219 if (query_string == NULL) {
1220 fprintf (stderr, "Out of memory\n");
1221 return EXIT_FAILURE;
1224 if (*query_string == '\0') {
1225 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1226 return EXIT_FAILURE;
1229 #if (GMIME_MAJOR_VERSION < 3)
1230 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1233 notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1234 if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1235 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
1236 if (notmuch_database_open (notmuch_config_get_database_path (config),
1238 return EXIT_FAILURE;
1240 notmuch_exit_if_unmatched_db_uuid (notmuch);
1242 query = notmuch_query_create (notmuch, query_string);
1243 if (query == NULL) {
1244 fprintf (stderr, "Out of memory\n");
1245 return EXIT_FAILURE;
1248 /* Create structure printer. */
1249 formatter = formatters[format];
1250 sprinter = formatter->new_sprinter(config, stdout);
1252 params.out_stream = g_mime_stream_stdout_new ();
1254 /* If a single message is requested we do not use search_excludes. */
1255 if (single_message) {
1256 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1258 /* We always apply set the exclude flag. The
1259 * exclude=true|false option controls whether or not we return
1260 * threads that only match in an excluded message */
1261 const char **search_exclude_tags;
1262 size_t search_exclude_tags_length;
1264 notmuch_status_t status;
1266 search_exclude_tags = notmuch_config_get_search_exclude_tags
1267 (config, &search_exclude_tags_length);
1269 for (i = 0; i < search_exclude_tags_length; i++) {
1270 status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1271 if (status && status != NOTMUCH_STATUS_IGNORED) {
1272 print_status_query ("notmuch show", query, status);
1278 if (exclude == false) {
1279 notmuch_query_set_omit_excluded (query, false);
1280 params.omit_excluded = false;
1283 ret = do_show (config, query, formatter, sprinter, ¶ms);
1287 g_mime_stream_flush (params.out_stream);
1288 g_object_unref (params.out_stream);
1290 _notmuch_crypto_cleanup (¶ms.crypto);
1291 notmuch_query_destroy (query);
1292 notmuch_database_destroy (notmuch);
1294 return ret ? EXIT_FAILURE : EXIT_SUCCESS;