1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
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,
37 void (*thread_summary) (const void *ctx,
38 const char *thread_id,
44 const char *tag_start;
50 const char *results_end;
51 const char *results_null;
55 format_item_id_text (const void *ctx,
56 const char *item_type,
60 format_thread_text (const void *ctx,
61 const char *thread_id,
67 static const search_format_t format_text = {
81 format_item_id_json (const void *ctx,
82 const char *item_type,
86 format_thread_json (const void *ctx,
87 const char *thread_id,
93 static const search_format_t format_json = {
107 format_item_id_text (unused (const void *ctx),
108 const char *item_type,
111 printf ("%s%s", item_type, item_id);
115 sanitize_string (const void *ctx, const char *str)
122 loop = out = talloc_strdup (ctx, str);
124 for (; *loop; loop++) {
125 if ((unsigned char)(*loop) < 32)
132 format_thread_text (const void *ctx,
133 const char *thread_id,
140 void *ctx_quote = talloc_new (ctx);
142 printf ("thread:%s %12s [%d/%d] %s; %s",
144 notmuch_time_relative_date (ctx, date),
147 sanitize_string (ctx_quote, authors),
148 sanitize_string (ctx_quote, subject));
150 talloc_free (ctx_quote);
154 format_item_id_json (const void *ctx,
155 unused (const char *item_type),
158 void *ctx_quote = talloc_new (ctx);
160 printf ("%s", json_quote_str (ctx_quote, item_id));
162 talloc_free (ctx_quote);
167 format_thread_json (const void *ctx,
168 const char *thread_id,
175 void *ctx_quote = talloc_new (ctx);
177 printf ("\"thread\": %s,\n"
178 "\"timestamp\": %ld,\n"
179 "\"date_relative\": \"%s\",\n"
183 "\"subject\": %s,\n",
184 json_quote_str (ctx_quote, thread_id),
186 notmuch_time_relative_date (ctx, date),
189 json_quote_str (ctx_quote, authors),
190 json_quote_str (ctx_quote, subject));
192 talloc_free (ctx_quote);
196 do_search_threads (const search_format_t *format,
197 notmuch_query_t *query,
203 notmuch_thread_t *thread;
204 notmuch_threads_t *threads;
205 notmuch_tags_t *tags;
207 int first_thread = 1;
211 offset += notmuch_query_count_threads (query);
216 threads = notmuch_query_search_threads (query);
220 fputs (format->results_start, stdout);
223 notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
224 notmuch_threads_move_to_next (threads), i++)
228 thread = notmuch_threads_get (threads);
231 notmuch_thread_destroy (thread);
236 fputs (format->item_sep, stdout);
238 if (output == OUTPUT_THREADS) {
239 format->item_id (thread, "thread:",
240 notmuch_thread_get_thread_id (thread));
241 } else { /* output == OUTPUT_SUMMARY */
242 fputs (format->item_start, stdout);
244 if (sort == NOTMUCH_SORT_OLDEST_FIRST)
245 date = notmuch_thread_get_oldest_date (thread);
247 date = notmuch_thread_get_newest_date (thread);
249 format->thread_summary (thread,
250 notmuch_thread_get_thread_id (thread),
252 notmuch_thread_get_matched_messages (thread),
253 notmuch_thread_get_total_messages (thread),
254 notmuch_thread_get_authors (thread),
255 notmuch_thread_get_subject (thread));
257 fputs (format->tag_start, stdout);
259 for (tags = notmuch_thread_get_tags (thread);
260 notmuch_tags_valid (tags);
261 notmuch_tags_move_to_next (tags))
264 fputs (format->tag_sep, stdout);
265 printf (format->tag, notmuch_tags_get (tags));
269 fputs (format->tag_end, stdout);
271 fputs (format->item_end, stdout);
276 notmuch_thread_destroy (thread);
280 fputs (format->results_null, stdout);
282 fputs (format->results_end, stdout);
288 do_search_messages (const search_format_t *format,
289 notmuch_query_t *query,
294 notmuch_message_t *message;
295 notmuch_messages_t *messages;
296 notmuch_filenames_t *filenames;
297 int first_message = 1;
301 offset += notmuch_query_count_messages (query);
306 messages = notmuch_query_search_messages (query);
307 if (messages == NULL)
310 fputs (format->results_start, stdout);
313 notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
314 notmuch_messages_move_to_next (messages), i++)
319 message = notmuch_messages_get (messages);
321 if (output == OUTPUT_FILES) {
322 filenames = notmuch_message_get_filenames (message);
325 notmuch_filenames_valid (filenames);
326 notmuch_filenames_move_to_next (filenames))
329 fputs (format->item_sep, stdout);
331 format->item_id (message, "",
332 notmuch_filenames_get (filenames));
337 notmuch_filenames_destroy( filenames );
339 } else { /* output == OUTPUT_MESSAGES */
341 fputs (format->item_sep, stdout);
343 format->item_id (message, "id:",
344 notmuch_message_get_message_id (message));
348 notmuch_message_destroy (message);
351 notmuch_messages_destroy (messages);
354 fputs (format->results_null, stdout);
356 fputs (format->results_end, stdout);
362 do_search_tags (notmuch_database_t *notmuch,
363 const search_format_t *format,
364 notmuch_query_t *query)
366 notmuch_messages_t *messages = NULL;
367 notmuch_tags_t *tags;
371 /* Special-case query of "*" for better performance. */
372 if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
373 tags = notmuch_database_get_all_tags (notmuch);
375 messages = notmuch_query_search_messages (query);
376 if (messages == NULL)
379 tags = notmuch_messages_collect_tags (messages);
384 fputs (format->results_start, stdout);
387 notmuch_tags_valid (tags);
388 notmuch_tags_move_to_next (tags))
390 tag = notmuch_tags_get (tags);
393 fputs (format->item_sep, stdout);
395 format->item_id (tags, "", tag);
400 notmuch_tags_destroy (tags);
403 notmuch_messages_destroy (messages);
406 fputs (format->results_null, stdout);
408 fputs (format->results_end, stdout);
414 notmuch_search_command (void *ctx, int argc, char *argv[])
416 notmuch_config_t *config;
417 notmuch_database_t *notmuch;
418 notmuch_query_t *query;
420 notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
421 const search_format_t *format = &format_text;
423 output_t output = OUTPUT_SUMMARY;
425 int limit = -1; /* unlimited */
426 const char **auto_exclude_tags;
427 size_t auto_exclude_tags_length;
430 enum { NOTMUCH_FORMAT_JSON, NOTMUCH_FORMAT_TEXT }
431 format_sel = NOTMUCH_FORMAT_TEXT;
433 notmuch_opt_desc_t options[] = {
434 { NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
435 (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
436 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
438 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
439 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
440 { "text", NOTMUCH_FORMAT_TEXT },
442 { NOTMUCH_OPT_KEYWORD, &output, "output", 'o',
443 (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
444 { "threads", OUTPUT_THREADS },
445 { "messages", OUTPUT_MESSAGES },
446 { "files", OUTPUT_FILES },
447 { "tags", OUTPUT_TAGS },
449 { NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 },
450 { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0 },
454 opt_index = parse_arguments (argc, argv, options, 1);
460 switch (format_sel) {
461 case NOTMUCH_FORMAT_TEXT:
462 format = &format_text;
464 case NOTMUCH_FORMAT_JSON:
465 format = &format_json;
469 config = notmuch_config_open (ctx, NULL, NULL);
473 notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
474 NOTMUCH_DATABASE_MODE_READ_ONLY);
478 query_str = query_string_from_args (notmuch, argc-opt_index, argv+opt_index);
479 if (query_str == NULL) {
480 fprintf (stderr, "Out of memory.\n");
483 if (*query_str == '\0') {
484 fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
488 query = notmuch_query_create (notmuch, query_str);
490 fprintf (stderr, "Out of memory\n");
494 notmuch_query_set_sort (query, sort);
496 auto_exclude_tags = notmuch_config_get_auto_exclude_tags
497 (config, &auto_exclude_tags_length);
498 for (i = 0; i < auto_exclude_tags_length; i++)
499 notmuch_query_add_tag_exclude (query, auto_exclude_tags[i]);
505 ret = do_search_threads (format, query, sort, output, offset, limit);
507 case OUTPUT_MESSAGES:
509 ret = do_search_messages (format, query, output, offset, limit);
512 ret = do_search_tags (notmuch, format, query);
516 notmuch_query_destroy (query);
517 notmuch_database_close (notmuch);