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;
213 const char *reply_to_string;
217 sp->map_key (sp, "Subject");
218 sp->string (sp, g_mime_message_get_subject (message));
220 sp->map_key (sp, "From");
221 sp->string (sp, g_mime_message_get_sender (message));
223 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
224 recipients_string = internet_address_list_to_string (recipients, 0);
225 if (recipients_string) {
226 sp->map_key (sp, "To");
227 sp->string (sp, recipients_string);
230 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
231 recipients_string = internet_address_list_to_string (recipients, 0);
232 if (recipients_string) {
233 sp->map_key (sp, "Cc");
234 sp->string (sp, recipients_string);
237 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
238 recipients_string = internet_address_list_to_string (recipients, 0);
239 if (recipients_string) {
240 sp->map_key (sp, "Bcc");
241 sp->string (sp, recipients_string);
244 reply_to_string = g_mime_message_get_reply_to (message);
245 if (reply_to_string) {
246 sp->map_key (sp, "Reply-To");
247 sp->string (sp, reply_to_string);
251 sp->map_key (sp, "In-reply-to");
252 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
254 sp->map_key (sp, "References");
255 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
257 sp->map_key (sp, "Date");
258 sp->string (sp, g_mime_message_get_date_as_string (message));
264 /* Write a MIME text part out to the given stream.
266 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
269 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
270 * UTF-8) will be performed, so it is inappropriate to call this
271 * function with a non-text part. Doing so will trigger an internal
275 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
276 notmuch_show_text_part_flags flags)
278 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
279 GMimeStream *stream_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_to_string (content_type));
287 if (stream_out == NULL)
290 stream_filter = g_mime_stream_filter_new (stream_out);
291 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
292 g_mime_filter_crlf_new (FALSE, FALSE));
294 charset = g_mime_object_get_content_type_parameter (part, "charset");
296 GMimeFilter *charset_filter;
297 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
298 /* This result can be NULL for things like "unknown-8bit".
299 * Don't set a NULL filter as that makes GMime print
300 * annoying assertion-failure messages on stderr. */
301 if (charset_filter) {
302 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
304 g_object_unref (charset_filter);
309 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
310 GMimeFilter *reply_filter;
311 reply_filter = g_mime_filter_reply_new (TRUE);
313 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
315 g_object_unref (reply_filter);
319 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
320 if (wrapper && stream_filter)
321 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
323 g_object_unref(stream_filter);
326 #ifdef GMIME_ATLEAST_26
328 signature_status_to_string (GMimeSignatureStatus x)
331 case GMIME_SIGNATURE_STATUS_GOOD:
333 case GMIME_SIGNATURE_STATUS_BAD:
335 case GMIME_SIGNATURE_STATUS_ERROR:
342 signer_status_to_string (GMimeSignerStatus x)
345 case GMIME_SIGNER_STATUS_NONE:
347 case GMIME_SIGNER_STATUS_GOOD:
349 case GMIME_SIGNER_STATUS_BAD:
351 case GMIME_SIGNER_STATUS_ERROR:
358 #ifdef GMIME_ATLEAST_26
360 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
362 GMimeSignatureList *siglist = node->sig_list;
372 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
373 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
378 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
379 sp->map_key (sp, "status");
380 sp->string (sp, signature_status_to_string (status));
382 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
383 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
385 sp->map_key (sp, "fingerprint");
386 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
388 /* these dates are seconds since the epoch; should we
389 * provide a more human-readable format string? */
390 time_t created = g_mime_signature_get_created (signature);
392 sp->map_key (sp, "created");
393 sp->integer (sp, created);
395 time_t expires = g_mime_signature_get_expires (signature);
397 sp->map_key (sp, "expires");
398 sp->integer (sp, expires);
400 /* output user id only if validity is FULL or ULTIMATE. */
401 /* note that gmime is using the term "trust" here, which
402 * is WRONG. It's actually user id "validity". */
404 const char *name = g_mime_certificate_get_name (certificate);
405 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
406 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
407 sp->map_key (sp, "userid");
408 sp->string (sp, name);
411 } else if (certificate) {
412 const char *key_id = g_mime_certificate_get_key_id (certificate);
414 sp->map_key (sp, "keyid");
415 sp->string (sp, key_id);
419 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
420 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
421 sp->map_key (sp, "errors");
422 sp->integer (sp, errors);
432 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
434 const GMimeSignatureValidity* validity = node->sig_validity;
443 const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity);
448 sp->map_key (sp, "status");
449 sp->string (sp, signer_status_to_string (signer->status));
451 if (signer->status == GMIME_SIGNER_STATUS_GOOD)
453 if (signer->fingerprint) {
454 sp->map_key (sp, "fingerprint");
455 sp->string (sp, signer->fingerprint);
457 /* these dates are seconds since the epoch; should we
458 * provide a more human-readable format string? */
459 if (signer->created) {
460 sp->map_key (sp, "created");
461 sp->integer (sp, signer->created);
463 if (signer->expires) {
464 sp->map_key (sp, "expires");
465 sp->integer (sp, signer->expires);
467 /* output user id only if validity is FULL or ULTIMATE. */
468 /* note that gmime is using the term "trust" here, which
469 * is WRONG. It's actually user id "validity". */
470 if ((signer->name) && (signer->trust)) {
471 if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE)) {
472 sp->map_key (sp, "userid");
473 sp->string (sp, signer->name);
478 sp->map_key (sp, "keyid");
479 sp->string (sp, signer->keyid);
482 if (signer->errors != GMIME_SIGNER_ERROR_NONE) {
483 sp->map_key (sp, "errors");
484 sp->integer (sp, signer->errors);
488 signer = signer->next;
495 static notmuch_status_t
496 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
497 int indent, const notmuch_show_params_t *params)
499 /* The disposition and content-type metadata are associated with
500 * the envelope for message parts */
501 GMimeObject *meta = node->envelope_part ?
502 GMIME_OBJECT (node->envelope_part) : node->part;
503 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
504 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
505 const char *part_type;
508 if (node->envelope_file) {
509 notmuch_message_t *message = node->envelope_file;
511 part_type = "message";
512 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
514 notmuch_message_get_message_id (message),
516 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
517 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
518 notmuch_message_get_filename (message));
520 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
521 const char *cid = g_mime_object_get_content_id (meta);
522 const char *filename = leaf ?
523 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
526 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
527 part_type = "attachment";
531 printf ("\f%s{ ID: %d", part_type, node->part_num);
533 printf (", Filename: %s", filename);
535 printf (", Content-id: %s", cid);
536 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
539 if (GMIME_IS_MESSAGE (node->part)) {
540 GMimeMessage *message = GMIME_MESSAGE (node->part);
541 InternetAddressList *recipients;
542 const char *recipients_string;
544 printf ("\fheader{\n");
545 if (node->envelope_file)
546 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
547 printf ("Subject: %s\n", g_mime_message_get_subject (message));
548 printf ("From: %s\n", g_mime_message_get_sender (message));
549 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
550 recipients_string = internet_address_list_to_string (recipients, 0);
551 if (recipients_string)
552 printf ("To: %s\n", recipients_string);
553 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
554 recipients_string = internet_address_list_to_string (recipients, 0);
555 if (recipients_string)
556 printf ("Cc: %s\n", recipients_string);
557 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
558 printf ("\fheader}\n");
560 printf ("\fbody{\n");
564 if (g_mime_content_type_is_type (content_type, "text", "*") &&
565 !g_mime_content_type_is_type (content_type, "text", "html"))
567 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
568 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
569 show_text_part_content (node->part, stream_stdout, 0);
570 g_object_unref(stream_stdout);
572 printf ("Non-text part: %s\n",
573 g_mime_content_type_to_string (content_type));
577 for (i = 0; i < node->nchildren; i++)
578 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
580 if (GMIME_IS_MESSAGE (node->part))
581 printf ("\fbody}\n");
583 printf ("\f%s}\n", part_type);
585 return NOTMUCH_STATUS_SUCCESS;
589 format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,
590 notmuch_bool_t first, notmuch_bool_t output_body)
592 /* Any changes to the JSON format should be reflected in the file
595 if (node->envelope_file) {
597 format_message_json (sp, node->envelope_file);
599 sp->map_key (sp, "headers");
600 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
603 sp->map_key (sp, "body");
605 format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);
612 /* The disposition and content-type metadata are associated with
613 * the envelope for message parts */
614 GMimeObject *meta = node->envelope_part ?
615 GMIME_OBJECT (node->envelope_part) : node->part;
616 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
617 const char *cid = g_mime_object_get_content_id (meta);
618 const char *filename = GMIME_IS_PART (node->part) ?
619 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
625 sp->map_key (sp, "id");
626 sp->integer (sp, node->part_num);
628 if (node->decrypt_attempted) {
629 sp->map_key (sp, "encstatus");
632 sp->map_key (sp, "status");
633 sp->string (sp, node->decrypt_success ? "good" : "bad");
638 if (node->verify_attempted) {
639 sp->map_key (sp, "sigstatus");
640 format_part_sigstatus_json (sp, node);
643 sp->map_key (sp, "content-type");
644 sp->string (sp, g_mime_content_type_to_string (content_type));
647 sp->map_key (sp, "content-id");
648 sp->string (sp, cid);
652 sp->map_key (sp, "filename");
653 sp->string (sp, filename);
656 if (GMIME_IS_PART (node->part)) {
657 /* For non-HTML text parts, we include the content in the
658 * JSON. Since JSON must be Unicode, we handle charset
659 * decoding here and do not report a charset to the caller.
660 * For text/html parts, we do not include the content. If a
661 * caller is interested in text/html parts, it should retrieve
662 * them separately and they will not be decoded. Since this
663 * makes charset decoding the responsibility on the caller, we
664 * report the charset for text/html parts.
666 if (g_mime_content_type_is_type (content_type, "text", "html")) {
667 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
669 if (content_charset != NULL) {
670 sp->map_key (sp, "content-charset");
671 sp->string (sp, content_charset);
673 } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
674 GMimeStream *stream_memory = g_mime_stream_mem_new ();
675 GByteArray *part_content;
676 show_text_part_content (node->part, stream_memory, 0);
677 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
678 sp->map_key (sp, "content");
679 sp->string_len (sp, (char *) part_content->data, part_content->len);
680 g_object_unref (stream_memory);
682 } else if (GMIME_IS_MULTIPART (node->part)) {
683 sp->map_key (sp, "content");
686 } else if (GMIME_IS_MESSAGE (node->part)) {
687 sp->map_key (sp, "content");
691 sp->map_key (sp, "headers");
692 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
694 sp->map_key (sp, "body");
699 for (i = 0; i < node->nchildren; i++)
700 format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
702 /* Close content structures */
703 for (i = 0; i < nclose; i++)
709 static notmuch_status_t
710 format_part_json_entry (const void *ctx, sprinter_t *sp,
711 mime_node_t *node, unused (int indent),
712 const notmuch_show_params_t *params)
714 format_part_json (ctx, sp, node, TRUE, params->output_body);
716 return NOTMUCH_STATUS_SUCCESS;
719 /* Print a message in "mboxrd" format as documented, for example,
722 * http://qmail.org/qmail-manual-html/man5/mbox.html
724 static notmuch_status_t
725 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
727 unused (const notmuch_show_params_t *params))
729 notmuch_message_t *message = node->envelope_file;
731 const char *filename;
736 struct tm date_gmtime;
737 char date_asctime[26];
744 INTERNAL_ERROR ("format_part_mbox requires a root part");
746 filename = notmuch_message_get_filename (message);
747 file = fopen (filename, "r");
749 fprintf (stderr, "Failed to open %s: %s\n",
750 filename, strerror (errno));
751 return NOTMUCH_STATUS_FILE_ERROR;
754 from = notmuch_message_get_header (message, "from");
755 from = _extract_email_address (ctx, from);
757 date = notmuch_message_get_date (message);
758 gmtime_r (&date, &date_gmtime);
759 asctime_r (&date_gmtime, date_asctime);
761 printf ("From %s %s", from, date_asctime);
763 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
764 if (_is_from_line (line))
773 return NOTMUCH_STATUS_SUCCESS;
776 static notmuch_status_t
777 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
778 mime_node_t *node, unused (int indent),
779 unused (const notmuch_show_params_t *params))
781 if (node->envelope_file) {
782 /* Special case the entire message to avoid MIME parsing. */
783 const char *filename;
788 filename = notmuch_message_get_filename (node->envelope_file);
789 if (filename == NULL) {
790 fprintf (stderr, "Error: Cannot get message filename.\n");
791 return NOTMUCH_STATUS_FILE_ERROR;
794 file = fopen (filename, "r");
796 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
797 return NOTMUCH_STATUS_FILE_ERROR;
800 while (!feof (file)) {
801 size = fread (buf, 1, sizeof (buf), file);
803 fprintf (stderr, "Error: Read failed from %s\n", filename);
805 return NOTMUCH_STATUS_FILE_ERROR;
808 if (fwrite (buf, size, 1, stdout) != 1) {
809 fprintf (stderr, "Error: Write failed\n");
811 return NOTMUCH_STATUS_FILE_ERROR;
816 return NOTMUCH_STATUS_SUCCESS;
819 GMimeStream *stream_stdout;
820 GMimeStream *stream_filter = NULL;
822 stream_stdout = g_mime_stream_file_new (stdout);
823 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
825 stream_filter = g_mime_stream_filter_new (stream_stdout);
827 if (GMIME_IS_PART (node->part)) {
828 /* For leaf parts, we emit only the transfer-decoded
830 GMimeDataWrapper *wrapper;
831 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
833 if (wrapper && stream_filter)
834 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
836 /* Write out the whole part. For message parts (the root
837 * part and embedded message parts), this will be the
838 * message including its headers (but not the
839 * encapsulating part's headers). For multipart parts,
840 * this will include the headers. */
842 g_mime_object_write_to_stream (node->part, stream_filter);
846 g_object_unref (stream_filter);
849 g_object_unref(stream_stdout);
851 return NOTMUCH_STATUS_SUCCESS;
854 static notmuch_status_t
855 show_message (void *ctx,
856 const notmuch_show_format_t *format,
858 notmuch_message_t *message,
860 notmuch_show_params_t *params)
862 void *local = talloc_new (ctx);
863 mime_node_t *root, *part;
864 notmuch_status_t status;
866 status = mime_node_open (local, message, &(params->crypto), &root);
869 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
871 status = format->part (local, sp, part, indent, params);
877 static notmuch_status_t
878 show_messages (void *ctx,
879 const notmuch_show_format_t *format,
881 notmuch_messages_t *messages,
883 notmuch_show_params_t *params)
885 notmuch_message_t *message;
886 notmuch_bool_t match;
887 notmuch_bool_t excluded;
889 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
894 notmuch_messages_valid (messages);
895 notmuch_messages_move_to_next (messages))
899 message = notmuch_messages_get (messages);
901 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
902 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
904 next_indent = indent;
906 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
907 status = show_message (ctx, format, sp, message, indent, params);
910 next_indent = indent + 1;
915 status = show_messages (ctx,
917 notmuch_message_get_replies (message),
923 notmuch_message_destroy (message);
933 /* Formatted output of single message */
935 do_show_single (void *ctx,
936 notmuch_query_t *query,
937 const notmuch_show_format_t *format,
939 notmuch_show_params_t *params)
941 notmuch_messages_t *messages;
942 notmuch_message_t *message;
944 if (notmuch_query_count_messages (query) != 1) {
945 fprintf (stderr, "Error: search term did not match precisely one message.\n");
949 messages = notmuch_query_search_messages (query);
950 message = notmuch_messages_get (messages);
952 if (message == NULL) {
953 fprintf (stderr, "Error: Cannot find matching message.\n");
957 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
959 return show_message (ctx, format, sp, message, 0, params)
960 != NOTMUCH_STATUS_SUCCESS;
963 /* Formatted output of threads */
966 notmuch_query_t *query,
967 const notmuch_show_format_t *format,
969 notmuch_show_params_t *params)
971 notmuch_threads_t *threads;
972 notmuch_thread_t *thread;
973 notmuch_messages_t *messages;
974 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
978 for (threads = notmuch_query_search_threads (query);
979 notmuch_threads_valid (threads);
980 notmuch_threads_move_to_next (threads))
982 thread = notmuch_threads_get (threads);
984 messages = notmuch_thread_get_toplevel_messages (thread);
986 if (messages == NULL)
987 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
988 notmuch_thread_get_thread_id (thread));
990 status = show_messages (ctx, format, sp, messages, 0, params);
994 notmuch_thread_destroy (thread);
1000 return res != NOTMUCH_STATUS_SUCCESS;
1004 NOTMUCH_FORMAT_NOT_SPECIFIED,
1005 NOTMUCH_FORMAT_JSON,
1006 NOTMUCH_FORMAT_TEXT,
1007 NOTMUCH_FORMAT_MBOX,
1012 ENTIRE_THREAD_DEFAULT,
1014 ENTIRE_THREAD_FALSE,
1017 /* The following is to allow future options to be added more easily */
1024 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
1026 notmuch_config_t *config;
1027 notmuch_database_t *notmuch;
1028 notmuch_query_t *query;
1031 const notmuch_show_format_t *format = &format_text;
1032 sprinter_t *sprinter;
1033 notmuch_show_params_t params = {
1035 .omit_excluded = TRUE,
1036 .output_body = TRUE,
1042 int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
1043 int exclude = EXCLUDE_TRUE;
1044 int entire_thread = ENTIRE_THREAD_DEFAULT;
1046 notmuch_opt_desc_t options[] = {
1047 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
1048 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1049 { "text", NOTMUCH_FORMAT_TEXT },
1050 { "mbox", NOTMUCH_FORMAT_MBOX },
1051 { "raw", NOTMUCH_FORMAT_RAW },
1053 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1054 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1055 { "false", EXCLUDE_FALSE },
1057 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1058 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1059 { "false", ENTIRE_THREAD_FALSE },
1060 { "", ENTIRE_THREAD_TRUE },
1062 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1063 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1064 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1065 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1069 opt_index = parse_arguments (argc, argv, options, 1);
1070 if (opt_index < 0) {
1071 /* diagnostics already printed */
1075 /* decryption implies verification */
1076 if (params.crypto.decrypt)
1077 params.crypto.verify = TRUE;
1079 if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1080 /* if part was requested and format was not specified, use format=raw */
1081 if (params.part >= 0)
1082 format_sel = NOTMUCH_FORMAT_RAW;
1084 format_sel = NOTMUCH_FORMAT_TEXT;
1087 switch (format_sel) {
1088 case NOTMUCH_FORMAT_JSON:
1089 format = &format_json;
1091 case NOTMUCH_FORMAT_TEXT:
1092 format = &format_text;
1094 case NOTMUCH_FORMAT_MBOX:
1095 if (params.part > 0) {
1096 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1100 format = &format_mbox;
1102 case NOTMUCH_FORMAT_RAW:
1103 format = &format_raw;
1104 /* If --format=raw specified without specifying part, we can only
1105 * output single message, so set part=0 */
1106 if (params.part < 0)
1112 /* Default is entire-thread = FALSE except for format=json. */
1113 if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1114 if (format == &format_json)
1115 entire_thread = ENTIRE_THREAD_TRUE;
1117 entire_thread = ENTIRE_THREAD_FALSE;
1120 if (!params.output_body) {
1121 if (params.part > 0) {
1122 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1123 params.output_body = TRUE;
1125 if (format != &format_json)
1126 fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
1130 if (entire_thread == ENTIRE_THREAD_TRUE)
1131 params.entire_thread = TRUE;
1133 params.entire_thread = FALSE;
1135 config = notmuch_config_open (ctx, NULL, NULL);
1139 query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
1140 if (query_string == NULL) {
1141 fprintf (stderr, "Out of memory\n");
1145 if (*query_string == '\0') {
1146 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1150 if (notmuch_database_open (notmuch_config_get_database_path (config),
1151 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1154 query = notmuch_query_create (notmuch, query_string);
1155 if (query == NULL) {
1156 fprintf (stderr, "Out of memory\n");
1160 /* Create structure printer. */
1161 sprinter = format->new_sprinter(ctx, stdout);
1163 /* If a single message is requested we do not use search_excludes. */
1164 if (params.part >= 0)
1165 ret = do_show_single (ctx, query, format, sprinter, ¶ms);
1167 /* We always apply set the exclude flag. The
1168 * exclude=true|false option controls whether or not we return
1169 * threads that only match in an excluded message */
1170 const char **search_exclude_tags;
1171 size_t search_exclude_tags_length;
1174 search_exclude_tags = notmuch_config_get_search_exclude_tags
1175 (config, &search_exclude_tags_length);
1176 for (i = 0; i < search_exclude_tags_length; i++)
1177 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1179 if (exclude == EXCLUDE_FALSE) {
1180 notmuch_query_set_omit_excluded (query, FALSE);
1181 params.omit_excluded = FALSE;
1184 ret = do_show (ctx, query, format, sprinter, ¶ms);
1187 notmuch_crypto_cleanup (¶ms.crypto);
1188 notmuch_query_destroy (query);
1189 notmuch_database_destroy (notmuch);