notmuch show: Include output for the enclosing multipart part of a MIME mail
[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 void
81 format_message_mbox (const void *ctx,
82                      notmuch_message_t *message,
83                      unused (int indent));
84
85 static const show_format_t format_mbox = {
86     "",
87         "", format_message_mbox,
88             "", NULL, "",
89             "", NULL, "",
90         "", "",
91     ""
92 };
93
94 static const char *
95 _get_tags_as_string (const void *ctx, notmuch_message_t *message)
96 {
97     notmuch_tags_t *tags;
98     int first = 1;
99     const char *tag;
100     char *result;
101
102     result = talloc_strdup (ctx, "");
103     if (result == NULL)
104         return NULL;
105
106     for (tags = notmuch_message_get_tags (message);
107          notmuch_tags_valid (tags);
108          notmuch_tags_move_to_next (tags))
109     {
110         tag = notmuch_tags_get (tags);
111
112         result = talloc_asprintf_append (result, "%s%s",
113                                          first ? "" : " ", tag);
114         first = 0;
115     }
116
117     return result;
118 }
119
120 /* Get a nice, single-line summary of message. */
121 static const char *
122 _get_one_line_summary (const void *ctx, notmuch_message_t *message)
123 {
124     const char *from;
125     time_t date;
126     const char *relative_date;
127     const char *tags;
128
129     from = notmuch_message_get_header (message, "from");
130
131     date = notmuch_message_get_date (message);
132     relative_date = notmuch_time_relative_date (ctx, date);
133
134     tags = _get_tags_as_string (ctx, message);
135
136     return talloc_asprintf (ctx, "%s (%s) (%s)",
137                             from, relative_date, tags);
138 }
139
140 static void
141 format_message_text (unused (const void *ctx), notmuch_message_t *message, int indent)
142 {
143     printf ("id:%s depth:%d match:%d filename:%s\n",
144             notmuch_message_get_message_id (message),
145             indent,
146             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH),
147             notmuch_message_get_filename (message));
148 }
149
150 static void
151 format_message_json (const void *ctx, notmuch_message_t *message, unused (int indent))
152 {
153     notmuch_tags_t *tags;
154     int first = 1;
155     void *ctx_quote = talloc_new (ctx);
156     time_t date;
157     const char *relative_date;
158
159     date = notmuch_message_get_date (message);
160     relative_date = notmuch_time_relative_date (ctx, date);
161
162     printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"timestamp\": %ld, \"date_relative\": \"%s\", \"tags\": [",
163             json_quote_str (ctx_quote, notmuch_message_get_message_id (message)),
164             notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH) ? "true" : "false",
165             json_quote_str (ctx_quote, notmuch_message_get_filename (message)),
166             date, relative_date);
167
168     for (tags = notmuch_message_get_tags (message);
169          notmuch_tags_valid (tags);
170          notmuch_tags_move_to_next (tags))
171     {
172          printf("%s%s", first ? "" : ",",
173                json_quote_str (ctx_quote, notmuch_tags_get (tags)));
174          first = 0;
175     }
176     printf("]");
177     talloc_free (ctx_quote);
178 }
179
180 /* Extract just the email address from the contents of a From:
181  * header. */
182 static const char *
183 _extract_email_address (const void *ctx, const char *from)
184 {
185     InternetAddressList *addresses;
186     InternetAddress *address;
187     InternetAddressMailbox *mailbox;
188     const char *email = "MAILER-DAEMON";
189
190     addresses = internet_address_list_parse_string (from);
191
192     /* Bail if there is no address here. */
193     if (addresses == NULL || internet_address_list_length (addresses) < 1)
194         goto DONE;
195
196     /* Otherwise, just use the first address. */
197     address = internet_address_list_get_address (addresses, 0);
198
199     /* The From header should never contain an address group rather
200      * than a mailbox. So bail if it does. */
201     if (! INTERNET_ADDRESS_IS_MAILBOX (address))
202         goto DONE;
203
204     mailbox = INTERNET_ADDRESS_MAILBOX (address);
205     email = internet_address_mailbox_get_addr (mailbox);
206     email = talloc_strdup (ctx, email);
207
208   DONE:
209     /* XXX: How to free addresses here? */
210     return email;
211    }
212
213 /* Return 1 if 'line' is an mbox From_ line---that is, a line
214  * beginning with zero or more '>' characters followed by the
215  * characters 'F', 'r', 'o', 'm', and space.
216  *
217  * Any characters at all may appear after that in the line.
218  */
219 static int
220 _is_from_line (const char *line)
221 {
222     const char *s = line;
223
224     if (line == NULL)
225         return 0;
226
227     while (*s == '>')
228         s++;
229
230     if (STRNCMP_LITERAL (s, "From ") == 0)
231         return 1;
232     else
233         return 0;
234 }
235
236 /* Print a message in "mboxrd" format as documented, for example,
237  * here:
238  *
239  * http://qmail.org/qmail-manual-html/man5/mbox.html
240  */
241 static void
242 format_message_mbox (const void *ctx,
243                      notmuch_message_t *message,
244                      unused (int indent))
245 {
246     const char *filename;
247     FILE *file;
248     const char *from;
249
250     time_t date;
251     struct tm date_gmtime;
252     char date_asctime[26];
253
254     char *line = NULL;
255     size_t line_size;
256     ssize_t line_len;
257
258     filename = notmuch_message_get_filename (message);
259     file = fopen (filename, "r");
260     if (file == NULL) {
261         fprintf (stderr, "Failed to open %s: %s\n",
262                  filename, strerror (errno));
263         return;
264     }
265
266     from = notmuch_message_get_header (message, "from");
267     from = _extract_email_address (ctx, from);
268
269     date = notmuch_message_get_date (message);
270     gmtime_r (&date, &date_gmtime);
271     asctime_r (&date_gmtime, date_asctime);
272
273     printf ("From %s %s", from, date_asctime);
274
275     while ((line_len = getline (&line, &line_size, file)) != -1 ) {
276         if (_is_from_line (line))
277             putchar ('>');
278         printf ("%s", line);
279     }
280
281     printf ("\n");
282
283     fclose (file);
284 }
285
286 static void
287 format_headers_text (const void *ctx, notmuch_message_t *message)
288 {
289     const char *headers[] = {
290         "Subject", "From", "To", "Cc", "Bcc", "Date"
291     };
292     const char *name, *value;
293     unsigned int i;
294
295     printf ("%s\n", _get_one_line_summary (ctx, message));
296
297     for (i = 0; i < ARRAY_SIZE (headers); i++) {
298         name = headers[i];
299         value = notmuch_message_get_header (message, name);
300         if (value && strlen (value))
301             printf ("%s: %s\n", name, value);
302     }
303 }
304
305 static void
306 format_headers_json (const void *ctx, notmuch_message_t *message)
307 {
308     const char *headers[] = {
309         "Subject", "From", "To", "Cc", "Bcc", "Date"
310     };
311     const char *name, *value;
312     unsigned int i;
313     int first_header = 1;
314     void *ctx_quote = talloc_new (ctx);
315
316     for (i = 0; i < ARRAY_SIZE (headers); i++) {
317         name = headers[i];
318         value = notmuch_message_get_header (message, name);
319         if (value)
320         {
321             if (!first_header)
322                 fputs (", ", stdout);
323             first_header = 0;
324
325             printf ("%s: %s",
326                     json_quote_str (ctx_quote, name),
327                     json_quote_str (ctx_quote, value));
328         }
329     }
330
331     talloc_free (ctx_quote);
332 }
333
334 static void
335 show_part_content (GMimeObject *part, GMimeStream *stream_out)
336 {
337     GMimeStream *stream_filter = NULL;
338     GMimeDataWrapper *wrapper;
339     const char *charset;
340
341     charset = g_mime_object_get_content_type_parameter (part, "charset");
342
343     if (stream_out) {
344         stream_filter = g_mime_stream_filter_new (stream_out);
345         g_mime_stream_filter_add(GMIME_STREAM_FILTER (stream_filter),
346                                  g_mime_filter_crlf_new (FALSE, FALSE));
347         if (charset) {
348             GMimeFilter *charset_filter;
349             charset_filter = g_mime_filter_charset_new (charset, "UTF-8");
350             /* This result can be NULL for things like "unknown-8bit".
351              * Don't set a NULL filter as that makes GMime print
352              * annoying assertion-failure messages on stderr. */
353             if (charset_filter)
354                 g_mime_stream_filter_add (GMIME_STREAM_FILTER (stream_filter),
355                                           charset_filter);
356         }
357     }
358
359     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
360     if (wrapper && stream_filter)
361         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
362     if (stream_filter)
363         g_object_unref(stream_filter);
364 }
365
366 static void
367 format_part_text (GMimeObject *part, int *part_count)
368 {
369     GMimeContentDisposition *disposition;
370     GMimeContentType *content_type;
371
372     disposition = g_mime_object_get_content_disposition (part);
373     if (disposition &&
374         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
375     {
376         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
377         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
378
379         printf ("\fattachment{ ID: %d, Content-type: %s\n",
380                 *part_count,
381                 g_mime_content_type_to_string (content_type));
382         printf ("Attachment: %s (%s)\n", filename,
383                 g_mime_content_type_to_string (content_type));
384
385         if (g_mime_content_type_is_type (content_type, "text", "*") &&
386             !g_mime_content_type_is_type (content_type, "text", "html"))
387         {
388             GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
389             g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
390             show_part_content (part, stream_stdout);
391             g_object_unref(stream_stdout);
392         }
393
394         printf ("\fattachment}\n");
395
396         return;
397     }
398
399     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
400
401     printf ("\fpart{ ID: %d, Content-type: %s\n",
402             *part_count,
403             g_mime_content_type_to_string (content_type));
404
405     if (g_mime_content_type_is_type (content_type, "text", "*") &&
406         !g_mime_content_type_is_type (content_type, "text", "html"))
407     {
408         GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
409         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
410         show_part_content (part, stream_stdout);
411         g_object_unref(stream_stdout);
412     }
413     else if (g_mime_content_type_is_type (content_type, "multipart", "*"))
414     {
415         /* Do nothing for multipart since its content will be printed
416          * when recursing. */
417     }
418     else
419     {
420         printf ("Non-text part: %s\n",
421                 g_mime_content_type_to_string (content_type));
422     }
423
424     printf ("\fpart}\n");
425 }
426
427 static void
428 format_part_json (GMimeObject *part, int *part_count)
429 {
430     GMimeContentType *content_type;
431     GMimeContentDisposition *disposition;
432     void *ctx = talloc_new (NULL);
433     GMimeStream *stream_memory = g_mime_stream_mem_new ();
434     GByteArray *part_content;
435
436     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
437
438     if (*part_count > 1)
439         fputs (", ", stdout);
440
441     printf ("{\"id\": %d, \"content-type\": %s",
442             *part_count,
443             json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
444
445     disposition = g_mime_object_get_content_disposition (part);
446     if (disposition &&
447         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
448     {
449         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
450
451         printf (", \"filename\": %s", json_quote_str (ctx, filename));
452     }
453
454     if (g_mime_content_type_is_type (content_type, "text", "*") &&
455         !g_mime_content_type_is_type (content_type, "text", "html"))
456     {
457         show_part_content (part, stream_memory);
458         part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
459
460         printf (", \"content\": %s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));
461     }
462
463     fputs ("}", stdout);
464
465     talloc_free (ctx);
466     if (stream_memory)
467         g_object_unref (stream_memory);
468 }
469
470 static void
471 show_message (void *ctx, const show_format_t *format, notmuch_message_t *message, int indent)
472 {
473     fputs (format->message_start, stdout);
474     if (format->message)
475         format->message(ctx, message, indent);
476
477     fputs (format->header_start, stdout);
478     if (format->header)
479         format->header(ctx, message);
480     fputs (format->header_end, stdout);
481
482     fputs (format->body_start, stdout);
483     if (format->part)
484         show_message_body (notmuch_message_get_filename (message), format->part);
485     fputs (format->body_end, stdout);
486
487     fputs (format->message_end, stdout);
488 }
489
490
491 static void
492 show_messages (void *ctx, const show_format_t *format, notmuch_messages_t *messages, int indent,
493                notmuch_bool_t entire_thread)
494 {
495     notmuch_message_t *message;
496     notmuch_bool_t match;
497     int first_set = 1;
498     int next_indent;
499
500     fputs (format->message_set_start, stdout);
501
502     for (;
503          notmuch_messages_valid (messages);
504          notmuch_messages_move_to_next (messages))
505     {
506         if (!first_set)
507             fputs (format->message_set_sep, stdout);
508         first_set = 0;
509
510         fputs (format->message_set_start, stdout);
511
512         message = notmuch_messages_get (messages);
513
514         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
515
516         next_indent = indent;
517
518         if (match || entire_thread) {
519             show_message (ctx, format, message, indent);
520             next_indent = indent + 1;
521
522             fputs (format->message_set_sep, stdout);
523         }
524
525         show_messages (ctx, format, notmuch_message_get_replies (message),
526                        next_indent, entire_thread);
527
528         notmuch_message_destroy (message);
529
530         fputs (format->message_set_end, stdout);
531     }
532
533     fputs (format->message_set_end, stdout);
534 }
535
536 /* Support for --format=raw */
537 static int
538 do_show_raw (unused(void *ctx), notmuch_query_t *query)
539 {
540     notmuch_messages_t *messages;
541     notmuch_message_t *message;
542     const char *filename;
543     FILE *file;
544     size_t size;
545     char buf[4096];
546
547     if (notmuch_query_count_messages (query) != 1) {
548         fprintf (stderr, "Error: search term did not match precisely one message.\n");
549         return 1;
550     }
551
552     messages = notmuch_query_search_messages (query);
553     message = notmuch_messages_get (messages);
554
555     if (message == NULL) {
556         fprintf (stderr, "Error: Cannot find matching message.\n");
557         return 1;
558     }
559
560     filename = notmuch_message_get_filename (message);
561     if (filename == NULL) {
562         fprintf (stderr, "Error: Cannot message filename.\n");
563         return 1;
564     }
565
566     file = fopen (filename, "r");
567     if (file == NULL) {
568         fprintf (stderr, "Error: Cannot open file %s: %s\n", filename, strerror (errno));
569         return 1;
570     }
571
572     while (!feof (file)) {
573         size = fread (buf, 1, sizeof (buf), file);
574         fwrite (buf, size, 1, stdout);
575     }
576
577     fclose (file);
578
579     return 0;
580 }
581
582 /* Support for --format=text|json|mbox */
583 static int
584 do_show (void *ctx,
585          notmuch_query_t *query,
586          const show_format_t *format,
587          int entire_thread)
588 {
589     notmuch_threads_t *threads;
590     notmuch_thread_t *thread;
591     notmuch_messages_t *messages;
592     int first_toplevel = 1;
593
594     fputs (format->message_set_start, stdout);
595
596     for (threads = notmuch_query_search_threads (query);
597          notmuch_threads_valid (threads);
598          notmuch_threads_move_to_next (threads))
599     {
600         thread = notmuch_threads_get (threads);
601
602         messages = notmuch_thread_get_toplevel_messages (thread);
603
604         if (messages == NULL)
605             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
606                             notmuch_thread_get_thread_id (thread));
607
608         if (!first_toplevel)
609             fputs (format->message_set_sep, stdout);
610         first_toplevel = 0;
611
612         show_messages (ctx, format, messages, 0, entire_thread);
613
614         notmuch_thread_destroy (thread);
615
616     }
617
618     fputs (format->message_set_end, stdout);
619
620     return 0;
621 }
622
623 int
624 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
625 {
626     notmuch_config_t *config;
627     notmuch_database_t *notmuch;
628     notmuch_query_t *query;
629     char *query_string;
630     char *opt;
631     const show_format_t *format = &format_text;
632     int entire_thread = 0;
633     int i;
634     int raw = 0;
635
636     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
637         if (strcmp (argv[i], "--") == 0) {
638             i++;
639             break;
640         }
641         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
642             opt = argv[i] + sizeof ("--format=") - 1;
643             if (strcmp (opt, "text") == 0) {
644                 format = &format_text;
645             } else if (strcmp (opt, "json") == 0) {
646                 format = &format_json;
647                 entire_thread = 1;
648             } else if (strcmp (opt, "mbox") == 0) {
649                 format = &format_mbox;
650             } else if (strcmp (opt, "raw") == 0) {
651                 raw = 1;
652             } else {
653                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
654                 return 1;
655             }
656         } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
657             entire_thread = 1;
658         } else {
659             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
660             return 1;
661         }
662     }
663
664     argc -= i;
665     argv += i;
666
667     config = notmuch_config_open (ctx, NULL, NULL);
668     if (config == NULL)
669         return 1;
670
671     query_string = query_string_from_args (ctx, argc, argv);
672     if (query_string == NULL) {
673         fprintf (stderr, "Out of memory\n");
674         return 1;
675     }
676
677     if (*query_string == '\0') {
678         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
679         return 1;
680     }
681
682     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
683                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
684     if (notmuch == NULL)
685         return 1;
686
687     query = notmuch_query_create (notmuch, query_string);
688     if (query == NULL) {
689         fprintf (stderr, "Out of memory\n");
690         return 1;
691     }
692
693     if (raw)
694         return do_show_raw (ctx, query);
695     else
696         return do_show (ctx, query, format, entire_thread);
697
698     notmuch_query_destroy (query);
699     notmuch_database_close (notmuch);
700
701     return 0;
702 }
703
704 int
705 notmuch_part_command (void *ctx, unused (int argc), unused (char *argv[]))
706 {
707         notmuch_config_t *config;
708         notmuch_database_t *notmuch;
709         notmuch_query_t *query;
710         notmuch_messages_t *messages;
711         notmuch_message_t *message;
712         char *query_string;
713         int i;
714         int part = 0;
715
716         for (i = 0; i < argc && argv[i][0] == '-'; i++) {
717                 if (strcmp (argv[i], "--") == 0) {
718                         i++;
719                         break;
720                 }
721                 if (STRNCMP_LITERAL (argv[i], "--part=") == 0) {
722                         part = atoi(argv[i] + sizeof ("--part=") - 1);
723                 } else {
724                         fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
725                         return 1;
726                 }
727         }
728
729         argc -= i;
730         argv += i;
731
732         config = notmuch_config_open (ctx, NULL, NULL);
733         if (config == NULL)
734                 return 1;
735
736         query_string = query_string_from_args (ctx, argc, argv);
737         if (query_string == NULL) {
738                 fprintf (stderr, "Out of memory\n");
739                 return 1;
740         }
741
742         if (*query_string == '\0') {
743                 fprintf (stderr, "Error: notmuch part requires at least one search term.\n");
744                 return 1;
745         }
746
747         notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
748                                          NOTMUCH_DATABASE_MODE_READ_ONLY);
749         if (notmuch == NULL)
750                 return 1;
751
752         query = notmuch_query_create (notmuch, query_string);
753         if (query == NULL) {
754                 fprintf (stderr, "Out of memory\n");
755                 return 1;
756         }
757
758         if (notmuch_query_count_messages (query) != 1) {
759                 fprintf (stderr, "Error: search term did not match precisely one message.\n");
760                 return 1;
761         }
762
763         messages = notmuch_query_search_messages (query);
764         message = notmuch_messages_get (messages);
765
766         if (message == NULL) {
767                 fprintf (stderr, "Error: cannot find matching message.\n");
768                 return 1;
769         }
770
771         show_one_part (notmuch_message_get_filename (message), part);
772
773         notmuch_query_destroy (query);
774         notmuch_database_close (notmuch);
775
776         return 0;
777 }