X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=1f5898949cac9153158bd227dcc3f0023a3c99d3;hp=25aa6c5f402a532b5558c928bdd2e40d107940da;hb=df959868d9fc4f78682da3363d15685d69d2353b;hpb=10c176ba0e6d71e920b72a3165c0e56f26b5e4b3 diff --git a/notmuch.c b/notmuch.c index 25aa6c5f..1f589894 100644 --- a/notmuch.c +++ b/notmuch.c @@ -18,19 +18,44 @@ * Author: Carl Worth */ +#ifndef _GNU_SOURCE +#define _GNU_SOURCE /* for getline */ +#endif +#include + #include "notmuch.h" -#include -#include +/* This is separate from notmuch-private.h because we're trying to + * keep notmuch.c from looking into any internals, (which helps us + * develop notmuch.h into a plausible library interface). + */ +#include "xutil.h" + +#include #include -#include #include #include #include #include #include -#include +#include + +#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])) @@ -39,131 +64,146 @@ typedef int (*command_function_t) (int argc, char *argv[]); typedef struct command { const char *name; command_function_t function; - const char *usage; + const char *summary; + const char *documentation; } command_t; -/* Read a line from stdin, without any line-terminator character. The - * return value is a newly allocated string. The caller should free() - * the string when finished with it. - * - * This function returns NULL if EOF is encountered before any - * characters are input (otherwise it returns those characters). - */ -char * -read_line (void) -{ - char *result = NULL; - GError *error = NULL; - GIOStatus g_io_status; - gsize length; - - GIOChannel *channel = g_io_channel_unix_new (fileno (stdin)); +typedef void (*add_files_callback_t) (notmuch_message_t *message); - g_io_status = g_io_channel_read_line (channel, &result, - &length, NULL, &error); - - if (g_io_status == EOF) - goto DONE; +typedef struct { + int ignore_read_only_directories; + int saw_read_only_directory; - if (g_io_status != G_IO_STATUS_NORMAL) { - fprintf(stderr, "Read error: %s\n", error->message); - exit (1); - } + int total_files; + int processed_files; + int added_messages; + struct timeval tv_start; - if (length && result[length - 1] == '\n') - result[length - 1] = '\0'; + add_files_callback_t callback; +} add_files_state_t; - DONE: - g_io_channel_unref (channel); - return result; +static void +chomp_newline (char *str) +{ + if (str && str[strlen(str)-1] == '\n') + str[strlen(str)-1] = '\0'; } -typedef struct { - int messages_total; - int count; - int count_last; - struct timeval tv_start; - struct timeval tv_last; -} add_files_state_t; - /* 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; int minutes; + if (seconds < 1) { + printf ("almost no time"); + return; + } + if (seconds > 3600) { hours = (int) seconds / 3600; - printf ("%d:", hours); + printf ("%dh ", hours); seconds -= hours * 3600; } - if (seconds > 60) + if (seconds > 60) { minutes = (int) seconds / 60; - else - minutes = 0; - - printf ("%02d:", minutes); - seconds -= minutes * 60; + printf ("%dm ", minutes); + seconds -= minutes * 60; + } - printf ("%02d", (int) seconds); + printf ("%ds", (int) seconds); } -void +static void add_files_print_progress (add_files_state_t *state) { struct timeval tv_now; - double ratio_complete; - double elapsed_current, rate_current; - double elapsed_overall; + double elapsed_overall, rate_overall; gettimeofday (&tv_now, NULL); - ratio_complete = (double) state->count / state->messages_total; - elapsed_current = tv_elapsed (state->tv_last, tv_now); - rate_current = (state->count - state->count_last) / elapsed_current; elapsed_overall = tv_elapsed (state->tv_start, tv_now); + rate_overall = (state->processed_files) / elapsed_overall; - printf ("Added %d messages at %d messages/sec. ", - state->count, (int) rate_current); - print_formatted_seconds (elapsed_overall); - printf ("/"); - print_formatted_seconds (elapsed_overall / ratio_complete); - printf (" elapsed (%.2f%%). \r", 100 * ratio_complete); + printf ("Processed %d", state->processed_files); - fflush (stdout); + if (state->total_files) { + printf (" of %d files (", state->total_files); + print_formatted_seconds ((state->total_files - state->processed_files) / + rate_overall); + printf (" remaining). \r"); + } else { + printf (" files (%d files/sec.) \r", (int) rate_overall); + } - state->tv_last = tv_now; - state->count_last = state->count; + fflush (stdout); } -/* Recursively find all regular files in 'path' and add them to the - * database. */ -void -add_files (notmuch_database_t *notmuch, const char *path, - add_files_state_t *state) +/* Examine 'path' recursively as follows: + * + * o Ask the filesystem for the mtime of 'path' (path_mtime) + * + * o Ask the database for its timestamp of 'path' (path_dbtime) + * + * o If 'path_mtime' > 'path_dbtime' + * + * o For each regular file in 'path' with mtime newer than the + * 'path_dbtime' call add_message to add the file to the + * database. + * + * o For each sub-directory of path, recursively call into this + * same function. + * + * o Tell the database to update its time of 'path' to 'path_mtime' + * + * The 'struct stat *st' must point to a structure that has already + * been initialized for 'path' by calling stat(). + */ +static notmuch_status_t +add_files_recursive (notmuch_database_t *notmuch, + const char *path, + struct stat *st, + add_files_state_t *state) { - DIR *dir; - struct dirent *entry, *e; + DIR *dir = NULL; + struct dirent *e, *entry = NULL; int entry_length; int err; - char *next; - 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; + } - dir = opendir (path); + path_mtime = st->st_mtime; + path_dbtime = notmuch_database_get_timestamp (notmuch, path); + + dir = opendir (path); if (dir == NULL) { - fprintf (stderr, "Warning: failed to open directory %s: %s\n", + fprintf (stderr, "Error opening directory %s: %s\n", path, strerror (errno)); - return; + ret = NOTMUCH_STATUS_FILE_ERROR; + goto DONE; } entry_length = offsetof (struct dirent, d_name) + @@ -175,13 +215,19 @@ add_files (notmuch_database_t *notmuch, const char *path, if (err) { fprintf (stderr, "Error reading directory: %s\n", strerror (errno)); - free (entry); - return; + ret = NOTMUCH_STATUS_FILE_ERROR; + goto DONE; } if (e == NULL) break; + /* If this directory hasn't been modified since the last + * add_files, then we only need to look further for + * sub-directories. */ + if (path_mtime <= path_dbtime && entry->d_type != DT_DIR) + continue; + /* Ignore special directories to avoid infinite recursion. * Also ignore the .notmuch directory. */ @@ -194,36 +240,127 @@ add_files (notmuch_database_t *notmuch, const char *path, continue; } - next = g_strdup_printf ("%s/%s", path, entry->d_name); + next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name); - stat (next, &st); + if (stat (next, st)) { + fprintf (stderr, "Error reading %s: %s\n", + next, strerror (errno)); + ret = NOTMUCH_STATUS_FILE_ERROR; + continue; + } - if (S_ISREG (st.st_mode)) { - notmuch_database_add_message (notmuch, next); - state->count++; - if (state->count % 1000 == 0) - add_files_print_progress (state); - } else if (S_ISDIR (st.st_mode)) { - add_files (notmuch, next, state); + if (S_ISREG (st->st_mode)) { + /* If the file hasn't been modified since the last + * add_files, then we need not look at it. */ + if (st->st_mtime > path_dbtime) { + state->processed_files++; + + 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: + /* Stay silent on this one. */ + break; + case NOTMUCH_STATUS_FILE_NOT_EMAIL: + fprintf (stderr, "Note: Ignoring non-mail file: %s\n", + next); + break; + /* Fatal issues. Don't process anymore. */ + case NOTMUCH_STATUS_XAPIAN_EXCEPTION: + case NOTMUCH_STATUS_OUT_OF_MEMORY: + fprintf (stderr, "Error: %s. Halting processing.\n", + notmuch_status_to_string (status)); + ret = status; + goto DONE; + default: + 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); + } + } else if (S_ISDIR (st->st_mode)) { + status = add_files_recursive (notmuch, next, st, state); + if (status && ret == NOTMUCH_STATUS_SUCCESS) + ret = status; } - free (next); + talloc_free (next); + next = NULL; } - free (entry); + status = notmuch_database_set_timestamp (notmuch, path, path_mtime); + if (status && ret == NOTMUCH_STATUS_SUCCESS) + ret = status; - closedir (dir); + DONE: + if (next) + talloc_free (next); + if (entry) + free (entry); + if (dir) + closedir (dir); + + return ret; +} + +/* This is the top-level entry point for add_files. It does a couple + * of error checks, and then calls into the recursive function, + * (avoiding the repeating of these error checks at every + * level---which would be useless becaues we already do a stat() at + * the level above). */ +static notmuch_status_t +add_files (notmuch_database_t *notmuch, + const char *path, + add_files_state_t *state) +{ + struct stat st; + + if (stat (path, &st)) { + fprintf (stderr, "Error reading directory %s: %s\n", + path, strerror (errno)); + return NOTMUCH_STATUS_FILE_ERROR; + } + + if (! S_ISDIR (st.st_mode)) { + fprintf (stderr, "Error: %s is not a directory.\n", path); + return NOTMUCH_STATUS_FILE_ERROR; + } + + return add_files_recursive (notmuch, path, &st, state); } /* Recursively count all regular files in path and all sub-direcotries * 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; @@ -234,7 +371,7 @@ count_files (const char *path, int *count) 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) + @@ -247,20 +384,30 @@ count_files (const char *path, int *count) fprintf (stderr, "Error reading directory: %s\n", strerror (errno)); free (entry); - return; + goto DONE; } if (e == NULL) break; - /* Skip these special directories to avoid infinite recursion. */ + /* Ignore special directories to avoid infinite recursion. + * Also ignore the .notmuch directory. + */ + /* XXX: Eventually we'll want more sophistication to let the + * user specify files to be ignored. */ if (strcmp (entry->d_name, ".") == 0 || - strcmp (entry->d_name, "..") == 0) + strcmp (entry->d_name, "..") == 0 || + strcmp (entry->d_name, ".notmuch") == 0) { 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); @@ -277,19 +424,24 @@ count_files (const char *path, int *count) 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; - char *mail_directory; + notmuch_database_t *notmuch = NULL; + char *default_path, *mail_directory = NULL; + size_t line_size; int count; add_files_state_t add_files_state; double elapsed; + struct timeval tv_now; + notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS; printf ("Welcome to notmuch!\n\n"); @@ -299,9 +451,10 @@ setup_command (int argc, char *argv[]) printf ("Notmuch needs to know the top-level directory of your email archive,\n" "(where you already have mail stored and where messages will be delivered\n" "in the future). This directory can contain any number of sub-directories\n" - "but the only files it contains should be individual email messages.\n" - "Either maildir or mh format directories are fine, but you will want to\n" - "move away any auxiliary files maintained by other email programs.\n\n"); + "and primarily just files with indvidual email messages (eg. maildir or mh\n" + "archives are perfect). If there are other, non-email files (such as\n" + "indexes maintained by other email programs) then notmuch will do its\n" + "best to detect those and ignore them.\n\n"); printf ("Mail storage that uses mbox format, (where one mbox file contains many\n" "messages), will not work with notmuch. If that's how your mail is currently\n" @@ -309,33 +462,42 @@ setup_command (int argc, char *argv[]) "such as mb2md. In that case, press Control-C now and run notmuch again\n" "once the conversion is complete.\n\n"); - printf ("Top-level mail directory [~/mail]: "); + + default_path = notmuch_database_default_path (); + printf ("Top-level mail directory [%s]: ", default_path); fflush (stdout); - mail_directory = read_line (); + getline (&mail_directory, &line_size, stdin); + chomp_newline (mail_directory); - if (mail_directory == NULL || strlen (mail_directory) == 0) { - char *home; + printf ("\n"); + if (mail_directory == NULL || strlen (mail_directory) == 0) { if (mail_directory) free (mail_directory); - - home = getenv ("HOME"); - if (!home) { - fprintf (stderr, "Error: No mail directory provided HOME environment variable is not set.\n"); - fprintf (stderr, "Cowardly refusing to just guess where your mail might be.\n"); - exit (1); + mail_directory = default_path; + } else { + /* XXX: Instead of telling the user to use an environment + * variable here, we should really be writing out a configuration + * file and loading that on the next run. */ + if (strcmp (mail_directory, default_path)) { + printf ("Note: Since you are not using the default path, you will want to set\n" + "the NOTMUCH_BASE environment variable to %s so that\n" + "future calls to notmuch commands will know where to find your mail.\n", + mail_directory); + printf ("For example, if you are using bash for your shell, add:\n\n"); + printf ("\texport NOTMUCH_BASE=%s\n\n", mail_directory); + printf ("to your ~/.bashrc file.\n\n"); } - - mail_directory = g_strdup_printf ("%s/mail", home); + free (default_path); } notmuch = notmuch_database_create (mail_directory); if (notmuch == NULL) { fprintf (stderr, "Failed to create new notmuch database at %s\n", mail_directory); - free (mail_directory); - return 1; + ret = NOTMUCH_STATUS_FILE_ERROR; + goto DONE; } printf ("OK. Let's take a look at the mail we can find in the directory\n"); @@ -348,76 +510,677 @@ setup_command (int argc, char *argv[]) printf ("Next, we'll inspect the messages and create a database of threads:\n"); - add_files_state.messages_total = count; - add_files_state.count = 0; - add_files_state.count_last = 0; + 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); - add_files_state.tv_last = add_files_state.tv_start; - add_files (notmuch, mail_directory, &add_files_state); + ret = add_files (notmuch, mail_directory, &add_files_state); - gettimeofday (&add_files_state.tv_last, NULL); + gettimeofday (&tv_now, NULL); elapsed = tv_elapsed (add_files_state.tv_start, - add_files_state.tv_last); - printf ("Added %d total messages in ", add_files_state.count); + tv_now); + printf ("Processed %d %s in ", add_files_state.processed_files, + add_files_state.processed_files == 1 ? + "file" : "total files"); print_formatted_seconds (elapsed); - printf (" (%d messages/sec.). \n", (int) (add_files_state.count / elapsed)); + if (elapsed > 1) { + printf (" (%d files/sec.). \n", + (int) (add_files_state.processed_files / elapsed)); + } else { + printf (". \n"); + } + if (add_files_state.added_messages) { + printf ("Added %d %s to the database.\n\n", + add_files_state.added_messages, + add_files_state.added_messages == 1 ? + "message" : "unique messages"); + } - notmuch_database_close (notmuch); + printf ("When new mail is delivered to %s in the future,\n" + "run \"notmuch new\" to add it to the database.\n\n", + mail_directory); - free (mail_directory); - - return 0; + if (ret) { + printf ("Note: At least one error was encountered: %s\n", + notmuch_status_to_string (ret)); + } + + DONE: + if (mail_directory) + free (mail_directory); + if (notmuch) + notmuch_database_close (notmuch); + + return ret; } -int +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; + add_files_state_t add_files_state; + double elapsed; + struct timeval tv_now; + int ret = 0; + + notmuch = notmuch_database_open (NULL); + if (notmuch == NULL) { + ret = 1; + goto DONE; + } + + 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); + + gettimeofday (&tv_now, NULL); + elapsed = tv_elapsed (add_files_state.tv_start, + tv_now); + if (add_files_state.processed_files) { + printf ("Processed %d %s in ", add_files_state.processed_files, + add_files_state.processed_files == 1 ? + "file" : "total files"); + print_formatted_seconds (elapsed); + if (elapsed > 1) { + printf (" (%d files/sec.). \n", + (int) (add_files_state.processed_files / elapsed)); + } else { + printf (". \n"); + } + } + if (add_files_state.added_messages) { + printf ("Added %d new %s to the database (not much, really).\n", + add_files_state.added_messages, + add_files_state.added_messages == 1 ? + "message" : "messages"); + } else { + 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 ("\nNote: At least one error was encountered: %s\n", + notmuch_status_to_string (ret)); + } + + DONE: + if (notmuch) + notmuch_database_close (notmuch); + + return ret; +} + +/* 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-thread is not implemented yet.\n"); + fprintf (stderr, "Error: show is not implemented yet.\n"); return 1; } +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 = NULL; + notmuch_database_t *notmuch = NULL; + notmuch_query_t *query; + notmuch_message_results_t *results; + notmuch_message_t *message; + notmuch_tags_t *tags; + int ret = 0; + + if (argc) { + output = fopen (argv[0], "w"); + if (output == NULL) { + fprintf (stderr, "Error opening %s for writing: %s\n", + argv[0], strerror (errno)); + ret = 1; + goto DONE; + } + } else { + output = stdout; + } + + notmuch = notmuch_database_open (NULL); + if (notmuch == NULL) { + ret = 1; + goto DONE; + } + + query = notmuch_query_create (notmuch, ""); + if (query == NULL) { + fprintf (stderr, "Out of memory\n"); + ret = 1; + goto DONE; + } + + notmuch_query_set_sort (query, NOTMUCH_SORT_MESSAGE_ID); + + for (results = notmuch_query_search_messages (query); + notmuch_message_results_has_more (results); + notmuch_message_results_advance (results)) + { + int first = 1; + message = notmuch_message_results_get (results); + + fprintf (output, + "%s (", notmuch_message_get_message_id (message)); + + for (tags = notmuch_message_get_tags (message); + notmuch_tags_has_more (tags); + notmuch_tags_advance (tags)) + { + if (! first) + fprintf (output, " "); + + fprintf (output, "%s", notmuch_tags_get (tags)); + + first = 0; + } + + fprintf (output, ")\n"); + + notmuch_message_destroy (message); + } + + notmuch_query_destroy (query); + + DONE: + if (notmuch) + notmuch_database_close (notmuch); + if (output && output != stdout) + fclose (output); + + return ret; +} + +static int +restore_command (int argc, char *argv[]) +{ + FILE *input = NULL; + notmuch_database_t *notmuch = NULL; + char *line = NULL; + size_t line_size; + ssize_t line_len; + regex_t regex; + int rerr; + int ret = 0; + + if (argc) { + input = fopen (argv[0], "r"); + if (input == NULL) { + fprintf (stderr, "Error opening %s for reading: %s\n", + argv[0], strerror (errno)); + ret = 1; + goto DONE; + } + } else { + printf ("No filename given. Reading dump from stdin.\n"); + input = stdin; + } + + notmuch = notmuch_database_open (NULL); + if (notmuch == NULL) { + ret = 1; + goto DONE; + } + + /* Dump output is one line per message. We match a sequence of + * non-space characters for the message-id, then one or more + * spaces, then a list of space-separated tags as a sequence of + * characters within literal '(' and ')'. */ + xregcomp (®ex, + "^([^ ]+) \\(([^)]*)\\)$", + REG_EXTENDED); + + while ((line_len = getline (&line, &line_size, input)) != -1) { + regmatch_t match[3]; + char *message_id, *tags, *tag, *next; + notmuch_message_t *message; + notmuch_status_t status; + + chomp_newline (line); + + rerr = xregexec (®ex, line, 3, match, 0); + if (rerr == REG_NOMATCH) + { + fprintf (stderr, "Warning: Ignoring invalid input line: %s\n", + line); + continue; + } + + message_id = xstrndup (line + match[1].rm_so, + match[1].rm_eo - match[1].rm_so); + tags = xstrndup (line + match[2].rm_so, + match[2].rm_eo - match[2].rm_so); + + if (strlen (tags)) { + + message = notmuch_database_find_message (notmuch, message_id); + if (message == NULL) { + 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; + 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)); + } + } + + notmuch_message_thaw (message); + notmuch_message_destroy (message); + } + NEXT_LINE: + free (message_id); + free (tags); + } + + regfree (®ex); + + DONE: + if (line) + 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 (no arguments).\n" + "Interactively setup notmuch for first use.", + "\t\tThe setup command is the first command you will run in order\n" + "\t\tto start using notmuch. It will prompt you for the directory\n" + "\t\tcontaining your email archives, and will then proceed to build\n" + "\t\ta database to allow fast searching of that mail.\n\n" "\t\tInvoking notmuch with no command argument will run setup if\n" - "\t\the setup command has not previously been completed." }, + "\t\tthe setup command has not previously been completed." }, + { "new", new_command, + "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 tagged 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 for threads matching the given search terms." }, + " [...]\n\n" + "\t\tSearch for threads matching the given search terms.", + "\t\tNote that the individual mail messages will be matched\n" + "\t\tagainst the search terms, but the results will be the\n" + "\t\tthreads containing the matched messages.\n\n" + "\t\tCurrently, the supported search terms are as follows, (where\n" + "\t\t indicate user-supplied values):\n\n" + "\t\t\ttag:\n" + "\t\t\tid:\n" + "\t\t\tthread:\n\n" + "\t\tValid tag values include \"inbox\" and \"unread\" by default\n" + "\t\tfor new messages added by \"notmuch new\" as well as any other\n" + "\t\ttag values added manually with \"notmuch tag\".\n\n" + "\t\tMessage ID values are the literal contents of the Message-ID:\n" + "\t\theader of email messages, but without the '<','>' delimiters.\n\n" + "\t\tThread ID values are generated internally by notmuch but can\n" + "\t\tbe seen in the output of \"notmuch search\" for example.\n\n" + "\t\tIn addition to individual terms, multiple terms can be\n" + "\t\tcombined with Boolean operators (\"and\", \"or\", \"not\", etc.).\n" + "\t\tEach term in the query will be implicitly connected by a\n" + "\t\tlogical AND if no explicit operator is provided.\n\n" + "\t\tParentheses can also be used to control the combination of\n" + "\t\tthe Boolean operators, but will have to be protected from\n" + "\t\tinterpretation by the shell, (such as by putting quotation\n" + "\t\tmarks around any parenthesized expression)." }, { "show", show_command, - "Show the thread with the given thread ID (see 'search')." } + "\n\n" + "\t\tNote: The \"notmuch show\" command is not implemented yet.\n\n" + "\t\tShow the thread with the given thread ID (see 'search').", + "\t\tThread ID values are given as the first column in the\n" + "\t\toutput of the \"notmuch search\" command. These are the\n" + "\t\trandom-looking strings of 32 characters." }, + { "tag", tag_command, + "+|- [...] [--] [...]\n\n" + "\t\tAdd/remove tags for all messages matching the search terms.", + "\t\tThe search terms are handled exactly 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 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.\n\n" + "\t\tNote: If you run \"notmuch new\" between reading a thread with\n" + "\t\t\"notmuch show\" and removing the \"inbox\" tag for that thread\n" + "\t\twith \"notmuch tag\" then you create the possibility of moving\n" + "\t\tsome messages from that thread out of your inbox without ever\n" + "\t\treading them. The easiest way to avoid this problem is to not\n" + "\t\trun \"notmuch new\" between reading and removing tags." }, + { "dump", dump_command, + "[]\n\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\tcritical thing to backup (and much more friendly to\n" + "\t\tincremental backup than the native database files.)" }, + { "restore", restore_command, + "\n\n" + "\t\tRestore the tags from the given dump file (see 'dump').", + "\t\tNote: The dump file format is specifically chosen to be\n" + "\t\tcompatible with the format of files produced by sup-dump.\n" + "\t\tSo if you've previously been using sup for mail, then the\n" + "\t\t\"notmuch restore\" command provides you a way to import\n" + "\t\tall of your tags (or labels as sup calls them)." }, + { "help", help_command, + "[]\n\n" + "\t\tThis message, or more detailed help for the named command.", + "\t\tExcept in this case, where there's not much more detailed\n" + "\t\thelp available." } }; -void +static void usage (void) { command_t *command; - int i; + unsigned int i; fprintf (stderr, "Usage: notmuch [args...]\n"); fprintf (stderr, "\n"); - fprintf (stderr, "Where is one of the following:\n"); + fprintf (stderr, "Where and [args...] are as follows:\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 \" 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); @@ -429,9 +1192,10 @@ main (int argc, char *argv[]) return (command->function) (argc - 2, &argv[2]); } + /* Don't complain about "help" being an unknown command when we're + about to provide exactly what's wanted anyway. */ fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]); usage (); - exit (1); - return 0; + return 1; }