/* notmuch - Not much of an email program, (just index and search) * * Copyright © 2009 Carl Worth * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see https://www.gnu.org/licenses/ . * * Author: Carl Worth */ #include "notmuch-client.h" #include "sprinter.h" #include "string-util.h" typedef enum { /* Search command */ OUTPUT_SUMMARY = 1 << 0, OUTPUT_THREADS = 1 << 1, OUTPUT_MESSAGES = 1 << 2, OUTPUT_FILES = 1 << 3, OUTPUT_TAGS = 1 << 4, /* Address command */ OUTPUT_SENDER = 1 << 5, OUTPUT_RECIPIENTS = 1 << 6, OUTPUT_COUNT = 1 << 7, OUTPUT_ADDRESS = 1 << 8, } output_t; typedef enum { DEDUP_NONE, DEDUP_MAILBOX, DEDUP_ADDRESS, } dedup_t; typedef enum { NOTMUCH_FORMAT_JSON, NOTMUCH_FORMAT_TEXT, NOTMUCH_FORMAT_TEXT0, NOTMUCH_FORMAT_SEXP } format_sel_t; typedef struct { notmuch_database_t *notmuch; void *talloc_ctx; int format_sel; sprinter_t *format; int exclude; int query_syntax; notmuch_query_t *query; int sort; int output; int offset; int limit; int dupe; GHashTable *addresses; int dedup; } search_context_t; typedef struct { const char *name; const char *addr; int count; } mailbox_t; /* Return two stable query strings that identify exactly the matched * and unmatched messages currently in thread. If there are no * matched or unmatched messages, the returned buffers will be * NULL. */ static int get_thread_query (notmuch_thread_t *thread, char **matched_out, char **unmatched_out) { notmuch_messages_t *messages; char *escaped = NULL; size_t escaped_len = 0; *matched_out = *unmatched_out = NULL; for (messages = notmuch_thread_get_messages (thread); notmuch_messages_valid (messages); notmuch_messages_move_to_next (messages)) { notmuch_message_t *message = notmuch_messages_get (messages); const char *mid = notmuch_message_get_message_id (message); notmuch_bool_t is_set; char **buf; if (notmuch_message_get_flag_st (message, NOTMUCH_MESSAGE_FLAG_MATCH, &is_set)) return -1; /* Determine which query buffer to extend */ buf = is_set ? matched_out : unmatched_out; /* Add this message's id: query. Since "id" is an exclusive * prefix, it is implicitly 'or'd together, so we only need to * join queries with a space. */ if (make_boolean_term (thread, "id", mid, &escaped, &escaped_len) < 0) return -1; if (*buf) *buf = talloc_asprintf_append_buffer (*buf, " %s", escaped); else *buf = talloc_strdup (thread, escaped); if (! *buf) return -1; } talloc_free (escaped); return 0; } static int do_search_threads (search_context_t *ctx) { notmuch_thread_t *thread; notmuch_threads_t *threads; notmuch_tags_t *tags; sprinter_t *format = ctx->format; time_t date; int i; notmuch_status_t status; if (ctx->offset < 0) { unsigned count; notmuch_status_t status; status = notmuch_query_count_threads (ctx->query, &count); if (print_status_query ("notmuch search", ctx->query, status)) return 1; ctx->offset += count; if (ctx->offset < 0) ctx->offset = 0; } status = notmuch_query_search_threads (ctx->query, &threads); if (print_status_query ("notmuch search", ctx->query, status)) return 1; format->begin_list (format); for (i = 0; notmuch_threads_valid (threads) && (ctx->limit < 0 || i < ctx->offset + ctx->limit); notmuch_threads_move_to_next (threads), i++) { thread = notmuch_threads_get (threads); if (i < ctx->offset) { notmuch_thread_destroy (thread); continue; } if (ctx->output == OUTPUT_THREADS) { format->set_prefix (format, "thread"); format->string (format, notmuch_thread_get_thread_id (thread)); format->separator (format); } else { /* output == OUTPUT_SUMMARY */ void *ctx_quote = talloc_new (thread); const char *authors = notmuch_thread_get_authors (thread); const char *subject = notmuch_thread_get_subject (thread); const char *thread_id = notmuch_thread_get_thread_id (thread); int matched = notmuch_thread_get_matched_messages (thread); int files = notmuch_thread_get_total_files (thread); int total = notmuch_thread_get_total_messages (thread); const char *relative_date = NULL; bool first_tag = true; format->begin_map (format); if (ctx->sort == NOTMUCH_SORT_OLDEST_FIRST) date = notmuch_thread_get_oldest_date (thread); else date = notmuch_thread_get_newest_date (thread); relative_date = notmuch_time_relative_date (ctx_quote, date); if (format->is_text_printer) { /* Special case for the text formatter */ printf ("thread:%s %12s ", thread_id, relative_date); if (total == files) printf ("[%d/%d] %s; %s (", matched, total, sanitize_string (ctx_quote, authors), sanitize_string (ctx_quote, subject)); else printf ("[%d/%d(%d)] %s; %s (", matched, total, files, sanitize_string (ctx_quote, authors), sanitize_string (ctx_quote, subject)); } else { /* Structured Output */ format->map_key (format, "thread"); format->string (format, thread_id); format->map_key (format, "timestamp"); format->integer (format, date); format->map_key (format, "date_relative"); format->string (format, relative_date); format->map_key (format, "matched"); format->integer (format, matched); format->map_key (format, "total"); format->integer (format, total); format->map_key (format, "authors"); format->string (format, authors); format->map_key (format, "subject"); format->string (format, subject); if (notmuch_format_version >= 2) { char *matched_query, *unmatched_query; if (get_thread_query (thread, &matched_query, &unmatched_query) < 0) { fprintf (stderr, "Out of memory\n"); return 1; } format->map_key (format, "query"); format->begin_list (format); if (matched_query) format->string (format, matched_query); else format->null (format); if (unmatched_query) format->string (format, unmatched_query); else format->null (format); format->end (format); } } talloc_free (ctx_quote); format->map_key (format, "tags"); format->begin_list (format); for (tags = notmuch_thread_get_tags (thread); notmuch_tags_valid (tags); notmuch_tags_move_to_next (tags)) { const char *tag = notmuch_tags_get (tags); if (format->is_text_printer) { /* Special case for the text formatter */ if (first_tag) first_tag = false; else fputc (' ', stdout); fputs (tag, stdout); } else { /* Structured Output */ format->string (format, tag); } } if (format->is_text_printer) printf (")"); format->end (format); format->end (format); format->separator (format); } notmuch_thread_destroy (thread); } format->end (format); return 0; } static mailbox_t * new_mailbox (void *ctx, const char *name, const char *addr) { mailbox_t *mailbox; mailbox = talloc (ctx, mailbox_t); if (! mailbox) return NULL; mailbox->name = talloc_strdup (mailbox, name); mailbox->addr = talloc_strdup (mailbox, addr); mailbox->count = 1; return mailbox; } static int mailbox_compare (const void *v1, const void *v2) { const mailbox_t *m1 = v1, *m2 = v2; int ret; ret = strcmp_null (m1->name, m2->name); if (! ret) ret = strcmp (m1->addr, m2->addr); return ret; } /* Returns true iff name and addr is duplicate. If not, stores the * name/addr pair in order to detect subsequent duplicates. */ static bool is_duplicate (const search_context_t *ctx, const char *name, const char *addr) { char *key; GList *list, *l; mailbox_t *mailbox; list = g_hash_table_lookup (ctx->addresses, addr); if (list) { mailbox_t find = { .name = name, .addr = addr, }; l = g_list_find_custom (list, &find, mailbox_compare); if (l) { mailbox = l->data; mailbox->count++; return true; } mailbox = new_mailbox (ctx->format, name, addr); if (! mailbox) return false; /* * XXX: It would be more efficient to prepend to the list, but * then we'd have to store the changed list head back to the * hash table. This check is here just to avoid the compiler * warning for unused result. */ if (list != g_list_append (list, mailbox)) INTERNAL_ERROR ("appending to list changed list head\n"); return false; } key = talloc_strdup (ctx->format, addr); if (! key) return false; mailbox = new_mailbox (ctx->format, name, addr); if (! mailbox) return false; list = g_list_append (NULL, mailbox); if (! list) return false; g_hash_table_insert (ctx->addresses, key, list); return false; } static void print_mailbox (const search_context_t *ctx, const mailbox_t *mailbox) { const char *name = mailbox->name; const char *addr = mailbox->addr; int count = mailbox->count; sprinter_t *format = ctx->format; InternetAddress *ia = internet_address_mailbox_new (name, addr); char *name_addr; /* name_addr has the name part quoted if necessary. Compare * 'John Doe ' vs. '"Doe, John" ' */ name_addr = internet_address_to_string (ia, NULL, false); if (format->is_text_printer) { if (ctx->output & OUTPUT_COUNT) { format->integer (format, count); format->string (format, "\t"); } if (ctx->output & OUTPUT_ADDRESS) format->string (format, addr); else format->string (format, name_addr); format->separator (format); } else { format->begin_map (format); format->map_key (format, "name"); format->string (format, name); format->map_key (format, "address"); format->string (format, addr); format->map_key (format, "name-addr"); format->string (format, name_addr); if (ctx->output & OUTPUT_COUNT) { format->map_key (format, "count"); format->integer (format, count); } format->end (format); format->separator (format); } g_object_unref (ia); g_free (name_addr); } /* Print or prepare for printing addresses from InternetAddressList. */ static void process_address_list (const search_context_t *ctx, InternetAddressList *list) { InternetAddress *address; int i; for (i = 0; i < internet_address_list_length (list); i++) { address = internet_address_list_get_address (list, i); if (INTERNET_ADDRESS_IS_GROUP (address)) { InternetAddressGroup *group; InternetAddressList *group_list; group = INTERNET_ADDRESS_GROUP (address); group_list = internet_address_group_get_members (group); if (group_list == NULL) continue; process_address_list (ctx, group_list); } else { InternetAddressMailbox *mailbox = INTERNET_ADDRESS_MAILBOX (address); mailbox_t mbx = { .name = internet_address_get_name (address), .addr = internet_address_mailbox_get_addr (mailbox), }; /* OUTPUT_COUNT only works with deduplication */ if (ctx->dedup != DEDUP_NONE && is_duplicate (ctx, mbx.name, mbx.addr)) continue; /* OUTPUT_COUNT and DEDUP_ADDRESS require a full pass. */ if (ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS) continue; print_mailbox (ctx, &mbx); } } } /* Print or prepare for printing addresses from a message header. */ static void process_address_header (const search_context_t *ctx, const char *value) { InternetAddressList *list; if (value == NULL) return; list = internet_address_list_parse (NULL, value); if (list == NULL) return; process_address_list (ctx, list); g_object_unref (list); } /* Destructor for talloc-allocated GHashTable keys and values. */ static void _talloc_free_for_g_hash (void *ptr) { talloc_free (ptr); } static void _list_free_for_g_hash (void *ptr) { g_list_free_full (ptr, _talloc_free_for_g_hash); } /* Print the most common variant of a list of unique mailboxes, and * conflate the counts. */ static void print_popular (const search_context_t *ctx, GList *list) { GList *l; mailbox_t *mailbox = NULL, *m; int max = 0; int total = 0; for (l = list; l; l = l->next) { m = l->data; total += m->count; if (m->count > max) { mailbox = m; max = m->count; } } if (! mailbox) INTERNAL_ERROR ("Empty list in address hash table\n"); /* The original count is no longer needed, so overwrite. */ mailbox->count = total; print_mailbox (ctx, mailbox); } static void print_list_value (void *mailbox, void *context) { print_mailbox (context, mailbox); } static void print_hash_value (unused (void *key), void *list, void *context) { const search_context_t *ctx = context; if (ctx->dedup == DEDUP_ADDRESS) print_popular (ctx, list); else g_list_foreach (list, print_list_value, context); } static int _count_filenames (notmuch_message_t *message) { notmuch_filenames_t *filenames; int i = 0; filenames = notmuch_message_get_filenames (message); while (notmuch_filenames_valid (filenames)) { notmuch_filenames_move_to_next (filenames); i++; } notmuch_filenames_destroy (filenames); return i; } static int do_search_messages (search_context_t *ctx) { notmuch_message_t *message; notmuch_messages_t *messages; notmuch_filenames_t *filenames; sprinter_t *format = ctx->format; int i; notmuch_status_t status; if (ctx->offset < 0) { unsigned count; notmuch_status_t status; status = notmuch_query_count_messages (ctx->query, &count); if (print_status_query ("notmuch search", ctx->query, status)) return 1; ctx->offset += count; if (ctx->offset < 0) ctx->offset = 0; } status = notmuch_query_search_messages (ctx->query, &messages); if (print_status_query ("notmuch search", ctx->query, status)) return 1; format->begin_list (format); for (i = 0; notmuch_messages_valid (messages) && (ctx->limit < 0 || i < ctx->offset + ctx->limit); notmuch_messages_move_to_next (messages), i++) { if (i < ctx->offset) continue; message = notmuch_messages_get (messages); if (ctx->output == OUTPUT_FILES) { int j; filenames = notmuch_message_get_filenames (message); for (j = 1; notmuch_filenames_valid (filenames); notmuch_filenames_move_to_next (filenames), j++) { if (ctx->dupe < 0 || ctx->dupe == j) { format->string (format, notmuch_filenames_get (filenames)); format->separator (format); } } notmuch_filenames_destroy ( filenames ); } else if (ctx->output == OUTPUT_MESSAGES) { /* special case 1 for speed */ if (ctx->dupe <= 1 || ctx->dupe <= _count_filenames (message)) { format->set_prefix (format, "id"); format->string (format, notmuch_message_get_message_id (message)); format->separator (format); } } else { if (ctx->output & OUTPUT_SENDER) { const char *addrs; addrs = notmuch_message_get_header (message, "from"); process_address_header (ctx, addrs); } if (ctx->output & OUTPUT_RECIPIENTS) { const char *hdrs[] = { "to", "cc", "bcc" }; const char *addrs; size_t j; for (j = 0; j < ARRAY_SIZE (hdrs); j++) { addrs = notmuch_message_get_header (message, hdrs[j]); process_address_header (ctx, addrs); } } } notmuch_message_destroy (message); } if (ctx->addresses && (ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS)) g_hash_table_foreach (ctx->addresses, print_hash_value, ctx); notmuch_messages_destroy (messages); format->end (format); return 0; } static int do_search_tags (const search_context_t *ctx) { notmuch_messages_t *messages = NULL; notmuch_tags_t *tags; const char *tag; sprinter_t *format = ctx->format; notmuch_query_t *query = ctx->query; notmuch_database_t *notmuch = ctx->notmuch; /* should the following only special case if no excluded terms * specified? */ /* Special-case query of "*" for better performance. */ if (strcmp (notmuch_query_get_query_string (query), "*") == 0) { tags = notmuch_database_get_all_tags (notmuch); } else { notmuch_status_t status; status = notmuch_query_search_messages (query, &messages); if (print_status_query ("notmuch search", query, status)) return 1; tags = notmuch_messages_collect_tags (messages); } if (tags == NULL) return 1; format->begin_list (format); for (; notmuch_tags_valid (tags); notmuch_tags_move_to_next (tags)) { tag = notmuch_tags_get (tags); format->string (format, tag); format->separator (format); } notmuch_tags_destroy (tags); if (messages) notmuch_messages_destroy (messages); format->end (format); return 0; } static int _notmuch_search_prepare (search_context_t *ctx, int argc, char *argv[]) { char *query_str; if (! ctx->talloc_ctx) ctx->talloc_ctx = talloc_new (NULL); switch (ctx->format_sel) { case NOTMUCH_FORMAT_TEXT: ctx->format = sprinter_text_create (ctx->talloc_ctx, stdout); break; case NOTMUCH_FORMAT_TEXT0: if (ctx->output == OUTPUT_SUMMARY) { fprintf (stderr, "Error: --format=text0 is not compatible with --output=summary.\n"); return EXIT_FAILURE; } ctx->format = sprinter_text0_create (ctx->talloc_ctx, stdout); break; case NOTMUCH_FORMAT_JSON: ctx->format = sprinter_json_create (ctx->talloc_ctx, stdout); break; case NOTMUCH_FORMAT_SEXP: ctx->format = sprinter_sexp_create (ctx->talloc_ctx, stdout); break; default: /* this should never happen */ INTERNAL_ERROR ("no output format selected"); } notmuch_exit_if_unsupported_format (); query_str = query_string_from_args (ctx->notmuch, argc, argv); if (query_str == NULL) { fprintf (stderr, "Out of memory.\n"); return EXIT_FAILURE; } if (*query_str == '\0') { fprintf (stderr, "Error: notmuch search requires at least one search term.\n"); return EXIT_FAILURE; } if (print_status_database ("notmuch search", ctx->notmuch, notmuch_query_create_with_syntax (ctx->notmuch, query_str, shared_option_query_syntax (), &ctx->query))) return EXIT_FAILURE; notmuch_query_set_sort (ctx->query, ctx->sort); if (ctx->exclude == NOTMUCH_EXCLUDE_FLAG && ctx->output != OUTPUT_SUMMARY) { /* If we are not doing summary output there is nowhere to * print the excluded flag so fall back on including the * excluded messages. */ fprintf (stderr, "Warning: this output format cannot flag excluded messages.\n"); ctx->exclude = NOTMUCH_EXCLUDE_FALSE; } if (ctx->exclude != NOTMUCH_EXCLUDE_FALSE) { notmuch_config_values_t *exclude_tags; notmuch_status_t status; for (exclude_tags = notmuch_config_get_values (ctx->notmuch, NOTMUCH_CONFIG_EXCLUDE_TAGS); notmuch_config_values_valid (exclude_tags); notmuch_config_values_move_to_next (exclude_tags)) { status = notmuch_query_add_tag_exclude (ctx->query, notmuch_config_values_get (exclude_tags)); if (status && status != NOTMUCH_STATUS_IGNORED) { print_status_query ("notmuch search", ctx->query, status); return EXIT_FAILURE; } } notmuch_query_set_omit_excluded (ctx->query, ctx->exclude); } return 0; } static void _notmuch_search_cleanup (search_context_t *ctx) { notmuch_query_destroy (ctx->query); notmuch_database_destroy (ctx->notmuch); talloc_free (ctx->format); } static search_context_t search_context = { .format_sel = NOTMUCH_FORMAT_TEXT, .exclude = NOTMUCH_EXCLUDE_TRUE, .sort = NOTMUCH_SORT_NEWEST_FIRST, .query_syntax = NOTMUCH_QUERY_SYNTAX_XAPIAN, .output = 0, .offset = 0, .limit = -1, /* unlimited */ .dupe = -1, .dedup = DEDUP_MAILBOX, }; static const notmuch_opt_desc_t common_options[] = { { .opt_keyword = &search_context.sort, .name = "sort", .keywords = (notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST }, { "newest-first", NOTMUCH_SORT_NEWEST_FIRST }, { 0, 0 } } }, { .opt_keyword = &search_context.format_sel, .name = "format", .keywords = (notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON }, { "sexp", NOTMUCH_FORMAT_SEXP }, { "text", NOTMUCH_FORMAT_TEXT }, { "text0", NOTMUCH_FORMAT_TEXT0 }, { 0, 0 } } }, { .opt_int = ¬much_format_version, .name = "format-version" }, { } }; int notmuch_search_command (notmuch_database_t *notmuch, int argc, char *argv[]) { search_context_t *ctx = &search_context; int opt_index, ret; notmuch_opt_desc_t options[] = { { .opt_keyword = &ctx->output, .name = "output", .keywords = (notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY }, { "threads", OUTPUT_THREADS }, { "messages", OUTPUT_MESSAGES }, { "files", OUTPUT_FILES }, { "tags", OUTPUT_TAGS }, { 0, 0 } } }, { .opt_keyword = &ctx->exclude, .name = "exclude", .keywords = (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE }, { "false", NOTMUCH_EXCLUDE_FALSE }, { "flag", NOTMUCH_EXCLUDE_FLAG }, { "all", NOTMUCH_EXCLUDE_ALL }, { 0, 0 } } }, { .opt_int = &ctx->offset, .name = "offset" }, { .opt_int = &ctx->limit, .name = "limit" }, { .opt_int = &ctx->dupe, .name = "duplicate" }, { .opt_inherit = common_options }, { .opt_inherit = notmuch_shared_options }, { } }; ctx->notmuch = notmuch; ctx->output = OUTPUT_SUMMARY; opt_index = parse_arguments (argc, argv, options, 1); if (opt_index < 0) return EXIT_FAILURE; notmuch_process_shared_options (notmuch, argv[0]); if (ctx->output != OUTPUT_FILES && ctx->output != OUTPUT_MESSAGES && ctx->dupe != -1) { fprintf (stderr, "Error: --duplicate=N is only supported with --output=files and --output=messages.\n"); return EXIT_FAILURE; } if (_notmuch_search_prepare (ctx, argc - opt_index, argv + opt_index)) return EXIT_FAILURE; switch (ctx->output) { case OUTPUT_SUMMARY: case OUTPUT_THREADS: ret = do_search_threads (ctx); break; case OUTPUT_MESSAGES: case OUTPUT_FILES: ret = do_search_messages (ctx); break; case OUTPUT_TAGS: ret = do_search_tags (ctx); break; default: INTERNAL_ERROR ("Unexpected output"); } _notmuch_search_cleanup (ctx); return ret ? EXIT_FAILURE : EXIT_SUCCESS; } int notmuch_address_command (notmuch_database_t *notmuch, int argc, char *argv[]) { search_context_t *ctx = &search_context; int opt_index, ret; notmuch_opt_desc_t options[] = { { .opt_flags = &ctx->output, .name = "output", .keywords = (notmuch_keyword_t []){ { "sender", OUTPUT_SENDER }, { "recipients", OUTPUT_RECIPIENTS }, { "count", OUTPUT_COUNT }, { "address", OUTPUT_ADDRESS }, { 0, 0 } } }, { .opt_keyword = &ctx->exclude, .name = "exclude", .keywords = (notmuch_keyword_t []){ { "true", NOTMUCH_EXCLUDE_TRUE }, { "false", NOTMUCH_EXCLUDE_FALSE }, { 0, 0 } } }, { .opt_keyword = &ctx->dedup, .name = "deduplicate", .keywords = (notmuch_keyword_t []){ { "no", DEDUP_NONE }, { "mailbox", DEDUP_MAILBOX }, { "address", DEDUP_ADDRESS }, { 0, 0 } } }, { .opt_inherit = common_options }, { .opt_inherit = notmuch_shared_options }, { } }; ctx->notmuch = notmuch; opt_index = parse_arguments (argc, argv, options, 1); if (opt_index < 0) return EXIT_FAILURE; notmuch_process_shared_options (notmuch, argv[0]); if (! (ctx->output & (OUTPUT_SENDER | OUTPUT_RECIPIENTS))) ctx->output |= OUTPUT_SENDER; if (ctx->output & OUTPUT_COUNT && ctx->dedup == DEDUP_NONE) { fprintf (stderr, "--output=count is not applicable with --deduplicate=no\n"); return EXIT_FAILURE; } if (_notmuch_search_prepare (ctx, argc - opt_index, argv + opt_index)) return EXIT_FAILURE; ctx->addresses = g_hash_table_new_full (strcase_hash, strcase_equal, _talloc_free_for_g_hash, _list_free_for_g_hash); /* The order is not guaranteed if a full pass is required, so go * for fastest. */ if (ctx->output & OUTPUT_COUNT || ctx->dedup == DEDUP_ADDRESS) notmuch_query_set_sort (ctx->query, NOTMUCH_SORT_UNSORTED); ret = do_search_messages (ctx); g_hash_table_unref (ctx->addresses); _notmuch_search_cleanup (ctx); return ret ? EXIT_FAILURE : EXIT_SUCCESS; }