1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
22 #include "gmime-filter-reply.h"
25 static notmuch_status_t
26 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
27 int indent, const notmuch_show_params_t *params);
29 static const notmuch_show_format_t format_text = {
30 .new_sprinter = sprinter_text_create,
31 .part = format_part_text,
34 static notmuch_status_t
35 format_part_json_entry (const void *ctx, sprinter_t *sp, mime_node_t *node,
36 int indent, const notmuch_show_params_t *params);
38 static const notmuch_show_format_t format_json = {
39 .new_sprinter = sprinter_json_create,
40 .part = format_part_json_entry,
43 static notmuch_status_t
44 format_part_mbox (const void *ctx, sprinter_t *sp, mime_node_t *node,
45 int indent, const notmuch_show_params_t *params);
47 static const notmuch_show_format_t format_mbox = {
48 .new_sprinter = sprinter_text_create,
49 .part = format_part_mbox,
52 static notmuch_status_t
53 format_part_raw (unused (const void *ctx), sprinter_t *sp, mime_node_t *node,
55 unused (const notmuch_show_params_t *params));
57 static const notmuch_show_format_t format_raw = {
58 .new_sprinter = sprinter_text_create,
59 .part = format_part_raw,
63 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
70 result = talloc_strdup (ctx, "");
74 for (tags = notmuch_message_get_tags (message);
75 notmuch_tags_valid (tags);
76 notmuch_tags_move_to_next (tags))
78 tag = notmuch_tags_get (tags);
80 result = talloc_asprintf_append (result, "%s%s",
81 first ? "" : " ", tag);
88 /* Get a nice, single-line summary of message. */
90 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
94 const char *relative_date;
97 from = notmuch_message_get_header (message, "from");
99 date = notmuch_message_get_date (message);
100 relative_date = notmuch_time_relative_date (ctx, date);
102 tags = _get_tags_as_string (ctx, message);
104 return talloc_asprintf (ctx, "%s (%s) (%s)",
105 from, relative_date, tags);
108 /* Emit a sequence of key/value pairs for the metadata of message.
109 * The caller should begin a map before calling this. */
111 format_message_json (sprinter_t *sp, notmuch_message_t *message)
113 void *local = talloc_new (NULL);
114 notmuch_tags_t *tags;
116 const char *relative_date;
118 sp->map_key (sp, "id");
119 sp->string (sp, notmuch_message_get_message_id (message));
121 sp->map_key (sp, "match");
122 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH));
124 sp->map_key (sp, "excluded");
125 sp->boolean (sp, notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED));
127 sp->map_key (sp, "filename");
128 sp->string (sp, notmuch_message_get_filename (message));
130 sp->map_key (sp, "timestamp");
131 date = notmuch_message_get_date (message);
132 sp->integer (sp, date);
134 sp->map_key (sp, "date_relative");
135 relative_date = notmuch_time_relative_date (local, date);
136 sp->string (sp, relative_date);
138 sp->map_key (sp, "tags");
140 for (tags = notmuch_message_get_tags (message);
141 notmuch_tags_valid (tags);
142 notmuch_tags_move_to_next (tags))
143 sp->string (sp, notmuch_tags_get (tags));
149 /* Extract just the email address from the contents of a From:
152 _extract_email_address (const void *ctx, const char *from)
154 InternetAddressList *addresses;
155 InternetAddress *address;
156 InternetAddressMailbox *mailbox;
157 const char *email = "MAILER-DAEMON";
159 addresses = internet_address_list_parse_string (from);
161 /* Bail if there is no address here. */
162 if (addresses == NULL || internet_address_list_length (addresses) < 1)
165 /* Otherwise, just use the first address. */
166 address = internet_address_list_get_address (addresses, 0);
168 /* The From header should never contain an address group rather
169 * than a mailbox. So bail if it does. */
170 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
173 mailbox = INTERNET_ADDRESS_MAILBOX (address);
174 email = internet_address_mailbox_get_addr (mailbox);
175 email = talloc_strdup (ctx, email);
179 g_object_unref (addresses);
184 /* Return 1 if 'line' is an mbox From_ line---that is, a line
185 * beginning with zero or more '>' characters followed by the
186 * characters 'F', 'r', 'o', 'm', and space.
188 * Any characters at all may appear after that in the line.
191 _is_from_line (const char *line)
193 const char *s = line;
201 if (STRNCMP_LITERAL (s, "From ") == 0)
208 format_headers_json (sprinter_t *sp, GMimeMessage *message,
209 notmuch_bool_t reply)
211 InternetAddressList *recipients;
212 const char *recipients_string;
216 sp->map_key (sp, "Subject");
217 sp->string (sp, g_mime_message_get_subject (message));
219 sp->map_key (sp, "From");
220 sp->string (sp, g_mime_message_get_sender (message));
222 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
223 recipients_string = internet_address_list_to_string (recipients, 0);
224 if (recipients_string) {
225 sp->map_key (sp, "To");
226 sp->string (sp, recipients_string);
229 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
230 recipients_string = internet_address_list_to_string (recipients, 0);
231 if (recipients_string) {
232 sp->map_key (sp, "Cc");
233 sp->string (sp, recipients_string);
237 sp->map_key (sp, "In-reply-to");
238 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "In-reply-to"));
240 sp->map_key (sp, "References");
241 sp->string (sp, g_mime_object_get_header (GMIME_OBJECT (message), "References"));
243 sp->map_key (sp, "Date");
244 sp->string (sp, g_mime_message_get_date_as_string (message));
250 /* Write a MIME text part out to the given stream.
252 * If (flags & NOTMUCH_SHOW_TEXT_PART_REPLY), this prepends "> " to
255 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
256 * UTF-8) will be performed, so it is inappropriate to call this
257 * function with a non-text part. Doing so will trigger an internal
261 show_text_part_content (GMimeObject *part, GMimeStream *stream_out,
262 notmuch_show_text_part_flags flags)
264 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
265 GMimeStream *stream_filter = NULL;
266 GMimeDataWrapper *wrapper;
269 if (! g_mime_content_type_is_type (content_type, "text", "*"))
270 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
271 g_mime_content_type_to_string (content_type));
273 if (stream_out == NULL)
276 stream_filter = g_mime_stream_filter_new (stream_out);
277 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
278 g_mime_filter_crlf_new (FALSE, FALSE));
280 charset = g_mime_object_get_content_type_parameter (part, "charset");
282 GMimeFilter *charset_filter;
283 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
284 /* This result can be NULL for things like "unknown-8bit".
285 * Don't set a NULL filter as that makes GMime print
286 * annoying assertion-failure messages on stderr. */
287 if (charset_filter) {
288 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
290 g_object_unref (charset_filter);
295 if (flags & NOTMUCH_SHOW_TEXT_PART_REPLY) {
296 GMimeFilter *reply_filter;
297 reply_filter = g_mime_filter_reply_new (TRUE);
299 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
301 g_object_unref (reply_filter);
305 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
306 if (wrapper && stream_filter)
307 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
309 g_object_unref(stream_filter);
312 #ifdef GMIME_ATLEAST_26
314 signature_status_to_string (GMimeSignatureStatus x)
317 case GMIME_SIGNATURE_STATUS_GOOD:
319 case GMIME_SIGNATURE_STATUS_BAD:
321 case GMIME_SIGNATURE_STATUS_ERROR:
328 signer_status_to_string (GMimeSignerStatus x)
331 case GMIME_SIGNER_STATUS_NONE:
333 case GMIME_SIGNER_STATUS_GOOD:
335 case GMIME_SIGNER_STATUS_BAD:
337 case GMIME_SIGNER_STATUS_ERROR:
344 #ifdef GMIME_ATLEAST_26
346 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
348 GMimeSignatureList *siglist = node->sig_list;
358 for (i = 0; i < g_mime_signature_list_length (siglist); i++) {
359 GMimeSignature *signature = g_mime_signature_list_get_signature (siglist, i);
364 GMimeSignatureStatus status = g_mime_signature_get_status (signature);
365 sp->map_key (sp, "status");
366 sp->string (sp, signature_status_to_string (status));
368 GMimeCertificate *certificate = g_mime_signature_get_certificate (signature);
369 if (status == GMIME_SIGNATURE_STATUS_GOOD) {
371 sp->map_key (sp, "fingerprint");
372 sp->string (sp, g_mime_certificate_get_fingerprint (certificate));
374 /* these dates are seconds since the epoch; should we
375 * provide a more human-readable format string? */
376 time_t created = g_mime_signature_get_created (signature);
378 sp->map_key (sp, "created");
379 sp->integer (sp, created);
381 time_t expires = g_mime_signature_get_expires (signature);
383 sp->map_key (sp, "expires");
384 sp->integer (sp, expires);
386 /* output user id only if validity is FULL or ULTIMATE. */
387 /* note that gmime is using the term "trust" here, which
388 * is WRONG. It's actually user id "validity". */
390 const char *name = g_mime_certificate_get_name (certificate);
391 GMimeCertificateTrust trust = g_mime_certificate_get_trust (certificate);
392 if (name && (trust == GMIME_CERTIFICATE_TRUST_FULLY || trust == GMIME_CERTIFICATE_TRUST_ULTIMATE)) {
393 sp->map_key (sp, "userid");
394 sp->string (sp, name);
397 } else if (certificate) {
398 const char *key_id = g_mime_certificate_get_key_id (certificate);
400 sp->map_key (sp, "keyid");
401 sp->string (sp, key_id);
405 GMimeSignatureError errors = g_mime_signature_get_errors (signature);
406 if (errors != GMIME_SIGNATURE_ERROR_NONE) {
407 sp->map_key (sp, "errors");
408 sp->integer (sp, errors);
418 format_part_sigstatus_json (sprinter_t *sp, mime_node_t *node)
420 const GMimeSignatureValidity* validity = node->sig_validity;
429 const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity);
434 sp->map_key (sp, "status");
435 sp->string (sp, signer_status_to_string (signer->status));
437 if (signer->status == GMIME_SIGNER_STATUS_GOOD)
439 if (signer->fingerprint) {
440 sp->map_key (sp, "fingerprint");
441 sp->string (sp, signer->fingerprint);
443 /* these dates are seconds since the epoch; should we
444 * provide a more human-readable format string? */
445 if (signer->created) {
446 sp->map_key (sp, "created");
447 sp->integer (sp, signer->created);
449 if (signer->expires) {
450 sp->map_key (sp, "expires");
451 sp->integer (sp, signer->expires);
453 /* output user id only if validity is FULL or ULTIMATE. */
454 /* note that gmime is using the term "trust" here, which
455 * is WRONG. It's actually user id "validity". */
456 if ((signer->name) && (signer->trust)) {
457 if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE)) {
458 sp->map_key (sp, "userid");
459 sp->string (sp, signer->name);
464 sp->map_key (sp, "keyid");
465 sp->string (sp, signer->keyid);
468 if (signer->errors != GMIME_SIGNER_ERROR_NONE) {
469 sp->map_key (sp, "errors");
470 sp->integer (sp, signer->errors);
474 signer = signer->next;
481 static notmuch_status_t
482 format_part_text (const void *ctx, sprinter_t *sp, mime_node_t *node,
483 int indent, const notmuch_show_params_t *params)
485 /* The disposition and content-type metadata are associated with
486 * the envelope for message parts */
487 GMimeObject *meta = node->envelope_part ?
488 GMIME_OBJECT (node->envelope_part) : node->part;
489 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
490 const notmuch_bool_t leaf = GMIME_IS_PART (node->part);
491 const char *part_type;
494 if (node->envelope_file) {
495 notmuch_message_t *message = node->envelope_file;
497 part_type = "message";
498 printf ("\f%s{ id:%s depth:%d match:%d excluded:%d filename:%s\n",
500 notmuch_message_get_message_id (message),
502 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? 1 : 0,
503 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED) ? 1 : 0,
504 notmuch_message_get_filename (message));
506 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (meta);
507 const char *cid = g_mime_object_get_content_id (meta);
508 const char *filename = leaf ?
509 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
512 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
513 part_type = "attachment";
517 printf ("\f%s{ ID: %d", part_type, node->part_num);
519 printf (", Filename: %s", filename);
521 printf (", Content-id: %s", cid);
522 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
525 if (GMIME_IS_MESSAGE (node->part)) {
526 GMimeMessage *message = GMIME_MESSAGE (node->part);
527 InternetAddressList *recipients;
528 const char *recipients_string;
530 printf ("\fheader{\n");
531 if (node->envelope_file)
532 printf ("%s\n", _get_one_line_summary (ctx, node->envelope_file));
533 printf ("Subject: %s\n", g_mime_message_get_subject (message));
534 printf ("From: %s\n", g_mime_message_get_sender (message));
535 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_TO);
536 recipients_string = internet_address_list_to_string (recipients, 0);
537 if (recipients_string)
538 printf ("To: %s\n", recipients_string);
539 recipients = g_mime_message_get_recipients (message, GMIME_RECIPIENT_TYPE_CC);
540 recipients_string = internet_address_list_to_string (recipients, 0);
541 if (recipients_string)
542 printf ("Cc: %s\n", recipients_string);
543 printf ("Date: %s\n", g_mime_message_get_date_as_string (message));
544 printf ("\fheader}\n");
546 printf ("\fbody{\n");
550 if (g_mime_content_type_is_type (content_type, "text", "*") &&
551 !g_mime_content_type_is_type (content_type, "text", "html"))
553 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
554 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
555 show_text_part_content (node->part, stream_stdout, 0);
556 g_object_unref(stream_stdout);
558 printf ("Non-text part: %s\n",
559 g_mime_content_type_to_string (content_type));
563 for (i = 0; i < node->nchildren; i++)
564 format_part_text (ctx, sp, mime_node_child (node, i), indent, params);
566 if (GMIME_IS_MESSAGE (node->part))
567 printf ("\fbody}\n");
569 printf ("\f%s}\n", part_type);
571 return NOTMUCH_STATUS_SUCCESS;
575 format_part_json (const void *ctx, sprinter_t *sp, mime_node_t *node,
576 notmuch_bool_t first, notmuch_bool_t output_body)
578 /* Any changes to the JSON format should be reflected in the file
581 if (node->envelope_file) {
583 format_message_json (sp, node->envelope_file);
585 sp->map_key (sp, "headers");
586 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
589 sp->map_key (sp, "body");
591 format_part_json (ctx, sp, mime_node_child (node, 0), first, TRUE);
598 /* The disposition and content-type metadata are associated with
599 * the envelope for message parts */
600 GMimeObject *meta = node->envelope_part ?
601 GMIME_OBJECT (node->envelope_part) : node->part;
602 GMimeContentType *content_type = g_mime_object_get_content_type (meta);
603 const char *cid = g_mime_object_get_content_id (meta);
604 const char *filename = GMIME_IS_PART (node->part) ?
605 g_mime_part_get_filename (GMIME_PART (node->part)) : NULL;
611 sp->map_key (sp, "id");
612 sp->integer (sp, node->part_num);
614 if (node->decrypt_attempted) {
615 sp->map_key (sp, "encstatus");
618 sp->map_key (sp, "status");
619 sp->string (sp, node->decrypt_success ? "good" : "bad");
624 if (node->verify_attempted) {
625 sp->map_key (sp, "sigstatus");
626 format_part_sigstatus_json (sp, node);
629 sp->map_key (sp, "content-type");
630 sp->string (sp, g_mime_content_type_to_string (content_type));
633 sp->map_key (sp, "content-id");
634 sp->string (sp, cid);
638 sp->map_key (sp, "filename");
639 sp->string (sp, filename);
642 if (GMIME_IS_PART (node->part)) {
643 /* For non-HTML text parts, we include the content in the
644 * JSON. Since JSON must be Unicode, we handle charset
645 * decoding here and do not report a charset to the caller.
646 * For text/html parts, we do not include the content. If a
647 * caller is interested in text/html parts, it should retrieve
648 * them separately and they will not be decoded. Since this
649 * makes charset decoding the responsibility on the caller, we
650 * report the charset for text/html parts.
652 if (g_mime_content_type_is_type (content_type, "text", "html")) {
653 const char *content_charset = g_mime_object_get_content_type_parameter (meta, "charset");
655 if (content_charset != NULL) {
656 sp->map_key (sp, "content-charset");
657 sp->string (sp, content_charset);
659 } else if (g_mime_content_type_is_type (content_type, "text", "*")) {
660 GMimeStream *stream_memory = g_mime_stream_mem_new ();
661 GByteArray *part_content;
662 show_text_part_content (node->part, stream_memory, 0);
663 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
664 sp->map_key (sp, "content");
665 sp->string_len (sp, (char *) part_content->data, part_content->len);
666 g_object_unref (stream_memory);
668 } else if (GMIME_IS_MULTIPART (node->part)) {
669 sp->map_key (sp, "content");
672 } else if (GMIME_IS_MESSAGE (node->part)) {
673 sp->map_key (sp, "content");
677 sp->map_key (sp, "headers");
678 format_headers_json (sp, GMIME_MESSAGE (node->part), FALSE);
680 sp->map_key (sp, "body");
685 for (i = 0; i < node->nchildren; i++)
686 format_part_json (ctx, sp, mime_node_child (node, i), i == 0, TRUE);
688 /* Close content structures */
689 for (i = 0; i < nclose; i++)
695 static notmuch_status_t
696 format_part_json_entry (const void *ctx, sprinter_t *sp,
697 mime_node_t *node, unused (int indent),
698 const notmuch_show_params_t *params)
700 format_part_json (ctx, sp, node, TRUE, params->output_body);
702 return NOTMUCH_STATUS_SUCCESS;
705 /* Print a message in "mboxrd" format as documented, for example,
708 * http://qmail.org/qmail-manual-html/man5/mbox.html
710 static notmuch_status_t
711 format_part_mbox (const void *ctx, unused (sprinter_t *sp), mime_node_t *node,
713 unused (const notmuch_show_params_t *params))
715 notmuch_message_t *message = node->envelope_file;
717 const char *filename;
722 struct tm date_gmtime;
723 char date_asctime[26];
730 INTERNAL_ERROR ("format_part_mbox requires a root part");
732 filename = notmuch_message_get_filename (message);
733 file = fopen (filename, "r");
735 fprintf (stderr, "Failed to open %s: %s\n",
736 filename, strerror (errno));
737 return NOTMUCH_STATUS_FILE_ERROR;
740 from = notmuch_message_get_header (message, "from");
741 from = _extract_email_address (ctx, from);
743 date = notmuch_message_get_date (message);
744 gmtime_r (&date, &date_gmtime);
745 asctime_r (&date_gmtime, date_asctime);
747 printf ("From %s %s", from, date_asctime);
749 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
750 if (_is_from_line (line))
759 return NOTMUCH_STATUS_SUCCESS;
762 static notmuch_status_t
763 format_part_raw (unused (const void *ctx), unused (sprinter_t *sp),
764 mime_node_t *node, unused (int indent),
765 unused (const notmuch_show_params_t *params))
767 if (node->envelope_file) {
768 /* Special case the entire message to avoid MIME parsing. */
769 const char *filename;
774 filename = notmuch_message_get_filename (node->envelope_file);
775 if (filename == NULL) {
776 fprintf (stderr, "Error: Cannot get message filename.\n");
777 return NOTMUCH_STATUS_FILE_ERROR;
780 file = fopen (filename, "r");
782 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
783 return NOTMUCH_STATUS_FILE_ERROR;
786 while (!feof (file)) {
787 size = fread (buf, 1, sizeof (buf), file);
789 fprintf (stderr, "Error: Read failed from %s\n", filename);
791 return NOTMUCH_STATUS_FILE_ERROR;
794 if (fwrite (buf, size, 1, stdout) != 1) {
795 fprintf (stderr, "Error: Write failed\n");
797 return NOTMUCH_STATUS_FILE_ERROR;
802 return NOTMUCH_STATUS_SUCCESS;
805 GMimeStream *stream_stdout;
806 GMimeStream *stream_filter = NULL;
808 stream_stdout = g_mime_stream_file_new (stdout);
809 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
811 stream_filter = g_mime_stream_filter_new (stream_stdout);
813 if (GMIME_IS_PART (node->part)) {
814 /* For leaf parts, we emit only the transfer-decoded
816 GMimeDataWrapper *wrapper;
817 wrapper = g_mime_part_get_content_object (GMIME_PART (node->part));
819 if (wrapper && stream_filter)
820 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
822 /* Write out the whole part. For message parts (the root
823 * part and embedded message parts), this will be the
824 * message including its headers (but not the
825 * encapsulating part's headers). For multipart parts,
826 * this will include the headers. */
828 g_mime_object_write_to_stream (node->part, stream_filter);
832 g_object_unref (stream_filter);
835 g_object_unref(stream_stdout);
837 return NOTMUCH_STATUS_SUCCESS;
840 static notmuch_status_t
841 show_message (void *ctx,
842 const notmuch_show_format_t *format,
844 notmuch_message_t *message,
846 notmuch_show_params_t *params)
848 void *local = talloc_new (ctx);
849 mime_node_t *root, *part;
850 notmuch_status_t status;
852 status = mime_node_open (local, message, &(params->crypto), &root);
855 part = mime_node_seek_dfs (root, (params->part < 0 ? 0 : params->part));
857 status = format->part (local, sp, part, indent, params);
863 static notmuch_status_t
864 show_messages (void *ctx,
865 const notmuch_show_format_t *format,
867 notmuch_messages_t *messages,
869 notmuch_show_params_t *params)
871 notmuch_message_t *message;
872 notmuch_bool_t match;
873 notmuch_bool_t excluded;
875 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
880 notmuch_messages_valid (messages);
881 notmuch_messages_move_to_next (messages))
885 message = notmuch_messages_get (messages);
887 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
888 excluded = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_EXCLUDED);
890 next_indent = indent;
892 if ((match && (!excluded || !params->omit_excluded)) || params->entire_thread) {
893 status = show_message (ctx, format, sp, message, indent, params);
896 next_indent = indent + 1;
901 status = show_messages (ctx,
903 notmuch_message_get_replies (message),
909 notmuch_message_destroy (message);
919 /* Formatted output of single message */
921 do_show_single (void *ctx,
922 notmuch_query_t *query,
923 const notmuch_show_format_t *format,
925 notmuch_show_params_t *params)
927 notmuch_messages_t *messages;
928 notmuch_message_t *message;
930 if (notmuch_query_count_messages (query) != 1) {
931 fprintf (stderr, "Error: search term did not match precisely one message.\n");
935 messages = notmuch_query_search_messages (query);
936 message = notmuch_messages_get (messages);
938 if (message == NULL) {
939 fprintf (stderr, "Error: Cannot find matching message.\n");
943 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
945 return show_message (ctx, format, sp, message, 0, params)
946 != NOTMUCH_STATUS_SUCCESS;
949 /* Formatted output of threads */
952 notmuch_query_t *query,
953 const notmuch_show_format_t *format,
955 notmuch_show_params_t *params)
957 notmuch_threads_t *threads;
958 notmuch_thread_t *thread;
959 notmuch_messages_t *messages;
960 notmuch_status_t status, res = NOTMUCH_STATUS_SUCCESS;
964 for (threads = notmuch_query_search_threads (query);
965 notmuch_threads_valid (threads);
966 notmuch_threads_move_to_next (threads))
968 thread = notmuch_threads_get (threads);
970 messages = notmuch_thread_get_toplevel_messages (thread);
972 if (messages == NULL)
973 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
974 notmuch_thread_get_thread_id (thread));
976 status = show_messages (ctx, format, sp, messages, 0, params);
980 notmuch_thread_destroy (thread);
986 return res != NOTMUCH_STATUS_SUCCESS;
990 NOTMUCH_FORMAT_NOT_SPECIFIED,
998 ENTIRE_THREAD_DEFAULT,
1000 ENTIRE_THREAD_FALSE,
1003 /* The following is to allow future options to be added more easily */
1010 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
1012 notmuch_config_t *config;
1013 notmuch_database_t *notmuch;
1014 notmuch_query_t *query;
1017 const notmuch_show_format_t *format = &format_text;
1018 sprinter_t *sprinter;
1019 notmuch_show_params_t params = {
1021 .omit_excluded = TRUE,
1022 .output_body = TRUE,
1028 int format_sel = NOTMUCH_FORMAT_NOT_SPECIFIED;
1029 int exclude = EXCLUDE_TRUE;
1030 int entire_thread = ENTIRE_THREAD_DEFAULT;
1032 notmuch_opt_desc_t options[] = {
1033 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
1034 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
1035 { "text", NOTMUCH_FORMAT_TEXT },
1036 { "mbox", NOTMUCH_FORMAT_MBOX },
1037 { "raw", NOTMUCH_FORMAT_RAW },
1039 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
1040 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
1041 { "false", EXCLUDE_FALSE },
1043 { NOTMUCH_OPT_KEYWORD, &entire_thread, "entire-thread", 't',
1044 (notmuch_keyword_t []){ { "true", ENTIRE_THREAD_TRUE },
1045 { "false", ENTIRE_THREAD_FALSE },
1046 { "", ENTIRE_THREAD_TRUE },
1048 { NOTMUCH_OPT_INT, ¶ms.part, "part", 'p', 0 },
1049 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.decrypt, "decrypt", 'd', 0 },
1050 { NOTMUCH_OPT_BOOLEAN, ¶ms.crypto.verify, "verify", 'v', 0 },
1051 { NOTMUCH_OPT_BOOLEAN, ¶ms.output_body, "body", 'b', 0 },
1055 opt_index = parse_arguments (argc, argv, options, 1);
1056 if (opt_index < 0) {
1057 /* diagnostics already printed */
1061 /* decryption implies verification */
1062 if (params.crypto.decrypt)
1063 params.crypto.verify = TRUE;
1065 if (format_sel == NOTMUCH_FORMAT_NOT_SPECIFIED) {
1066 /* if part was requested and format was not specified, use format=raw */
1067 if (params.part >= 0)
1068 format_sel = NOTMUCH_FORMAT_RAW;
1070 format_sel = NOTMUCH_FORMAT_TEXT;
1073 switch (format_sel) {
1074 case NOTMUCH_FORMAT_JSON:
1075 format = &format_json;
1077 case NOTMUCH_FORMAT_TEXT:
1078 format = &format_text;
1080 case NOTMUCH_FORMAT_MBOX:
1081 if (params.part > 0) {
1082 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
1086 format = &format_mbox;
1088 case NOTMUCH_FORMAT_RAW:
1089 format = &format_raw;
1090 /* If --format=raw specified without specifying part, we can only
1091 * output single message, so set part=0 */
1092 if (params.part < 0)
1098 /* Default is entire-thread = FALSE except for format=json. */
1099 if (entire_thread == ENTIRE_THREAD_DEFAULT) {
1100 if (format == &format_json)
1101 entire_thread = ENTIRE_THREAD_TRUE;
1103 entire_thread = ENTIRE_THREAD_FALSE;
1106 if (!params.output_body) {
1107 if (params.part > 0) {
1108 fprintf (stderr, "Warning: --body=false is incompatible with --part > 0. Disabling.\n");
1109 params.output_body = TRUE;
1111 if (format != &format_json)
1112 fprintf (stderr, "Warning: --body=false only implemented for format=json\n");
1116 if (entire_thread == ENTIRE_THREAD_TRUE)
1117 params.entire_thread = TRUE;
1119 params.entire_thread = FALSE;
1121 config = notmuch_config_open (ctx, NULL, NULL);
1125 query_string = query_string_from_args (ctx, argc-opt_index, argv+opt_index);
1126 if (query_string == NULL) {
1127 fprintf (stderr, "Out of memory\n");
1131 if (*query_string == '\0') {
1132 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
1136 if (notmuch_database_open (notmuch_config_get_database_path (config),
1137 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
1140 query = notmuch_query_create (notmuch, query_string);
1141 if (query == NULL) {
1142 fprintf (stderr, "Out of memory\n");
1146 /* Create structure printer. */
1147 sprinter = format->new_sprinter(ctx, stdout);
1149 /* If a single message is requested we do not use search_excludes. */
1150 if (params.part >= 0)
1151 ret = do_show_single (ctx, query, format, sprinter, ¶ms);
1153 /* We always apply set the exclude flag. The
1154 * exclude=true|false option controls whether or not we return
1155 * threads that only match in an excluded message */
1156 const char **search_exclude_tags;
1157 size_t search_exclude_tags_length;
1160 search_exclude_tags = notmuch_config_get_search_exclude_tags
1161 (config, &search_exclude_tags_length);
1162 for (i = 0; i < search_exclude_tags_length; i++)
1163 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
1165 if (exclude == EXCLUDE_FALSE) {
1166 notmuch_query_set_omit_excluded (query, FALSE);
1167 params.omit_excluded = FALSE;
1170 ret = do_show (ctx, query, format, sprinter, ¶ms);
1173 notmuch_crypto_cleanup (¶ms.crypto);
1174 notmuch_query_destroy (query);
1175 notmuch_database_destroy (notmuch);