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"
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_sprinter_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_sprinter_entry,
43 static const notmuch_show_format_t format_sexp = {
44 .new_sprinter = sprinter_sexp_create,
45 .part = format_part_sprinter_entry,
48 static notmuch_status_t
49 format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
50 int indent, const notmuch_show_params_t *params);
52 static const notmuch_show_format_t format_mbox = {
53 .new_sprinter = sprinter_text_create,
54 .part = format_part_mbox,
57 static notmuch_status_t
58 format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node,
60 unused (const notmuch_show_params_t *params));
62 static const notmuch_show_format_t format_raw = {
63 .new_sprinter = sprinter_text_create,
64 .part = format_part_raw,
68 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
75 result = talloc_strdup (ctx, "");
79 for (tags = notmuch_message_get_tags (message);
80 notmuch_tags_valid (tags);
81 notmuch_tags_move_to_next (tags))
83 tag = notmuch_tags_get (tags);
85 result = talloc_asprintf_append (result, "%s%s",
86 first ? "" : " ", tag);
93 /* Get a nice, single-line summary of message. */
95 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
99 const char *relative_date;
102 from = notmuch_message_get_header (message, "from");
104 date = notmuch_message_get_date (message);
105 relative_date = notmuch_time_relative_date (ctx, date);
107 tags = _get_tags_as_string (ctx, message);
109 return talloc_asprintf (ctx, "%s (%s) (%s)",
110 from, relative_date, tags);
113 /* Emit a sequence of key/value pairs for the metadata of message.
114 * The caller should begin a map before calling this. */
116 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
118 /* Any changes to the JSON or S-Expression format should be
119 * reflected in the file devel/schemata. */
121 void *local = talloc_new (NULL);
122 notmuch_tags_t *tags;
124 const char *relative_date;
126 sp->map_key (sp, "id");
127 sp->string (sp, notmuch_message_get_message_id (message));
129 sp->map_key (sp, "match");
130 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
132 sp->map_key (sp, "excluded");
133 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
135 sp->map_key (sp, "filename");
136 sp->string (sp, notmuch_message_get_filename (message));
138 sp->map_key (sp, "timestamp");
139 date = notmuch_message_get_date (message);
140 sp->integer (sp, date);
142 sp->map_key (sp, "date_relative");
143 relative_date = notmuch_time_relative_date (local, date);
144 sp->string (sp, relative_date);
146 sp->map_key (sp, "tags");
148 for (tags = notmuch_message_get_tags (message);
149 notmuch_tags_valid (tags);
150 notmuch_tags_move_to_next (tags))
151 sp->string (sp, notmuch_tags_get (tags));
157 /* Extract just the email address from the contents of a From:
160 _extract_email_address (const void *ctx, const char *from)
162 InternetAddressList *addresses;
163 InternetAddress *address;
164 InternetAddressMailbox *mailbox;
165 const char *email = "MAILER-DAEMON";
167 addresses = internet_address_list_parse_string (from);
169 /* Bail if there is no address here. */
170 if (addresses == NULL || internet_address_list_length (addresses) < 1)
173 /* Otherwise, just use the first address. */
174 address = internet_address_list_get_address (addresses, 0);
176 /* The From header should never contain an address group rather
177 * than a mailbox. So bail if it does. */
178 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
181 mailbox = INTERNET_ADDRESS_MAILBOX (address);
182 email = internet_address_mailbox_get_addr (mailbox);
183 email = talloc_strdup (ctx, email);
187 g_object_unref (addresses);
192 /* Return 1 if 'line' is an mbox From_ line---that is, a line
193 * beginning with zero or more '>' characters followed by the
194 * characters 'F', 'r', 'o', 'm', and space.
196 * Any characters at all may appear after that in the line.
199 _is_from_line (const char *line)
201 const char *s = line;
209 if (STRNCMP_LITERAL (s, "From ") == 0)
216 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
217 notmuch_bool_t reply)
219 /* Any changes to the JSON or S-Expression format should be
220 * reflected in the file devel/schemata. */
222 InternetAddressList *recipients;
223 const char *recipients_string;
224 const char *reply_to_string;
228 sp->map_key (sp, "Subject");
229 sp->string (sp, g_mime_message_get_subject (message));
231 sp->map_key (sp, "From");
232 sp->string (sp, g_mime_message_get_sender (message));
234 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
235 recipients_string = internet_address_list_to_string (recipients, 0);
236 if (recipients_string) {
237 sp->map_key (sp, "To");
238 sp->string (sp, recipients_string);
241 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
242 recipients_string = internet_address_list_to_string (recipients, 0);
243 if (recipients_string) {
244 sp->map_key (sp, "Cc");
245 sp->string (sp, recipients_string);
248 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
249 recipients_string = internet_address_list_to_string (recipients, 0);
250 if (recipients_string) {
251 sp->map_key (sp, "Bcc");
252 sp->string (sp, recipients_string);
255 reply_to_string = g_mime_message_get_reply_to (message);
256 if (reply_to_string) {
257 sp->map_key (sp, "Reply-To");
258 sp->string (sp, reply_to_string);
262 sp->map_key (sp, "In-reply-to");
263 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
265 sp->map_key (sp, "References");
266 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
268 sp->map_key (sp, "Date");
269 sp->string (sp, g_mime_message_get_date_as_string (message));
275 /* Write a MIME text part out to the given stream.
277 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
280 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
281 * UTF-8) will be performed, so it is inappropriate to call this
282 * function with a non-text part. Doing so will trigger an internal
286 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
287 notmuch_show_text_part_flags flags)
289 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
290 GMimeStream *stream_filter = NULL;
291 GMimeDataWrapper *wrapper;
294 if (! g_mime_content_type_is_type (content_type, "text", "*"))
295 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
296 g_mime_content_type_to_string (content_type));
298 if (stream_out == NULL)
301 stream_filter = g_mime_stream_filter_new (stream_out);
302 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
303 g_mime_filter_crlf_new (FALSE, FALSE));
305 charset = g_mime_object_get_content_type_parameter (part, "charset");
307 GMimeFilter *charset_filter;
308 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
309 /* This result can be NULL for things like "unknown-8bit".
310 * Don't set a NULL filter as that makes GMime print
311 * annoying assertion-failure messages on stderr. */
312 if (charset_filter) {
313 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
315 g_object_unref (charset_filter);
320 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
321 GMimeFilter *reply_filter;
322 reply_filter = g_mime_filter_reply_new (TRUE);
324 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
326 g_object_unref (reply_filter);
330 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
331 if (wrapper && stream_filter)
332 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
334 g_object_unref(stream_filter);
337 /* Get signature status string (GMime 2.6) */
339 signature_status_to_string (GMimeSignatureStatus x)
342 case GMIME_SIGNATURE_STATUS_GOOD:
344 case GMIME_SIGNATURE_STATUS_BAD:
346 case GMIME_SIGNATURE_STATUS_ERROR:
352 /* Signature status sprinter (GMime 2.6) */
354 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
356 /* Any changes to the JSON or S-Expression format should be
357 * reflected in the file devel/schemata. */
359 GMimeSignatureList *siglist = node->sig_list;
369 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
370 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
375 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
376 sp->map_key (sp, "status");
377 sp->string (sp, signature_status_to_string (status));
379 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
380 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
382 sp->map_key (sp, "fingerprint");
383 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
385 /* these dates are seconds since the epoch; should we
386 * provide a more human-readable format string? */
387 time_t created = g_mime_signature_get_created (signature);
389 sp->map_key (sp, "created");
390 sp->integer (sp, created);
392 time_t expires = g_mime_signature_get_expires (signature);
394 sp->map_key (sp, "expires");
395 sp->integer (sp, expires);
397 /* output user id only if validity is FULL or ULTIMATE. */
398 /* note that gmime is using the term "trust" here, which
399 * is WRONG. It's actually user id "validity". */
401 const char *name = g_mime_certificate_get_name (certificate);
402 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
403 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
404 sp->map_key (sp, "userid");
405 sp->string (sp, name);
408 } else if (certificate) {
409 const char *key_id = g_mime_certificate_get_key_id (certificate);
411 sp->map_key (sp, "keyid");
412 sp->string (sp, key_id);
416 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
417 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
418 sp->map_key (sp, "errors");
419 sp->integer (sp, errors);
428 static notmuch_status_t
429 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
430 int indent, const notmuch_show_params_t *params)
432 /* The disposition and content-type metadata are associated with
433 * the envelope for message parts */
434 GMimeObject *meta = node->envelope_part ?
435 GMIME_OBJECT (node->envelope_part) : node->part;
436 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
437 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
438 const char *part_type;
441 if (node->envelope_file) {
442 notmuch_message_t *message = node->envelope_file;
444 part_type = "message";
445 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
447 notmuch_message_get_message_id (message),
449 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
450 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
451 notmuch_message_get_filename (message));
453 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
454 const char *cid = g_mime_object_get_content_id (meta);
455 const char *filename = leaf ?
456 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
459 strcasecmp (g_mime_content_disposition_get_disposition (disposition),
460 GMIME_DISPOSITION_ATTACHMENT) == 0)
461 part_type = "attachment";
465 printf ("\f%s{ ID: %d", part_type, node->part_num);
467 printf (", Filename: %s", filename);
469 printf (", Content-id: %s", cid);
470 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
473 if (GMIME_IS_MESSAGE (node->part)) {
474 GMimeMessage *message = GMIME_MESSAGE (node->part);
475 InternetAddressList *recipients;
476 const char *recipients_string;
478 printf ("\fheader{\n");
479 if (node->envelope_file)
480 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
481 printf ("Subject: %s\n", g_mime_message_get_subject (message));
482 printf ("From: %s\n", g_mime_message_get_sender (message));
483 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
484 recipients_string = internet_address_list_to_string (recipients, 0);
485 if (recipients_string)
486 printf ("To: %s\n", recipients_string);
487 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
488 recipients_string = internet_address_list_to_string (recipients, 0);
489 if (recipients_string)
490 printf ("Cc: %s\n", recipients_string);
491 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
492 printf ("\fheader}\n");
494 printf ("\fbody{\n");
498 if (g_mime_content_type_is_type (content_type, "text", "*") &&
499 !g_mime_content_type_is_type (content_type, "text", "html"))
501 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
502 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
503 show_text_part_content (node->part, stream_stdout, 0);
504 g_object_unref(stream_stdout);
506 printf ("Non-text part: %s\n",
507 g_mime_content_type_to_string (content_type));
511 for (i = 0; i < node->nchildren; i++)
512 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
514 if (GMIME_IS_MESSAGE (node->part))
515 printf ("\fbody}\n");
517 printf ("\f%s}\n", part_type);
519 return NOTMUCH_STATUS_SUCCESS;
523 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
525 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
526 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
527 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
528 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
529 ssize_t content_length = g_mime_stream_length (stream);
531 if (content_charset != NULL) {
532 sp->map_key (sp, "content-charset");
533 sp->string (sp, content_charset);
536 sp->map_key (sp, "content-transfer-encoding");
537 sp->string (sp, cte);
539 if (content_length >= 0) {
540 sp->map_key (sp, "content-length");
541 sp->integer (sp, content_length);
546 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
547 notmuch_bool_t first, notmuch_bool_t output_body,
548 notmuch_bool_t include_html)
550 /* Any changes to the JSON or S-Expression format should be
551 * reflected in the file devel/schemata. */
553 if (node->envelope_file) {
555 format_message_sprinter (sp, node->envelope_file);
557 sp->map_key (sp, "headers");
558 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
561 sp->map_key (sp, "body");
563 format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
570 /* The disposition and content-type metadata are associated with
571 * the envelope for message parts */
572 GMimeObject *meta = node->envelope_part ?
573 GMIME_OBJECT (node->envelope_part) : node->part;
574 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
575 const char *cid = g_mime_object_get_content_id (meta);
576 const char *filename = GMIME_IS_PART (node->part) ?
577 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
583 sp->map_key (sp, "id");
584 sp->integer (sp, node->part_num);
586 if (node->decrypt_attempted) {
587 sp->map_key (sp, "encstatus");
590 sp->map_key (sp, "status");
591 sp->string (sp, node->decrypt_success ? "good" : "bad");
596 if (node->verify_attempted) {
597 sp->map_key (sp, "sigstatus");
598 format_part_sigstatus_sprinter (sp, node);
601 sp->map_key (sp, "content-type");
602 sp->string (sp, g_mime_content_type_to_string (content_type));
605 sp->map_key (sp, "content-id");
606 sp->string (sp, cid);
610 sp->map_key (sp, "filename");
611 sp->string (sp, filename);
614 if (GMIME_IS_PART (node->part)) {
615 /* For non-HTML text parts, we include the content in the
616 * JSON. Since JSON must be Unicode, we handle charset
617 * decoding here and do not report a charset to the caller.
618 * For text/html parts, we do not include the content unless
619 * the --include-html option has been passed. If a html part
620 * is not included, it can be requested directly. This makes
621 * charset decoding the responsibility on the caller so we
622 * report the charset for text/html parts.
624 if (g_mime_content_type_is_type (content_type, "text", "*") &&
626 ! g_mime_content_type_is_type (content_type, "text", "html")))
628 GMimeStream *stream_memory = g_mime_stream_mem_new ();
629 GByteArray *part_content;
630 show_text_part_content (node->part, stream_memory, 0);
631 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
632 sp->map_key (sp, "content");
633 sp->string_len (sp, (char *) part_content->data, part_content->len);
634 g_object_unref (stream_memory);
636 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
638 } else if (GMIME_IS_MULTIPART (node->part)) {
639 sp->map_key (sp, "content");
642 } else if (GMIME_IS_MESSAGE (node->part)) {
643 sp->map_key (sp, "content");
647 sp->map_key (sp, "headers");
648 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
650 sp->map_key (sp, "body");
655 for (i = 0; i < node->nchildren; i++)
656 format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
658 /* Close content structures */
659 for (i = 0; i < nclose; i++)
665 static notmuch_status_t
666 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
667 mime_node_t *node, unused (int indent),
668 const notmuch_show_params_t *params)
670 format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
672 return NOTMUCH_STATUS_SUCCESS;
675 /* Print a message in "mboxrd" format as documented, for example,
678 * http://qmail.org/qmail-manual-html/man5/mbox.html
680 static notmuch_status_t
681 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
683 unused (const notmuch_show_params_t *params))
685 notmuch_message_t *message = node->envelope_file;
687 const char *filename;
692 struct tm date_gmtime;
693 char date_asctime[26];
700 INTERNAL_ERROR ("format_part_mbox requires a root part");
702 filename = notmuch_message_get_filename (message);
703 file = fopen (filename, "r");
705 fprintf (stderr, "Failed to open %s: %s\n",
706 filename, strerror (errno));
707 return NOTMUCH_STATUS_FILE_ERROR;
710 from = notmuch_message_get_header (message, "from");
711 from = _extract_email_address (ctx, from);
713 date = notmuch_message_get_date (message);
714 gmtime_r (&date, &date_gmtime);
715 asctime_r (&date_gmtime, date_asctime);
717 printf ("From %s %s", from, date_asctime);
719 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
720 if (_is_from_line (line))
729 return NOTMUCH_STATUS_SUCCESS;
732 static notmuch_status_t
733 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
734 mime_node_t *node, unused (int indent),
735 unused (const notmuch_show_params_t *params))
737 if (node->envelope_file) {
738 /* Special case the entire message to avoid MIME parsing. */
739 const char *filename;
744 filename = notmuch_message_get_filename (node->envelope_file);
745 if (filename == NULL) {
746 fprintf (stderr, "Error: Cannot get message filename.\n");
747 return NOTMUCH_STATUS_FILE_ERROR;
750 file = fopen (filename, "r");
752 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
753 return NOTMUCH_STATUS_FILE_ERROR;
756 while (!feof (file)) {
757 size = fread (buf, 1, sizeof (buf), file);
759 fprintf (stderr, "Error: Read failed from %s\n", filename);
761 return NOTMUCH_STATUS_FILE_ERROR;
764 if (fwrite (buf, size, 1, stdout) != 1) {
765 fprintf (stderr, "Error: Write failed\n");
767 return NOTMUCH_STATUS_FILE_ERROR;
772 return NOTMUCH_STATUS_SUCCESS;
775 GMimeStream *stream_stdout;
776 GMimeStream *stream_filter = NULL;
778 stream_stdout = g_mime_stream_file_new (stdout);
779 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
781 stream_filter = g_mime_stream_filter_new (stream_stdout);
783 if (GMIME_IS_PART (node->part)) {
784 /* For leaf parts, we emit only the transfer-decoded
786 GMimeDataWrapper *wrapper;
787 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
789 if (wrapper && stream_filter)
790 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
792 /* Write out the whole part. For message parts (the root
793 * part and embedded message parts), this will be the
794 * message including its headers (but not the
795 * encapsulating part's headers). For multipart parts,
796 * this will include the headers. */
798 g_mime_object_write_to_stream (node->part, stream_filter);
802 g_object_unref (stream_filter);
805 g_object_unref(stream_stdout);
807 return NOTMUCH_STATUS_SUCCESS;
810 static notmuch_status_t
811 show_message (void *ctx,
812 const notmuch_show_format_t *format,
814 notmuch_message_t *message,
816 notmuch_show_params_t *params)
818 void *local = talloc_new (ctx);
819 mime_node_t *root, *part;
820 notmuch_status_t status;
822 status = mime_node_open (local, message, &(params->crypto), &root);
825 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
827 status = format->part (local, sp, part, indent, params);
833 static notmuch_status_t
834 show_messages (void *ctx,
835 const notmuch_show_format_t *format,
837 notmuch_messages_t *messages,
839 notmuch_show_params_t *params)
841 notmuch_message_t *message;
842 notmuch_bool_t match;
843 notmuch_bool_t excluded;
845 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
850 notmuch_messages_valid (messages);
851 notmuch_messages_move_to_next (messages))
855 message = notmuch_messages_get (messages);
857 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
858 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
860 next_indent = indent;
862 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
863 status = show_message (ctx, format, sp, message, indent, params);
866 next_indent = indent + 1;
871 status = show_messages (ctx,
873 notmuch_message_get_replies (message),
879 notmuch_message_destroy (message);
889 /* Formatted output of single message */
891 do_show_single (void *ctx,
892 notmuch_query_t *query,
893 const notmuch_show_format_t *format,
895 notmuch_show_params_t *params)
897 notmuch_messages_t *messages;
898 notmuch_message_t *message;
899 notmuch_status_t status;
902 status = notmuch_query_count_messages_st (query, &count);
903 if (print_status_query ("notmuch show", query, status))
907 fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
911 status = notmuch_query_search_messages_st (query, &messages);
912 if (print_status_query ("notmuch show", query, status))
915 message = notmuch_messages_get (messages);
917 if (message == NULL) {
918 fprintf (stderr, "Error: Cannot find matching message.\n");
922 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
924 return show_message (ctx, format, sp, message, 0, params)
925 != NOTMUCH_STATUS_SUCCESS;
928 /* Formatted output of threads */
931 notmuch_query_t *query,
932 const notmuch_show_format_t *format,
934 notmuch_show_params_t *params)
936 notmuch_threads_t *threads;
937 notmuch_thread_t *thread;
938 notmuch_messages_t *messages;
939 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
941 status= notmuch_query_search_threads_st (query, &threads);
942 if (print_status_query ("notmuch show", query, status))
948 notmuch_threads_valid (threads);
949 notmuch_threads_move_to_next (threads))
951 thread = notmuch_threads_get (threads);
953 messages = notmuch_thread_get_toplevel_messages (thread);
955 if (messages == NULL)
956 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
957 notmuch_thread_get_thread_id (thread));
959 status = show_messages (ctx, format, sp, messages, 0, params);
963 notmuch_thread_destroy (thread);
969 return res != NOTMUCH_STATUS_SUCCESS;
973 NOTMUCH_FORMAT_NOT_SPECIFIED,
982 ENTIRE_THREAD_DEFAULT,
987 /* The following is to allow future options to be added more easily */
994 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
996 notmuch_database_t *notmuch;
997 notmuch_query_t *query;
1000 const notmuch_show_format_t *format = &format_text;
1001 sprinter_t *sprinter;
1002 notmuch_show_params_t params = {
1004 .omit_excluded = TRUE,
1005 .output_body = TRUE,
1011 .include_html = FALSE
1013 int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
1014 int exclude = EXCLUDE_TRUE;
1015 int entire_thread = ENTIRE_THREAD_DEFAULT;
1017 notmuch_opt_desc_t options[] = {
1018 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
1019 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1020 { "text", NOTMUCH_FORMAT_TEXT },
1021 { "sexp", NOTMUCH_FORMAT_SEXP },
1022 { "mbox", NOTMUCH_FORMAT_MBOX },
1023 { "raw", NOTMUCH_FORMAT_RAW },
1025 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
1026 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1027 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1028 { "false", EXCLUDE_FALSE },
1030 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1031 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1032 { "false", ENTIRE_THREAD_FALSE },
1033 { "", ENTIRE_THREAD_TRUE },
1035 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1036 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1037 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1038 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1039 { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 },
1040 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
1044 opt_index = parse_arguments (argc, argv, options, 1);
1046 return EXIT_FAILURE;
1048 notmuch_process_shared_options (argv[0]);
1050 /* decryption implies verification */
1051 if (params.crypto.decrypt)
1052 params.crypto.verify = TRUE;
1054 if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1055 /* if part was requested and format was not specified, use format=raw */
1056 if (params.part >= 0)
1057 format_sel = NOTMUCH_FORMAT_RAW;
1059 format_sel = NOTMUCH_FORMAT_TEXT;
1062 switch (format_sel) {
1063 case NOTMUCH_FORMAT_JSON:
1064 format = &format_json;
1066 case NOTMUCH_FORMAT_TEXT:
1067 format = &format_text;
1069 case NOTMUCH_FORMAT_SEXP:
1070 format = &format_sexp;
1072 case NOTMUCH_FORMAT_MBOX:
1073 if (params.part > 0) {
1074 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1075 return EXIT_FAILURE;
1078 format = &format_mbox;
1080 case NOTMUCH_FORMAT_RAW:
1081 format = &format_raw;
1082 /* If --format=raw specified without specifying part, we can only
1083 * output single message, so set part=0 */
1084 if (params.part < 0)
1090 notmuch_exit_if_unsupported_format ();
1092 /* Default is entire-thread = FALSE except for format=json and
1094 if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1095 if (format == &format_json || format == &format_sexp)
1096 entire_thread = ENTIRE_THREAD_TRUE;
1098 entire_thread = ENTIRE_THREAD_FALSE;
1101 if (!params.output_body) {
1102 if (params.part > 0) {
1103 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1104 params.output_body = TRUE;
1106 if (format != &format_json && format != &format_sexp)
1108 "Warning: --body=false only implemented for format=json and format=sexp\n");
1112 if (params.include_html &&
1113 (format_sel != NOTMUCH_FORMAT_JSON && format_sel != NOTMUCH_FORMAT_SEXP)) {
1114 fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1117 if (entire_thread == ENTIRE_THREAD_TRUE)
1118 params.entire_thread = TRUE;
1120 params.entire_thread = FALSE;
1122 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1123 if (query_string == NULL) {
1124 fprintf (stderr, "Out of memory\n");
1125 return EXIT_FAILURE;
1128 if (*query_string == '\0') {
1129 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1130 return EXIT_FAILURE;
1133 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1135 if (notmuch_database_open (notmuch_config_get_database_path (config),
1136 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1137 return EXIT_FAILURE;
1139 notmuch_exit_if_unmatched_db_uuid (notmuch);
1141 query = notmuch_query_create (notmuch, query_string);
1142 if (query == NULL) {
1143 fprintf (stderr, "Out of memory\n");
1144 return EXIT_FAILURE;
1147 /* Create structure printer. */
1148 sprinter = format->new_sprinter(config, stdout);
1150 /* If a single message is requested we do not use search_excludes. */
1151 if (params.part >= 0)
1152 ret = do_show_single (config, query, format, sprinter, ¶ms);
1154 /* We always apply set the exclude flag. The
1155 * exclude=true|false option controls whether or not we return
1156 * threads that only match in an excluded message */
1157 const char **search_exclude_tags;
1158 size_t search_exclude_tags_length;
1161 search_exclude_tags = notmuch_config_get_search_exclude_tags
1162 (config, &search_exclude_tags_length);
1163 for (i = 0; i < search_exclude_tags_length; i++)
1164 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1166 if (exclude == EXCLUDE_FALSE) {
1167 notmuch_query_set_omit_excluded (query, FALSE);
1168 params.omit_excluded = FALSE;
1171 ret = do_show (config, query, format, sprinter, ¶ms);
1174 notmuch_crypto_cleanup (¶ms.crypto);
1175 notmuch_query_destroy (query);
1176 notmuch_database_destroy (notmuch);
1178 return ret ? EXIT_FAILURE : EXIT_SUCCESS;