notmuch/notmuch-search.c
Mark Walters d845662970 cli: add --no-exclude option to count and search.
This option turns off the exclusion so all matching messages are
returned. We do not need to add this to notmuch-show as that does not
(yet) exclude.
2012-03-02 08:24:38 -04:00

528 lines
12 KiB
C

/* 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 http://www.gnu.org/licenses/ .
*
* Author: Carl Worth <cworth@cworth.org>
*/
#include "notmuch-client.h"
typedef enum {
OUTPUT_SUMMARY,
OUTPUT_THREADS,
OUTPUT_MESSAGES,
OUTPUT_FILES,
OUTPUT_TAGS
} output_t;
typedef struct search_format {
const char *results_start;
const char *item_start;
void (*item_id) (const void *ctx,
const char *item_type,
const char *item_id);
void (*thread_summary) (const void *ctx,
const char *thread_id,
const time_t date,
const int matched,
const int total,
const char *authors,
const char *subject);
const char *tag_start;
const char *tag;
const char *tag_sep;
const char *tag_end;
const char *item_sep;
const char *item_end;
const char *results_end;
const char *results_null;
} search_format_t;
static void
format_item_id_text (const void *ctx,
const char *item_type,
const char *item_id);
static void
format_thread_text (const void *ctx,
const char *thread_id,
const time_t date,
const int matched,
const int total,
const char *authors,
const char *subject);
static const search_format_t format_text = {
"",
"",
format_item_id_text,
format_thread_text,
" (",
"%s", " ",
")", "\n",
"",
"\n",
"",
};
static void
format_item_id_json (const void *ctx,
const char *item_type,
const char *item_id);
static void
format_thread_json (const void *ctx,
const char *thread_id,
const time_t date,
const int matched,
const int total,
const char *authors,
const char *subject);
/* Any changes to the JSON format should be reflected in the file
* devel/schemata. */
static const search_format_t format_json = {
"[",
"{",
format_item_id_json,
format_thread_json,
"\"tags\": [",
"\"%s\"", ", ",
"]", ",\n",
"}",
"]\n",
"]\n",
};
static void
format_item_id_text (unused (const void *ctx),
const char *item_type,
const char *item_id)
{
printf ("%s%s", item_type, item_id);
}
static char *
sanitize_string (const void *ctx, const char *str)
{
char *out, *loop;
if (NULL == str)
return NULL;
loop = out = talloc_strdup (ctx, str);
for (; *loop; loop++) {
if ((unsigned char)(*loop) < 32)
*loop = '?';
}
return out;
}
static void
format_thread_text (const void *ctx,
const char *thread_id,
const time_t date,
const int matched,
const int total,
const char *authors,
const char *subject)
{
void *ctx_quote = talloc_new (ctx);
printf ("thread:%s %12s [%d/%d] %s; %s",
thread_id,
notmuch_time_relative_date (ctx, date),
matched,
total,
sanitize_string (ctx_quote, authors),
sanitize_string (ctx_quote, subject));
talloc_free (ctx_quote);
}
static void
format_item_id_json (const void *ctx,
unused (const char *item_type),
const char *item_id)
{
void *ctx_quote = talloc_new (ctx);
printf ("%s", json_quote_str (ctx_quote, item_id));
talloc_free (ctx_quote);
}
static void
format_thread_json (const void *ctx,
const char *thread_id,
const time_t date,
const int matched,
const int total,
const char *authors,
const char *subject)
{
void *ctx_quote = talloc_new (ctx);
printf ("\"thread\": %s,\n"
"\"timestamp\": %ld,\n"
"\"date_relative\": \"%s\",\n"
"\"matched\": %d,\n"
"\"total\": %d,\n"
"\"authors\": %s,\n"
"\"subject\": %s,\n",
json_quote_str (ctx_quote, thread_id),
date,
notmuch_time_relative_date (ctx, date),
matched,
total,
json_quote_str (ctx_quote, authors),
json_quote_str (ctx_quote, subject));
talloc_free (ctx_quote);
}
static int
do_search_threads (const search_format_t *format,
notmuch_query_t *query,
notmuch_sort_t sort,
output_t output,
int offset,
int limit)
{
notmuch_thread_t *thread;
notmuch_threads_t *threads;
notmuch_tags_t *tags;
time_t date;
int first_thread = 1;
int i;
if (offset < 0) {
offset += notmuch_query_count_threads (query);
if (offset < 0)
offset = 0;
}
threads = notmuch_query_search_threads (query);
if (threads == NULL)
return 1;
fputs (format->results_start, stdout);
for (i = 0;
notmuch_threads_valid (threads) && (limit < 0 || i < offset + limit);
notmuch_threads_move_to_next (threads), i++)
{
int first_tag = 1;
thread = notmuch_threads_get (threads);
if (i < offset) {
notmuch_thread_destroy (thread);
continue;
}
if (! first_thread)
fputs (format->item_sep, stdout);
if (output == OUTPUT_THREADS) {
format->item_id (thread, "thread:",
notmuch_thread_get_thread_id (thread));
} else { /* output == OUTPUT_SUMMARY */
fputs (format->item_start, stdout);
if (sort == NOTMUCH_SORT_OLDEST_FIRST)
date = notmuch_thread_get_oldest_date (thread);
else
date = notmuch_thread_get_newest_date (thread);
format->thread_summary (thread,
notmuch_thread_get_thread_id (thread),
date,
notmuch_thread_get_matched_messages (thread),
notmuch_thread_get_total_messages (thread),
notmuch_thread_get_authors (thread),
notmuch_thread_get_subject (thread));
fputs (format->tag_start, stdout);
for (tags = notmuch_thread_get_tags (thread);
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags))
{
if (! first_tag)
fputs (format->tag_sep, stdout);
printf (format->tag, notmuch_tags_get (tags));
first_tag = 0;
}
fputs (format->tag_end, stdout);
fputs (format->item_end, stdout);
}
first_thread = 0;
notmuch_thread_destroy (thread);
}
if (first_thread)
fputs (format->results_null, stdout);
else
fputs (format->results_end, stdout);
return 0;
}
static int
do_search_messages (const search_format_t *format,
notmuch_query_t *query,
output_t output,
int offset,
int limit)
{
notmuch_message_t *message;
notmuch_messages_t *messages;
notmuch_filenames_t *filenames;
int first_message = 1;
int i;
if (offset < 0) {
offset += notmuch_query_count_messages (query);
if (offset < 0)
offset = 0;
}
messages = notmuch_query_search_messages (query);
if (messages == NULL)
return 1;
fputs (format->results_start, stdout);
for (i = 0;
notmuch_messages_valid (messages) && (limit < 0 || i < offset + limit);
notmuch_messages_move_to_next (messages), i++)
{
if (i < offset)
continue;
message = notmuch_messages_get (messages);
if (output == OUTPUT_FILES) {
filenames = notmuch_message_get_filenames (message);
for (;
notmuch_filenames_valid (filenames);
notmuch_filenames_move_to_next (filenames))
{
if (! first_message)
fputs (format->item_sep, stdout);
format->item_id (message, "",
notmuch_filenames_get (filenames));
first_message = 0;
}
notmuch_filenames_destroy( filenames );
} else { /* output == OUTPUT_MESSAGES */
if (! first_message)
fputs (format->item_sep, stdout);
format->item_id (message, "id:",
notmuch_message_get_message_id (message));
first_message = 0;
}
notmuch_message_destroy (message);
}
notmuch_messages_destroy (messages);
if (first_message)
fputs (format->results_null, stdout);
else
fputs (format->results_end, stdout);
return 0;
}
static int
do_search_tags (notmuch_database_t *notmuch,
const search_format_t *format,
notmuch_query_t *query)
{
notmuch_messages_t *messages = NULL;
notmuch_tags_t *tags;
const char *tag;
int first_tag = 1;
/* Special-case query of "*" for better performance. */
if (strcmp (notmuch_query_get_query_string (query), "*") == 0) {
tags = notmuch_database_get_all_tags (notmuch);
} else {
messages = notmuch_query_search_messages (query);
if (messages == NULL)
return 1;
tags = notmuch_messages_collect_tags (messages);
}
if (tags == NULL)
return 1;
fputs (format->results_start, stdout);
for (;
notmuch_tags_valid (tags);
notmuch_tags_move_to_next (tags))
{
tag = notmuch_tags_get (tags);
if (! first_tag)
fputs (format->item_sep, stdout);
format->item_id (tags, "", tag);
first_tag = 0;
}
notmuch_tags_destroy (tags);
if (messages)
notmuch_messages_destroy (messages);
if (first_tag)
fputs (format->results_null, stdout);
else
fputs (format->results_end, stdout);
return 0;
}
int
notmuch_search_command (void *ctx, int argc, char *argv[])
{
notmuch_config_t *config;
notmuch_database_t *notmuch;
notmuch_query_t *query;
char *query_str;
notmuch_sort_t sort = NOTMUCH_SORT_NEWEST_FIRST;
const search_format_t *format = &format_text;
int opt_index, ret;
output_t output = OUTPUT_SUMMARY;
int offset = 0;
int limit = -1; /* unlimited */
notmuch_bool_t no_exclude = FALSE;
unsigned int i;
enum { NOTMUCH_FORMAT_JSON, NOTMUCH_FORMAT_TEXT }
format_sel = NOTMUCH_FORMAT_TEXT;
notmuch_opt_desc_t options[] = {
{ NOTMUCH_OPT_KEYWORD, &sort, "sort", 's',
(notmuch_keyword_t []){ { "oldest-first", NOTMUCH_SORT_OLDEST_FIRST },
{ "newest-first", NOTMUCH_SORT_NEWEST_FIRST },
{ 0, 0 } } },
{ NOTMUCH_OPT_KEYWORD, &format_sel, "format", 'f',
(notmuch_keyword_t []){ { "json", NOTMUCH_FORMAT_JSON },
{ "text", NOTMUCH_FORMAT_TEXT },
{ 0, 0 } } },
{ NOTMUCH_OPT_KEYWORD, &output, "output", 'o',
(notmuch_keyword_t []){ { "summary", OUTPUT_SUMMARY },
{ "threads", OUTPUT_THREADS },
{ "messages", OUTPUT_MESSAGES },
{ "files", OUTPUT_FILES },
{ "tags", OUTPUT_TAGS },
{ 0, 0 } } },
{ NOTMUCH_OPT_BOOLEAN, &no_exclude, "no-exclude", 'd', 0 },
{ NOTMUCH_OPT_INT, &offset, "offset", 'O', 0 },
{ NOTMUCH_OPT_INT, &limit, "limit", 'L', 0 },
{ 0, 0, 0, 0, 0 }
};
opt_index = parse_arguments (argc, argv, options, 1);
if (opt_index < 0) {
return 1;
}
switch (format_sel) {
case NOTMUCH_FORMAT_TEXT:
format = &format_text;
break;
case NOTMUCH_FORMAT_JSON:
format = &format_json;
break;
}
config = notmuch_config_open (ctx, NULL, NULL);
if (config == NULL)
return 1;
notmuch = notmuch_database_open (notmuch_config_get_database_path (config),
NOTMUCH_DATABASE_MODE_READ_ONLY);
if (notmuch == NULL)
return 1;
query_str = query_string_from_args (notmuch, argc-opt_index, argv+opt_index);
if (query_str == NULL) {
fprintf (stderr, "Out of memory.\n");
return 1;
}
if (*query_str == '\0') {
fprintf (stderr, "Error: notmuch search requires at least one search term.\n");
return 1;
}
query = notmuch_query_create (notmuch, query_str);
if (query == NULL) {
fprintf (stderr, "Out of memory\n");
return 1;
}
notmuch_query_set_sort (query, sort);
if (!no_exclude) {
const char **search_exclude_tags;
size_t search_exclude_tags_length;
search_exclude_tags = notmuch_config_get_search_exclude_tags
(config, &search_exclude_tags_length);
for (i = 0; i < search_exclude_tags_length; i++)
notmuch_query_add_tag_exclude (query, search_exclude_tags[i]);
}
switch (output) {
default:
case OUTPUT_SUMMARY:
case OUTPUT_THREADS:
ret = do_search_threads (format, query, sort, output, offset, limit);
break;
case OUTPUT_MESSAGES:
case OUTPUT_FILES:
ret = do_search_messages (format, query, output, offset, limit);
break;
case OUTPUT_TAGS:
ret = do_search_tags (notmuch, format, query);
break;
}
notmuch_query_destroy (query);
notmuch_database_close (notmuch);
return ret;
}