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