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"
24 format_message_text (unused (const void *ctx),
25 notmuch_message_t *message,
28 format_headers_text (const void *ctx,
29 notmuch_message_t *message);
32 format_part_start_text (GMimeObject *part,
36 format_part_content_text (GMimeObject *part);
39 format_part_end_text (GMimeObject *part);
41 static const notmuch_show_format_t format_text = {
43 "\fmessage{ ", format_message_text,
44 "\fheader{\n", format_headers_text, "\fheader}\n",
46 format_part_start_text,
49 format_part_content_text,
58 format_message_json (const void *ctx,
59 notmuch_message_t *message,
62 format_headers_json (const void *ctx,
63 notmuch_message_t *message);
66 format_part_start_json (unused (GMimeObject *part),
70 format_part_encstatus_json (int status);
73 format_part_sigstatus_json (const GMimeSignatureValidity* validity);
76 format_part_content_json (GMimeObject *part);
79 format_part_end_json (GMimeObject *part);
81 static const notmuch_show_format_t format_json = {
83 "{", format_message_json,
84 ", \"headers\": {", format_headers_json, "}",
86 format_part_start_json,
87 format_part_encstatus_json,
88 format_part_sigstatus_json,
89 format_part_content_json,
98 format_message_mbox (const void *ctx,
99 notmuch_message_t *message,
100 unused (int indent));
102 static const notmuch_show_format_t format_mbox = {
104 "", format_message_mbox,
119 format_part_content_raw (GMimeObject *part);
121 static const notmuch_show_format_t format_raw = {
129 format_part_content_raw,
138 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
140 notmuch_tags_t *tags;
145 result = talloc_strdup (ctx, "");
149 for (tags = notmuch_message_get_tags (message);
150 notmuch_tags_valid (tags);
151 notmuch_tags_move_to_next (tags))
153 tag = notmuch_tags_get (tags);
155 result = talloc_asprintf_append (result, "%s%s",
156 first ? "" : " ", tag);
163 /* Get a nice, single-line summary of message. */
165 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
169 const char *relative_date;
172 from = notmuch_message_get_header (message, "from");
174 date = notmuch_message_get_date (message);
175 relative_date = notmuch_time_relative_date (ctx, date);
177 tags = _get_tags_as_string (ctx, message);
179 return talloc_asprintf (ctx, "%s (%s) (%s)",
180 from, relative_date, tags);
184 format_message_text (unused (const void *ctx), notmuch_message_t *message, int indent)
186 printf ("id:%s depth:%d match:%d filename:%s\n",
187 notmuch_message_get_message_id (message),
189 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
190 notmuch_message_get_filename (message));
194 format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
196 notmuch_tags_t *tags;
198 void *ctx_quote = talloc_new (ctx);
200 const char *relative_date;
202 date = notmuch_message_get_date (message);
203 relative_date = notmuch_time_relative_date (ctx, date);
205 printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
206 json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
207 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
208 json_quote_str (ctx_quote, notmuch_message_get_filename (message)),
209 date, relative_date);
211 for (tags = notmuch_message_get_tags (message);
212 notmuch_tags_valid (tags);
213 notmuch_tags_move_to_next (tags))
215 printf("%s%s", first ? "" : ",",
216 json_quote_str (ctx_quote, notmuch_tags_get (tags)));
220 talloc_free (ctx_quote);
223 /* Extract just the email address from the contents of a From:
226 _extract_email_address (const void *ctx, const char *from)
228 InternetAddressList *addresses;
229 InternetAddress *address;
230 InternetAddressMailbox *mailbox;
231 const char *email = "MAILER-DAEMON";
233 addresses = internet_address_list_parse_string (from);
235 /* Bail if there is no address here. */
236 if (addresses == NULL || internet_address_list_length (addresses) < 1)
239 /* Otherwise, just use the first address. */
240 address = internet_address_list_get_address (addresses, 0);
242 /* The From header should never contain an address group rather
243 * than a mailbox. So bail if it does. */
244 if (! INTERNET_ADDRESS_IS_MAILBOX (address))
247 mailbox = INTERNET_ADDRESS_MAILBOX (address);
248 email = internet_address_mailbox_get_addr (mailbox);
249 email = talloc_strdup (ctx, email);
252 /* XXX: How to free addresses here? */
256 /* Return 1 if 'line' is an mbox From_ line---that is, a line
257 * beginning with zero or more '>' characters followed by the
258 * characters 'F', 'r', 'o', 'm', and space.
260 * Any characters at all may appear after that in the line.
263 _is_from_line (const char *line)
265 const char *s = line;
273 if (STRNCMP_LITERAL (s, "From ") == 0)
279 /* Print a message in "mboxrd" format as documented, for example,
282 * http://qmail.org/qmail-manual-html/man5/mbox.html
285 format_message_mbox (const void *ctx,
286 notmuch_message_t *message,
289 const char *filename;
294 struct tm date_gmtime;
295 char date_asctime[26];
301 filename = notmuch_message_get_filename (message);
302 file = fopen (filename, "r");
304 fprintf (stderr, "Failed to open %s: %s\n",
305 filename, strerror (errno));
309 from = notmuch_message_get_header (message, "from");
310 from = _extract_email_address (ctx, from);
312 date = notmuch_message_get_date (message);
313 gmtime_r (&date, &date_gmtime);
314 asctime_r (&date_gmtime, date_asctime);
316 printf ("From %s %s", from, date_asctime);
318 while ((line_len = getline (&line, &line_size, file)) != -1 ) {
319 if (_is_from_line (line))
330 format_headers_text (const void *ctx, notmuch_message_t *message)
332 const char *headers[] = {
333 "Subject", "From", "To", "Cc", "Bcc", "Date"
335 const char *name, *value;
338 printf ("%s\n", _get_one_line_summary (ctx, message));
340 for (i = 0; i < ARRAY_SIZE (headers); i++) {
342 value = notmuch_message_get_header (message, name);
343 if (value && strlen (value))
344 printf ("%s: %s\n", name, value);
349 format_headers_json (const void *ctx, notmuch_message_t *message)
351 const char *headers[] = {
352 "Subject", "From", "To", "Cc", "Bcc", "Date"
354 const char *name, *value;
356 int first_header = 1;
357 void *ctx_quote = talloc_new (ctx);
359 for (i = 0; i < ARRAY_SIZE (headers); i++) {
361 value = notmuch_message_get_header (message, name);
365 fputs (", ", stdout);
369 json_quote_str (ctx_quote, name),
370 json_quote_str (ctx_quote, value));
374 talloc_free (ctx_quote);
377 /* Write a MIME text part out to the given stream.
379 * Both line-ending conversion (CRLF->LF) and charset conversion ( ->
380 * UTF-8) will be performed, so it is inappropriate to call this
381 * function with a non-text part. Doing so will trigger an internal
385 show_text_part_content (GMimeObject *part, GMimeStream *stream_out)
387 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
388 GMimeStream *stream_filter = NULL;
389 GMimeDataWrapper *wrapper;
392 if (! g_mime_content_type_is_type (content_type, "text", "*"))
393 INTERNAL_ERROR ("Illegal request to format non-text part (%s) as text.",
394 g_mime_content_type_to_string (content_type));
396 charset = g_mime_object_get_content_type_parameter (part, "charset");
399 stream_filter = g_mime_stream_filter_new (stream_out);
400 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
401 g_mime_filter_crlf_new (FALSE, FALSE));
403 GMimeFilter *charset_filter;
404 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
405 /* This result can be NULL for things like "unknown-8bit".
406 * Don't set a NULL filter as that makes GMime print
407 * annoying assertion-failure messages on stderr. */
409 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
414 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
415 if (wrapper && stream_filter)
416 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
418 g_object_unref(stream_filter);
422 signerstatustostring (GMimeSignerStatus x)
425 case GMIME_SIGNER_STATUS_NONE:
427 case GMIME_SIGNER_STATUS_GOOD:
429 case GMIME_SIGNER_STATUS_BAD:
431 case GMIME_SIGNER_STATUS_ERROR:
438 format_part_start_text (GMimeObject *part, int *part_count)
440 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (part);
443 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
445 printf ("\fattachment{ ID: %d", *part_count);
449 printf ("\fpart{ ID: %d", *part_count);
454 format_part_content_text (GMimeObject *part)
456 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (part);
457 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
458 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
460 printf (", Content-type: %s\n", g_mime_content_type_to_string (content_type));
463 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
465 const char *filename = g_mime_part_get_filename (GMIME_PART (part));
466 printf ("Attachment: %s (%s)\n", filename,
467 g_mime_content_type_to_string (content_type));
470 if (g_mime_content_type_is_type (content_type, "text", "*") &&
471 !g_mime_content_type_is_type (content_type, "text", "html"))
473 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
474 show_text_part_content (part, stream_stdout);
475 g_object_unref(stream_stdout);
477 else if (g_mime_content_type_is_type (content_type, "multipart", "*") ||
478 g_mime_content_type_is_type (content_type, "message", "rfc822"))
480 /* Do nothing for multipart since its content will be printed
485 printf ("Non-text part: %s\n",
486 g_mime_content_type_to_string (content_type));
491 format_part_end_text (GMimeObject *part)
493 GMimeContentDisposition *disposition;
495 disposition = g_mime_object_get_content_disposition (part);
497 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
499 printf ("\fattachment}\n");
503 printf ("\fpart}\n");
508 format_part_start_json (unused (GMimeObject *part), int *part_count)
510 printf ("{\"id\": %d", *part_count);
514 format_part_encstatus_json (int status)
516 printf (", \"encstatus\": [{\"status\": ");
526 format_part_sigstatus_json (const GMimeSignatureValidity* validity)
528 printf (", \"sigstatus\": [");
535 const GMimeSigner *signer = g_mime_signature_validity_get_signers (validity);
537 void *ctx_quote = talloc_new (NULL);
548 printf ("\"status\": %s", json_quote_str (ctx_quote, signerstatustostring(signer->status)));
550 if (signer->status == GMIME_SIGNER_STATUS_GOOD)
552 if (signer->fingerprint)
553 printf (", \"fingerprint\": %s", json_quote_str (ctx_quote, signer->fingerprint));
554 /* these dates are seconds since the epoch; should we
555 * provide a more human-readable format string? */
557 printf (", \"created\": %d", (int) signer->created);
559 printf (", \"expires\": %d", (int) signer->expires);
560 /* output user id only if validity is FULL or ULTIMATE. */
561 /* note that gmime is using the term "trust" here, which
562 * is WRONG. It's actually user id "validity". */
563 if ((signer->name) && (signer->trust)) {
564 if ((signer->trust == GMIME_SIGNER_TRUST_FULLY) || (signer->trust == GMIME_SIGNER_TRUST_ULTIMATE))
565 printf (", \"userid\": %s", json_quote_str (ctx_quote, signer->name));
569 printf (", \"keyid\": %s", json_quote_str (ctx_quote, signer->keyid));
571 if (signer->errors != GMIME_SIGNER_ERROR_NONE) {
572 printf (", \"errors\": %x", signer->errors);
576 signer = signer->next;
581 talloc_free (ctx_quote);
585 format_part_content_json (GMimeObject *part)
587 GMimeContentType *content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
588 GMimeStream *stream_memory = g_mime_stream_mem_new ();
589 const char *cid = g_mime_object_get_content_id (part);
590 void *ctx = talloc_new (NULL);
591 GMimeContentDisposition *disposition = g_mime_object_get_content_disposition (part);
592 GByteArray *part_content;
594 printf (", \"content-type\": %s",
595 json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
598 printf(", \"content-id\": %s", json_quote_str (ctx, cid));
601 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
603 const char *filename = g_mime_part_get_filename (GMIME_PART (part));
605 printf (", \"filename\": %s", json_quote_str (ctx, filename));
608 if (g_mime_content_type_is_type (content_type, "text", "*") &&
609 !g_mime_content_type_is_type (content_type, "text", "html"))
611 show_text_part_content (part, stream_memory);
612 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
614 printf (", \"content\": %s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));
616 else if (g_mime_content_type_is_type (content_type, "multipart", "*") ||
617 g_mime_content_type_is_type (content_type, "message", "rfc822"))
619 printf (", \"content\": [");
624 g_object_unref (stream_memory);
628 format_part_end_json (GMimeObject *part)
630 GMimeContentType *content_type;
632 content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
634 if (g_mime_content_type_is_type (content_type, "multipart", "*") ||
635 g_mime_content_type_is_type (content_type, "message", "rfc822"))
642 format_part_content_raw (GMimeObject *part)
644 GMimeStream *stream_stdout;
645 GMimeStream *stream_filter = NULL;
646 GMimeDataWrapper *wrapper;
648 stream_stdout = g_mime_stream_file_new (stdout);
649 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
651 stream_filter = g_mime_stream_filter_new (stream_stdout);
653 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
655 if (wrapper && stream_filter)
656 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
659 g_object_unref (stream_filter);
662 g_object_unref(stream_stdout);
666 show_message (void *ctx,
667 const notmuch_show_format_t *format,
668 notmuch_message_t *message,
670 notmuch_show_params_t *params)
672 if (params->part <= 0) {
673 fputs (format->message_start, stdout);
675 format->message(ctx, message, indent);
677 fputs (format->header_start, stdout);
679 format->header(ctx, message);
680 fputs (format->header_end, stdout);
682 fputs (format->body_start, stdout);
685 if (format->part_content)
686 show_message_body (notmuch_message_get_filename (message),
689 if (params->part <= 0) {
690 fputs (format->body_end, stdout);
692 fputs (format->message_end, stdout);
697 show_messages (void *ctx,
698 const notmuch_show_format_t *format,
699 notmuch_messages_t *messages,
701 notmuch_show_params_t *params)
703 notmuch_message_t *message;
704 notmuch_bool_t match;
708 fputs (format->message_set_start, stdout);
711 notmuch_messages_valid (messages);
712 notmuch_messages_move_to_next (messages))
715 fputs (format->message_set_sep, stdout);
718 fputs (format->message_set_start, stdout);
720 message = notmuch_messages_get (messages);
722 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
724 next_indent = indent;
726 if (match || params->entire_thread) {
727 show_message (ctx, format, message, indent, params);
728 next_indent = indent + 1;
730 fputs (format->message_set_sep, stdout);
735 notmuch_message_get_replies (message),
739 notmuch_message_destroy (message);
741 fputs (format->message_set_end, stdout);
744 fputs (format->message_set_end, stdout);
747 /* Formatted output of single message */
749 do_show_single (void *ctx,
750 notmuch_query_t *query,
751 const notmuch_show_format_t *format,
752 notmuch_show_params_t *params)
754 notmuch_messages_t *messages;
755 notmuch_message_t *message;
757 if (notmuch_query_count_messages (query) != 1) {
758 fprintf (stderr, "Error: search term did not match precisely one message.\n");
762 messages = notmuch_query_search_messages (query);
763 message = notmuch_messages_get (messages);
765 if (message == NULL) {
766 fprintf (stderr, "Error: Cannot find matching message.\n");
770 notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH, 1);
772 /* Special case for --format=raw of full single message, just cat out file */
773 if (params->raw && 0 == params->part) {
775 const char *filename;
780 filename = notmuch_message_get_filename (message);
781 if (filename == NULL) {
782 fprintf (stderr, "Error: Cannot message filename.\n");
786 file = fopen (filename, "r");
788 fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
792 while (!feof (file)) {
793 size = fread (buf, 1, sizeof (buf), file);
794 fwrite (buf, size, 1, stdout);
801 show_message (ctx, format, message, 0, params);
808 /* Formatted output of threads */
811 notmuch_query_t *query,
812 const notmuch_show_format_t *format,
813 notmuch_show_params_t *params)
815 notmuch_threads_t *threads;
816 notmuch_thread_t *thread;
817 notmuch_messages_t *messages;
818 int first_toplevel = 1;
820 fputs (format->message_set_start, stdout);
822 for (threads = notmuch_query_search_threads (query);
823 notmuch_threads_valid (threads);
824 notmuch_threads_move_to_next (threads))
826 thread = notmuch_threads_get (threads);
828 messages = notmuch_thread_get_toplevel_messages (thread);
830 if (messages == NULL)
831 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
832 notmuch_thread_get_thread_id (thread));
835 fputs (format->message_set_sep, stdout);
838 show_messages (ctx, format, messages, 0, params);
840 notmuch_thread_destroy (thread);
844 fputs (format->message_set_end, stdout);
850 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
852 notmuch_config_t *config;
853 notmuch_database_t *notmuch;
854 notmuch_query_t *query;
857 const notmuch_show_format_t *format = &format_text;
858 notmuch_show_params_t params;
860 int format_specified = 0;
863 params.entire_thread = 0;
866 params.cryptoctx = NULL;
869 for (i = 0; i < argc && argv[i][0] == '-'; i++) {
870 if (strcmp (argv[i], "--") == 0) {
874 if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
875 opt = argv[i] + sizeof ("--format=") - 1;
876 if (strcmp (opt, "text") == 0) {
877 format = &format_text;
878 } else if (strcmp (opt, "json") == 0) {
879 format = &format_json;
880 params.entire_thread = 1;
881 } else if (strcmp (opt, "mbox") == 0) {
882 format = &format_mbox;
884 } else if (strcmp (opt, "raw") == 0) {
885 format = &format_raw;
888 fprintf (stderr, "Invalid value for --format: %s\n", opt);
891 format_specified = 1;
892 } else if (STRNCMP_LITERAL (argv[i], "--part=") == 0) {
893 params.part = atoi(argv[i] + sizeof ("--part=") - 1);
894 } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
895 params.entire_thread = 1;
896 } else if ((STRNCMP_LITERAL (argv[i], "--verify") == 0) ||
897 (STRNCMP_LITERAL (argv[i], "--decrypt") == 0)) {
898 if (params.cryptoctx == NULL) {
899 GMimeSession* session = g_object_new(notmuch_gmime_session_get_type(), NULL);
900 if (NULL == (params.cryptoctx = g_mime_gpg_context_new(session, "gpg")))
901 fprintf (stderr, "Failed to construct gpg context.\n");
903 g_mime_gpg_context_set_always_trust((GMimeGpgContext*)params.cryptoctx, FALSE);
904 g_object_unref (session);
907 if (STRNCMP_LITERAL (argv[i], "--decrypt") == 0)
910 fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
918 config = notmuch_config_open (ctx, NULL, NULL);
922 query_string = query_string_from_args (ctx, argc, argv);
923 if (query_string == NULL) {
924 fprintf (stderr, "Out of memory\n");
928 if (mbox && params.part > 0) {
929 fprintf (stderr, "Error: specifying parts is incompatible with mbox output format.\n");
933 if (*query_string == '\0') {
934 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
938 notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
939 NOTMUCH_DATABASE_MODE_READ_ONLY);
943 query = notmuch_query_create (notmuch, query_string);
945 fprintf (stderr, "Out of memory\n");
949 /* if part was requested and format was not specified, use format=raw */
950 if (params.part >= 0 && !format_specified)
951 format = &format_raw;
953 /* If --format=raw specified without specifying part, we can only
954 * output single message, so set part=0 */
955 if (params.raw && params.part < 0)
958 if (params.part >= 0)
959 return do_show_single (ctx, query, format, ¶ms);
961 return do_show (ctx, query, format, ¶ms);
963 notmuch_query_destroy (query);
964 notmuch_database_close (notmuch);
966 if (params.cryptoctx)
967 g_object_unref(params.cryptoctx);