1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
22 #include "gmime-filter-reply.h"
26 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
33 result = talloc_strdup (ctx, "");
37 for (tags = notmuch_message_get_tags (message);
38 notmuch_tags_valid (tags);
39 notmuch_tags_move_to_next (tags))
41 tag = notmuch_tags_get (tags);
43 result = talloc_asprintf_append (result, "%s%s",
44 first ? "" : " ", tag);
51 /* Get a nice, single-line summary of message. */
53 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
57 const char *relative_date;
60 from = notmuch_message_get_header (message, "from");
62 date = notmuch_message_get_date (message);
63 relative_date = notmuch_time_relative_date (ctx, date);
65 tags = _get_tags_as_string (ctx, message);
67 return talloc_asprintf (ctx, "%s (%s) (%s)",
68 from, relative_date, tags);
71 static const char *_get_disposition(GMimeObject *meta)
73 GMimeContentDisposition *disposition;
75 disposition = g_mime_object_get_content_disposition (meta);
79 return g_mime_content_disposition_get_disposition (disposition);
82 /* Emit a sequence of key/value pairs for the metadata of message.
83 * The caller should begin a map before calling this. */
85 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
87 /* Any changes to the JSON or S-Expression format should be
88 * reflected in the file devel/schemata. */
90 void *local = talloc_new (NULL);
93 const char *relative_date;
95 sp->map_key (sp, "id");
96 sp->string (sp, notmuch_message_get_message_id (message));
98 sp->map_key (sp, "match");
99 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
101 sp->map_key (sp, "excluded");
102 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
104 sp->map_key (sp, "filename");
105 if (notmuch_format_version >= 3) {
106 notmuch_filenames_t *filenames;
109 for (filenames = notmuch_message_get_filenames (message);
110 notmuch_filenames_valid (filenames);
111 notmuch_filenames_move_to_next (filenames)) {
112 sp->string (sp, notmuch_filenames_get (filenames));
114 notmuch_filenames_destroy (filenames);
117 sp->string (sp, notmuch_message_get_filename (message));
120 sp->map_key (sp, "timestamp");
121 date = notmuch_message_get_date (message);
122 sp->integer (sp, date);
124 sp->map_key (sp, "date_relative");
125 relative_date = notmuch_time_relative_date (local, date);
126 sp->string (sp, relative_date);
128 sp->map_key (sp, "tags");
130 for (tags = notmuch_message_get_tags (message);
131 notmuch_tags_valid (tags);
132 notmuch_tags_move_to_next (tags))
133 sp->string (sp, notmuch_tags_get (tags));
139 /* Extract just the email address from the contents of a From:
142 _extract_email_address (const void *ctx, const char *from)
144 InternetAddressList *addresses;
145 InternetAddress *address;
146 InternetAddressMailbox *mailbox;
147 const char *email = "MAILER-DAEMON";
149 addresses = internet_address_list_parse_string (from);
151 /* Bail if there is no address here. */
152 if (addresses == NULL || internet_address_list_length (addresses) < 1)
155 /* Otherwise, just use the first address. */
156 address = internet_address_list_get_address (addresses, 0);
158 /* The From header should never contain an address group rather
159 * than a mailbox. So bail if it does. */
160 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
163 mailbox = INTERNET_ADDRESS_MAILBOX (address);
164 email = internet_address_mailbox_get_addr (mailbox);
165 email = talloc_strdup (ctx, email);
169 g_object_unref (addresses);
174 /* Return 1 if 'line' is an mbox From_ line---that is, a line
175 * beginning with zero or more '>' characters followed by the
176 * characters 'F', 'r', 'o', 'm', and space.
178 * Any characters at all may appear after that in the line.
181 _is_from_line (const char *line)
183 const char *s = line;
191 if (STRNCMP_LITERAL (s, "From ") == 0)
198 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
199 notmuch_bool_t reply)
201 /* Any changes to the JSON or S-Expression format should be
202 * reflected in the file devel/schemata. */
204 InternetAddressList *recipients;
205 const char *recipients_string;
206 const char *reply_to_string;
210 sp->map_key (sp, "Subject");
211 sp->string (sp, g_mime_message_get_subject (message));
213 sp->map_key (sp, "From");
214 sp->string (sp, g_mime_message_get_sender (message));
216 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
217 recipients_string = internet_address_list_to_string (recipients, 0);
218 if (recipients_string) {
219 sp->map_key (sp, "To");
220 sp->string (sp, recipients_string);
223 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
224 recipients_string = internet_address_list_to_string (recipients, 0);
225 if (recipients_string) {
226 sp->map_key (sp, "Cc");
227 sp->string (sp, recipients_string);
230 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
231 recipients_string = internet_address_list_to_string (recipients, 0);
232 if (recipients_string) {
233 sp->map_key (sp, "Bcc");
234 sp->string (sp, recipients_string);
237 reply_to_string = g_mime_message_get_reply_to (message);
238 if (reply_to_string) {
239 sp->map_key (sp, "Reply-To");
240 sp->string (sp, reply_to_string);
244 sp->map_key (sp, "In-reply-to");
245 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
247 sp->map_key (sp, "References");
248 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
250 sp->map_key (sp, "Date");
251 sp->string (sp, g_mime_message_get_date_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 /* Get signature status string (GMime 2.6) */
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:
334 /* Signature status sprinter (GMime 2.6) */
336 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
338 /* Any changes to the JSON or S-Expression format should be
339 * reflected in the file devel/schemata. */
341 GMimeSignatureList *siglist = node->sig_list;
351 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
352 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
357 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
358 sp->map_key (sp, "status");
359 sp->string (sp, signature_status_to_string (status));
361 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
362 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
364 sp->map_key (sp, "fingerprint");
365 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
367 /* these dates are seconds since the epoch; should we
368 * provide a more human-readable format string? */
369 time_t created = g_mime_signature_get_created (signature);
371 sp->map_key (sp, "created");
372 sp->integer (sp, created);
374 time_t expires = g_mime_signature_get_expires (signature);
376 sp->map_key (sp, "expires");
377 sp->integer (sp, expires);
379 /* output user id only if validity is FULL or ULTIMATE. */
380 /* note that gmime is using the term "trust" here, which
381 * is WRONG. It's actually user id "validity". */
383 const char *name = g_mime_certificate_get_name (certificate);
384 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
385 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
386 sp->map_key (sp, "userid");
387 sp->string (sp, name);
390 } else if (certificate) {
391 const char *key_id = g_mime_certificate_get_key_id (certificate);
393 sp->map_key (sp, "keyid");
394 sp->string (sp, key_id);
398 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
399 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
400 sp->map_key (sp, "errors");
401 sp->integer (sp, errors);
410 static notmuch_status_t
411 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
412 int indent, const notmuch_show_params_t *params)
414 /* The disposition and content-type metadata are associated with
415 * the envelope for message parts */
416 GMimeObject *meta = node->envelope_part ?
417 GMIME_OBJECT (node->envelope_part) : node->part;
418 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
419 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
420 const char *part_type;
423 if (node->envelope_file) {
424 notmuch_message_t *message = node->envelope_file;
426 part_type = "message";
427 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
429 notmuch_message_get_message_id (message),
431 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
432 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
433 notmuch_message_get_filename (message));
435 const char *disposition = _get_disposition (meta);
436 const char *cid = g_mime_object_get_content_id (meta);
437 const char *filename = leaf ?
438 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
441 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
442 part_type = "attachment";
446 printf ("\f%s{ ID: %d", part_type, node->part_num);
448 printf (", Filename: %s", filename);
450 printf (", Content-id: %s", cid);
451 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
454 if (GMIME_IS_MESSAGE (node->part)) {
455 GMimeMessage *message = GMIME_MESSAGE (node->part);
456 InternetAddressList *recipients;
457 const char *recipients_string;
459 printf ("\fheader{\n");
460 if (node->envelope_file)
461 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
462 printf ("Subject: %s\n", g_mime_message_get_subject (message));
463 printf ("From: %s\n", g_mime_message_get_sender (message));
464 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
465 recipients_string = internet_address_list_to_string (recipients, 0);
466 if (recipients_string)
467 printf ("To: %s\n", recipients_string);
468 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
469 recipients_string = internet_address_list_to_string (recipients, 0);
470 if (recipients_string)
471 printf ("Cc: %s\n", recipients_string);
472 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
473 printf ("\fheader}\n");
475 printf ("\fbody{\n");
479 if (g_mime_content_type_is_type (content_type, "text", "*") &&
480 !g_mime_content_type_is_type (content_type, "text", "html"))
482 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
483 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
484 show_text_part_content (node->part, stream_stdout, 0);
485 g_object_unref(stream_stdout);
487 printf ("Non-text part: %s\n",
488 g_mime_content_type_to_string (content_type));
492 for (i = 0; i < node->nchildren; i++)
493 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
495 if (GMIME_IS_MESSAGE (node->part))
496 printf ("\fbody}\n");
498 printf ("\f%s}\n", part_type);
500 return NOTMUCH_STATUS_SUCCESS;
504 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
506 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
507 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
508 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
509 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
510 ssize_t content_length = g_mime_stream_length (stream);
512 if (content_charset != NULL) {
513 sp->map_key (sp, "content-charset");
514 sp->string (sp, content_charset);
517 sp->map_key (sp, "content-transfer-encoding");
518 sp->string (sp, cte);
520 if (content_length >= 0) {
521 sp->map_key (sp, "content-length");
522 sp->integer (sp, content_length);
527 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
528 notmuch_bool_t first, notmuch_bool_t output_body,
529 notmuch_bool_t include_html)
531 /* Any changes to the JSON or S-Expression format should be
532 * reflected in the file devel/schemata. */
534 if (node->envelope_file) {
536 format_message_sprinter (sp, node->envelope_file);
538 sp->map_key (sp, "headers");
539 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
542 sp->map_key (sp, "body");
544 format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
551 /* The disposition and content-type metadata are associated with
552 * the envelope for message parts */
553 GMimeObject *meta = node->envelope_part ?
554 GMIME_OBJECT (node->envelope_part) : node->part;
555 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
556 const char *disposition = _get_disposition (meta);
557 const char *cid = g_mime_object_get_content_id (meta);
558 const char *filename = GMIME_IS_PART (node->part) ?
559 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
565 sp->map_key (sp, "id");
566 sp->integer (sp, node->part_num);
568 if (node->decrypt_attempted) {
569 sp->map_key (sp, "encstatus");
572 sp->map_key (sp, "status");
573 sp->string (sp, node->decrypt_success ? "good" : "bad");
578 if (node->verify_attempted) {
579 sp->map_key (sp, "sigstatus");
580 format_part_sigstatus_sprinter (sp, node);
583 sp->map_key (sp, "content-type");
584 sp->string (sp, g_mime_content_type_to_string (content_type));
587 sp->map_key (sp, "content-disposition");
588 sp->string (sp, disposition);
592 sp->map_key (sp, "content-id");
593 sp->string (sp, cid);
597 sp->map_key (sp, "filename");
598 sp->string (sp, filename);
601 if (GMIME_IS_PART (node->part)) {
602 /* For non-HTML text parts, we include the content in the
603 * JSON. Since JSON must be Unicode, we handle charset
604 * decoding here and do not report a charset to the caller.
605 * For text/html parts, we do not include the content unless
606 * the --include-html option has been passed. If a html part
607 * is not included, it can be requested directly. This makes
608 * charset decoding the responsibility on the caller so we
609 * report the charset for text/html parts.
611 if (g_mime_content_type_is_type (content_type, "text", "*") &&
613 ! g_mime_content_type_is_type (content_type, "text", "html")))
615 GMimeStream *stream_memory = g_mime_stream_mem_new ();
616 GByteArray *part_content;
617 show_text_part_content (node->part, stream_memory, 0);
618 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
619 sp->map_key (sp, "content");
620 sp->string_len (sp, (char *) part_content->data, part_content->len);
621 g_object_unref (stream_memory);
623 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
625 } else if (GMIME_IS_MULTIPART (node->part)) {
626 sp->map_key (sp, "content");
629 } else if (GMIME_IS_MESSAGE (node->part)) {
630 sp->map_key (sp, "content");
634 sp->map_key (sp, "headers");
635 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
637 sp->map_key (sp, "body");
642 for (i = 0; i < node->nchildren; i++)
643 format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
645 /* Close content structures */
646 for (i = 0; i < nclose; i++)
652 static notmuch_status_t
653 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
654 mime_node_t *node, unused (int indent),
655 const notmuch_show_params_t *params)
657 format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
659 return NOTMUCH_STATUS_SUCCESS;
662 /* Print a message in "mboxrd" format as documented, for example,
665 * http://qmail.org/qmail-manual-html/man5/mbox.html
667 static notmuch_status_t
668 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
670 unused (const notmuch_show_params_t *params))
672 notmuch_message_t *message = node->envelope_file;
674 const char *filename;
679 struct tm date_gmtime;
680 char date_asctime[26];
687 INTERNAL_ERROR ("format_part_mbox requires a root part");
689 filename = notmuch_message_get_filename (message);
690 file = fopen (filename, "r");
692 fprintf (stderr, "Failed to open %s: %s\n",
693 filename, strerror (errno));
694 return NOTMUCH_STATUS_FILE_ERROR;
697 from = notmuch_message_get_header (message, "from");
698 from = _extract_email_address (ctx, from);
700 date = notmuch_message_get_date (message);
701 gmtime_r (&date, &date_gmtime);
702 asctime_r (&date_gmtime, date_asctime);
704 printf ("From %s %s", from, date_asctime);
706 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
707 if (_is_from_line (line))
716 return NOTMUCH_STATUS_SUCCESS;
719 static notmuch_status_t
720 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
721 mime_node_t *node, unused (int indent),
722 unused (const notmuch_show_params_t *params))
724 if (node->envelope_file) {
725 /* Special case the entire message to avoid MIME parsing. */
726 const char *filename;
731 filename = notmuch_message_get_filename (node->envelope_file);
732 if (filename == NULL) {
733 fprintf (stderr, "Error: Cannot get message filename.\n");
734 return NOTMUCH_STATUS_FILE_ERROR;
737 file = fopen (filename, "r");
739 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
740 return NOTMUCH_STATUS_FILE_ERROR;
743 while (!feof (file)) {
744 size = fread (buf, 1, sizeof (buf), file);
746 fprintf (stderr, "Error: Read failed from %s\n", filename);
748 return NOTMUCH_STATUS_FILE_ERROR;
751 if (fwrite (buf, size, 1, stdout) != 1) {
752 fprintf (stderr, "Error: Write failed\n");
754 return NOTMUCH_STATUS_FILE_ERROR;
759 return NOTMUCH_STATUS_SUCCESS;
762 GMimeStream *stream_stdout;
763 GMimeStream *stream_filter = NULL;
765 stream_stdout = g_mime_stream_file_new (stdout);
766 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
768 stream_filter = g_mime_stream_filter_new (stream_stdout);
770 if (GMIME_IS_PART (node->part)) {
771 /* For leaf parts, we emit only the transfer-decoded
773 GMimeDataWrapper *wrapper;
774 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
776 if (wrapper && stream_filter)
777 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
779 /* Write out the whole part. For message parts (the root
780 * part and embedded message parts), this will be the
781 * message including its headers (but not the
782 * encapsulating part's headers). For multipart parts,
783 * this will include the headers. */
785 g_mime_object_write_to_stream (node->part, stream_filter);
789 g_object_unref (stream_filter);
792 g_object_unref(stream_stdout);
794 return NOTMUCH_STATUS_SUCCESS;
797 static notmuch_status_t
798 show_message (void *ctx,
799 const notmuch_show_format_t *format,
801 notmuch_message_t *message,
803 notmuch_show_params_t *params)
805 void *local = talloc_new (ctx);
806 mime_node_t *root, *part;
807 notmuch_status_t status;
809 status = mime_node_open (local, message, &(params->crypto), &root);
812 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
814 status = format->part (local, sp, part, indent, params);
820 static notmuch_status_t
821 show_messages (void *ctx,
822 const notmuch_show_format_t *format,
824 notmuch_messages_t *messages,
826 notmuch_show_params_t *params)
828 notmuch_message_t *message;
829 notmuch_bool_t match;
830 notmuch_bool_t excluded;
832 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
837 notmuch_messages_valid (messages);
838 notmuch_messages_move_to_next (messages))
842 message = notmuch_messages_get (messages);
844 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
845 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
847 next_indent = indent;
849 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
850 status = show_message (ctx, format, sp, message, indent, params);
853 next_indent = indent + 1;
858 status = show_messages (ctx,
860 notmuch_message_get_replies (message),
866 notmuch_message_destroy (message);
876 /* Formatted output of single message */
878 do_show_single (void *ctx,
879 notmuch_query_t *query,
880 const notmuch_show_format_t *format,
882 notmuch_show_params_t *params)
884 notmuch_messages_t *messages;
885 notmuch_message_t *message;
886 notmuch_status_t status;
889 status = notmuch_query_count_messages_st (query, &count);
890 if (print_status_query ("notmuch show", query, status))
894 fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
898 status = notmuch_query_search_messages_st (query, &messages);
899 if (print_status_query ("notmuch show", query, status))
902 message = notmuch_messages_get (messages);
904 if (message == NULL) {
905 fprintf (stderr, "Error: Cannot find matching message.\n");
909 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
911 return show_message (ctx, format, sp, message, 0, params)
912 != NOTMUCH_STATUS_SUCCESS;
915 /* Formatted output of threads */
918 notmuch_query_t *query,
919 const notmuch_show_format_t *format,
921 notmuch_show_params_t *params)
923 notmuch_threads_t *threads;
924 notmuch_thread_t *thread;
925 notmuch_messages_t *messages;
926 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
928 status= notmuch_query_search_threads_st (query, &threads);
929 if (print_status_query ("notmuch show", query, status))
935 notmuch_threads_valid (threads);
936 notmuch_threads_move_to_next (threads))
938 thread = notmuch_threads_get (threads);
940 messages = notmuch_thread_get_toplevel_messages (thread);
942 if (messages == NULL)
943 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
944 notmuch_thread_get_thread_id (thread));
946 status = show_messages (ctx, format, sp, messages, 0, params);
950 notmuch_thread_destroy (thread);
956 return res != NOTMUCH_STATUS_SUCCESS;
960 NOTMUCH_FORMAT_NOT_SPECIFIED,
968 static const notmuch_show_format_t format_json = {
969 .new_sprinter = sprinter_json_create,
970 .part = format_part_sprinter_entry,
973 static const notmuch_show_format_t format_sexp = {
974 .new_sprinter = sprinter_sexp_create,
975 .part = format_part_sprinter_entry,
978 static const notmuch_show_format_t format_text = {
979 .new_sprinter = sprinter_text_create,
980 .part = format_part_text,
983 static const notmuch_show_format_t format_mbox = {
984 .new_sprinter = sprinter_text_create,
985 .part = format_part_mbox,
988 static const notmuch_show_format_t format_raw = {
989 .new_sprinter = sprinter_text_create,
990 .part = format_part_raw,
993 static const notmuch_show_format_t *formatters[] = {
994 [NOTMUCH_FORMAT_JSON] = &format_json,
995 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
996 [NOTMUCH_FORMAT_TEXT] = &format_text,
997 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
998 [NOTMUCH_FORMAT_RAW] = &format_raw,
1002 ENTIRE_THREAD_DEFAULT = -1,
1003 ENTIRE_THREAD_FALSE = FALSE,
1004 ENTIRE_THREAD_TRUE = TRUE,
1007 /* The following is to allow future options to be added more easily */
1014 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1016 notmuch_database_t *notmuch;
1017 notmuch_query_t *query;
1020 const notmuch_show_format_t *formatter;
1021 sprinter_t *sprinter;
1022 notmuch_show_params_t params = {
1024 .omit_excluded = TRUE,
1025 .output_body = TRUE,
1027 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1028 int exclude = EXCLUDE_TRUE;
1029 int entire_thread = ENTIRE_THREAD_DEFAULT;
1030 notmuch_bool_t single_message;
1032 notmuch_opt_desc_t options[] = {
1033 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
1034 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1035 { "text", NOTMUCH_FORMAT_TEXT },
1036 { "sexp", NOTMUCH_FORMAT_SEXP },
1037 { "mbox", NOTMUCH_FORMAT_MBOX },
1038 { "raw", NOTMUCH_FORMAT_RAW },
1040 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
1041 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1042 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1043 { "false", EXCLUDE_FALSE },
1045 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1046 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1047 { "false", ENTIRE_THREAD_FALSE },
1048 { "", ENTIRE_THREAD_TRUE },
1050 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1051 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1052 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1053 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1054 { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 },
1055 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
1059 opt_index = parse_arguments (argc, argv, options, 1);
1061 return EXIT_FAILURE;
1063 notmuch_process_shared_options (argv[0]);
1065 /* decryption implies verification */
1066 if (params.crypto.decrypt)
1067 params.crypto.verify = TRUE;
1069 /* specifying a part implies single message display */
1070 single_message = params.part >= 0;
1072 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1073 /* if part was requested and format was not specified, use format=raw */
1074 if (params.part >= 0)
1075 format = NOTMUCH_FORMAT_RAW;
1077 format = NOTMUCH_FORMAT_TEXT;
1080 if (format == NOTMUCH_FORMAT_MBOX) {
1081 if (params.part > 0) {
1082 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1083 return EXIT_FAILURE;
1085 } else if (format == NOTMUCH_FORMAT_RAW) {
1086 /* raw format only supports single message display */
1087 single_message = TRUE;
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 == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP)
1096 params.entire_thread = TRUE;
1098 params.entire_thread = FALSE;
1100 params.entire_thread = entire_thread;
1103 if (!params.output_body) {
1104 if (params.part > 0) {
1105 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1106 params.output_body = TRUE;
1108 if (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)
1110 "Warning: --body=false only implemented for format=json and format=sexp\n");
1114 if (params.include_html &&
1115 (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1116 fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1119 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1120 if (query_string == NULL) {
1121 fprintf (stderr, "Out of memory\n");
1122 return EXIT_FAILURE;
1125 if (*query_string == '\0') {
1126 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1127 return EXIT_FAILURE;
1130 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1132 if (notmuch_database_open (notmuch_config_get_database_path (config),
1133 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1134 return EXIT_FAILURE;
1136 notmuch_exit_if_unmatched_db_uuid (notmuch);
1138 query = notmuch_query_create (notmuch, query_string);
1139 if (query == NULL) {
1140 fprintf (stderr, "Out of memory\n");
1141 return EXIT_FAILURE;
1144 /* Create structure printer. */
1145 formatter = formatters[format];
1146 sprinter = formatter->new_sprinter(config, stdout);
1148 /* If a single message is requested we do not use search_excludes. */
1149 if (single_message) {
1150 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1152 /* We always apply set the exclude flag. The
1153 * exclude=true|false option controls whether or not we return
1154 * threads that only match in an excluded message */
1155 const char **search_exclude_tags;
1156 size_t search_exclude_tags_length;
1159 search_exclude_tags = notmuch_config_get_search_exclude_tags
1160 (config, &search_exclude_tags_length);
1161 for (i = 0; i < search_exclude_tags_length; i++)
1162 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1164 if (exclude == EXCLUDE_FALSE) {
1165 notmuch_query_set_omit_excluded (query, FALSE);
1166 params.omit_excluded = FALSE;
1169 ret = do_show (config, query, formatter, sprinter, ¶ms);
1172 notmuch_crypto_cleanup (¶ms.crypto);
1173 notmuch_query_destroy (query);
1174 notmuch_database_destroy (notmuch);
1176 return ret ? EXIT_FAILURE : EXIT_SUCCESS;