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 static const char *_get_disposition(GMimeObject *meta)
115 GMimeContentDisposition *disposition;
117 disposition = g_mime_object_get_content_disposition (meta);
121 return g_mime_content_disposition_get_disposition (disposition);
124 /* Emit a sequence of key/value pairs for the metadata of message.
125 * The caller should begin a map before calling this. */
127 format_message_sprinter (sprinter_t *sp, notmuch_message_t *message)
129 /* Any changes to the JSON or S-Expression format should be
130 * reflected in the file devel/schemata. */
132 void *local = talloc_new (NULL);
133 notmuch_tags_t *tags;
135 const char *relative_date;
137 sp->map_key (sp, "id");
138 sp->string (sp, notmuch_message_get_message_id (message));
140 sp->map_key (sp, "match");
141 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
143 sp->map_key (sp, "excluded");
144 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
146 sp->map_key (sp, "filename");
147 if (notmuch_format_version >= 3) {
148 notmuch_filenames_t *filenames;
151 for (filenames = notmuch_message_get_filenames (message);
152 notmuch_filenames_valid (filenames);
153 notmuch_filenames_move_to_next (filenames)) {
154 sp->string (sp, notmuch_filenames_get (filenames));
156 notmuch_filenames_destroy (filenames);
159 sp->string (sp, notmuch_message_get_filename (message));
162 sp->map_key (sp, "timestamp");
163 date = notmuch_message_get_date (message);
164 sp->integer (sp, date);
166 sp->map_key (sp, "date_relative");
167 relative_date = notmuch_time_relative_date (local, date);
168 sp->string (sp, relative_date);
170 sp->map_key (sp, "tags");
172 for (tags = notmuch_message_get_tags (message);
173 notmuch_tags_valid (tags);
174 notmuch_tags_move_to_next (tags))
175 sp->string (sp, notmuch_tags_get (tags));
181 /* Extract just the email address from the contents of a From:
184 _extract_email_address (const void *ctx, const char *from)
186 InternetAddressList *addresses;
187 InternetAddress *address;
188 InternetAddressMailbox *mailbox;
189 const char *email = "MAILER-DAEMON";
191 addresses = internet_address_list_parse_string (from);
193 /* Bail if there is no address here. */
194 if (addresses == NULL || internet_address_list_length (addresses) < 1)
197 /* Otherwise, just use the first address. */
198 address = internet_address_list_get_address (addresses, 0);
200 /* The From header should never contain an address group rather
201 * than a mailbox. So bail if it does. */
202 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
205 mailbox = INTERNET_ADDRESS_MAILBOX (address);
206 email = internet_address_mailbox_get_addr (mailbox);
207 email = talloc_strdup (ctx, email);
211 g_object_unref (addresses);
216 /* Return 1 if 'line' is an mbox From_ line---that is, a line
217 * beginning with zero or more '>' characters followed by the
218 * characters 'F', 'r', 'o', 'm', and space.
220 * Any characters at all may appear after that in the line.
223 _is_from_line (const char *line)
225 const char *s = line;
233 if (STRNCMP_LITERAL (s, "From ") == 0)
240 format_headers_sprinter (sprinter_t *sp, GMimeMessage *message,
241 notmuch_bool_t reply)
243 /* Any changes to the JSON or S-Expression format should be
244 * reflected in the file devel/schemata. */
246 InternetAddressList *recipients;
247 const char *recipients_string;
248 const char *reply_to_string;
252 sp->map_key (sp, "Subject");
253 sp->string (sp, g_mime_message_get_subject (message));
255 sp->map_key (sp, "From");
256 sp->string (sp, g_mime_message_get_sender (message));
258 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
259 recipients_string = internet_address_list_to_string (recipients, 0);
260 if (recipients_string) {
261 sp->map_key (sp, "To");
262 sp->string (sp, recipients_string);
265 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
266 recipients_string = internet_address_list_to_string (recipients, 0);
267 if (recipients_string) {
268 sp->map_key (sp, "Cc");
269 sp->string (sp, recipients_string);
272 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_BCC);
273 recipients_string = internet_address_list_to_string (recipients, 0);
274 if (recipients_string) {
275 sp->map_key (sp, "Bcc");
276 sp->string (sp, recipients_string);
279 reply_to_string = g_mime_message_get_reply_to (message);
280 if (reply_to_string) {
281 sp->map_key (sp, "Reply-To");
282 sp->string (sp, reply_to_string);
286 sp->map_key (sp, "In-reply-to");
287 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
289 sp->map_key (sp, "References");
290 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
292 sp->map_key (sp, "Date");
293 sp->string (sp, g_mime_message_get_date_as_string (message));
299 /* Write a MIME text part out to the given stream.
301 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
304 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
305 * UTF-8) will be performed, so it is inappropriate to call this
306 * function with a non-text part. Doing so will trigger an internal
310 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
311 notmuch_show_text_part_flags flags)
313 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
314 GMimeStream *stream_filter = NULL;
315 GMimeDataWrapper *wrapper;
318 if (! g_mime_content_type_is_type (content_type, "text", "*"))
319 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
320 g_mime_content_type_to_string (content_type));
322 if (stream_out == NULL)
325 stream_filter = g_mime_stream_filter_new (stream_out);
326 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
327 g_mime_filter_crlf_new (FALSE, FALSE));
329 charset = g_mime_object_get_content_type_parameter (part, "charset");
331 GMimeFilter *charset_filter;
332 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
333 /* This result can be NULL for things like "unknown-8bit".
334 * Don't set a NULL filter as that makes GMime print
335 * annoying assertion-failure messages on stderr. */
336 if (charset_filter) {
337 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
339 g_object_unref (charset_filter);
344 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
345 GMimeFilter *reply_filter;
346 reply_filter = g_mime_filter_reply_new (TRUE);
348 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
350 g_object_unref (reply_filter);
354 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
355 if (wrapper && stream_filter)
356 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
358 g_object_unref(stream_filter);
361 /* Get signature status string (GMime 2.6) */
363 signature_status_to_string (GMimeSignatureStatus x)
366 case GMIME_SIGNATURE_STATUS_GOOD:
368 case GMIME_SIGNATURE_STATUS_BAD:
370 case GMIME_SIGNATURE_STATUS_ERROR:
376 /* Signature status sprinter (GMime 2.6) */
378 format_part_sigstatus_sprinter (sprinter_t *sp, mime_node_t *node)
380 /* Any changes to the JSON or S-Expression format should be
381 * reflected in the file devel/schemata. */
383 GMimeSignatureList *siglist = node->sig_list;
393 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
394 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
399 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
400 sp->map_key (sp, "status");
401 sp->string (sp, signature_status_to_string (status));
403 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
404 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
406 sp->map_key (sp, "fingerprint");
407 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
409 /* these dates are seconds since the epoch; should we
410 * provide a more human-readable format string? */
411 time_t created = g_mime_signature_get_created (signature);
413 sp->map_key (sp, "created");
414 sp->integer (sp, created);
416 time_t expires = g_mime_signature_get_expires (signature);
418 sp->map_key (sp, "expires");
419 sp->integer (sp, expires);
421 /* output user id only if validity is FULL or ULTIMATE. */
422 /* note that gmime is using the term "trust" here, which
423 * is WRONG. It's actually user id "validity". */
425 const char *name = g_mime_certificate_get_name (certificate);
426 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
427 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
428 sp->map_key (sp, "userid");
429 sp->string (sp, name);
432 } else if (certificate) {
433 const char *key_id = g_mime_certificate_get_key_id (certificate);
435 sp->map_key (sp, "keyid");
436 sp->string (sp, key_id);
440 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
441 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
442 sp->map_key (sp, "errors");
443 sp->integer (sp, errors);
452 static notmuch_status_t
453 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
454 int indent, const notmuch_show_params_t *params)
456 /* The disposition and content-type metadata are associated with
457 * the envelope for message parts */
458 GMimeObject *meta = node->envelope_part ?
459 GMIME_OBJECT (node->envelope_part) : node->part;
460 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
461 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
462 const char *part_type;
465 if (node->envelope_file) {
466 notmuch_message_t *message = node->envelope_file;
468 part_type = "message";
469 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
471 notmuch_message_get_message_id (message),
473 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
474 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
475 notmuch_message_get_filename (message));
477 const char *disposition = _get_disposition (meta);
478 const char *cid = g_mime_object_get_content_id (meta);
479 const char *filename = leaf ?
480 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
483 strcasecmp (disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
484 part_type = "attachment";
488 printf ("\f%s{ ID: %d", part_type, node->part_num);
490 printf (", Filename: %s", filename);
492 printf (", Content-id: %s", cid);
493 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
496 if (GMIME_IS_MESSAGE (node->part)) {
497 GMimeMessage *message = GMIME_MESSAGE (node->part);
498 InternetAddressList *recipients;
499 const char *recipients_string;
501 printf ("\fheader{\n");
502 if (node->envelope_file)
503 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
504 printf ("Subject: %s\n", g_mime_message_get_subject (message));
505 printf ("From: %s\n", g_mime_message_get_sender (message));
506 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
507 recipients_string = internet_address_list_to_string (recipients, 0);
508 if (recipients_string)
509 printf ("To: %s\n", recipients_string);
510 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
511 recipients_string = internet_address_list_to_string (recipients, 0);
512 if (recipients_string)
513 printf ("Cc: %s\n", recipients_string);
514 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
515 printf ("\fheader}\n");
517 printf ("\fbody{\n");
521 if (g_mime_content_type_is_type (content_type, "text", "*") &&
522 !g_mime_content_type_is_type (content_type, "text", "html"))
524 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
525 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
526 show_text_part_content (node->part, stream_stdout, 0);
527 g_object_unref(stream_stdout);
529 printf ("Non-text part: %s\n",
530 g_mime_content_type_to_string (content_type));
534 for (i = 0; i < node->nchildren; i++)
535 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
537 if (GMIME_IS_MESSAGE (node->part))
538 printf ("\fbody}\n");
540 printf ("\f%s}\n", part_type);
542 return NOTMUCH_STATUS_SUCCESS;
546 format_omitted_part_meta_sprinter (sprinter_t *sp, GMimeObject *meta, GMimePart *part)
548 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
549 const char *cte = g_mime_object_get_header (meta, "content-transfer-encoding");
550 GMimeDataWrapper *wrapper = g_mime_part_get_content_object (part);
551 GMimeStream *stream = g_mime_data_wrapper_get_stream (wrapper);
552 ssize_t content_length = g_mime_stream_length (stream);
554 if (content_charset != NULL) {
555 sp->map_key (sp, "content-charset");
556 sp->string (sp, content_charset);
559 sp->map_key (sp, "content-transfer-encoding");
560 sp->string (sp, cte);
562 if (content_length >= 0) {
563 sp->map_key (sp, "content-length");
564 sp->integer (sp, content_length);
569 format_part_sprinter (const void *ctx, sprinter_t *sp, mime_node_t *node,
570 notmuch_bool_t first, notmuch_bool_t output_body,
571 notmuch_bool_t include_html)
573 /* Any changes to the JSON or S-Expression format should be
574 * reflected in the file devel/schemata. */
576 if (node->envelope_file) {
578 format_message_sprinter (sp, node->envelope_file);
580 sp->map_key (sp, "headers");
581 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
584 sp->map_key (sp, "body");
586 format_part_sprinter (ctx, sp, mime_node_child (node, 0), first, TRUE, include_html);
593 /* The disposition and content-type metadata are associated with
594 * the envelope for message parts */
595 GMimeObject *meta = node->envelope_part ?
596 GMIME_OBJECT (node->envelope_part) : node->part;
597 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
598 const char *disposition = _get_disposition (meta);
599 const char *cid = g_mime_object_get_content_id (meta);
600 const char *filename = GMIME_IS_PART (node->part) ?
601 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
607 sp->map_key (sp, "id");
608 sp->integer (sp, node->part_num);
610 if (node->decrypt_attempted) {
611 sp->map_key (sp, "encstatus");
614 sp->map_key (sp, "status");
615 sp->string (sp, node->decrypt_success ? "good" : "bad");
620 if (node->verify_attempted) {
621 sp->map_key (sp, "sigstatus");
622 format_part_sigstatus_sprinter (sp, node);
625 sp->map_key (sp, "content-type");
626 sp->string (sp, g_mime_content_type_to_string (content_type));
629 sp->map_key (sp, "content-disposition");
630 sp->string (sp, disposition);
634 sp->map_key (sp, "content-id");
635 sp->string (sp, cid);
639 sp->map_key (sp, "filename");
640 sp->string (sp, filename);
643 if (GMIME_IS_PART (node->part)) {
644 /* For non-HTML text parts, we include the content in the
645 * JSON. Since JSON must be Unicode, we handle charset
646 * decoding here and do not report a charset to the caller.
647 * For text/html parts, we do not include the content unless
648 * the --include-html option has been passed. If a html part
649 * is not included, it can be requested directly. This makes
650 * charset decoding the responsibility on the caller so we
651 * report the charset for text/html parts.
653 if (g_mime_content_type_is_type (content_type, "text", "*") &&
655 ! g_mime_content_type_is_type (content_type, "text", "html")))
657 GMimeStream *stream_memory = g_mime_stream_mem_new ();
658 GByteArray *part_content;
659 show_text_part_content (node->part, stream_memory, 0);
660 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
661 sp->map_key (sp, "content");
662 sp->string_len (sp, (char *) part_content->data, part_content->len);
663 g_object_unref (stream_memory);
665 format_omitted_part_meta_sprinter (sp, meta, GMIME_PART (node->part));
667 } else if (GMIME_IS_MULTIPART (node->part)) {
668 sp->map_key (sp, "content");
671 } else if (GMIME_IS_MESSAGE (node->part)) {
672 sp->map_key (sp, "content");
676 sp->map_key (sp, "headers");
677 format_headers_sprinter (sp, GMIME_MESSAGE (node->part), FALSE);
679 sp->map_key (sp, "body");
684 for (i = 0; i < node->nchildren; i++)
685 format_part_sprinter (ctx, sp, mime_node_child (node, i), i == 0, TRUE, include_html);
687 /* Close content structures */
688 for (i = 0; i < nclose; i++)
694 static notmuch_status_t
695 format_part_sprinter_entry (const void *ctx, sprinter_t *sp,
696 mime_node_t *node, unused (int indent),
697 const notmuch_show_params_t *params)
699 format_part_sprinter (ctx, sp, node, TRUE, params->output_body, params->include_html);
701 return NOTMUCH_STATUS_SUCCESS;
704 /* Print a message in "mboxrd" format as documented, for example,
707 * http://qmail.org/qmail-manual-html/man5/mbox.html
709 static notmuch_status_t
710 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
712 unused (const notmuch_show_params_t *params))
714 notmuch_message_t *message = node->envelope_file;
716 const char *filename;
721 struct tm date_gmtime;
722 char date_asctime[26];
729 INTERNAL_ERROR ("format_part_mbox requires a root part");
731 filename = notmuch_message_get_filename (message);
732 file = fopen (filename, "r");
734 fprintf (stderr, "Failed to open %s: %s\n",
735 filename, strerror (errno));
736 return NOTMUCH_STATUS_FILE_ERROR;
739 from = notmuch_message_get_header (message, "from");
740 from = _extract_email_address (ctx, from);
742 date = notmuch_message_get_date (message);
743 gmtime_r (&date, &date_gmtime);
744 asctime_r (&date_gmtime, date_asctime);
746 printf ("From %s %s", from, date_asctime);
748 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
749 if (_is_from_line (line))
758 return NOTMUCH_STATUS_SUCCESS;
761 static notmuch_status_t
762 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
763 mime_node_t *node, unused (int indent),
764 unused (const notmuch_show_params_t *params))
766 if (node->envelope_file) {
767 /* Special case the entire message to avoid MIME parsing. */
768 const char *filename;
773 filename = notmuch_message_get_filename (node->envelope_file);
774 if (filename == NULL) {
775 fprintf (stderr, "Error: Cannot get message filename.\n");
776 return NOTMUCH_STATUS_FILE_ERROR;
779 file = fopen (filename, "r");
781 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
782 return NOTMUCH_STATUS_FILE_ERROR;
785 while (!feof (file)) {
786 size = fread (buf, 1, sizeof (buf), file);
788 fprintf (stderr, "Error: Read failed from %s\n", filename);
790 return NOTMUCH_STATUS_FILE_ERROR;
793 if (fwrite (buf, size, 1, stdout) != 1) {
794 fprintf (stderr, "Error: Write failed\n");
796 return NOTMUCH_STATUS_FILE_ERROR;
801 return NOTMUCH_STATUS_SUCCESS;
804 GMimeStream *stream_stdout;
805 GMimeStream *stream_filter = NULL;
807 stream_stdout = g_mime_stream_file_new (stdout);
808 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
810 stream_filter = g_mime_stream_filter_new (stream_stdout);
812 if (GMIME_IS_PART (node->part)) {
813 /* For leaf parts, we emit only the transfer-decoded
815 GMimeDataWrapper *wrapper;
816 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
818 if (wrapper && stream_filter)
819 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
821 /* Write out the whole part. For message parts (the root
822 * part and embedded message parts), this will be the
823 * message including its headers (but not the
824 * encapsulating part's headers). For multipart parts,
825 * this will include the headers. */
827 g_mime_object_write_to_stream (node->part, stream_filter);
831 g_object_unref (stream_filter);
834 g_object_unref(stream_stdout);
836 return NOTMUCH_STATUS_SUCCESS;
839 static notmuch_status_t
840 show_message (void *ctx,
841 const notmuch_show_format_t *format,
843 notmuch_message_t *message,
845 notmuch_show_params_t *params)
847 void *local = talloc_new (ctx);
848 mime_node_t *root, *part;
849 notmuch_status_t status;
851 status = mime_node_open (local, message, &(params->crypto), &root);
854 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
856 status = format->part (local, sp, part, indent, params);
862 static notmuch_status_t
863 show_messages (void *ctx,
864 const notmuch_show_format_t *format,
866 notmuch_messages_t *messages,
868 notmuch_show_params_t *params)
870 notmuch_message_t *message;
871 notmuch_bool_t match;
872 notmuch_bool_t excluded;
874 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
879 notmuch_messages_valid (messages);
880 notmuch_messages_move_to_next (messages))
884 message = notmuch_messages_get (messages);
886 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
887 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
889 next_indent = indent;
891 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
892 status = show_message (ctx, format, sp, message, indent, params);
895 next_indent = indent + 1;
900 status = show_messages (ctx,
902 notmuch_message_get_replies (message),
908 notmuch_message_destroy (message);
918 /* Formatted output of single message */
920 do_show_single (void *ctx,
921 notmuch_query_t *query,
922 const notmuch_show_format_t *format,
924 notmuch_show_params_t *params)
926 notmuch_messages_t *messages;
927 notmuch_message_t *message;
928 notmuch_status_t status;
931 status = notmuch_query_count_messages_st (query, &count);
932 if (print_status_query ("notmuch show", query, status))
936 fprintf (stderr, "Error: search term did not match precisely one message (matched %d messages).\n", count);
940 status = notmuch_query_search_messages_st (query, &messages);
941 if (print_status_query ("notmuch show", query, status))
944 message = notmuch_messages_get (messages);
946 if (message == NULL) {
947 fprintf (stderr, "Error: Cannot find matching message.\n");
951 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
953 return show_message (ctx, format, sp, message, 0, params)
954 != NOTMUCH_STATUS_SUCCESS;
957 /* Formatted output of threads */
960 notmuch_query_t *query,
961 const notmuch_show_format_t *format,
963 notmuch_show_params_t *params)
965 notmuch_threads_t *threads;
966 notmuch_thread_t *thread;
967 notmuch_messages_t *messages;
968 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
970 status= notmuch_query_search_threads_st (query, &threads);
971 if (print_status_query ("notmuch show", query, status))
977 notmuch_threads_valid (threads);
978 notmuch_threads_move_to_next (threads))
980 thread = notmuch_threads_get (threads);
982 messages = notmuch_thread_get_toplevel_messages (thread);
984 if (messages == NULL)
985 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
986 notmuch_thread_get_thread_id (thread));
988 status = show_messages (ctx, format, sp, messages, 0, params);
992 notmuch_thread_destroy (thread);
998 return res != NOTMUCH_STATUS_SUCCESS;
1002 NOTMUCH_FORMAT_NOT_SPECIFIED,
1003 NOTMUCH_FORMAT_JSON,
1004 NOTMUCH_FORMAT_SEXP,
1005 NOTMUCH_FORMAT_TEXT,
1006 NOTMUCH_FORMAT_MBOX,
1010 static const notmuch_show_format_t *formatters[] = {
1011 [NOTMUCH_FORMAT_JSON] = &format_json,
1012 [NOTMUCH_FORMAT_SEXP] = &format_sexp,
1013 [NOTMUCH_FORMAT_TEXT] = &format_text,
1014 [NOTMUCH_FORMAT_MBOX] = &format_mbox,
1015 [NOTMUCH_FORMAT_RAW] = &format_raw,
1019 ENTIRE_THREAD_DEFAULT = -1,
1020 ENTIRE_THREAD_FALSE = FALSE,
1021 ENTIRE_THREAD_TRUE = TRUE,
1024 /* The following is to allow future options to be added more easily */
1031 notmuch_show_command (notmuch_config_t *config, int argc, char *argv[])
1033 notmuch_database_t *notmuch;
1034 notmuch_query_t *query;
1037 const notmuch_show_format_t *formatter;
1038 sprinter_t *sprinter;
1039 notmuch_show_params_t params = {
1041 .omit_excluded = TRUE,
1042 .output_body = TRUE,
1048 .include_html = FALSE
1050 int format = NOTMUCH_FORMAT_NOT_SPECIFIED;
1051 int exclude = EXCLUDE_TRUE;
1052 int entire_thread = ENTIRE_THREAD_DEFAULT;
1053 notmuch_bool_t single_message;
1055 notmuch_opt_desc_t options[] = {
1056 { NOTMUCH_OPT_KEYWORD, &format, "format", 'f',
1057 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1058 { "text", NOTMUCH_FORMAT_TEXT },
1059 { "sexp", NOTMUCH_FORMAT_SEXP },
1060 { "mbox", NOTMUCH_FORMAT_MBOX },
1061 { "raw", NOTMUCH_FORMAT_RAW },
1063 { NOTMUCH_OPT_INT, ¬much_format_version, "format-version", 0, 0 },
1064 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1065 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1066 { "false", EXCLUDE_FALSE },
1068 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1069 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1070 { "false", ENTIRE_THREAD_FALSE },
1071 { "", ENTIRE_THREAD_TRUE },
1073 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1074 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1075 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1076 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1077 { NOTMUCH_OPT_BOOLEAN, ¶ms.include_html, "include-html", 0, 0 },
1078 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
1082 opt_index = parse_arguments (argc, argv, options, 1);
1084 return EXIT_FAILURE;
1086 notmuch_process_shared_options (argv[0]);
1088 /* decryption implies verification */
1089 if (params.crypto.decrypt)
1090 params.crypto.verify = TRUE;
1092 /* specifying a part implies single message display */
1093 single_message = params.part >= 0;
1095 if (format == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1096 /* if part was requested and format was not specified, use format=raw */
1097 if (params.part >= 0)
1098 format = NOTMUCH_FORMAT_RAW;
1100 format = NOTMUCH_FORMAT_TEXT;
1103 if (format == NOTMUCH_FORMAT_MBOX) {
1104 if (params.part > 0) {
1105 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1106 return EXIT_FAILURE;
1108 } else if (format == NOTMUCH_FORMAT_RAW) {
1109 /* raw format only supports single message display */
1110 single_message = TRUE;
1113 notmuch_exit_if_unsupported_format ();
1115 /* Default is entire-thread = FALSE except for format=json and
1117 if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1118 if (format == NOTMUCH_FORMAT_JSON || format == NOTMUCH_FORMAT_SEXP)
1119 params.entire_thread = TRUE;
1121 params.entire_thread = FALSE;
1123 params.entire_thread = entire_thread;
1126 if (!params.output_body) {
1127 if (params.part > 0) {
1128 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1129 params.output_body = TRUE;
1131 if (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)
1133 "Warning: --body=false only implemented for format=json and format=sexp\n");
1137 if (params.include_html &&
1138 (format != NOTMUCH_FORMAT_JSON && format != NOTMUCH_FORMAT_SEXP)) {
1139 fprintf (stderr, "Warning: --include-html only implemented for format=json and format=sexp\n");
1142 query_string = query_string_from_args (config, argc-opt_index, argv+opt_index);
1143 if (query_string == NULL) {
1144 fprintf (stderr, "Out of memory\n");
1145 return EXIT_FAILURE;
1148 if (*query_string == '\0') {
1149 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1150 return EXIT_FAILURE;
1153 params.crypto.gpgpath = notmuch_config_get_crypto_gpg_path (config);
1155 if (notmuch_database_open (notmuch_config_get_database_path (config),
1156 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1157 return EXIT_FAILURE;
1159 notmuch_exit_if_unmatched_db_uuid (notmuch);
1161 query = notmuch_query_create (notmuch, query_string);
1162 if (query == NULL) {
1163 fprintf (stderr, "Out of memory\n");
1164 return EXIT_FAILURE;
1167 /* Create structure printer. */
1168 formatter = formatters[format];
1169 sprinter = formatter->new_sprinter(config, stdout);
1171 /* If a single message is requested we do not use search_excludes. */
1172 if (single_message) {
1173 ret = do_show_single (config, query, formatter, sprinter, ¶ms);
1175 /* We always apply set the exclude flag. The
1176 * exclude=true|false option controls whether or not we return
1177 * threads that only match in an excluded message */
1178 const char **search_exclude_tags;
1179 size_t search_exclude_tags_length;
1182 search_exclude_tags = notmuch_config_get_search_exclude_tags
1183 (config, &search_exclude_tags_length);
1184 for (i = 0; i < search_exclude_tags_length; i++)
1185 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1187 if (exclude == EXCLUDE_FALSE) {
1188 notmuch_query_set_omit_excluded (query, FALSE);
1189 params.omit_excluded = FALSE;
1192 ret = do_show (config, query, formatter, sprinter, ¶ms);
1195 notmuch_crypto_cleanup (¶ms.crypto);
1196 notmuch_query_destroy (query);
1197 notmuch_database_destroy (notmuch);
1199 return ret ? EXIT_FAILURE : EXIT_SUCCESS;