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 http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
22 #include "gmime-filter-reply.h"
25 static notmuch_status_t
26 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
27 int indent, const notmuch_show_params_t *params);
29 static const notmuch_show_format_t format_text = {
30 .new_sprinter = sprinter_text_create,
31 .part = format_part_text,
34 static notmuch_status_t
35 format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
36 int indent, const notmuch_show_params_t *params);
38 static const notmuch_show_format_t format_json = {
39 .new_sprinter = sprinter_json_create,
40 .part = format_part_json_entry,
43 static notmuch_status_t
44 format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
45 int indent, const notmuch_show_params_t *params);
47 static const notmuch_show_format_t format_mbox = {
48 .new_sprinter = sprinter_text_create,
49 .part = format_part_mbox,
52 static notmuch_status_t
53 format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node,
55 unused (const notmuch_show_params_t *params));
57 static const notmuch_show_format_t format_raw = {
58 .new_sprinter = sprinter_text_create,
59 .part = format_part_raw,
63 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
70 result = talloc_strdup (ctx, "");
74 for (tags = notmuch_message_get_tags (message);
75 notmuch_tags_valid (tags);
76 notmuch_tags_move_to_next (tags))
78 tag = notmuch_tags_get (tags);
80 result = talloc_asprintf_append (result, "%s%s",
81 first ? "" : " ", tag);
88 /* Get a nice, single-line summary of message. */
90 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
94 const char *relative_date;
97 from = notmuch_message_get_header (message, "from");
99 date = notmuch_message_get_date (message);
100 relative_date = notmuch_time_relative_date (ctx, date);
102 tags = _get_tags_as_string (ctx, message);
104 return talloc_asprintf (ctx, "%s (%s) (%s)",
105 from, relative_date, tags);
108 /* Emit a sequence of key/value pairs for the metadata of message.
109 * The caller should begin a map before calling this. */
111 format_message_json (sprinter_t *sp, notmuch_message_t *message)
113 void *local = talloc_new (NULL);
114 notmuch_tags_t *tags;
116 const char *relative_date;
118 sp->map_key (sp, "id");
119 sp->string (sp, notmuch_message_get_message_id (message));
121 sp->map_key (sp, "match");
122 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
124 sp->map_key (sp, "excluded");
125 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
127 sp->map_key (sp, "filename");
128 sp->string (sp, notmuch_message_get_filename (message));
130 sp->map_key (sp, "timestamp");
131 date = notmuch_message_get_date (message);
132 sp->integer (sp, date);
134 sp->map_key (sp, "date_relative");
135 relative_date = notmuch_time_relative_date (local, date);
136 sp->string (sp, relative_date);
138 sp->map_key (sp, "tags");
140 for (tags = notmuch_message_get_tags (message);
141 notmuch_tags_valid (tags);
142 notmuch_tags_move_to_next (tags))
143 sp->string (sp, notmuch_tags_get (tags));
149 /* Extract just the email address from the contents of a From:
152 _extract_email_address (const void *ctx, const char *from)
154 InternetAddressList *addresses;
155 InternetAddress *address;
156 InternetAddressMailbox *mailbox;
157 const char *email = "MAILER-DAEMON";
159 addresses = internet_address_list_parse_string (from);
161 /* Bail if there is no address here. */
162 if (addresses == NULL || internet_address_list_length (addresses) < 1)
165 /* Otherwise, just use the first address. */
166 address = internet_address_list_get_address (addresses, 0);
168 /* The From header should never contain an address group rather
169 * than a mailbox. So bail if it does. */
170 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
173 mailbox = INTERNET_ADDRESS_MAILBOX (address);
174 email = internet_address_mailbox_get_addr (mailbox);
175 email = talloc_strdup (ctx, email);
179 g_object_unref (addresses);
184 /* Return 1 if 'line' is an mbox From_ line---that is, a line
185 * beginning with zero or more '>' characters followed by the
186 * characters 'F', 'r', 'o', 'm', and space.
188 * Any characters at all may appear after that in the line.
191 _is_from_line (const char *line)
193 const char *s = line;
201 if (STRNCMP_LITERAL (s, "From ") == 0)
208 format_headers_json (sprinter_t *sp, GMimeMessage *message,
209 notmuch_bool_t reply)
211 InternetAddressList *recipients;
212 const char *recipients_string;
216 sp->map_key (sp, "Subject");
217 sp->string (sp, g_mime_message_get_subject (message));
219 sp->map_key (sp, "From");
220 sp->string (sp, g_mime_message_get_sender (message));
222 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
223 recipients_string = internet_address_list_to_string (recipients, 0);
224 if (recipients_string) {
225 sp->map_key (sp, "To");
226 sp->string (sp, recipients_string);
229 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
230 recipients_string = internet_address_list_to_string (recipients, 0);
231 if (recipients_string) {
232 sp->map_key (sp, "Cc");
233 sp->string (sp, recipients_string);
236 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
237 recipients_string = internet_address_list_to_string (recipients, 0);
238 if (recipients_string) {
239 sp->map_key (sp, "Bcc");
240 sp->string (sp, recipients_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_as_string (message));
257 /* Write a MIME text part out to the given stream.
259 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
262 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
263 * UTF-8) will be performed, so it is inappropriate to call this
264 * function with a non-text part. Doing so will trigger an internal
268 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
269 notmuch_show_text_part_flags flags)
271 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
272 GMimeStream *stream_filter = NULL;
273 GMimeDataWrapper *wrapper;
276 if (! g_mime_content_type_is_type (content_type, "text", "*"))
277 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
278 g_mime_content_type_to_string (content_type));
280 if (stream_out == NULL)
283 stream_filter = g_mime_stream_filter_new (stream_out);
284 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
285 g_mime_filter_crlf_new (FALSE, FALSE));
287 charset = g_mime_object_get_content_type_parameter (part, "charset");
289 GMimeFilter *charset_filter;
290 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
291 /* This result can be NULL for things like "unknown-8bit".
292 * Don't set a NULL filter as that makes GMime print
293 * annoying assertion-failure messages on stderr. */
294 if (charset_filter) {
295 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
297 g_object_unref (charset_filter);
302 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
303 GMimeFilter *reply_filter;
304 reply_filter = g_mime_filter_reply_new (TRUE);
306 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
308 g_object_unref (reply_filter);
312 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
313 if (wrapper && stream_filter)
314 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
316 g_object_unref(stream_filter);
319 #ifdef GMIME_ATLEAST_26
321 signature_status_to_string (GMimeSignatureStatus x)
324 case GMIME_SIGNATURE_STATUS_GOOD:
326 case GMIME_SIGNATURE_STATUS_BAD:
328 case GMIME_SIGNATURE_STATUS_ERROR:
335 signer_status_to_string (GMimeSignerStatus x)
338 case GMIME_SIGNER_STATUS_NONE:
340 case GMIME_SIGNER_STATUS_GOOD:
342 case GMIME_SIGNER_STATUS_BAD:
344 case GMIME_SIGNER_STATUS_ERROR:
351 #ifdef GMIME_ATLEAST_26
353 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
355 GMimeSignatureList *siglist = node->sig_list;
365 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
366 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
371 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
372 sp->map_key (sp, "status");
373 sp->string (sp, signature_status_to_string (status));
375 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
376 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
378 sp->map_key (sp, "fingerprint");
379 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
381 /* these dates are seconds since the epoch; should we
382 * provide a more human-readable format string? */
383 time_t created = g_mime_signature_get_created (signature);
385 sp->map_key (sp, "created");
386 sp->integer (sp, created);
388 time_t expires = g_mime_signature_get_expires (signature);
390 sp->map_key (sp, "expires");
391 sp->integer (sp, expires);
393 /* output user id only if validity is FULL or ULTIMATE. */
394 /* note that gmime is using the term "trust" here, which
395 * is WRONG. It's actually user id "validity". */
397 const char *name = g_mime_certificate_get_name (certificate);
398 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
399 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
400 sp->map_key (sp, "userid");
401 sp->string (sp, name);
404 } else if (certificate) {
405 const char *key_id = g_mime_certificate_get_key_id (certificate);
407 sp->map_key (sp, "keyid");
408 sp->string (sp, key_id);
412 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
413 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
414 sp->map_key (sp, "errors");
415 sp->integer (sp, errors);
425 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
427 const GMimeSignatureValidity* validity = node->sig_validity;
436 const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity);
441 sp->map_key (sp, "status");
442 sp->string (sp, signer_status_to_string (signer->status));
444 if (signer->status == GMIME_SIGNER_STATUS_GOOD)
446 if (signer->fingerprint) {
447 sp->map_key (sp, "fingerprint");
448 sp->string (sp, signer->fingerprint);
450 /* these dates are seconds since the epoch; should we
451 * provide a more human-readable format string? */
452 if (signer->created) {
453 sp->map_key (sp, "created");
454 sp->integer (sp, signer->created);
456 if (signer->expires) {
457 sp->map_key (sp, "expires");
458 sp->integer (sp, signer->expires);
460 /* output user id only if validity is FULL or ULTIMATE. */
461 /* note that gmime is using the term "trust" here, which
462 * is WRONG. It's actually user id "validity". */
463 if ((signer->name) && (signer->trust)) {
464 if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE)) {
465 sp->map_key (sp, "userid");
466 sp->string (sp, signer->name);
471 sp->map_key (sp, "keyid");
472 sp->string (sp, signer->keyid);
475 if (signer->errors != GMIME_SIGNER_ERROR_NONE) {
476 sp->map_key (sp, "errors");
477 sp->integer (sp, signer->errors);
481 signer = signer->next;
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 notmuch_bool_t leaf = GMIME_IS_PART (node->part);
498 const char *part_type;
501 if (node->envelope_file) {
502 notmuch_message_t *message = node->envelope_file;
504 part_type = "message";
505 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
507 notmuch_message_get_message_id (message),
509 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
510 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
511 notmuch_message_get_filename (message));
513 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
514 const char *cid = g_mime_object_get_content_id (meta);
515 const char *filename = leaf ?
516 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
519 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
520 part_type = "attachment";
524 printf ("\f%s{ ID: %d", part_type, node->part_num);
526 printf (", Filename: %s", filename);
528 printf (", Content-id: %s", cid);
529 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
532 if (GMIME_IS_MESSAGE (node->part)) {
533 GMimeMessage *message = GMIME_MESSAGE (node->part);
534 InternetAddressList *recipients;
535 const char *recipients_string;
537 printf ("\fheader{\n");
538 if (node->envelope_file)
539 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
540 printf ("Subject: %s\n", g_mime_message_get_subject (message));
541 printf ("From: %s\n", g_mime_message_get_sender (message));
542 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
543 recipients_string = internet_address_list_to_string (recipients, 0);
544 if (recipients_string)
545 printf ("To: %s\n", recipients_string);
546 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
547 recipients_string = internet_address_list_to_string (recipients, 0);
548 if (recipients_string)
549 printf ("Cc: %s\n", recipients_string);
550 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
551 printf ("\fheader}\n");
553 printf ("\fbody{\n");
557 if (g_mime_content_type_is_type (content_type, "text", "*") &&
558 !g_mime_content_type_is_type (content_type, "text", "html"))
560 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
561 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
562 show_text_part_content (node->part, stream_stdout, 0);
563 g_object_unref(stream_stdout);
565 printf ("Non-text part: %s\n",
566 g_mime_content_type_to_string (content_type));
570 for (i = 0; i < node->nchildren; i++)
571 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
573 if (GMIME_IS_MESSAGE (node->part))
574 printf ("\fbody}\n");
576 printf ("\f%s}\n", part_type);
578 return NOTMUCH_STATUS_SUCCESS;
582 format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,
583 notmuch_bool_t first, notmuch_bool_t output_body)
585 /* Any changes to the JSON format should be reflected in the file
588 if (node->envelope_file) {
590 format_message_json (sp, node->envelope_file);
592 sp->map_key (sp, "headers");
593 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
596 sp->map_key (sp, "body");
598 format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);
605 /* The disposition and content-type metadata are associated with
606 * the envelope for message parts */
607 GMimeObject *meta = node->envelope_part ?
608 GMIME_OBJECT (node->envelope_part) : node->part;
609 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
610 const char *cid = g_mime_object_get_content_id (meta);
611 const char *filename = GMIME_IS_PART (node->part) ?
612 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
618 sp->map_key (sp, "id");
619 sp->integer (sp, node->part_num);
621 if (node->decrypt_attempted) {
622 sp->map_key (sp, "encstatus");
625 sp->map_key (sp, "status");
626 sp->string (sp, node->decrypt_success ? "good" : "bad");
631 if (node->verify_attempted) {
632 sp->map_key (sp, "sigstatus");
633 format_part_sigstatus_json (sp, node);
636 sp->map_key (sp, "content-type");
637 sp->string (sp, g_mime_content_type_to_string (content_type));
640 sp->map_key (sp, "content-id");
641 sp->string (sp, cid);
645 sp->map_key (sp, "filename");
646 sp->string (sp, filename);
649 if (GMIME_IS_PART (node->part)) {
650 /* For non-HTML text parts, we include the content in the
651 * JSON. Since JSON must be Unicode, we handle charset
652 * decoding here and do not report a charset to the caller.
653 * For text/html parts, we do not include the content. If a
654 * caller is interested in text/html parts, it should retrieve
655 * them separately and they will not be decoded. Since this
656 * makes charset decoding the responsibility on the caller, we
657 * report the charset for text/html parts.
659 if (g_mime_content_type_is_type (content_type, "text", "html")) {
660 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
662 if (content_charset != NULL) {
663 sp->map_key (sp, "content-charset");
664 sp->string (sp, content_charset);
666 } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
667 GMimeStream *stream_memory = g_mime_stream_mem_new ();
668 GByteArray *part_content;
669 show_text_part_content (node->part, stream_memory, 0);
670 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
671 sp->map_key (sp, "content");
672 sp->string_len (sp, (char *) part_content->data, part_content->len);
673 g_object_unref (stream_memory);
675 } else if (GMIME_IS_MULTIPART (node->part)) {
676 sp->map_key (sp, "content");
679 } else if (GMIME_IS_MESSAGE (node->part)) {
680 sp->map_key (sp, "content");
684 sp->map_key (sp, "headers");
685 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
687 sp->map_key (sp, "body");
692 for (i = 0; i < node->nchildren; i++)
693 format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
695 /* Close content structures */
696 for (i = 0; i < nclose; i++)
702 static notmuch_status_t
703 format_part_json_entry (const void *ctx, sprinter_t *sp,
704 mime_node_t *node, unused (int indent),
705 const notmuch_show_params_t *params)
707 format_part_json (ctx, sp, node, TRUE, params->output_body);
709 return NOTMUCH_STATUS_SUCCESS;
712 /* Print a message in "mboxrd" format as documented, for example,
715 * http://qmail.org/qmail-manual-html/man5/mbox.html
717 static notmuch_status_t
718 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
720 unused (const notmuch_show_params_t *params))
722 notmuch_message_t *message = node->envelope_file;
724 const char *filename;
729 struct tm date_gmtime;
730 char date_asctime[26];
737 INTERNAL_ERROR ("format_part_mbox requires a root part");
739 filename = notmuch_message_get_filename (message);
740 file = fopen (filename, "r");
742 fprintf (stderr, "Failed to open %s: %s\n",
743 filename, strerror (errno));
744 return NOTMUCH_STATUS_FILE_ERROR;
747 from = notmuch_message_get_header (message, "from");
748 from = _extract_email_address (ctx, from);
750 date = notmuch_message_get_date (message);
751 gmtime_r (&date, &date_gmtime);
752 asctime_r (&date_gmtime, date_asctime);
754 printf ("From %s %s", from, date_asctime);
756 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
757 if (_is_from_line (line))
766 return NOTMUCH_STATUS_SUCCESS;
769 static notmuch_status_t
770 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
771 mime_node_t *node, unused (int indent),
772 unused (const notmuch_show_params_t *params))
774 if (node->envelope_file) {
775 /* Special case the entire message to avoid MIME parsing. */
776 const char *filename;
781 filename = notmuch_message_get_filename (node->envelope_file);
782 if (filename == NULL) {
783 fprintf (stderr, "Error: Cannot get message filename.\n");
784 return NOTMUCH_STATUS_FILE_ERROR;
787 file = fopen (filename, "r");
789 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
790 return NOTMUCH_STATUS_FILE_ERROR;
793 while (!feof (file)) {
794 size = fread (buf, 1, sizeof (buf), file);
796 fprintf (stderr, "Error: Read failed from %s\n", filename);
798 return NOTMUCH_STATUS_FILE_ERROR;
801 if (fwrite (buf, size, 1, stdout) != 1) {
802 fprintf (stderr, "Error: Write failed\n");
804 return NOTMUCH_STATUS_FILE_ERROR;
809 return NOTMUCH_STATUS_SUCCESS;
812 GMimeStream *stream_stdout;
813 GMimeStream *stream_filter = NULL;
815 stream_stdout = g_mime_stream_file_new (stdout);
816 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
818 stream_filter = g_mime_stream_filter_new (stream_stdout);
820 if (GMIME_IS_PART (node->part)) {
821 /* For leaf parts, we emit only the transfer-decoded
823 GMimeDataWrapper *wrapper;
824 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
826 if (wrapper && stream_filter)
827 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
829 /* Write out the whole part. For message parts (the root
830 * part and embedded message parts), this will be the
831 * message including its headers (but not the
832 * encapsulating part's headers). For multipart parts,
833 * this will include the headers. */
835 g_mime_object_write_to_stream (node->part, stream_filter);
839 g_object_unref (stream_filter);
842 g_object_unref(stream_stdout);
844 return NOTMUCH_STATUS_SUCCESS;
847 static notmuch_status_t
848 show_message (void *ctx,
849 const notmuch_show_format_t *format,
851 notmuch_message_t *message,
853 notmuch_show_params_t *params)
855 void *local = talloc_new (ctx);
856 mime_node_t *root, *part;
857 notmuch_status_t status;
859 status = mime_node_open (local, message, &(params->crypto), &root);
862 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
864 status = format->part (local, sp, part, indent, params);
870 static notmuch_status_t
871 show_messages (void *ctx,
872 const notmuch_show_format_t *format,
874 notmuch_messages_t *messages,
876 notmuch_show_params_t *params)
878 notmuch_message_t *message;
879 notmuch_bool_t match;
880 notmuch_bool_t excluded;
882 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
887 notmuch_messages_valid (messages);
888 notmuch_messages_move_to_next (messages))
892 message = notmuch_messages_get (messages);
894 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
895 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
897 next_indent = indent;
899 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
900 status = show_message (ctx, format, sp, message, indent, params);
903 next_indent = indent + 1;
908 status = show_messages (ctx,
910 notmuch_message_get_replies (message),
916 notmuch_message_destroy (message);
926 /* Formatted output of single message */
928 do_show_single (void *ctx,
929 notmuch_query_t *query,
930 const notmuch_show_format_t *format,
932 notmuch_show_params_t *params)
934 notmuch_messages_t *messages;
935 notmuch_message_t *message;
937 if (notmuch_query_count_messages (query) != 1) {
938 fprintf (stderr, "Error: search term did not match precisely one message.\n");
942 messages = notmuch_query_search_messages (query);
943 message = notmuch_messages_get (messages);
945 if (message == NULL) {
946 fprintf (stderr, "Error: Cannot find matching message.\n");
950 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
952 return show_message (ctx, format, sp, message, 0, params)
953 != NOTMUCH_STATUS_SUCCESS;
956 /* Formatted output of threads */
959 notmuch_query_t *query,
960 const notmuch_show_format_t *format,
962 notmuch_show_params_t *params)
964 notmuch_threads_t *threads;
965 notmuch_thread_t *thread;
966 notmuch_messages_t *messages;
967 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
971 for (threads = notmuch_query_search_threads (query);
972 notmuch_threads_valid (threads);
973 notmuch_threads_move_to_next (threads))
975 thread = notmuch_threads_get (threads);
977 messages = notmuch_thread_get_toplevel_messages (thread);
979 if (messages == NULL)
980 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
981 notmuch_thread_get_thread_id (thread));
983 status = show_messages (ctx, format, sp, messages, 0, params);
987 notmuch_thread_destroy (thread);
993 return res != NOTMUCH_STATUS_SUCCESS;
997 NOTMUCH_FORMAT_NOT_SPECIFIED,
1000 NOTMUCH_FORMAT_MBOX,
1005 ENTIRE_THREAD_DEFAULT,
1007 ENTIRE_THREAD_FALSE,
1010 /* The following is to allow future options to be added more easily */
1017 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
1019 notmuch_config_t *config;
1020 notmuch_database_t *notmuch;
1021 notmuch_query_t *query;
1024 const notmuch_show_format_t *format = &format_text;
1025 sprinter_t *sprinter;
1026 notmuch_show_params_t params = {
1028 .omit_excluded = TRUE,
1029 .output_body = TRUE,
1035 int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
1036 int exclude = EXCLUDE_TRUE;
1037 int entire_thread = ENTIRE_THREAD_DEFAULT;
1039 notmuch_opt_desc_t options[] = {
1040 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
1041 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1042 { "text", NOTMUCH_FORMAT_TEXT },
1043 { "mbox", NOTMUCH_FORMAT_MBOX },
1044 { "raw", NOTMUCH_FORMAT_RAW },
1046 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1047 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1048 { "false", EXCLUDE_FALSE },
1050 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1051 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1052 { "false", ENTIRE_THREAD_FALSE },
1053 { "", ENTIRE_THREAD_TRUE },
1055 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1056 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1057 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1058 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1062 opt_index = parse_arguments (argc, argv, options, 1);
1063 if (opt_index < 0) {
1064 /* diagnostics already printed */
1068 /* decryption implies verification */
1069 if (params.crypto.decrypt)
1070 params.crypto.verify = TRUE;
1072 if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1073 /* if part was requested and format was not specified, use format=raw */
1074 if (params.part >= 0)
1075 format_sel = NOTMUCH_FORMAT_RAW;
1077 format_sel = NOTMUCH_FORMAT_TEXT;
1080 switch (format_sel) {
1081 case NOTMUCH_FORMAT_JSON:
1082 format = &format_json;
1084 case NOTMUCH_FORMAT_TEXT:
1085 format = &format_text;
1087 case NOTMUCH_FORMAT_MBOX:
1088 if (params.part > 0) {
1089 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1093 format = &format_mbox;
1095 case NOTMUCH_FORMAT_RAW:
1096 format = &format_raw;
1097 /* If --format=raw specified without specifying part, we can only
1098 * output single message, so set part=0 */
1099 if (params.part < 0)
1105 /* Default is entire-thread = FALSE except for format=json. */
1106 if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1107 if (format == &format_json)
1108 entire_thread = ENTIRE_THREAD_TRUE;
1110 entire_thread = ENTIRE_THREAD_FALSE;
1113 if (!params.output_body) {
1114 if (params.part > 0) {
1115 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1116 params.output_body = TRUE;
1118 if (format != &format_json)
1119 fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
1123 if (entire_thread == ENTIRE_THREAD_TRUE)
1124 params.entire_thread = TRUE;
1126 params.entire_thread = FALSE;
1128 config = notmuch_config_open (ctx, NULL, NULL);
1132 query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
1133 if (query_string == NULL) {
1134 fprintf (stderr, "Out of memory\n");
1138 if (*query_string == '\0') {
1139 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1143 if (notmuch_database_open (notmuch_config_get_database_path (config),
1144 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1147 query = notmuch_query_create (notmuch, query_string);
1148 if (query == NULL) {
1149 fprintf (stderr, "Out of memory\n");
1153 /* Create structure printer. */
1154 sprinter = format->new_sprinter(ctx, stdout);
1156 /* If a single message is requested we do not use search_excludes. */
1157 if (params.part >= 0)
1158 ret = do_show_single (ctx, query, format, sprinter, ¶ms);
1160 /* We always apply set the exclude flag. The
1161 * exclude=true|false option controls whether or not we return
1162 * threads that only match in an excluded message */
1163 const char **search_exclude_tags;
1164 size_t search_exclude_tags_length;
1167 search_exclude_tags = notmuch_config_get_search_exclude_tags
1168 (config, &search_exclude_tags_length);
1169 for (i = 0; i < search_exclude_tags_length; i++)
1170 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1172 if (exclude == EXCLUDE_FALSE) {
1173 notmuch_query_set_omit_excluded (query, FALSE);
1174 params.omit_excluded = FALSE;
1177 ret = do_show (ctx, query, format, sprinter, ¶ms);
1180 notmuch_crypto_cleanup (¶ms.crypto);
1181 notmuch_query_destroy (query);
1182 notmuch_database_destroy (notmuch);