Setup the GMimeStream only when needed
[notmuch] / notmuch-show.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
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/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #include "notmuch-client.h"
22
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,
28                      int indent);
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,
35                   int *part_count);
36     const char *body_end;
37     const char *message_end;
38     const char *message_set_sep;
39     const char *message_set_end;
40 } show_format_t;
41
42 static void
43 format_message_text (unused (const void *ctx),
44                      notmuch_message_t *message,
45                      int indent);
46 static void
47 format_headers_text (const void *ctx,
48                      notmuch_message_t *message);
49 static void
50 format_part_text (GMimeObject *part,
51                   int *part_count);
52 static const show_format_t format_text = {
53     "",
54         "\fmessage{ ", format_message_text,
55             "\fheader{\n", format_headers_text, "\fheader}\n",
56             "\fbody{\n", format_part_text, "\fbody}\n",
57         "\fmessage}\n", "",
58     ""
59 };
60
61 static void
62 format_message_json (const void *ctx,
63                      notmuch_message_t *message,
64                      unused (int indent));
65 static void
66 format_headers_json (const void *ctx,
67                      notmuch_message_t *message);
68 static void
69 format_part_json (GMimeObject *part,
70                   int *part_count);
71 static const show_format_t format_json = {
72     "[",
73         "{", format_message_json,
74             ", \"headers\": {", format_headers_json, "}",
75             ", \"body\": [", format_part_json, "]",
76         "}", ", ",
77     "]"
78 };
79
80 static const char *
81 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
82 {
83     notmuch_tags_t *tags;
84     int first = 1;
85     const char *tag;
86     char *result;
87
88     result = talloc_strdup (ctx, "");
89     if (result == NULL)
90         return NULL;
91
92     for (tags = notmuch_message_get_tags (message);
93          notmuch_tags_valid (tags);
94          notmuch_tags_move_to_next (tags))
95     {
96         tag = notmuch_tags_get (tags);
97
98         result = talloc_asprintf_append (result, "%s%s",
99                                          first ? "" : " ", tag);
100         first = 0;
101     }
102
103     return result;
104 }
105
106 /* Get a nice, single-line summary of message. */
107 static const char *
108 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
109 {
110     const char *from;
111     time_t date;
112     const char *relative_date;
113     const char *tags;
114
115     from = notmuch_message_get_header (message, "from");
116
117     date = notmuch_message_get_date (message);
118     relative_date = notmuch_time_relative_date (ctx, date);
119
120     tags = _get_tags_as_string (ctx, message);
121
122     return talloc_asprintf (ctx, "%s (%s) (%s)",
123                             from, relative_date, tags);
124 }
125
126 static void
127 format_message_text (unused (const void *ctx), notmuch_message_t *message, int indent)
128 {
129     printf ("id:%s depth:%d match:%d filename:%s\n",
130             notmuch_message_get_message_id (message),
131             indent,
132             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
133             notmuch_message_get_filename (message));
134 }
135
136 static void
137 format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
138 {
139     notmuch_tags_t *tags;
140     int first = 1;
141     void *ctx_quote = talloc_new (ctx);
142
143     printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"tags\": [",
144             json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
145             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
146             json_quote_str (ctx_quote, notmuch_message_get_filename (message)));
147
148     for (tags = notmuch_message_get_tags (message);
149          notmuch_tags_valid (tags);
150          notmuch_tags_move_to_next (tags))
151     {
152          printf("%s%s", first ? "" : ",",
153                json_quote_str (ctx_quote, notmuch_tags_get (tags)));
154          first = 0;
155     }
156     printf("]");
157     talloc_free (ctx_quote);
158 }
159
160 static void
161 format_headers_text (const void *ctx, notmuch_message_t *message)
162 {
163     const char *headers[] = {
164         "Subject", "From", "To", "Cc", "Bcc", "Date"
165     };
166     const char *name, *value;
167     unsigned int i;
168
169     printf ("%s\n", _get_one_line_summary (ctx, message));
170
171     for (i = 0; i < ARRAY_SIZE (headers); i++) {
172         name = headers[i];
173         value = notmuch_message_get_header (message, name);
174         if (value && strlen (value))
175             printf ("%s: %s\n", name, value);
176     }
177 }
178
179 static void
180 format_headers_json (const void *ctx, notmuch_message_t *message)
181 {
182     const char *headers[] = {
183         "Subject", "From", "To", "Cc", "Bcc", "Date"
184     };
185     const char *name, *value;
186     unsigned int i;
187     int first_header = 1;
188     void *ctx_quote = talloc_new (ctx);
189
190     for (i = 0; i < ARRAY_SIZE (headers); i++) {
191         name = headers[i];
192         value = notmuch_message_get_header (message, name);
193         if (value)
194         {
195             if (!first_header)
196                 fputs (", ", stdout);
197             first_header = 0;
198
199             printf ("%s: %s",
200                     json_quote_str (ctx_quote, name),
201                     json_quote_str (ctx_quote, value));
202         }
203     }
204
205     talloc_free (ctx_quote);
206 }
207
208 static void
209 show_part_content (GMimeObject *part, GMimeStream *stream_out)
210 {
211     GMimeStream *stream_filter = NULL;
212     GMimeDataWrapper *wrapper;
213     const char *charset;
214
215     charset = g_mime_object_get_content_type_parameter (part, "charset");
216
217     if (stream_out) {
218         stream_filter = g_mime_stream_filter_new(stream_out);
219         g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
220                                  g_mime_filter_crlf_new(FALSE, FALSE));
221         if (charset) {
222           g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
223                                    g_mime_filter_charset_new(charset, "UTF-8"));
224         }
225     }
226
227     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
228     if (wrapper && stream_filter)
229         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
230     if (stream_filter)
231         g_object_unref(stream_filter);
232 }
233
234 static void
235 format_part_text (GMimeObject *part, int *part_count)
236 {
237     GMimeContentDisposition *disposition;
238     GMimeContentType *content_type;
239
240     disposition = g_mime_object_get_content_disposition (part);
241     if (disposition &&
242         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
243     {
244         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
245         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
246
247         printf ("\fattachment{ ID: %d, Content-type: %s\n",
248                 *part_count,
249                 g_mime_content_type_to_string (content_type));
250         printf ("Attachment: %s (%s)\n", filename,
251                 g_mime_content_type_to_string (content_type));
252
253         if (g_mime_content_type_is_type (content_type, "text", "*") &&
254             !g_mime_content_type_is_type (content_type, "text", "html"))
255         {
256             GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
257             g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
258             show_part_content (part, stream_stdout);
259             g_object_unref(stream_stdout);
260         }
261
262         printf ("\fattachment}\n");
263
264         return;
265     }
266
267     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
268
269     printf ("\fpart{ ID: %d, Content-type: %s\n",
270             *part_count,
271             g_mime_content_type_to_string (content_type));
272
273     if (g_mime_content_type_is_type (content_type, "text", "*") &&
274         !g_mime_content_type_is_type (content_type, "text", "html"))
275     {
276         GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
277         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
278         show_part_content (part, stream_stdout);
279         g_object_unref(stream_stdout);
280     }
281     else
282     {
283         printf ("Non-text part: %s\n",
284                 g_mime_content_type_to_string (content_type));
285     }
286
287     printf ("\fpart}\n");
288 }
289
290 static void
291 format_part_json (GMimeObject *part, int *part_count)
292 {
293     GMimeContentType *content_type;
294     GMimeContentDisposition *disposition;
295     void *ctx = talloc_new (NULL);
296     GMimeStream *stream_memory = g_mime_stream_mem_new ();
297     GByteArray *part_content;
298
299     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
300
301     if (*part_count > 1)
302         fputs (", ", stdout);
303
304     printf ("{\"id\": %d, \"content-type\": %s",
305             *part_count,
306             json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
307
308     disposition = g_mime_object_get_content_disposition (part);
309     if (disposition &&
310         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
311     {
312         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
313
314         printf (", \"filename\": %s", json_quote_str (ctx, filename));
315     }
316
317     if (g_mime_content_type_is_type (content_type, "text", "*") &&
318         !g_mime_content_type_is_type (content_type, "text", "html"))
319     {
320         show_part_content (part, stream_memory);
321         part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
322
323         printf (", \"content\": %s", json_quote_str (ctx, (char *) part_content->data));
324     }
325
326     fputs ("}", stdout);
327
328     talloc_free (ctx);
329     if (stream_memory)
330         g_object_unref (stream_memory);
331 }
332
333 static void
334 show_message (void *ctx, const show_format_t *format, notmuch_message_t *message, int indent)
335 {
336     fputs (format->message_start, stdout);
337     if (format->message)
338         format->message(ctx, message, indent);
339
340     fputs (format->header_start, stdout);
341     if (format->header)
342         format->header(ctx, message);
343     fputs (format->header_end, stdout);
344
345     fputs (format->body_start, stdout);
346     if (format->part)
347         show_message_body (notmuch_message_get_filename (message), format->part);
348     fputs (format->body_end, stdout);
349
350     fputs (format->message_end, stdout);
351 }
352
353
354 static void
355 show_messages (void *ctx, const show_format_t *format, notmuch_messages_t *messages, int indent,
356                notmuch_bool_t entire_thread)
357 {
358     notmuch_message_t *message;
359     notmuch_bool_t match;
360     int first_set = 1;
361     int next_indent;
362
363     fputs (format->message_set_start, stdout);
364
365     for (;
366          notmuch_messages_valid (messages);
367          notmuch_messages_move_to_next (messages))
368     {
369         if (!first_set)
370             fputs (format->message_set_sep, stdout);
371         first_set = 0;
372
373         fputs (format->message_set_start, stdout);
374
375         message = notmuch_messages_get (messages);
376
377         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
378
379         next_indent = indent;
380
381         if (match || entire_thread) {
382             show_message (ctx, format, message, indent);
383             next_indent = indent + 1;
384
385             fputs (format->message_set_sep, stdout);
386         }
387
388         show_messages (ctx, format, notmuch_message_get_replies (message),
389                        next_indent, entire_thread);
390
391         notmuch_message_destroy (message);
392
393         fputs (format->message_set_end, stdout);
394     }
395
396     fputs (format->message_set_end, stdout);
397 }
398
399 int
400 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
401 {
402     notmuch_config_t *config;
403     notmuch_database_t *notmuch;
404     notmuch_query_t *query;
405     notmuch_threads_t *threads;
406     notmuch_thread_t *thread;
407     notmuch_messages_t *messages;
408     char *query_string;
409     char *opt;
410     const show_format_t *format = &format_text;
411     int entire_thread = 0;
412     int i;
413     int first_toplevel = 1;
414
415     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
416         if (strcmp (argv[i], "--") == 0) {
417             i++;
418             break;
419         }
420         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
421             opt = argv[i] + sizeof ("--format=") - 1;
422             if (strcmp (opt, "text") == 0) {
423                 format = &format_text;
424             } else if (strcmp (opt, "json") == 0) {
425                 format = &format_json;
426                 entire_thread = 1;
427             } else {
428                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
429                 return 1;
430             }
431         } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
432             entire_thread = 1;
433         } else {
434             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
435             return 1;
436         }
437     }
438
439     argc -= i;
440     argv += i;
441
442     config = notmuch_config_open (ctx, NULL, NULL);
443     if (config == NULL)
444         return 1;
445
446     query_string = query_string_from_args (ctx, argc, argv);
447     if (query_string == NULL) {
448         fprintf (stderr, "Out of memory\n");
449         return 1;
450     }
451
452     if (*query_string == '\0') {
453         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
454         return 1;
455     }
456
457     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
458                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
459     if (notmuch == NULL)
460         return 1;
461
462     query = notmuch_query_create (notmuch, query_string);
463     if (query == NULL) {
464         fprintf (stderr, "Out of memory\n");
465         return 1;
466     }
467
468     fputs (format->message_set_start, stdout);
469
470     for (threads = notmuch_query_search_threads (query);
471          notmuch_threads_valid (threads);
472          notmuch_threads_move_to_next (threads))
473     {
474         thread = notmuch_threads_get (threads);
475
476         messages = notmuch_thread_get_toplevel_messages (thread);
477
478         if (messages == NULL)
479             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
480                             notmuch_thread_get_thread_id (thread));
481
482         if (!first_toplevel)
483             fputs (format->message_set_sep, stdout);
484         first_toplevel = 0;
485
486         show_messages (ctx, format, messages, 0, entire_thread);
487
488         notmuch_thread_destroy (thread);
489
490     }
491
492     fputs (format->message_set_end, stdout);
493
494     notmuch_query_destroy (query);
495     notmuch_database_close (notmuch);
496
497     return 0;
498 }