lib: Document the metadata stored within the Xapian database.
[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     time_t date;
143     const char *relative_date;
144
145     date = notmuch_message_get_date (message);
146     relative_date = notmuch_time_relative_date (ctx, date);
147
148     printf ("\"id\": %s, \"match\": %s, \"filename\": %s, \"date_unix\": %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);
153
154     for (tags = notmuch_message_get_tags (message);
155          notmuch_tags_valid (tags);
156          notmuch_tags_move_to_next (tags))
157     {
158          printf("%s%s", first ? "" : ",",
159                json_quote_str (ctx_quote, notmuch_tags_get (tags)));
160          first = 0;
161     }
162     printf("]");
163     talloc_free (ctx_quote);
164 }
165
166 static void
167 format_headers_text (const void *ctx, notmuch_message_t *message)
168 {
169     const char *headers[] = {
170         "Subject", "From", "To", "Cc", "Bcc", "Date"
171     };
172     const char *name, *value;
173     unsigned int i;
174
175     printf ("%s\n", _get_one_line_summary (ctx, message));
176
177     for (i = 0; i < ARRAY_SIZE (headers); i++) {
178         name = headers[i];
179         value = notmuch_message_get_header (message, name);
180         if (value && strlen (value))
181             printf ("%s: %s\n", name, value);
182     }
183 }
184
185 static void
186 format_headers_json (const void *ctx, notmuch_message_t *message)
187 {
188     const char *headers[] = {
189         "Subject", "From", "To", "Cc", "Bcc", "Date"
190     };
191     const char *name, *value;
192     unsigned int i;
193     int first_header = 1;
194     void *ctx_quote = talloc_new (ctx);
195
196     for (i = 0; i < ARRAY_SIZE (headers); i++) {
197         name = headers[i];
198         value = notmuch_message_get_header (message, name);
199         if (value)
200         {
201             if (!first_header)
202                 fputs (", ", stdout);
203             first_header = 0;
204
205             printf ("%s: %s",
206                     json_quote_str (ctx_quote, name),
207                     json_quote_str (ctx_quote, value));
208         }
209     }
210
211     talloc_free (ctx_quote);
212 }
213
214 static void
215 show_part_content (GMimeObject *part, GMimeStream *stream_out)
216 {
217     GMimeStream *stream_filter = NULL;
218     GMimeDataWrapper *wrapper;
219     const char *charset;
220
221     charset = g_mime_object_get_content_type_parameter (part, "charset");
222
223     if (stream_out) {
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));
227         if (charset) {
228           g_mime_stream_filter_add(GMIME_STREAM_FILTER(stream_filter),
229                                    g_mime_filter_charset_new(charset, "UTF-8"));
230         }
231     }
232
233     wrapper = g_mime_part_get_content_object (GMIME_PART (part));
234     if (wrapper && stream_filter)
235         g_mime_data_wrapper_write_to_stream (wrapper, stream_filter);
236     if (stream_filter)
237         g_object_unref(stream_filter);
238 }
239
240 static void
241 format_part_text (GMimeObject *part, int *part_count)
242 {
243     GMimeContentDisposition *disposition;
244     GMimeContentType *content_type;
245
246     disposition = g_mime_object_get_content_disposition (part);
247     if (disposition &&
248         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
249     {
250         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
251         content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
252
253         printf ("\fattachment{ ID: %d, Content-type: %s\n",
254                 *part_count,
255                 g_mime_content_type_to_string (content_type));
256         printf ("Attachment: %s (%s)\n", filename,
257                 g_mime_content_type_to_string (content_type));
258
259         if (g_mime_content_type_is_type (content_type, "text", "*") &&
260             !g_mime_content_type_is_type (content_type, "text", "html"))
261         {
262             GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
263             g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
264             show_part_content (part, stream_stdout);
265             g_object_unref(stream_stdout);
266         }
267
268         printf ("\fattachment}\n");
269
270         return;
271     }
272
273     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
274
275     printf ("\fpart{ ID: %d, Content-type: %s\n",
276             *part_count,
277             g_mime_content_type_to_string (content_type));
278
279     if (g_mime_content_type_is_type (content_type, "text", "*") &&
280         !g_mime_content_type_is_type (content_type, "text", "html"))
281     {
282         GMimeStream *stream_stdout = g_mime_stream_file_new (stdout);
283         g_mime_stream_file_set_owner (GMIME_STREAM_FILE (stream_stdout), FALSE);
284         show_part_content (part, stream_stdout);
285         g_object_unref(stream_stdout);
286     }
287     else
288     {
289         printf ("Non-text part: %s\n",
290                 g_mime_content_type_to_string (content_type));
291     }
292
293     printf ("\fpart}\n");
294 }
295
296 static void
297 format_part_json (GMimeObject *part, int *part_count)
298 {
299     GMimeContentType *content_type;
300     GMimeContentDisposition *disposition;
301     void *ctx = talloc_new (NULL);
302     GMimeStream *stream_memory = g_mime_stream_mem_new ();
303     GByteArray *part_content;
304
305     content_type = g_mime_object_get_content_type (GMIME_OBJECT (part));
306
307     if (*part_count > 1)
308         fputs (", ", stdout);
309
310     printf ("{\"id\": %d, \"content-type\": %s",
311             *part_count,
312             json_quote_str (ctx, g_mime_content_type_to_string (content_type)));
313
314     disposition = g_mime_object_get_content_disposition (part);
315     if (disposition &&
316         strcmp (disposition->disposition, GMIME_DISPOSITION_ATTACHMENT) == 0)
317     {
318         const char *filename = g_mime_part_get_filename (GMIME_PART (part));
319
320         printf (", \"filename\": %s", json_quote_str (ctx, filename));
321     }
322
323     if (g_mime_content_type_is_type (content_type, "text", "*") &&
324         !g_mime_content_type_is_type (content_type, "text", "html"))
325     {
326         show_part_content (part, stream_memory);
327         part_content = g_mime_stream_mem_get_byte_array (GMIME_STREAM_MEM (stream_memory));
328
329         printf (", \"content\": %s", json_quote_chararray (ctx, (char *) part_content->data, part_content->len));
330     }
331
332     fputs ("}", stdout);
333
334     talloc_free (ctx);
335     if (stream_memory)
336         g_object_unref (stream_memory);
337 }
338
339 static void
340 show_message (void *ctx, const show_format_t *format, notmuch_message_t *message, int indent)
341 {
342     fputs (format->message_start, stdout);
343     if (format->message)
344         format->message(ctx, message, indent);
345
346     fputs (format->header_start, stdout);
347     if (format->header)
348         format->header(ctx, message);
349     fputs (format->header_end, stdout);
350
351     fputs (format->body_start, stdout);
352     if (format->part)
353         show_message_body (notmuch_message_get_filename (message), format->part);
354     fputs (format->body_end, stdout);
355
356     fputs (format->message_end, stdout);
357 }
358
359
360 static void
361 show_messages (void *ctx, const show_format_t *format, notmuch_messages_t *messages, int indent,
362                notmuch_bool_t entire_thread)
363 {
364     notmuch_message_t *message;
365     notmuch_bool_t match;
366     int first_set = 1;
367     int next_indent;
368
369     fputs (format->message_set_start, stdout);
370
371     for (;
372          notmuch_messages_valid (messages);
373          notmuch_messages_move_to_next (messages))
374     {
375         if (!first_set)
376             fputs (format->message_set_sep, stdout);
377         first_set = 0;
378
379         fputs (format->message_set_start, stdout);
380
381         message = notmuch_messages_get (messages);
382
383         match = notmuch_message_get_flag (message, NOTMUCH_MESSAGE_FLAG_MATCH);
384
385         next_indent = indent;
386
387         if (match || entire_thread) {
388             show_message (ctx, format, message, indent);
389             next_indent = indent + 1;
390
391             fputs (format->message_set_sep, stdout);
392         }
393
394         show_messages (ctx, format, notmuch_message_get_replies (message),
395                        next_indent, entire_thread);
396
397         notmuch_message_destroy (message);
398
399         fputs (format->message_set_end, stdout);
400     }
401
402     fputs (format->message_set_end, stdout);
403 }
404
405 int
406 notmuch_show_command (void *ctx, unused (int argc), unused (char *argv[]))
407 {
408     notmuch_config_t *config;
409     notmuch_database_t *notmuch;
410     notmuch_query_t *query;
411     notmuch_threads_t *threads;
412     notmuch_thread_t *thread;
413     notmuch_messages_t *messages;
414     char *query_string;
415     char *opt;
416     const show_format_t *format = &format_text;
417     int entire_thread = 0;
418     int i;
419     int first_toplevel = 1;
420
421     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
422         if (strcmp (argv[i], "--") == 0) {
423             i++;
424             break;
425         }
426         if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
427             opt = argv[i] + sizeof ("--format=") - 1;
428             if (strcmp (opt, "text") == 0) {
429                 format = &format_text;
430             } else if (strcmp (opt, "json") == 0) {
431                 format = &format_json;
432                 entire_thread = 1;
433             } else {
434                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
435                 return 1;
436             }
437         } else if (STRNCMP_LITERAL (argv[i], "--entire-thread") == 0) {
438             entire_thread = 1;
439         } else {
440             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
441             return 1;
442         }
443     }
444
445     argc -= i;
446     argv += i;
447
448     config = notmuch_config_open (ctx, NULL, NULL);
449     if (config == NULL)
450         return 1;
451
452     query_string = query_string_from_args (ctx, argc, argv);
453     if (query_string == NULL) {
454         fprintf (stderr, "Out of memory\n");
455         return 1;
456     }
457
458     if (*query_string == '\0') {
459         fprintf (stderr, "Error: notmuch show requires at least one search term.\n");
460         return 1;
461     }
462
463     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
464                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
465     if (notmuch == NULL)
466         return 1;
467
468     query = notmuch_query_create (notmuch, query_string);
469     if (query == NULL) {
470         fprintf (stderr, "Out of memory\n");
471         return 1;
472     }
473
474     fputs (format->message_set_start, stdout);
475
476     for (threads = notmuch_query_search_threads (query);
477          notmuch_threads_valid (threads);
478          notmuch_threads_move_to_next (threads))
479     {
480         thread = notmuch_threads_get (threads);
481
482         messages = notmuch_thread_get_toplevel_messages (thread);
483
484         if (messages == NULL)
485             INTERNAL_ERROR ("Thread %s has no toplevel messages.\n",
486                             notmuch_thread_get_thread_id (thread));
487
488         if (!first_toplevel)
489             fputs (format->message_set_sep, stdout);
490         first_toplevel = 0;
491
492         show_messages (ctx, format, messages, 0, entire_thread);
493
494         notmuch_thread_destroy (thread);
495
496     }
497
498     fputs (format->message_set_end, stdout);
499
500     notmuch_query_destroy (query);
501     notmuch_database_close (notmuch);
502
503     return 0;
504 }
505
506 int
507 notmuch_part_command (void *ctx, unused (int argc), unused (char *argv[]))
508 {
509         notmuch_config_t *config;
510         notmuch_database_t *notmuch;
511         notmuch_query_t *query;
512         notmuch_messages_t *messages;
513         notmuch_message_t *message;
514         char *query_string;
515         int i;
516         int part = 0;
517
518         for (i = 0; i < argc && argv[i][0] == '-'; i++) {
519                 if (strcmp (argv[i], "--") == 0) {
520                         i++;
521                         break;
522                 }
523                 if (STRNCMP_LITERAL (argv[i], "--part=") == 0) {
524                         part = atoi(argv[i] + sizeof ("--part=") - 1);
525                 } else {
526                         fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
527                         return 1;
528                 }
529         }
530
531         argc -= i;
532         argv += i;
533
534         config = notmuch_config_open (ctx, NULL, NULL);
535         if (config == NULL)
536                 return 1;
537
538         query_string = query_string_from_args (ctx, argc, argv);
539         if (query_string == NULL) {
540                 fprintf (stderr, "Out of memory\n");
541                 return 1;
542         }
543
544         if (*query_string == '\0') {
545                 fprintf (stderr, "Error: notmuch part requires at least one search term.\n");
546                 return 1;
547         }
548
549         notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
550                                          NOTMUCH_DATABASE_MODE_READ_ONLY);
551         if (notmuch == NULL)
552                 return 1;
553
554         query = notmuch_query_create (notmuch, query_string);
555         if (query == NULL) {
556                 fprintf (stderr, "Out of memory\n");
557                 return 1;
558         }
559
560         if (notmuch_query_count_messages (query) != 1) {
561                 fprintf (stderr, "Error: search term did not match precisely one message.\n");
562                 return 1;
563         }
564
565         messages = notmuch_query_search_messages (query);
566         message = notmuch_messages_get (messages);
567
568         if (message == NULL) {
569                 fprintf (stderr, "Error: cannot find matching message.\n");
570                 return 1;
571         }
572
573         show_one_part (notmuch_message_get_filename (message), part);
574
575         notmuch_query_destroy (query);
576         notmuch_database_close (notmuch);
577
578         return 0;
579 }