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,
94 /* Any changes to the JSON format should be reflected in the file
96 static const search_format_t format_json = {
110 format_item_id_text (unused (const void *ctx),
111 const char *item_type,
114 printf ("%s%s", item_type, item_id);
118 sanitize_string (const void *ctx, const char *str)
125 loop = out = talloc_strdup (ctx, str);
127 for (; *loop; loop++) {
128 if ((unsigned char)(*loop) < 32)
135 format_thread_text (const void *ctx,
136 const char *thread_id,
143 void *ctx_quote = talloc_new (ctx);
145 printf ("thread:%s %12s [%d/%d] %s; %s",
147 notmuch_time_relative_date (ctx, date),
150 sanitize_string (ctx_quote, authors),
151 sanitize_string (ctx_quote, subject));
153 talloc_free (ctx_quote);
157 format_item_id_json (const void *ctx,
158 unused (const char *item_type),
161 void *ctx_quote = talloc_new (ctx);
163 printf ("%s", json_quote_str (ctx_quote, item_id));
165 talloc_free (ctx_quote);
170 format_thread_json (const void *ctx,
171 const char *thread_id,
178 void *ctx_quote = talloc_new (ctx);
180 printf ("\"thread\": %s,\n"
181 "\"timestamp\": %ld,\n"
182 "\"date_relative\": \"%s\",\n"
186 "\"subject\": %s,\n",
187 json_quote_str (ctx_quote, thread_id),
189 notmuch_time_relative_date (ctx, date),
192 json_quote_str (ctx_quote, authors),
193 json_quote_str (ctx_quote, subject));
195 talloc_free (ctx_quote);
199 do_search_threads (const search_format_t *format,
200 notmuch_query_t *query,
206 notmuch_thread_t *thread;
207 notmuch_threads_t *threads;
208 notmuch_tags_t *tags;
210 int first_thread = 1;
214 offset += notmuch_query_count_threads (query);
219 threads = notmuch_query_search_threads (query);
223 fputs (format->results_start, stdout);
226 notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
227 notmuch_threads_move_to_next (threads), i++)
231 thread = notmuch_threads_get (threads);
234 notmuch_thread_destroy (thread);
239 fputs (format->item_sep, stdout);
241 if (output == OUTPUT_THREADS) {
242 format->item_id (thread, "thread:",
243 notmuch_thread_get_thread_id (thread));
244 } else { /* output == OUTPUT_SUMMARY */
245 fputs (format->item_start, stdout);
247 if (sort == NOTMUCH_SORT_OLDEST_FIRST)
248 date = notmuch_thread_get_oldest_date (thread);
250 date = notmuch_thread_get_newest_date (thread);
252 format->thread_summary (thread,
253 notmuch_thread_get_thread_id (thread),
255 notmuch_thread_get_matched_messages (thread),
256 notmuch_thread_get_total_messages (thread),
257 notmuch_thread_get_authors (thread),
258 notmuch_thread_get_subject (thread));
260 fputs (format->tag_start, stdout);
262 for (tags = notmuch_thread_get_tags (thread);
263 notmuch_tags_valid (tags);
264 notmuch_tags_move_to_next (tags))
267 fputs (format->tag_sep, stdout);
268 printf (format->tag, notmuch_tags_get (tags));
272 fputs (format->tag_end, stdout);
274 fputs (format->item_end, stdout);
279 notmuch_thread_destroy (thread);
283 fputs (format->results_null, stdout);
285 fputs (format->results_end, stdout);
291 do_search_messages (const search_format_t *format,
292 notmuch_query_t *query,
297 notmuch_message_t *message;
298 notmuch_messages_t *messages;
299 notmuch_filenames_t *filenames;
300 int first_message = 1;
304 offset += notmuch_query_count_messages (query);
309 messages = notmuch_query_search_messages (query);
310 if (messages == NULL)
313 fputs (format->results_start, stdout);
316 notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
317 notmuch_messages_move_to_next (messages), i++)
322 message = notmuch_messages_get (messages);
324 if (output == OUTPUT_FILES) {
325 filenames = notmuch_message_get_filenames (message);
328 notmuch_filenames_valid (filenames);
329 notmuch_filenames_move_to_next (filenames))
332 fputs (format->item_sep, stdout);
334 format->item_id (message, "",
335 notmuch_filenames_get (filenames));
340 notmuch_filenames_destroy( filenames );
342 } else { /* output == OUTPUT_MESSAGES */
344 fputs (format->item_sep, stdout);
346 format->item_id (message, "id:",
347 notmuch_message_get_message_id (message));
351 notmuch_message_destroy (message);
354 notmuch_messages_destroy (messages);
357 fputs (format->results_null, stdout);
359 fputs (format->results_end, stdout);
365 do_search_tags (notmuch_database_t *notmuch,
366 const search_format_t *format,
367 notmuch_query_t *query)
369 notmuch_messages_t *messages = NULL;
370 notmuch_tags_t *tags;
374 /* should the following only special case if no excluded terms
377 /* Special-case query of "*" for better performance. */
378 if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
379 tags = notmuch_database_get_all_tags (notmuch);
381 messages = notmuch_query_search_messages (query);
382 if (messages == NULL)
385 tags = notmuch_messages_collect_tags (messages);
390 fputs (format->results_start, stdout);
393 notmuch_tags_valid (tags);
394 notmuch_tags_move_to_next (tags))
396 tag = notmuch_tags_get (tags);
399 fputs (format->item_sep, stdout);
401 format->item_id (tags, "", tag);
406 notmuch_tags_destroy (tags);
409 notmuch_messages_destroy (messages);
412 fputs (format->results_null, stdout);
414 fputs (format->results_end, stdout);
426 notmuch_search_command (void *ctx, int argc, char *argv[])
428 notmuch_config_t *config;
429 notmuch_database_t *notmuch;
430 notmuch_query_t *query;
432 notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
433 const search_format_t *format = &format_text;
435 output_t output = OUTPUT_SUMMARY;
437 int limit = -1; /* unlimited */
438 int exclude = EXCLUDE_TRUE;
441 enum { NOTMUCH_FORMAT_JSON, NOTMUCH_FORMAT_TEXT }
442 format_sel = NOTMUCH_FORMAT_TEXT;
444 notmuch_opt_desc_t options[] = {
445 { NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
446 (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
447 { "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
449 { NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
450 (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
451 { "text", NOTMUCH_FORMAT_TEXT },
453 { NOTMUCH_OPT_KEYWORD, &output, "output", 'o',
454 (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
455 { "threads", OUTPUT_THREADS },
456 { "messages", OUTPUT_MESSAGES },
457 { "files", OUTPUT_FILES },
458 { "tags", OUTPUT_TAGS },
460 { NOTMUCH_OPT_KEYWORD, &exclude, "exclude", 'x',
461 (notmuch_keyword_t []){ { "true", EXCLUDE_TRUE },
462 { "false", EXCLUDE_FALSE },
463 { "flag", EXCLUDE_FLAG },
465 { NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 },
466 { NOTMUCH_OPT_INT, &limit, "limit", 'L', 0 },
470 opt_index = parse_arguments (argc, argv, options, 1);
476 switch (format_sel) {
477 case NOTMUCH_FORMAT_TEXT:
478 format = &format_text;
480 case NOTMUCH_FORMAT_JSON:
481 format = &format_json;
485 config = notmuch_config_open (ctx, NULL, NULL);
489 if (notmuch_database_open (notmuch_config_get_database_path (config),
490 NOTMUCH_DATABASE_MODE_READ_ONLY, ¬much))
493 query_str = query_string_from_args (notmuch, argc-opt_index, argv+opt_index);
494 if (query_str == NULL) {
495 fprintf (stderr, "Out of memory.\n");
498 if (*query_str == '\0') {
499 fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
503 query = notmuch_query_create (notmuch, query_str);
505 fprintf (stderr, "Out of memory\n");
509 notmuch_query_set_sort (query, sort);
511 if (exclude == EXCLUDE_FLAG && output != OUTPUT_SUMMARY) {
512 /* If we are not doing summary output there is nowhere to
513 * print the excluded flag so fall back on including the
514 * excluded messages. */
515 fprintf (stderr, "Warning: this output format cannot flag excluded messages.\n");
516 exclude = EXCLUDE_FALSE;
519 if (exclude == EXCLUDE_TRUE || exclude == EXCLUDE_FLAG) {
520 const char **search_exclude_tags;
521 size_t search_exclude_tags_length;
523 search_exclude_tags = notmuch_config_get_search_exclude_tags
524 (config, &search_exclude_tags_length);
525 for (i = 0; i < search_exclude_tags_length; i++)
526 notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
527 if (exclude == EXCLUDE_FLAG)
528 notmuch_query_set_omit_excluded (query, FALSE);
535 ret = do_search_threads (format, query, sort, output, offset, limit);
537 case OUTPUT_MESSAGES:
539 ret = do_search_messages (format, query, output, offset, limit);
542 ret = do_search_tags (notmuch, format, query);
546 notmuch_query_destroy (query);
547 notmuch_database_destroy (notmuch);