69af6171b3461f9528460676c308749dad0e1ca3
[notmuch] / notmuch-search.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 enum {
24     OUTPUT_SUMMARY,
25     OUTPUT_THREADS,
26     OUTPUT_MESSAGES,
27     OUTPUT_FILES,
28     OUTPUT_TAGS
29 } output_t;
30
31 typedef struct search_format {
32     const char *results_start;
33     const char *item_start;
34     void (*item_id) (const void *ctx,
35                      const char *item_type,
36                      const char *item_id);
37     void (*thread_summary) (const void *ctx,
38                             const char *thread_id,
39                             const time_t date,
40                             const int matched,
41                             const int total,
42                             const char *authors,
43                             const char *subject);
44     const char *tag_start;
45     const char *tag;
46     const char *tag_sep;
47     const char *tag_end;
48     const char *item_sep;
49     const char *item_end;
50     const char *results_end;
51     const char *results_null;
52 } search_format_t;
53
54 static void
55 format_item_id_text (const void *ctx,
56                      const char *item_type,
57                      const char *item_id);
58
59 static void
60 format_thread_text (const void *ctx,
61                     const char *thread_id,
62                     const time_t date,
63                     const int matched,
64                     const int total,
65                     const char *authors,
66                     const char *subject);
67 static const search_format_t format_text = {
68     "",
69         "",
70             format_item_id_text,
71             format_thread_text,
72             " (",
73                 "%s", " ",
74             ")", "\n",
75         "",
76     "\n",
77     "",
78 };
79
80 static void
81 format_item_id_json (const void *ctx,
82                      const char *item_type,
83                      const char *item_id);
84
85 static void
86 format_thread_json (const void *ctx,
87                     const char *thread_id,
88                     const time_t date,
89                     const int matched,
90                     const int total,
91                     const char *authors,
92                     const char *subject);
93 static const search_format_t format_json = {
94     "[",
95         "{",
96             format_item_id_json,
97             format_thread_json,
98             "\"tags\": [",
99                 "\"%s\"", ", ",
100             "]", ",\n",
101         "}",
102     "]\n",
103     "]\n",
104 };
105
106 static void
107 format_item_id_text (unused (const void *ctx),
108                      const char *item_type,
109                      const char *item_id)
110 {
111     printf ("%s%s", item_type, item_id);
112 }
113
114 static void
115 format_thread_text (const void *ctx,
116                     const char *thread_id,
117                     const time_t date,
118                     const int matched,
119                     const int total,
120                     const char *authors,
121                     const char *subject)
122 {
123     printf ("thread:%s %12s [%d/%d] %s; %s",
124             thread_id,
125             notmuch_time_relative_date (ctx, date),
126             matched,
127             total,
128             authors,
129             subject);
130 }
131
132 static void
133 format_item_id_json (const void *ctx,
134                      unused (const char *item_type),
135                      const char *item_id)
136 {
137     void *ctx_quote = talloc_new (ctx);
138
139     printf ("%s", json_quote_str (ctx_quote, item_id));
140
141     talloc_free (ctx_quote);
142     
143 }
144
145 static void
146 format_thread_json (const void *ctx,
147                     const char *thread_id,
148                     const time_t date,
149                     const int matched,
150                     const int total,
151                     const char *authors,
152                     const char *subject)
153 {
154     void *ctx_quote = talloc_new (ctx);
155
156     printf ("\"thread\": %s,\n"
157             "\"timestamp\": %ld,\n"
158             "\"matched\": %d,\n"
159             "\"total\": %d,\n"
160             "\"authors\": %s,\n"
161             "\"subject\": %s,\n",
162             json_quote_str (ctx_quote, thread_id),
163             date,
164             matched,
165             total,
166             json_quote_str (ctx_quote, authors),
167             json_quote_str (ctx_quote, subject));
168
169     talloc_free (ctx_quote);
170 }
171
172 static int
173 do_search_threads (const search_format_t *format,
174                    notmuch_query_t *query,
175                    notmuch_sort_t sort,
176                    output_t output)
177 {
178     notmuch_thread_t *thread;
179     notmuch_threads_t *threads;
180     notmuch_tags_t *tags;
181     time_t date;
182     int first_thread = 1;
183
184     threads = notmuch_query_search_threads (query);
185     if (threads == NULL)
186         return 1;
187
188     fputs (format->results_start, stdout);
189
190     for (;
191          notmuch_threads_valid (threads);
192          notmuch_threads_move_to_next (threads))
193     {
194         int first_tag = 1;
195
196         if (! first_thread)
197             fputs (format->item_sep, stdout);
198
199         thread = notmuch_threads_get (threads);
200
201         if (output == OUTPUT_THREADS) {
202             format->item_id (thread, "thread:",
203                              notmuch_thread_get_thread_id (thread));
204         } else { /* output == OUTPUT_SUMMARY */
205             fputs (format->item_start, stdout);
206
207             if (sort == NOTMUCH_SORT_OLDEST_FIRST)
208                 date = notmuch_thread_get_oldest_date (thread);
209             else
210                 date = notmuch_thread_get_newest_date (thread);
211
212             format->thread_summary (thread,
213                                     notmuch_thread_get_thread_id (thread),
214                                     date,
215                                     notmuch_thread_get_matched_messages (thread),
216                                     notmuch_thread_get_total_messages (thread),
217                                     notmuch_thread_get_authors (thread),
218                                     notmuch_thread_get_subject (thread));
219
220             fputs (format->tag_start, stdout);
221
222             for (tags = notmuch_thread_get_tags (thread);
223                  notmuch_tags_valid (tags);
224                  notmuch_tags_move_to_next (tags))
225             {
226                 if (! first_tag)
227                     fputs (format->tag_sep, stdout);
228                 printf (format->tag, notmuch_tags_get (tags));
229                 first_tag = 0;
230             }
231
232             fputs (format->tag_end, stdout);
233
234             fputs (format->item_end, stdout);
235         }
236
237         first_thread = 0;
238
239         notmuch_thread_destroy (thread);
240     }
241
242     if (first_thread)
243         fputs (format->results_null, stdout);
244     else
245         fputs (format->results_end, stdout);
246
247     return 0;
248 }
249
250 static int
251 do_search_messages (const search_format_t *format,
252                     notmuch_query_t *query,
253                     output_t output)
254 {
255     notmuch_message_t *message;
256     notmuch_messages_t *messages;
257     int first_message = 1;
258
259     messages = notmuch_query_search_messages (query);
260     if (messages == NULL)
261         return 1;
262
263     fputs (format->results_start, stdout);
264
265     for (;
266          notmuch_messages_valid (messages);
267          notmuch_messages_move_to_next (messages))
268     {
269         message = notmuch_messages_get (messages);
270
271         if (! first_message)
272             fputs (format->item_sep, stdout);
273
274         if (output == OUTPUT_FILES) {
275             format->item_id (message, "",
276                              notmuch_message_get_filename (message));
277         } else { /* output == OUTPUT_MESSAGES */
278             format->item_id (message, "id:",
279                              notmuch_message_get_message_id (message));
280         }
281
282         first_message = 0;
283
284         notmuch_message_destroy (message);
285     }
286
287     notmuch_messages_destroy (messages);
288
289     if (first_message)
290         fputs (format->results_null, stdout);
291     else
292         fputs (format->results_end, stdout);
293
294     return 0;
295 }
296
297 static int
298 do_search_tags (notmuch_database_t *notmuch,
299                 const search_format_t *format,
300                 notmuch_query_t *query)
301 {
302     notmuch_messages_t *messages = NULL;
303     notmuch_tags_t *tags;
304     const char *tag;
305     int first_tag = 1;
306
307     /* Special-case query of "*" for better performance. */
308     if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
309         tags = notmuch_database_get_all_tags (notmuch);
310     } else {
311         messages = notmuch_query_search_messages (query);
312         if (messages == NULL)
313             return 1;
314
315         tags = notmuch_messages_collect_tags (messages);
316     }
317     if (tags == NULL)
318         return 1;
319
320     fputs (format->results_start, stdout);
321
322     for (;
323          notmuch_tags_valid (tags);
324          notmuch_tags_move_to_next (tags))
325     {
326         tag = notmuch_tags_get (tags);
327
328         if (! first_tag)
329             fputs (format->item_sep, stdout);
330
331         format->item_id (tags, "", tag);
332
333         first_tag = 0;
334     }
335
336     notmuch_tags_destroy (tags);
337
338     if (messages)
339         notmuch_messages_destroy (messages);
340
341     if (first_tag)
342         fputs (format->results_null, stdout);
343     else
344         fputs (format->results_end, stdout);
345
346     return 0;
347 }
348
349 int
350 notmuch_search_command (void *ctx, int argc, char *argv[])
351 {
352     notmuch_config_t *config;
353     notmuch_database_t *notmuch;
354     notmuch_query_t *query;
355     char *query_str;
356     char *opt;
357     notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
358     const search_format_t *format = &format_text;
359     int i, ret;
360     output_t output = OUTPUT_SUMMARY;
361
362     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
363         if (strcmp (argv[i], "--") == 0) {
364             i++;
365             break;
366         }
367         if (STRNCMP_LITERAL (argv[i], "--sort=") == 0) {
368             opt = argv[i] + sizeof ("--sort=") - 1;
369             if (strcmp (opt, "oldest-first") == 0) {
370                 sort = NOTMUCH_SORT_OLDEST_FIRST;
371             } else if (strcmp (opt, "newest-first") == 0) {
372                 sort = NOTMUCH_SORT_NEWEST_FIRST;
373             } else {
374                 fprintf (stderr, "Invalid value for --sort: %s\n", opt);
375                 return 1;
376             }
377         } else if (STRNCMP_LITERAL (argv[i], "--format=") == 0) {
378             opt = argv[i] + sizeof ("--format=") - 1;
379             if (strcmp (opt, "text") == 0) {
380                 format = &format_text;
381             } else if (strcmp (opt, "json") == 0) {
382                 format = &format_json;
383             } else {
384                 fprintf (stderr, "Invalid value for --format: %s\n", opt);
385                 return 1;
386             }
387         } else if (STRNCMP_LITERAL (argv[i], "--output=") == 0) {
388             opt = argv[i] + sizeof ("--output=") - 1;
389             if (strcmp (opt, "summary") == 0) {
390                 output = OUTPUT_SUMMARY;
391             } else if (strcmp (opt, "threads") == 0) {
392                 output = OUTPUT_THREADS;
393             } else if (strcmp (opt, "messages") == 0) {
394                 output = OUTPUT_MESSAGES;
395             } else if (strcmp (opt, "files") == 0) {
396                 output = OUTPUT_FILES;
397             } else if (strcmp (opt, "tags") == 0) {
398                 output = OUTPUT_TAGS;
399             } else {
400                 fprintf (stderr, "Invalid value for --output: %s\n", opt);
401                 return 1;
402             }
403         } else {
404             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
405             return 1;
406         }
407     }
408
409     argc -= i;
410     argv += i;
411
412     config = notmuch_config_open (ctx, NULL, NULL);
413     if (config == NULL)
414         return 1;
415
416     notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
417                                      NOTMUCH_DATABASE_MODE_READ_ONLY);
418     if (notmuch == NULL)
419         return 1;
420
421     query_str = query_string_from_args (notmuch, argc, argv);
422     if (query_str == NULL) {
423         fprintf (stderr, "Out of memory.\n");
424         return 1;
425     }
426     if (*query_str == '\0') {
427         fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
428         return 1;
429     }
430
431     query = notmuch_query_create (notmuch, query_str);
432     if (query == NULL) {
433         fprintf (stderr, "Out of memory\n");
434         return 1;
435     }
436
437     notmuch_query_set_sort (query, sort);
438
439     switch (output) {
440     default:
441     case OUTPUT_SUMMARY:
442     case OUTPUT_THREADS:
443         ret = do_search_threads (format, query, sort, output);
444         break;
445     case OUTPUT_MESSAGES:
446     case OUTPUT_FILES:
447         ret = do_search_messages (format, query, output);
448         break;
449     case OUTPUT_TAGS:
450         ret = do_search_tags (notmuch, format, query);
451         break;
452     }
453
454     notmuch_query_destroy (query);
455     notmuch_database_close (notmuch);
456
457     return ret;
458 }