#include <talloc.h>
-#include <glib.h> /* g_strdup_printf */
+#define unused(x) x __attribute__ ((unused))
+
+/* There's no point in continuing when we've detected that we've done
+ * something wrong internally (as opposed to the user passing in a
+ * bogus value).
+ *
+ * Note that __location__ comes from talloc.h.
+ */
+#define INTERNAL_ERROR(format, ...) \
+ do { \
+ fprintf(stderr, \
+ "Internal error: " format " (%s)\n", \
+ ##__VA_ARGS__, __location__); \
+ exit (1); \
+ } while (0)
#define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
typedef struct command {
const char *name;
command_function_t function;
- const char *usage;
+ const char *summary;
+ const char *documentation;
} command_t;
+typedef void (*add_files_callback_t) (notmuch_message_t *message);
+
typedef struct {
+ int ignore_read_only_directories;
+ int saw_read_only_directory;
+
int total_files;
int processed_files;
int added_messages;
struct timeval tv_start;
+
+ add_files_callback_t callback;
} add_files_state_t;
static void
}
/* Compute the number of seconds elapsed from start to end. */
-double
+static double
tv_elapsed (struct timeval start, struct timeval end)
{
return ((end.tv_sec - start.tv_sec) +
(end.tv_usec - start.tv_usec) / 1e6);
}
-void
+static void
print_formatted_seconds (double seconds)
{
int hours;
printf ("%ds", (int) seconds);
}
-void
+static void
add_files_print_progress (add_files_state_t *state)
{
struct timeval tv_now;
* The 'struct stat *st' must point to a structure that has already
* been initialized for 'path' by calling stat().
*/
-notmuch_status_t
+static notmuch_status_t
add_files_recursive (notmuch_database_t *notmuch,
const char *path,
struct stat *st,
char *next = NULL;
time_t path_mtime, path_dbtime;
notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
+ notmuch_message_t *message = NULL, **closure;
+
+ /* If we're told to, we bail out on encountering a read-only
+ * directory, (with this being a clear clue from the user to
+ * Notmuch that new mail won't be arriving there and we need not
+ * look. */
+ if (state->ignore_read_only_directories &&
+ (st->st_mode & S_IWUSR) == 0)
+ {
+ state->saw_read_only_directory = TRUE;
+ goto DONE;
+ }
path_mtime = st->st_mtime;
continue;
}
- next = g_strdup_printf ("%s/%s", path, entry->d_name);
+ next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
if (stat (next, st)) {
fprintf (stderr, "Error reading %s: %s\n",
if (st->st_mtime > path_dbtime) {
state->processed_files++;
- status = notmuch_database_add_message (notmuch, next);
+ if (state->callback)
+ closure = &message;
+ else
+ closure = NULL;
+
+ status = notmuch_database_add_message (notmuch, next, closure);
switch (status) {
/* success */
case NOTMUCH_STATUS_SUCCESS:
state->added_messages++;
+ if (state->callback)
+ (state->callback) (message);
break;
/* Non-fatal issues (go on to next file) */
case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
break;
/* Fatal issues. Don't process anymore. */
case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
- fprintf (stderr, "A Xapian error was encountered. Halting processing.\n");
+ case NOTMUCH_STATUS_OUT_OF_MEMORY:
+ fprintf (stderr, "Error: %s. Halting processing.\n",
+ notmuch_status_to_string (status));
ret = status;
goto DONE;
default:
- fprintf (stderr, "Internal error: add_message returned unexpected value: %d\n", status);
- ret = status;
+ case NOTMUCH_STATUS_FILE_ERROR:
+ case NOTMUCH_STATUS_NULL_POINTER:
+ case NOTMUCH_STATUS_TAG_TOO_LONG:
+ case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
+ case NOTMUCH_STATUS_LAST_STATUS:
+ INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
goto DONE;
}
+
+ if (message) {
+ notmuch_message_destroy (message);
+ message = NULL;
+ }
+
if (state->processed_files % 1000 == 0)
add_files_print_progress (state);
}
ret = status;
}
- free (next);
+ talloc_free (next);
next = NULL;
}
- notmuch_database_set_timestamp (notmuch, path, path_mtime);
+ status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
+ if (status && ret == NOTMUCH_STATUS_SUCCESS)
+ ret = status;
DONE:
if (next)
- free (next);
+ talloc_free (next);
if (entry)
free (entry);
if (dir)
* of path. The result is added to *count (which should be
* initialized to zero by the top-level caller before calling
* count_files). */
-void
+static void
count_files (const char *path, int *count)
{
DIR *dir;
- struct dirent *entry, *e;
+ struct dirent *e, *entry = NULL;
int entry_length;
int err;
char *next;
if (dir == NULL) {
fprintf (stderr, "Warning: failed to open directory %s: %s\n",
path, strerror (errno));
- return;
+ goto DONE;
}
entry_length = offsetof (struct dirent, d_name) +
fprintf (stderr, "Error reading directory: %s\n",
strerror (errno));
free (entry);
- return;
+ goto DONE;
}
if (e == NULL)
continue;
}
- next = g_strdup_printf ("%s/%s", path, entry->d_name);
+ if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
+ next = NULL;
+ fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
+ path, entry->d_name);
+ continue;
+ }
stat (next, &st);
free (next);
}
- free (entry);
+ DONE:
+ if (entry)
+ free (entry);
closedir (dir);
}
-int
-setup_command (int argc, char *argv[])
+static int
+setup_command (unused (int argc), unused (char *argv[]))
{
notmuch_database_t *notmuch = NULL;
char *default_path, *mail_directory = NULL;
printf ("Next, we'll inspect the messages and create a database of threads:\n");
+ add_files_state.ignore_read_only_directories = FALSE;
+ add_files_state.saw_read_only_directory = FALSE;
add_files_state.total_files = count;
add_files_state.processed_files = 0;
add_files_state.added_messages = 0;
+ add_files_state.callback = NULL;
gettimeofday (&add_files_state.tv_start, NULL);
ret = add_files (notmuch, mail_directory, &add_files_state);
}
printf ("When new mail is delivered to %s in the future,\n"
- "run \"notmuch new\" to add it to the database.\n",
+ "run \"notmuch new\" to add it to the database.\n\n",
mail_directory);
if (ret) {
return ret;
}
-int
-new_command (int argc, char *argv[])
+static void
+tag_inbox_and_unread (notmuch_message_t *message)
+{
+ notmuch_message_add_tag (message, "inbox");
+ notmuch_message_add_tag (message, "unread");
+}
+
+static int
+new_command (unused (int argc), unused (char *argv[]))
{
notmuch_database_t *notmuch;
const char *mail_directory;
mail_directory = notmuch_database_get_path (notmuch);
+ add_files_state.ignore_read_only_directories = TRUE;
+ add_files_state.saw_read_only_directory = FALSE;
add_files_state.total_files = 0;
add_files_state.processed_files = 0;
add_files_state.added_messages = 0;
+ add_files_state.callback = tag_inbox_and_unread;
gettimeofday (&add_files_state.tv_start, NULL);
ret = add_files (notmuch, mail_directory, &add_files_state);
add_files_state.added_messages == 1 ?
"message" : "messages");
} else {
- printf ("No new mail---and that's not much!\n");
+ printf ("No new mail---and that's not much.\n");
+ }
+
+ if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
+ printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
+ "they will never receive new mail), marking these directores as\n"
+ "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
+ "much more efficient (it won't even look in those directories).\n");
}
if (ret) {
- printf ("Note: At least one error was encountered: %s\n",
+ printf ("\nNote: At least one error was encountered: %s\n",
notmuch_status_to_string (ret));
}
return ret;
}
-int
+/* Construct a single query string from the passed arguments, using
+ * 'ctx' as the talloc owner for all allocations.
+ *
+ * Currently, the arguments are just connected with space characters,
+ * but we might do more processing in the future, (such as inserting
+ * any AND operators needed to work around Xapian QueryParser bugs).
+ *
+ * This function returns NULL in case of insufficient memory.
+ */
+static char *
+query_string_from_args (void *ctx, int argc, char *argv[])
+{
+ char *query_string;
+ int i;
+
+ query_string = talloc_strdup (ctx, "");
+ if (query_string == NULL)
+ return NULL;
+
+ for (i = 0; i < argc; i++) {
+ if (i != 0) {
+ query_string = talloc_strdup_append (query_string, " ");
+ if (query_string == NULL)
+ return NULL;
+ }
+
+ query_string = talloc_strdup_append (query_string, argv[i]);
+ if (query_string == NULL)
+ return NULL;
+ }
+
+ return query_string;
+}
+
+static int
search_command (int argc, char *argv[])
{
- fprintf (stderr, "Error: search is not implemented yet.\n");
- return 1;
+ void *local = talloc_new (NULL);
+ notmuch_database_t *notmuch = NULL;
+ notmuch_query_t *query;
+ notmuch_thread_results_t *results;
+ notmuch_thread_t *thread;
+ notmuch_tags_t *tags;
+ char *query_str;
+ notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
+
+ notmuch = notmuch_database_open (NULL);
+ if (notmuch == NULL) {
+ ret = 1;
+ goto DONE;
+ }
+
+ query_str = query_string_from_args (local, argc, argv);
+
+ query = notmuch_query_create (notmuch, query_str);
+ if (query == NULL) {
+ fprintf (stderr, "Out of memory\n");
+ ret = 1;
+ goto DONE;
+ }
+
+ for (results = notmuch_query_search_threads (query);
+ notmuch_thread_results_has_more (results);
+ notmuch_thread_results_advance (results))
+ {
+ int first = 1;
+
+ thread = notmuch_thread_results_get (results);
+
+ printf ("%s %s",
+ notmuch_thread_get_thread_id (thread),
+ notmuch_thread_get_subject (thread));
+
+ printf (" (");
+ for (tags = notmuch_thread_get_tags (thread);
+ notmuch_tags_has_more (tags);
+ notmuch_tags_advance (tags))
+ {
+ if (! first)
+ printf (" ");
+ printf ("%s", notmuch_tags_get (tags));
+ first = 0;
+ }
+ printf (")\n");
+
+ notmuch_thread_destroy (thread);
+ }
+
+ notmuch_query_destroy (query);
+
+ DONE:
+ if (notmuch)
+ notmuch_database_close (notmuch);
+ talloc_free (local);
+
+ return ret;
}
-int
-show_command (int argc, char *argv[])
+static int
+show_command (unused (int argc), unused (char *argv[]))
{
fprintf (stderr, "Error: show is not implemented yet.\n");
return 1;
}
-int
+static int
+tag_command (unused (int argc), unused (char *argv[]))
+{
+ void *local;
+ int *add_tags, *remove_tags;
+ int add_tags_count = 0;
+ int remove_tags_count = 0;
+ char *query_string;
+ notmuch_database_t *notmuch = NULL;
+ notmuch_query_t *query;
+ notmuch_message_results_t *results;
+ notmuch_message_t *message;
+ int ret = 0;
+ int i;
+
+ local = talloc_new (NULL);
+ if (local == NULL) {
+ ret = 1;
+ goto DONE;
+ }
+
+ add_tags = talloc_size (local, argc * sizeof (int));
+ if (add_tags == NULL) {
+ ret = 1;
+ goto DONE;
+ }
+
+ remove_tags = talloc_size (local, argc * sizeof (int));
+ if (remove_tags == NULL) {
+ ret = 1;
+ goto DONE;
+ }
+
+ for (i = 0; i < argc; i++) {
+ if (strcmp (argv[i], "--") == 0) {
+ i++;
+ break;
+ }
+ if (argv[i][0] == '+') {
+ add_tags[add_tags_count++] = i;
+ } else if (argv[i][0] == '-') {
+ remove_tags[remove_tags_count++] = i;
+ } else {
+ break;
+ }
+ }
+
+ if (add_tags_count == 0 && remove_tags_count == 0) {
+ fprintf (stderr, "Error: 'notmuch tag' requires at least one tag to add or remove.\n");
+ ret = 1;
+ goto DONE;
+ }
+
+ if (i == argc) {
+ fprintf (stderr, "Error: 'notmuch tag' requires at least one search term.\n");
+ ret = 1;
+ goto DONE;
+ }
+
+ notmuch = notmuch_database_open (NULL);
+ if (notmuch == NULL) {
+ ret = 1;
+ goto DONE;
+ }
+
+ query_string = query_string_from_args (local, argc - i, &argv[i]);
+
+ query = notmuch_query_create (notmuch, query_string);
+ if (query == NULL) {
+ fprintf (stderr, "Out of memory.\n");
+ ret = 1;
+ goto DONE;
+ }
+
+ for (results = notmuch_query_search_messages (query);
+ notmuch_message_results_has_more (results);
+ notmuch_message_results_advance (results))
+ {
+ message = notmuch_message_results_get (results);
+
+ notmuch_message_freeze (message);
+
+ for (i = 0; i < remove_tags_count; i++)
+ notmuch_message_remove_tag (message,
+ argv[remove_tags[i]] + 1);
+
+ for (i = 0; i < add_tags_count; i++)
+ notmuch_message_add_tag (message, argv[add_tags[i]] + 1);
+
+ notmuch_message_thaw (message);
+
+ notmuch_message_destroy (message);
+ }
+
+ notmuch_query_destroy (query);
+
+ DONE:
+ if (notmuch)
+ notmuch_database_close (notmuch);
+
+ talloc_free (local);
+
+ return ret;
+}
+
+static int
dump_command (int argc, char *argv[])
{
- FILE *output;
- notmuch_database_t *notmuch;
+ FILE *output = NULL;
+ notmuch_database_t *notmuch = NULL;
notmuch_query_t *query;
- notmuch_results_t *results;
+ notmuch_message_results_t *results;
notmuch_message_t *message;
notmuch_tags_t *tags;
int ret = 0;
notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID);
- for (results = notmuch_query_search (query);
- notmuch_results_has_more (results);
- notmuch_results_advance (results))
+ for (results = notmuch_query_search_messages (query);
+ notmuch_message_results_has_more (results);
+ notmuch_message_results_advance (results))
{
int first = 1;
- message = notmuch_results_get (results);
+ message = notmuch_message_results_get (results);
fprintf (output,
"%s (", notmuch_message_get_message_id (message));
DONE:
if (notmuch)
notmuch_database_close (notmuch);
- if (output != stdout)
+ if (output && output != stdout)
fclose (output);
return ret;
}
-int
+static int
restore_command (int argc, char *argv[])
{
- FILE *input;
- notmuch_database_t *notmuch;
+ FILE *input = NULL;
+ notmuch_database_t *notmuch = NULL;
char *line = NULL;
- size_t line_size, line_len;
+ size_t line_size;
+ ssize_t line_len;
regex_t regex;
int rerr;
int ret = 0;
message = notmuch_database_find_message (notmuch, message_id);
if (message == NULL) {
- fprintf (stderr, "Warning: Cannot apply tags to missing message: %s (",
+ fprintf (stderr, "Warning: Cannot apply tags to missing message: %s\n",
message_id);
+ goto NEXT_LINE;
}
+ notmuch_message_freeze (message);
+
+ notmuch_message_remove_all_tags (message);
+
next = tags;
while (next) {
tag = strsep (&next, " ");
if (*tag == '\0')
continue;
- if (message) {
- status = notmuch_message_add_tag (message, tag);
- if (status) {
- fprintf (stderr,
- "Error applying tag %s to message %s:\n",
- tag, message_id);
- fprintf (stderr, "%s\n",
- notmuch_status_to_string (status));
- }
- } else {
- fprintf (stderr, "%s ", tag);
+ status = notmuch_message_add_tag (message, tag);
+ if (status) {
+ fprintf (stderr,
+ "Error applying tag %s to message %s:\n",
+ tag, message_id);
+ fprintf (stderr, "%s\n",
+ notmuch_status_to_string (status));
}
}
- if (message)
- notmuch_message_destroy (message);
- else
- fprintf (stderr, ")\n");
+ notmuch_message_thaw (message);
+ notmuch_message_destroy (message);
}
+ NEXT_LINE:
free (message_id);
free (tags);
}
free (line);
if (notmuch)
notmuch_database_close (notmuch);
+ if (input && input != stdin)
+ fclose (input);
return ret;
}
+static int
+help_command (int argc, char *argv[]);
+
command_t commands[] = {
{ "setup", setup_command,
- "Interactively setup notmuch for first use.\n"
+ "Interactively setup notmuch for first use.",
"\t\tInvoking notmuch with no command argument will run setup if\n"
"\t\tthe setup command has not previously been completed." },
{ "new", new_command,
- "Find and import any new messages."},
+ "Find and import any new messages.",
+ "\t\tScans all sub-directories of the database, adding new messages\n"
+ "\t\tthat are found. Each new message will be tagges as both\n"
+ "\t\t\"inbox\" and \"unread\".\n"
+ "\n"
+ "\t\tNote: \"notmuch new\" will skip any read-only directories,\n"
+ "\t\tso you can use that to mark tdirectories that will not\n"
+ "\t\treceive any new mail (and make \"notmuch new\" faster)." },
{ "search", search_command,
"<search-term> [...]\n\n"
- "\t\tSearch for threads matching the given search terms.\n"
+ "\t\tSearch for threads matching the given search terms.",
"\t\tOnce we actually implement search we'll document the\n"
"\t\tsyntax here." },
{ "show", show_command,
"<thread-id>\n\n"
- "\t\tShow the thread with the given thread ID (see 'search')." },
+ "\t\tShow the thread with the given thread ID (see 'search').",
+ "" },
+ { "tag", tag_command,
+ "+<tag>|-<tag> [...] [--] <search-term> [...]\n\n"
+ "\t\tAdd/remove tags for all messages matching the search terms.",
+ "\t\tThe search terms are handled texactly as in 'search' so one\n"
+ "\t\tcan use that command first to see what will be modified.\n\n"
+ "\t\tTags prefixed by '+' are added while those prefixed by '-' are\n"
+ "\t\tremoved. For each message, tag removal is before tag addition.\n\n"
+ "\t\tThe beginning of <search-terms> is recognized by the first\n"
+ "\t\targument that begins with neither '+' nor '-'. Support for\n"
+ "\t\tan initial search term beginning with '+' or '-' is provided\n"
+ "\t\tby allowing the user to specify a \"--\" argument to separate\n"
+ "\t\tthe tags from the search terms." },
{ "dump", dump_command,
"[<filename>]\n\n"
- "\t\tCreate a plain-text dump of the tags for each message\n"
- "\t\twriting to the given filename, if any, or to stdout.\n"
+ "\t\tCreate a plain-text dump of the tags for each message.",
+ "\t\tOutput is to the given filename, if any, or to stdout.\n"
"\t\tThese tags are the only data in the notmuch database\n"
"\t\tthat can't be recreated from the messages themselves.\n"
"\t\tThe output of notmuch dump is therefore the only\n"
"\t\tincremental backup than the native database files." },
{ "restore", restore_command,
"<filename>\n\n"
- "\t\tRestore the tags from the given dump file (see 'dump')." }
+ "\t\tRestore the tags from the given dump file (see 'dump').",
+ "" },
+ { "help", help_command,
+ "[<command>]\n\n"
+ "\t\tThis message, or more detailed help for the named command.",
+ "" }
};
-void
+static void
usage (void)
{
command_t *command;
- int i;
+ unsigned int i;
fprintf (stderr, "Usage: notmuch <command> [args...]\n");
fprintf (stderr, "\n");
for (i = 0; i < ARRAY_SIZE (commands); i++) {
command = &commands[i];
- fprintf (stderr, "\t%s\t%s\n\n", command->name, command->usage);
+ fprintf (stderr, "\t%s\t%s\n\n", command->name, command->summary);
+ }
+
+ fprintf (stderr, "Use \"notmuch help <command>\" for more details on each command.\n\n");
+}
+
+static int
+help_command (int argc, char *argv[])
+{
+ command_t *command;
+ unsigned int i;
+
+ if (argc == 0) {
+ fprintf (stderr, "The notmuch mail system.\n\n");
+ usage ();
+ return 0;
+ }
+
+ for (i = 0; i < ARRAY_SIZE (commands); i++) {
+ command = &commands[i];
+
+ if (strcmp (argv[0], command->name) == 0) {
+ fprintf (stderr, "Help for \"notmuch %s\":\n\n", argv[0]);
+ fprintf (stderr, "\t%s\t%s\n\n%s\n\n", command->name,
+ command->summary, command->documentation);
+ return 0;
+ }
}
+
+ fprintf (stderr,
+ "\nSorry, %s is not a known command. There's not much I can do to help.\n\n",
+ argv[0]);
+ return 1;
}
int
main (int argc, char *argv[])
{
command_t *command;
- int i;
+ unsigned int i;
if (argc == 1)
return setup_command (0, NULL);
/* Don't complain about "help" being an unknown command when we're
about to provide exactly what's wanted anyway. */
- if (strcmp (argv[1], "help") == 0 ||
- strcmp (argv[1], "--help") == 0)
- {
- fprintf (stderr, "The notmuch mail system.\n\n");
- } else {
- fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);
- }
+ fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]);
usage ();
- exit (1);
- return 0;
+ return 1;
}
projects / notmuch / blobdiff