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"
23 typedef struct show_format {
24 const char *message_set_start;
25 const char *message_start;
26 void (*message) (const void *ctx,
27 notmuch_message_t *message,
29 const char *header_start;
30 void (*header) (const void *ctx,
31 notmuch_message_t *message);
32 const char *header_end;
33 const char *body_start;
34 void (*part) (GMimeObject *part,
37 const char *message_end;
38 const char *message_set_sep;
39 const char *message_set_end;
43 format_message_text (unused (const void *ctx),
44 notmuch_message_t *message,
47 format_headers_text (const void *ctx,
48 notmuch_message_t *message);
50 format_part_text (GMimeObject *part,
52 static const show_format_t format_text = {
54 "\fmessage{ ", format_message_text,
55 "\fheader{\n", format_headers_text, "\fheader}\n",
56 "\fbody{\n", format_part_text, "\fbody}\n",
62 format_message_json (const void *ctx,
63 notmuch_message_t *message,
66 format_headers_json (const void *ctx,
67 notmuch_message_t *message);
69 format_part_json (GMimeObject *part,
71 static const show_format_t format_json = {
73 "{", format_message_json,
74 ", \"headers\": {", format_headers_json, "}",
75 ", \"body\": [", format_part_json, "]",
81 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
88 result = talloc_strdup (ctx, "");
92 for (tags = notmuch_message_get_tags (message);
93 notmuch_tags_valid (tags);
94 notmuch_tags_move_to_next (tags))
96 tag = notmuch_tags_get (tags);
98 result = talloc_asprintf_append (result, "%s%s",
99 first ? "" : " ", tag);
106 /* Get a nice, single-line summary of message. */
108 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
112 const char *relative_date;
115 from = notmuch_message_get_header (message, "from");
117 date = notmuch_message_get_date (message);
118 relative_date = notmuch_time_relative_date (ctx, date);
120 tags = _get_tags_as_string (ctx, message);
122 return talloc_asprintf (ctx, "%s (%s) (%s)",
123 from, relative_date, tags);
127 format_message_text (unused (const void *ctx), notmuch_message_t *message, int indent)
129 printf ("id:%s depth:%d match:%d filename:%s\n",
130 notmuch_message_get_message_id (message),
132 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
133 notmuch_message_get_filename (message));
137 format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
139 notmuch_tags_t *tags;
141 void *ctx_quote = talloc_new (ctx);
143 const char *relative_date;
145 date = notmuch_message_get_date (message);
146 relative_date = notmuch_time_relative_date (ctx, date);
148 printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
149 json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
150 notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
151 json_quote_str (ctx_quote, notmuch_message_get_filename (message)),
152 date, relative_date);
154 for (tags = notmuch_message_get_tags (message);
155 notmuch_tags_valid (tags);
156 notmuch_tags_move_to_next (tags))
158 printf("%s%s", first ? "" : ",",
159 json_quote_str (ctx_quote, notmuch_tags_get (tags)));
163 talloc_free (ctx_quote);
167 format_headers_text (const void *ctx, notmuch_message_t *message)
169 const char *headers[] = {
170 "Subject", "From", "To", "Cc", "Bcc", "Date"
172 const char *name, *value;
175 printf ("%s\n", _get_one_line_summary (ctx, message));
177 for (i = 0; i < ARRAY_SIZE (headers); i++) {
179 value = notmuch_message_get_header (message, name);
180 if (value && strlen (value))
181 printf ("%s: %s\n", name, value);
186 format_headers_json (const void *ctx, notmuch_message_t *message)
188 const char *headers[] = {
189 "Subject", "From", "To", "Cc", "Bcc", "Date"
191 const char *name, *value;
193 int first_header = 1;
194 void *ctx_quote = talloc_new (ctx);
196 for (i = 0; i < ARRAY_SIZE (headers); i++) {
198 value = notmuch_message_get_header (message, name);
202 fputs (", ", stdout);
206 json_quote_str (ctx_quote, name),
207 json_quote_str (ctx_quote, value));
211 talloc_free (ctx_quote);
215 show_part_content (GMimeObject *part, GMimeStream *stream_out)
217 GMimeStream *stream_filter = NULL;
218 GMimeDataWrapper *wrapper;
221 charset = g_mime_object_get_content_type_parameter (part, "charset");
224 stream_filter = g_mime_stream_filter_new (stream_out);
225 g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
226 g_mime_filter_crlf_new (FALSE, FALSE));
228 GMimeFilter *charset_filter;
229 charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
230 /* This result can be NULL for things like "unknown-8bit".
231 * Don't set a NULL filter as that makes GMime print
232 * annoying assertion-failure messages on stderr. */
234 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
239 wrapper = g_mime_part_get_content_object (GMIME_PART (part));
240 if (wrapper && stream_filter)
241 g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
243 g_object_unref(stream_filter);
247 format_part_text (GMimeObject *part, int *part_count)
249 GMimeContentDisposition *disposition;
250 GMimeContentType *content_type;
252 disposition = g_mime_object_get_content_disposition (part);
254 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
256 const char *filename = g_mime_part_get_filename (GMIME_PART (part));
257 content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
259 printf ("\fattachment{ ID: %d, Content-type: %s\n",
261 g_mime_content_type_to_string (content_type));
262 printf ("Attachment: %s (%s)\n", filename,
263 g_mime_content_type_to_string (content_type));
265 if (g_mime_content_type_is_type (content_type, "text", "*") &&
266 !g_mime_content_type_is_type (content_type, "text", "html"))
268 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
269 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
270 show_part_content (part, stream_stdout);
271 g_object_unref(stream_stdout);
274 printf ("\fattachment}\n");
279 content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
281 printf ("\fpart{ ID: %d, Content-type: %s\n",
283 g_mime_content_type_to_string (content_type));
285 if (g_mime_content_type_is_type (content_type, "text", "*") &&
286 !g_mime_content_type_is_type (content_type, "text", "html"))
288 GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
289 g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
290 show_part_content (part, stream_stdout);
291 g_object_unref(stream_stdout);
295 printf ("Non-text part: %s\n",
296 g_mime_content_type_to_string (content_type));
299 printf ("\fpart}\n");
303 format_part_json (GMimeObject *part, int *part_count)
305 GMimeContentType *content_type;
306 GMimeContentDisposition *disposition;
307 void *ctx = talloc_new (NULL);
308 GMimeStream *stream_memory = g_mime_stream_mem_new ();
309 GByteArray *part_content;
311 content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
314 fputs (", ", stdout);
316 printf ("{\"id\": %d, \"content-type\": %s",
318 json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
320 disposition = g_mime_object_get_content_disposition (part);
322 strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
324 const char *filename = g_mime_part_get_filename (GMIME_PART (part));
326 printf (", \"filename\": %s", json_quote_str (ctx, filename));
329 if (g_mime_content_type_is_type (content_type, "text", "*") &&
330 !g_mime_content_type_is_type (content_type, "text", "html"))
332 show_part_content (part, stream_memory);
333 part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
335 printf (", \"content\": %s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));
342 g_object_unref (stream_memory);
346 show_message (void *ctx, const show_format_t *format, notmuch_message_t *message, int indent)
348 fputs (format->message_start, stdout);
350 format->message(ctx, message, indent);
352 fputs (format->header_start, stdout);
354 format->header(ctx, message);
355 fputs (format->header_end, stdout);
357 fputs (format->body_start, stdout);
359 show_message_body (notmuch_message_get_filename (message), format->part);
360 fputs (format->body_end, stdout);
362 fputs (format->message_end, stdout);
367 show_messages (void *ctx, const show_format_t *format, notmuch_messages_t *messages, int indent,
368 notmuch_bool_t entire_thread)
370 notmuch_message_t *message;
371 notmuch_bool_t match;
375 fputs (format->message_set_start, stdout);
378 notmuch_messages_valid (messages);
379 notmuch_messages_move_to_next (messages))
382 fputs (format->message_set_sep, stdout);
385 fputs (format->message_set_start, stdout);
387 message = notmuch_messages_get (messages);
389 match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
391 next_indent = indent;
393 if (match || entire_thread) {
394 show_message (ctx, format, message, indent);
395 next_indent = indent + 1;
397 fputs (format->message_set_sep, stdout);
400 show_messages (ctx, format, notmuch_message_get_replies (message),
401 next_indent, entire_thread);
403 notmuch_message_destroy (message);
405 fputs (format->message_set_end, stdout);
408 fputs (format->message_set_end, stdout);
412 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
414 notmuch_config_t *config;
415 notmuch_database_t *notmuch;
416 notmuch_query_t *query;
417 notmuch_threads_t *threads;
418 notmuch_thread_t *thread;
419 notmuch_messages_t *messages;
422 const show_format_t *format = &format_text;
423 int entire_thread = 0;
425 int first_toplevel = 1;
427 for (i = 0; i < argc && argv[i][0] == '-'; i++) {
428 if (strcmp (argv[i], "--") == 0) {
432 if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
433 opt = argv[i] + sizeof ("--format=") - 1;
434 if (strcmp (opt, "text") == 0) {
435 format = &format_text;
436 } else if (strcmp (opt, "json") == 0) {
437 format = &format_json;
440 fprintf (stderr, "Invalid value for --format: %s\n", opt);
443 } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
446 fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
454 config = notmuch_config_open (ctx, NULL, NULL);
458 query_string = query_string_from_args (ctx, argc, argv);
459 if (query_string == NULL) {
460 fprintf (stderr, "Out of memory\n");
464 if (*query_string == '\0') {
465 fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
469 notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
470 NOTMUCH_DATABASE_MODE_READ_ONLY);
474 query = notmuch_query_create (notmuch, query_string);
476 fprintf (stderr, "Out of memory\n");
480 fputs (format->message_set_start, stdout);
482 for (threads = notmuch_query_search_threads (query);
483 notmuch_threads_valid (threads);
484 notmuch_threads_move_to_next (threads))
486 thread = notmuch_threads_get (threads);
488 messages = notmuch_thread_get_toplevel_messages (thread);
490 if (messages == NULL)
491 INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
492 notmuch_thread_get_thread_id (thread));
495 fputs (format->message_set_sep, stdout);
498 show_messages (ctx, format, messages, 0, entire_thread);
500 notmuch_thread_destroy (thread);
504 fputs (format->message_set_end, stdout);
506 notmuch_query_destroy (query);
507 notmuch_database_close (notmuch);
513 notmuch_part_command (void *ctx, unused (int argc), unused (char *argv[]))
515 notmuch_config_t *config;
516 notmuch_database_t *notmuch;
517 notmuch_query_t *query;
518 notmuch_messages_t *messages;
519 notmuch_message_t *message;
524 for (i = 0; i < argc && argv[i][0] == '-'; i++) {
525 if (strcmp (argv[i], "--") == 0) {
529 if (STRNCMP_LITERAL (argv[i], "--part=") == 0) {
530 part = atoi(argv[i] + sizeof ("--part=") - 1);
532 fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
540 config = notmuch_config_open (ctx, NULL, NULL);
544 query_string = query_string_from_args (ctx, argc, argv);
545 if (query_string == NULL) {
546 fprintf (stderr, "Out of memory\n");
550 if (*query_string == '\0') {
551 fprintf (stderr, "Error: notmuch part requires at least one search term.\n");
555 notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
556 NOTMUCH_DATABASE_MODE_READ_ONLY);
560 query = notmuch_query_create (notmuch, query_string);
562 fprintf (stderr, "Out of memory\n");
566 if (notmuch_query_count_messages (query) != 1) {
567 fprintf (stderr, "Error: search term did not match precisely one message.\n");
571 messages = notmuch_query_search_messages (query);
572 message = notmuch_messages_get (messages);
574 if (message == NULL) {
575 fprintf (stderr, "Error: cannot find matching message.\n");
579 show_one_part (notmuch_message_get_filename (message), part);
581 notmuch_query_destroy (query);
582 notmuch_database_close (notmuch);