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"
24 #include "zlib-extra.h"
27 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
34 result = talloc_strdup (ctx, "");
38 for (tags = notmuch_message_get_tags (message);
39 notmuch_tags_valid (tags);
40 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);
72 _get_disposition (GMimeObject *meta)
74 GMimeContentDisposition *disposition;
76 disposition = g_mime_object_get_content_disposition (meta);
80 return g_mime_content_disposition_get_disposition (disposition);
83 /* Emit a sequence of key/value pairs for the metadata of message.
84 * The caller should begin a map before calling this. */
86 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
88 /* Any changes to the JSON or S-Expression format should be
89 * reflected in the file devel/schemata. */
91 void *local = talloc_new (NULL);
94 const char *relative_date;
96 sp->map_key (sp, "id");
97 sp->string (sp, notmuch_message_get_message_id (message));
99 sp->map_key (sp, "match");
100 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
102 sp->map_key (sp, "excluded");
103 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
105 sp->map_key (sp, "filename");
106 if (notmuch_format_version >= 3) {
107 notmuch_filenames_t *filenames;
110 for (filenames = notmuch_message_get_filenames (message);
111 notmuch_filenames_valid (filenames);
112 notmuch_filenames_move_to_next (filenames)) {
113 sp->string (sp, notmuch_filenames_get (filenames));
115 notmuch_filenames_destroy (filenames);
118 sp->string (sp, notmuch_message_get_filename (message));
121 sp->map_key (sp, "timestamp");
122 date = notmuch_message_get_date (message);
123 sp->integer (sp, date);
125 sp->map_key (sp, "date_relative");
126 relative_date = notmuch_time_relative_date (local, date);
127 sp->string (sp, relative_date);
129 sp->map_key (sp, "tags");
131 for (tags = notmuch_message_get_tags (message);
132 notmuch_tags_valid (tags);
133 notmuch_tags_move_to_next (tags))
134 sp->string (sp, notmuch_tags_get (tags));
140 /* Extract just the email address from the contents of a From:
143 _extract_email_address (const void *ctx, const char *from)
145 InternetAddressList *addresses;
146 InternetAddress *address;
147 InternetAddressMailbox *mailbox;
148 const char *email = "MAILER-DAEMON";
150 addresses = internet_address_list_parse (NULL, from);
152 /* Bail if there is no address here. */
153 if (addresses == NULL || internet_address_list_length (addresses) < 1)
156 /* Otherwise, just use the first address. */
157 address = internet_address_list_get_address (addresses, 0);
159 /* The From header should never contain an address group rather
160 * than a mailbox. So bail if it does. */
161 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
164 mailbox = INTERNET_ADDRESS_MAILBOX (address);
165 email = internet_address_mailbox_get_addr (mailbox);
166 email = talloc_strdup (ctx, email);
170 g_object_unref (addresses);
175 /* Return 1 if 'line' is an mbox From_ line---that is, a line
176 * beginning with zero or more '>' characters followed by the
177 * characters 'F', 'r', 'o', 'm', and space.
179 * Any characters at all may appear after that in the line.
182 _is_from_line (const char *line)
184 const char *s = line;
192 if (STRNCMP_LITERAL (s, "From ") == 0)
199 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
200 bool reply, const _notmuch_message_crypto_t *msg_crypto)
202 /* Any changes to the JSON or S-Expression format should be
203 * reflected in the file devel/schemata. */
205 char *recipients_string;
206 const char *reply_to_string;
207 void *local = talloc_new (sp);
211 sp->map_key (sp, "Subject");
212 if (msg_crypto && msg_crypto->payload_subject) {
213 sp->string (sp, msg_crypto->payload_subject);
215 sp->string (sp, g_mime_message_get_subject (message));
217 sp->map_key (sp, "From");
218 sp->string (sp, g_mime_message_get_from_string (message));
220 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
221 if (recipients_string) {
222 sp->map_key (sp, "To");
223 sp->string (sp, recipients_string);
224 g_free (recipients_string);
227 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
228 if (recipients_string) {
229 sp->map_key (sp, "Cc");
230 sp->string (sp, recipients_string);
231 g_free (recipients_string);
234 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_BCC);
235 if (recipients_string) {
236 sp->map_key (sp, "Bcc");
237 sp->string (sp, recipients_string);
238 g_free (recipients_string);
241 reply_to_string = g_mime_message_get_reply_to_string (local, message);
242 if (reply_to_string) {
243 sp->map_key (sp, "Reply-To");
244 sp->string (sp, reply_to_string);
248 sp->map_key (sp, "In-reply-to");
249 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
251 sp->map_key (sp, "References");
252 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
254 sp->map_key (sp, "Date");
255 sp->string (sp, g_mime_message_get_date_string (sp, message));
262 /* Write a MIME text part out to the given stream.
264 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
267 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
268 * UTF-8) will be performed, so it is inappropriate to call this
269 * function with a non-text part. Doing so will trigger an internal
273 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
274 notmuch_show_text_part_flags flags)
276 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
277 GMimeStream *stream_filter = NULL;
278 GMimeFilter *crlf_filter = NULL;
279 GMimeFilter *windows_filter = NULL;
280 GMimeDataWrapper *wrapper;
283 if (! g_mime_content_type_is_type (content_type, "text", "*"))
284 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
285 g_mime_content_type_get_mime_type (content_type));
287 if (stream_out == NULL)
290 charset = g_mime_object_get_content_type_parameter (part, "charset");
291 charset = charset ? g_mime_charset_canon_name (charset) : NULL;
292 wrapper = g_mime_part_get_content (GMIME_PART (part));
293 if (wrapper && charset && ! g_ascii_strncasecmp (charset, "iso-8859-", 9)) {
294 GMimeStream *null_stream = NULL;
295 GMimeStream *null_stream_filter = NULL;
297 /* Check for mislabeled Windows encoding */
298 null_stream = g_mime_stream_null_new ();
299 null_stream_filter = g_mime_stream_filter_new (null_stream);
300 windows_filter = g_mime_filter_windows_new (charset);
301 g_mime_stream_filter_add (GMIME_STREAM_FILTER (null_stream_filter),
303 g_mime_data_wrapper_write_to_stream (wrapper, null_stream_filter);
304 charset = g_mime_filter_windows_real_charset (
305 (GMimeFilterWindows *) windows_filter);
307 if (null_stream_filter)
308 g_object_unref (null_stream_filter);
310 g_object_unref (null_stream);
311 /* Keep a reference to windows_filter in order to prevent the
312 * charset string from deallocation. */
315 stream_filter = g_mime_stream_filter_new (stream_out);
316 crlf_filter = g_mime_filter_dos2unix_new (false);
317 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
319 g_object_unref (crlf_filter);
322 GMimeFilter *charset_filter;
323 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
324 /* This result can be NULL for things like "unknown-8bit".
325 * Don't set a NULL filter as that makes GMime print
326 * annoying assertion-failure messages on stderr. */
327 if (charset_filter) {
328 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
330 g_object_unref (charset_filter);
335 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
336 GMimeFilter *reply_filter;
337 reply_filter = g_mime_filter_reply_new (true);
339 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
341 g_object_unref (reply_filter);
345 if (wrapper && stream_filter)
346 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
348 g_object_unref (stream_filter);
350 g_object_unref (windows_filter);
354 signature_status_to_string (GMimeSignatureStatus status)
356 if (g_mime_signature_status_bad (status))
359 if (g_mime_signature_status_error (status))
362 if (g_mime_signature_status_good (status))
368 /* Print signature flags */
369 struct key_map_struct {
370 GMimeSignatureStatus bit;
375 do_format_signature_errors (sprinter_t *sp, struct key_map_struct *key_map,
376 unsigned int array_map_len, GMimeSignatureStatus errors)
378 sp->map_key (sp, "errors");
381 for (unsigned int i = 0; i < array_map_len; i++) {
382 if (errors & key_map[i].bit) {
383 sp->map_key (sp, key_map[i].string);
384 sp->boolean (sp, true);
392 format_signature_errors (sprinter_t *sp, GMimeSignature *signature)
394 GMimeSignatureStatus errors = g_mime_signature_get_status (signature);
396 if (! (errors & GMIME_SIGNATURE_STATUS_ERROR_MASK))
399 struct key_map_struct key_map[] = {
400 { GMIME_SIGNATURE_STATUS_KEY_REVOKED, "key-revoked" },
401 { GMIME_SIGNATURE_STATUS_KEY_EXPIRED, "key-expired" },
402 { GMIME_SIGNATURE_STATUS_SIG_EXPIRED, "sig-expired" },
403 { GMIME_SIGNATURE_STATUS_KEY_MISSING, "key-missing" },
404 { GMIME_SIGNATURE_STATUS_CRL_MISSING, "crl-missing" },
405 { GMIME_SIGNATURE_STATUS_CRL_TOO_OLD, "crl-too-old" },
406 { GMIME_SIGNATURE_STATUS_BAD_POLICY, "bad-policy" },
407 { GMIME_SIGNATURE_STATUS_SYS_ERROR, "sys-error" },
408 { GMIME_SIGNATURE_STATUS_TOFU_CONFLICT, "tofu-conflict" },
411 do_format_signature_errors (sp, key_map, ARRAY_SIZE (key_map), errors);
414 /* Signature status sprinter */
416 format_part_sigstatus_sprinter (sprinter_t *sp, GMimeSignatureList *siglist)
418 /* Any changes to the JSON or S-Expression format should be
419 * reflected in the file devel/schemata. */
429 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
430 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
435 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
436 sp->map_key (sp, "status");
437 sp->string (sp, signature_status_to_string (status));
439 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
440 if (g_mime_signature_status_good (status)) {
442 sp->map_key (sp, "fingerprint");
443 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
445 /* these dates are seconds since the epoch; should we
446 * provide a more human-readable format string? */
447 time_t created = g_mime_signature_get_created (signature);
449 sp->map_key (sp, "created");
450 sp->integer (sp, created);
452 time_t expires = g_mime_signature_get_expires (signature);
454 sp->map_key (sp, "expires");
455 sp->integer (sp, expires);
458 const char *uid = g_mime_certificate_get_valid_userid (certificate);
460 sp->map_key (sp, "userid");
461 sp->string (sp, uid);
464 } else if (certificate) {
465 const char *key_id = g_mime_certificate_get_fpr16 (certificate);
467 sp->map_key (sp, "keyid");
468 sp->string (sp, key_id);
472 if (notmuch_format_version <= 3) {
473 GMimeSignatureStatus errors = g_mime_signature_get_status (signature);
474 if (g_mime_signature_status_error (errors)) {
475 sp->map_key (sp, "errors");
476 sp->integer (sp, errors);
479 format_signature_errors (sp, signature);
488 static notmuch_status_t
489 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
490 int indent, const notmuch_show_params_t *params)
492 /* The disposition and content-type metadata are associated with
493 * the envelope for message parts */
494 GMimeObject *meta = node->envelope_part ? (
495 GMIME_OBJECT (node->envelope_part) ) : node->part;
496 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
497 const bool leaf = GMIME_IS_PART (node->part);
498 GMimeStream *stream = params->out_stream;
499 const char *part_type;
502 if (node->envelope_file) {
503 notmuch_message_t *message = node->envelope_file;
505 part_type = "message";
506 g_mime_stream_printf (stream, "\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
508 notmuch_message_get_message_id (message),
510 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
511 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
512 notmuch_message_get_filename (message));
514 char *content_string;
515 const char *disposition = _get_disposition (meta);
516 const char *cid = g_mime_object_get_content_id (meta);
517 const char *filename = leaf ? (
518 g_mime_part_get_filename (GMIME_PART (node->part)) ) : NULL;
521 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
522 part_type = "attachment";
526 g_mime_stream_printf (stream, "\f%s{ ID: %d", part_type, node->part_num);
528 g_mime_stream_printf (stream, ", Filename: %s", filename);
530 g_mime_stream_printf (stream, ", Content-id: %s", cid);
532 content_string = g_mime_content_type_get_mime_type (content_type);
533 g_mime_stream_printf (stream, ", Content-type: %s\n", content_string);
534 g_free (content_string);
537 if (GMIME_IS_MESSAGE (node->part)) {
538 GMimeMessage *message = GMIME_MESSAGE (node->part);
539 char *recipients_string;
542 g_mime_stream_printf (stream, "\fheader{\n");
543 if (node->envelope_file)
544 g_mime_stream_printf (stream, "%s\n", _get_one_line_summary (ctx, node->envelope_file));
545 g_mime_stream_printf (stream, "Subject: %s\n", g_mime_message_get_subject (message));
546 g_mime_stream_printf (stream, "From: %s\n", g_mime_message_get_from_string (message));
547 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_TO);
548 if (recipients_string)
549 g_mime_stream_printf (stream, "To: %s\n", recipients_string);
550 g_free (recipients_string);
551 recipients_string = g_mime_message_get_address_string (message, GMIME_ADDRESS_TYPE_CC);
552 if (recipients_string)
553 g_mime_stream_printf (stream, "Cc: %s\n", recipients_string);
554 g_free (recipients_string);
555 date_string = g_mime_message_get_date_string (node, message);
556 g_mime_stream_printf (stream, "Date: %s\n", date_string);
557 g_mime_stream_printf (stream, "\fheader}\n");
559 if (! params->output_body) {
560 g_mime_stream_printf (stream, "\f%s}\n", part_type);
561 return NOTMUCH_STATUS_SUCCESS;
563 g_mime_stream_printf (stream, "\fbody{\n");
567 if (g_mime_content_type_is_type (content_type, "text", "*") &&
568 (params->include_html ||
569 ! g_mime_content_type_is_type (content_type, "text", "html"))) {
570 show_text_part_content (node->part, stream, 0);
572 char *content_string = g_mime_content_type_get_mime_type (content_type);
573 g_mime_stream_printf (stream, "Non-text part: %s\n", content_string);
574 g_free (content_string);
578 for (i = 0; i < node->nchildren; i++)
579 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
581 if (GMIME_IS_MESSAGE (node->part))
582 g_mime_stream_printf (stream, "\fbody}\n");
584 g_mime_stream_printf (stream, "\f%s}\n", part_type);
586 return NOTMUCH_STATUS_SUCCESS;
590 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
592 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
593 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
594 GMimeDataWrapper *wrapper = g_mime_part_get_content (part);
595 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
596 ssize_t content_length = g_mime_stream_length (stream);
598 if (content_charset != NULL) {
599 sp->map_key (sp, "content-charset");
600 sp->string (sp, content_charset);
603 sp->map_key (sp, "content-transfer-encoding");
604 sp->string (sp, cte);
606 if (content_length >= 0) {
607 sp->map_key (sp, "content-length");
608 sp->integer (sp, content_length);
613 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
617 /* Any changes to the JSON or S-Expression format should be
618 * reflected in the file devel/schemata. */
620 if (node->envelope_file) {
621 const _notmuch_message_crypto_t *msg_crypto = NULL;
623 format_message_sprinter (sp, node->envelope_file);
626 sp->map_key (sp, "body");
628 format_part_sprinter (ctx, sp, mime_node_child (node, 0), true, include_html);
632 msg_crypto = mime_node_get_message_crypto_status (node);
633 if (notmuch_format_version >= 4) {
634 sp->map_key (sp, "crypto");
636 if (msg_crypto->sig_list ||
637 msg_crypto->decryption_status != NOTMUCH_MESSAGE_DECRYPTED_NONE) {
638 if (msg_crypto->sig_list) {
639 sp->map_key (sp, "signed");
641 sp->map_key (sp, "status");
642 format_part_sigstatus_sprinter (sp, msg_crypto->sig_list);
643 if (msg_crypto->signature_encrypted) {
644 sp->map_key (sp, "encrypted");
645 sp->boolean (sp, msg_crypto->signature_encrypted);
647 if (msg_crypto->payload_subject) {
648 sp->map_key (sp, "headers");
650 sp->string (sp, "Subject");
655 if (msg_crypto->decryption_status != NOTMUCH_MESSAGE_DECRYPTED_NONE) {
656 sp->map_key (sp, "decrypted");
658 sp->map_key (sp, "status");
659 sp->string (sp, msg_crypto->decryption_status == NOTMUCH_MESSAGE_DECRYPTED_FULL ? "full" : "partial");
661 if (msg_crypto->payload_subject) {
662 const char *subject = g_mime_message_get_subject GMIME_MESSAGE (node->part);
663 if (subject == NULL || strcmp (subject, msg_crypto->payload_subject)) {
664 /* protected subject differs from the external header */
665 sp->map_key (sp, "header-mask");
667 sp->map_key (sp, "Subject");
671 sp->string (sp, subject);
681 sp->map_key (sp, "headers");
682 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false, msg_crypto);
688 /* The disposition and content-type metadata are associated with
689 * the envelope for message parts */
690 GMimeObject *meta = node->envelope_part ? (
691 GMIME_OBJECT (node->envelope_part) ) : node->part;
692 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
693 char *content_string;
694 const char *disposition = _get_disposition (meta);
695 const char *cid = g_mime_object_get_content_id (meta);
696 const char *filename = GMIME_IS_PART (node->part) ? (
697 g_mime_part_get_filename (GMIME_PART (node->part) ) ) : NULL;
703 sp->map_key (sp, "id");
704 sp->integer (sp, node->part_num);
706 if (node->decrypt_attempted) {
707 sp->map_key (sp, "encstatus");
710 sp->map_key (sp, "status");
711 sp->string (sp, node->decrypt_success ? "good" : "bad");
716 if (node->verify_attempted) {
717 sp->map_key (sp, "sigstatus");
718 format_part_sigstatus_sprinter (sp, node->sig_list);
721 sp->map_key (sp, "content-type");
722 content_string = g_mime_content_type_get_mime_type (content_type);
723 sp->string (sp, content_string);
724 g_free (content_string);
727 sp->map_key (sp, "content-disposition");
728 sp->string (sp, disposition);
732 sp->map_key (sp, "content-id");
733 sp->string (sp, cid);
737 sp->map_key (sp, "filename");
738 sp->string (sp, filename);
741 if (GMIME_IS_PART (node->part)) {
742 /* For non-HTML text parts, we include the content in the
743 * JSON. Since JSON must be Unicode, we handle charset
744 * decoding here and do not report a charset to the caller.
745 * For text/html parts, we do not include the content unless
746 * the --include-html option has been passed. If a html part
747 * is not included, it can be requested directly. This makes
748 * charset decoding the responsibility on the caller so we
749 * report the charset for text/html parts.
751 if (g_mime_content_type_is_type (content_type, "text", "*") &&
753 ! g_mime_content_type_is_type (content_type, "text", "html"))) {
754 GMimeStream *stream_memory = g_mime_stream_mem_new ();
755 GByteArray *part_content;
756 show_text_part_content (node->part, stream_memory, 0);
757 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
758 sp->map_key (sp, "content");
759 sp->string_len (sp, (char *) part_content->data, part_content->len);
760 g_object_unref (stream_memory);
762 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
764 } else if (GMIME_IS_MULTIPART (node->part)) {
765 sp->map_key (sp, "content");
768 } else if (GMIME_IS_MESSAGE (node->part)) {
769 sp->map_key (sp, "content");
773 sp->map_key (sp, "headers");
774 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), false, NULL);
776 sp->map_key (sp, "body");
781 for (i = 0; i < node->nchildren; i++)
782 format_part_sprinter (ctx, sp, mime_node_child (node, i), true, include_html);
784 /* Close content structures */
785 for (i = 0; i < nclose; i++)
791 static notmuch_status_t
792 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
793 mime_node_t *node, unused (int indent),
794 const notmuch_show_params_t *params)
796 format_part_sprinter (ctx, sp, node, params->output_body, params->include_html);
798 return NOTMUCH_STATUS_SUCCESS;
801 /* Print a message in "mboxrd" format as documented, for example,
804 * http://qmail.org/qmail-manual-html/man5/mbox.html
806 static notmuch_status_t
807 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
809 unused (const notmuch_show_params_t *params))
811 notmuch_message_t *message = node->envelope_file;
813 const char *filename;
818 struct tm date_gmtime;
819 char date_asctime[26];
826 INTERNAL_ERROR ("format_part_mbox requires a root part");
828 filename = notmuch_message_get_filename (message);
829 file = gzopen (filename, "r");
831 fprintf (stderr, "Failed to open %s: %s\n",
832 filename, strerror (errno));
833 return NOTMUCH_STATUS_FILE_ERROR;
836 from = notmuch_message_get_header (message, "from");
837 from = _extract_email_address (ctx, from);
839 date = notmuch_message_get_date (message);
840 gmtime_r (&date, &date_gmtime);
841 asctime_r (&date_gmtime, date_asctime);
843 printf ("From %s %s", from, date_asctime);
845 while ((line_len = gz_getline (message, &line, &line_size, file)) != UTIL_EOF ) {
846 if (_is_from_line (line))
855 return NOTMUCH_STATUS_SUCCESS;
858 static notmuch_status_t
859 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
860 mime_node_t *node, unused (int indent),
861 const notmuch_show_params_t *params)
863 if (node->envelope_file) {
864 /* Special case the entire message to avoid MIME parsing. */
865 const char *filename;
866 GMimeStream *stream = NULL;
869 notmuch_status_t ret = NOTMUCH_STATUS_FILE_ERROR;
871 filename = notmuch_message_get_filename (node->envelope_file);
872 if (filename == NULL) {
873 fprintf (stderr, "Error: Cannot get message filename.\n");
877 stream = g_mime_stream_gzfile_open (filename);
878 if (stream == NULL) {
879 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
883 while (! g_mime_stream_eos (stream)) {
884 ssize = g_mime_stream_read (stream, buf, sizeof (buf));
886 fprintf (stderr, "Error: Read failed from %s\n", filename);
890 if (ssize > 0 && fwrite (buf, ssize, 1, stdout) != 1) {
891 fprintf (stderr, "Error: Write %ld chars to stdout failed\n", ssize);
896 ret = NOTMUCH_STATUS_SUCCESS;
898 /* XXX This DONE is just for the special case of a node in a single file */
901 g_object_unref (stream);
906 GMimeStream *stream_filter = g_mime_stream_filter_new (params->out_stream);
908 if (GMIME_IS_PART (node->part)) {
909 /* For leaf parts, we emit only the transfer-decoded
911 GMimeDataWrapper *wrapper;
912 wrapper = g_mime_part_get_content (GMIME_PART (node->part));
914 if (wrapper && stream_filter)
915 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
917 /* Write out the whole part. For message parts (the root
918 * part and embedded message parts), this will be the
919 * message including its headers (but not the
920 * encapsulating part's headers). For multipart parts,
921 * this will include the headers. */
923 g_mime_object_write_to_stream (node->part, NULL, stream_filter);
927 g_object_unref (stream_filter);
929 return NOTMUCH_STATUS_SUCCESS;
932 static notmuch_status_t
933 show_message (void *ctx,
934 const notmuch_show_format_t *format,
936 notmuch_message_t *message,
938 notmuch_show_params_t *params)
940 void *local = talloc_new (ctx);
941 mime_node_t *root, *part;
942 notmuch_status_t status;
943 unsigned int session_keys = 0;
944 notmuch_status_t session_key_count_error = NOTMUCH_STATUS_SUCCESS;
946 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
947 session_key_count_error = notmuch_message_count_properties (message, "session-key", &session_keys);
949 status = mime_node_open (local, message, &(params->crypto), &root);
952 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
954 status = format->part (local, sp, part, indent, params);
955 if (params->crypto.decrypt == NOTMUCH_DECRYPT_TRUE && session_key_count_error == NOTMUCH_STATUS_SUCCESS) {
956 unsigned int new_session_keys = 0;
957 if (notmuch_message_count_properties (message, "session-key", &new_session_keys) == NOTMUCH_STATUS_SUCCESS &&
958 new_session_keys > session_keys) {
959 /* try a quiet re-indexing */
960 notmuch_indexopts_t *indexopts = notmuch_database_get_default_indexopts (notmuch_message_get_database (message));
962 notmuch_indexopts_set_decrypt_policy (indexopts, NOTMUCH_DECRYPT_AUTO);
963 print_status_message ("Error re-indexing message with --decrypt=stash",
964 message, notmuch_message_reindex (message, indexopts));
973 static notmuch_status_t
974 show_messages (void *ctx,
975 const notmuch_show_format_t *format,
977 notmuch_messages_t *messages,
979 notmuch_show_params_t *params)
981 notmuch_message_t *message;
985 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
990 notmuch_messages_valid (messages);
991 notmuch_messages_move_to_next (messages)) {
994 message = notmuch_messages_get (messages);
996 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
997 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
999 next_indent = indent;
1001 if ((match && (! excluded || ! params->omit_excluded)) || params->entire_thread) {
1002 status = show_message (ctx, format, sp, message, indent, params);
1003 if (status && ! res)
1005 next_indent = indent + 1;
1010 status = show_messages (ctx,
1012 notmuch_message_get_replies (message),
1015 if (status && ! res)
1018 notmuch_message_destroy (message);
1028 /* Formatted output of single message */
1030 do_show_single (void *ctx,
1031 notmuch_query_t *query,
1032 const notmuch_show_format_t *format,
1034 notmuch_show_params_t *params)
1036 notmuch_messages_t *messages;
1037 notmuch_message_t *message;
1038 notmuch_status_t status;
1041 status = notmuch_query_count_messages (query, &count);
1042 if (print_status_query ("notmuch show", query, status))
1046 fprintf (stderr, "Error: search term did not match precisely one message (matched %u messages).\n", count);
1050 status = notmuch_query_search_messages (query, &messages);
1051 if (print_status_query ("notmuch show", query, status))
1054 message = notmuch_messages_get (messages);
1056 if (message == NULL) {
1057 fprintf (stderr, "Error: Cannot find matching message.\n");
1061 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
1063 return show_message (ctx, format, sp, message, 0, params)
1064 != NOTMUCH_STATUS_SUCCESS;
1067 /* Formatted output of threads */
1069 do_show_threaded (void *ctx,
1070 notmuch_query_t *query,
1071 const notmuch_show_format_t *format,
1073 notmuch_show_params_t *params)
1075 notmuch_threads_t *threads;
1076 notmuch_thread_t *thread;
1077 notmuch_messages_t *messages;
1078 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1080 status = notmuch_query_search_threads (query, &threads);
1081 if (print_status_query ("notmuch show", query, status))
1084 sp->begin_list (sp);
1087 notmuch_threads_valid (threads);
1088 notmuch_threads_move_to_next (threads)) {
1089 thread = notmuch_threads_get (threads);
1091 messages = notmuch_thread_get_toplevel_messages (thread);
1093 if (messages == NULL)
1094 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
1095 notmuch_thread_get_thread_id (thread));
1097 status = show_messages (ctx, format, sp, messages, 0, params);
1098 if (status && ! res)
1101 notmuch_thread_destroy (thread);
1107 return res != NOTMUCH_STATUS_SUCCESS;
1111 do_show_unthreaded (void *ctx,
1112 notmuch_query_t *query,
1113 const notmuch_show_format_t *format,
1115 notmuch_show_params_t *params)
1117 notmuch_messages_t *messages;
1118 notmuch_message_t *message;
1119 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
1120 notmuch_bool_t excluded;
1122 status = notmuch_query_search_messages (query, &messages);
1123 if (print_status_query ("notmuch show", query, status))
1126 sp->begin_list (sp);
1129 notmuch_messages_valid (messages);
1130 notmuch_messages_move_to_next (messages)) {
1131 sp->begin_list (sp);
1132 sp->begin_list (sp);
1134 message = notmuch_messages_get (messages);
1136 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, TRUE);
1137 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
1139 if (!excluded || !params->omit_excluded) {
1140 status = show_message (ctx, format, sp, message, 0, params);
1146 notmuch_message_destroy (message);
1155 NOTMUCH_FORMAT_NOT_SPECIFIED,
1156 NOTMUCH_FORMAT_JSON,
1157 NOTMUCH_FORMAT_SEXP,
1158 NOTMUCH_FORMAT_TEXT,
1159 NOTMUCH_FORMAT_MBOX,
1163 static const notmuch_show_format_t format_json = {
1164 .new_sprinter = sprinter_json_create,
1165 .part = format_part_sprinter_entry,
1168 static const notmuch_show_format_t format_sexp = {
1169 .new_sprinter = sprinter_sexp_create,
1170 .part = format_part_sprinter_entry,
1173 static const notmuch_show_format_t format_text = {
1174 .new_sprinter = sprinter_text_create,
1175 .part = format_part_text,
1178 static const notmuch_show_format_t format_mbox = {
1179 .new_sprinter = sprinter_text_create,
1180 .part = format_part_mbox,
1183 static const notmuch_show_format_t format_raw = {
1184 .new_sprinter = sprinter_text_create,
1185 .part = format_part_raw,
1188 static const notmuch_show_format_t *formatters[] = {
1189 [NOTMUCH_FORMAT_JSON] = &format_json,
1190 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1191 [NOTMUCH_FORMAT_TEXT] = &format_text,
1192 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1193 [NOTMUCH_FORMAT_RAW] = &format_raw,
1197 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1199 notmuch_database_t *notmuch;
1200 notmuch_query_t *query;
1203 const notmuch_show_format_t *formatter;
1204 sprinter_t *sprinter;
1205 notmuch_show_params_t params = {
1207 .omit_excluded = true,
1208 .output_body = true,
1209 .crypto = { .decrypt = NOTMUCH_DECRYPT_AUTO },
1211 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1212 bool exclude = true;
1213 bool entire_thread_set = false;
1214 bool single_message;
1215 bool unthreaded = FALSE;
1217 notmuch_opt_desc_t options[] = {
1218 { .opt_keyword = &format, .name = "format", .keywords =
1219 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1220 { "text", NOTMUCH_FORMAT_TEXT },
1221 { "sexp", NOTMUCH_FORMAT_SEXP },
1222 { "mbox", NOTMUCH_FORMAT_MBOX },
1223 { "raw", NOTMUCH_FORMAT_RAW },
1225 { .opt_int = ¬much_format_version, .name = "format-version" },
1226 { .opt_bool = &exclude, .name = "exclude" },
1227 { .opt_bool = ¶ms.entire_thread, .name = "entire-thread",
1228 .present = &entire_thread_set },
1229 { .opt_bool = &unthreaded, .name = "unthreaded" },
1230 { .opt_int = ¶ms.part, .name = "part" },
1231 { .opt_keyword = (int *) (¶ms.crypto.decrypt), .name = "decrypt",
1232 .keyword_no_arg_value = "true", .keywords =
1233 (notmuch_keyword_t []){ { "false", NOTMUCH_DECRYPT_FALSE },
1234 { "auto", NOTMUCH_DECRYPT_AUTO },
1235 { "true", NOTMUCH_DECRYPT_NOSTASH },
1236 { "stash", NOTMUCH_DECRYPT_TRUE },
1238 { .opt_bool = ¶ms.crypto.verify, .name = "verify" },
1239 { .opt_bool = ¶ms.output_body, .name = "body" },
1240 { .opt_bool = ¶ms.include_html, .name = "include-html" },
1241 { .opt_inherit = notmuch_shared_options },
1245 opt_index = parse_arguments (argc, argv, options, 1);
1247 return EXIT_FAILURE;
1249 notmuch_process_shared_options (argv[0]);
1251 /* explicit decryption implies verification */
1252 if (params.crypto.decrypt == NOTMUCH_DECRYPT_NOSTASH ||
1253 params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1254 params.crypto.verify = true;
1256 /* specifying a part implies single message display */
1257 single_message = params.part >= 0;
1259 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1260 /* if part was requested and format was not specified, use format=raw */
1261 if (params.part >= 0)
1262 format = NOTMUCH_FORMAT_RAW;
1264 format = NOTMUCH_FORMAT_TEXT;
1267 if (format == NOTMUCH_FORMAT_MBOX) {
1268 if (params.part > 0) {
1269 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1270 return EXIT_FAILURE;
1272 } else if (format == NOTMUCH_FORMAT_RAW) {
1273 /* raw format only supports single message display */
1274 single_message = true;
1277 notmuch_exit_if_unsupported_format ();
1279 /* Default is entire-thread = false except for format=json and
1281 if (! entire_thread_set &&
1282 (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP))
1283 params.entire_thread = true;
1285 if (! params.output_body) {
1286 if (params.part > 0) {
1287 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1288 params.output_body = true;
1290 if (format != NOTMUCH_FORMAT_TEXT &&
1291 format != NOTMUCH_FORMAT_JSON &&
1292 format != NOTMUCH_FORMAT_SEXP)
1294 "Warning: --body=false only implemented for format=text, format=json and format=sexp\n");
1298 if (params.include_html &&
1299 (format != NOTMUCH_FORMAT_TEXT &&
1300 format != NOTMUCH_FORMAT_JSON &&
1301 format != NOTMUCH_FORMAT_SEXP)) {
1302 fprintf (stderr, "Warning: --include-html only implemented for format=text, format=json and format=sexp\n");
1305 query_string = query_string_from_args (config, argc - opt_index, argv + opt_index);
1306 if (query_string == NULL) {
1307 fprintf (stderr, "Out of memory\n");
1308 return EXIT_FAILURE;
1311 if (*query_string == '\0') {
1312 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1313 return EXIT_FAILURE;
1316 notmuch_database_mode_t mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1317 if (params.crypto.decrypt == NOTMUCH_DECRYPT_TRUE)
1318 mode = NOTMUCH_DATABASE_MODE_READ_WRITE;
1319 if (notmuch_database_open (notmuch_config_get_database_path (config),
1321 return EXIT_FAILURE;
1323 notmuch_exit_if_unmatched_db_uuid (notmuch);
1325 query = notmuch_query_create (notmuch, query_string);
1326 if (query == NULL) {
1327 fprintf (stderr, "Out of memory\n");
1328 return EXIT_FAILURE;
1331 /* Create structure printer. */
1332 formatter = formatters[format];
1333 sprinter = formatter->new_sprinter (config, stdout);
1335 params.out_stream = g_mime_stream_stdout_new ();
1337 /* If a single message is requested we do not use search_excludes. */
1338 if (single_message) {
1339 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1341 /* We always apply set the exclude flag. The
1342 * exclude=true|false option controls whether or not we return
1343 * threads that only match in an excluded message */
1344 const char **search_exclude_tags;
1345 size_t search_exclude_tags_length;
1347 notmuch_status_t status;
1349 search_exclude_tags = notmuch_config_get_search_exclude_tags
1350 (config, &search_exclude_tags_length);
1352 for (i = 0; i < search_exclude_tags_length; i++) {
1353 status = notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1354 if (status && status != NOTMUCH_STATUS_IGNORED) {
1355 print_status_query ("notmuch show", query, status);
1361 if (exclude == false) {
1362 notmuch_query_set_omit_excluded (query, false);
1363 params.omit_excluded = false;
1367 ret = do_show_unthreaded (config, query, formatter, sprinter, ¶ms);
1369 ret = do_show_threaded (config, query, formatter, sprinter, ¶ms);
1373 g_mime_stream_flush (params.out_stream);
1374 g_object_unref (params.out_stream);
1376 _notmuch_crypto_cleanup (¶ms.crypto);
1377 notmuch_query_destroy (query);
1378 notmuch_database_destroy (notmuch);
1380 return ret ? EXIT_FAILURE : EXIT_SUCCESS;