X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=d76425213dba3ffc6d76f4da66081d19e503887c;hp=73d9a9acf2483e711415ba4330a977d5c9688882;hb=2afd95bfc2ef2241f7ef80b592c349aac67a28d1;hpb=36640b303ea68ae28e89f27694356141f515819b diff --git a/notmuch.c b/notmuch.c index 73d9a9ac..d7642521 100644 --- a/notmuch.c +++ b/notmuch.c @@ -18,16 +18,26 @@ * Author: Carl Worth */ +#include "notmuch.h" + +#ifndef _GNU_SOURCE +#define _GNU_SOURCE /* for getline */ +#endif + #include #include +#include #include #include #include +#include #include #include #include -#include +#include + +#include /* g_strdup_printf */ #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0])) @@ -39,40 +49,135 @@ typedef struct command { const char *usage; } 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) +typedef struct { + int total_messages; + int count; + struct timeval tv_start; +} add_files_state_t; + +/* Compute the number of seconds elapsed from start to end. */ +double +tv_elapsed (struct timeval start, struct timeval end) { - char *result = NULL; - GError *error = NULL; - GIOStatus g_io_status; - gsize length; + return ((end.tv_sec - start.tv_sec) + + (end.tv_usec - start.tv_usec) / 1e6); +} - GIOChannel *channel = g_io_channel_unix_new (fileno (stdin)); +void +print_formatted_seconds (double seconds) +{ + int hours; + int minutes; - g_io_status = g_io_channel_read_line (channel, &result, - &length, NULL, &error); + if (seconds > 3600) { + hours = (int) seconds / 3600; + printf ("%dh ", hours); + seconds -= hours * 3600; + } - if (g_io_status == EOF) - goto DONE; + if (seconds > 60) { + minutes = (int) seconds / 60; + printf ("%dm ", minutes); + seconds -= minutes * 60; + } + + printf ("%02ds", (int) seconds); +} - if (g_io_status != G_IO_STATUS_NORMAL) { - fprintf(stderr, "Read error: %s\n", error->message); - exit (1); +void +add_files_print_progress (add_files_state_t *state) +{ + struct timeval tv_now; + double elapsed_overall, rate_overall; + + gettimeofday (&tv_now, NULL); + + elapsed_overall = tv_elapsed (state->tv_start, tv_now); + rate_overall = (state->count) / elapsed_overall; + + printf ("Added %d of %d messages (", + state->count, state->total_messages); + print_formatted_seconds ((state->total_messages - state->count) / + rate_overall); + printf (" remaining). \r"); + + 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) +{ + DIR *dir; + struct dirent *entry, *e; + int entry_length; + int err; + char *next; + struct stat st; + notmuch_status_t status; + + dir = opendir (path); + + if (dir == NULL) { + fprintf (stderr, "Warning: failed to open directory %s: %s\n", + path, strerror (errno)); + return; } - if (length && result[length - 1] == '\n') - result[length - 1] = '\0'; + entry_length = offsetof (struct dirent, d_name) + + pathconf (path, _PC_NAME_MAX) + 1; + entry = malloc (entry_length); - DONE: - g_io_channel_unref (channel); - return result; + while (1) { + err = readdir_r (dir, entry, &e); + if (err) { + fprintf (stderr, "Error reading directory: %s\n", + strerror (errno)); + free (entry); + return; + } + + if (e == NULL) + break; + + /* 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, ".notmuch") ==0) + { + continue; + } + + next = g_strdup_printf ("%s/%s", path, entry->d_name); + + stat (next, &st); + + if (S_ISREG (st.st_mode)) { + status = notmuch_database_add_message (notmuch, next); + if (status == NOTMUCH_STATUS_FILE_NOT_EMAIL) { + fprintf (stderr, "Note: Ignoring non-mail file: %s\n", + next); + } else { + state->count++; + } + if (state->count % 1000 == 0) + add_files_print_progress (state); + } else if (S_ISDIR (st.st_mode)) { + add_files (notmuch, next, state); + } + + free (next); + } + + free (entry); + + closedir (dir); } /* Recursively count all regular files in path and all sub-direcotries @@ -113,9 +218,14 @@ count_files (const char *path, int *count) 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; } @@ -124,14 +234,14 @@ count_files (const char *path, int *count) stat (next, &st); - if (S_ISREG (st.st_mode)) + if (S_ISREG (st.st_mode)) { *count = *count + 1; - else if (S_ISDIR (st.st_mode)) + if (*count % 1000 == 0) { + printf ("Found %d files so far.\r", *count); + fflush (stdout); + } + } else if (S_ISDIR (st.st_mode)) { count_files (next, count); - - if (*count % 1000 == 0) { - printf ("Found %d files so far.\r", *count); - fflush (stdout); } free (next); @@ -145,8 +255,13 @@ count_files (const char *path, int *count) int setup_command (int argc, char *argv[]) { - char *mail_directory; + notmuch_database_t *notmuch; + char *mail_directory, *default_path; + size_t line_size; int count; + add_files_state_t add_files_state; + double elapsed; + struct timeval tv_now; printf ("Welcome to notmuch!\n\n"); @@ -156,9 +271,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" @@ -166,25 +282,47 @@ 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 (); + mail_directory = NULL; + getline (&mail_directory, &line_size, stdin); + printf ("\n"); - if (mail_directory == NULL || strlen (mail_directory) == 0) { - char *home; + if (mail_directory && + mail_directory[strlen(mail_directory)-1] == '\n') + { + mail_directory[strlen(mail_directory)-1] = '\0'; + } + 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"); } + free (default_path); + } - mail_directory = g_strdup_printf ("%s/mail", home); + 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; } printf ("OK. Let's take a look at the mail we can find in the directory\n"); @@ -193,7 +331,24 @@ setup_command (int argc, char *argv[]) count = 0; count_files (mail_directory, &count); - printf ("Found %d total files. That's not much mail.\n", count); + printf ("Found %d total files. That's not much mail.\n\n", count); + + printf ("Next, we'll inspect the messages and create a database of threads:\n"); + + add_files_state.total_messages = count; + add_files_state.count = 0; + gettimeofday (&add_files_state.tv_start, NULL); + + add_files (notmuch, mail_directory, &add_files_state); + + gettimeofday (&tv_now, NULL); + elapsed = tv_elapsed (add_files_state.tv_start, + tv_now); + printf ("Added %d total messages in ", add_files_state.count); + print_formatted_seconds (elapsed); + printf (" (%d messages/sec.). \n", (int) (add_files_state.count / elapsed)); + + notmuch_database_close (notmuch); free (mail_directory); @@ -210,19 +365,118 @@ search_command (int argc, char *argv[]) int show_command (int argc, char *argv[]) { - fprintf (stderr, "Error: show-thread is not implemented yet.\n"); + fprintf (stderr, "Error: show is not implemented yet.\n"); + return 1; +} + +int +dump_command (int argc, char *argv[]) +{ + FILE *output; + notmuch_database_t *notmuch = NULL; + notmuch_query_t *query; + notmuch_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 (query); + notmuch_results_has_more (results); + notmuch_results_advance (results)) + { + int first = 1; + message = notmuch_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 != stdout) + fclose (output); + + return ret; +} + +int +restore_command (int argc, char *argv[]) +{ + fprintf (stderr, "Error: restore is not implemented yet.\n"); return 1; } command_t commands[] = { { "setup", setup_command, - "Interactively setup notmuch for first use (no arguments).\n" + "Interactively setup notmuch for first use.\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." }, { "search", search_command, - "Search for threads matching the given search terms." }, + " [...]\n\n" + "\t\tSearch for threads matching the given search terms.\n" + "\t\tOnce we actually implement search we'll document the\n" + "\t\tsyntax here." }, { "show", show_command, - "Show the thread with the given thread ID (see 'search')." } + "\n\n" + "\t\tShow the thread with the given thread ID (see 'search')." }, + { "dump", dump_command, + "[]\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\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')." } }; void @@ -233,7 +487,7 @@ usage (void) 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++) { @@ -259,7 +513,15 @@ main (int argc, char *argv[]) return (command->function) (argc - 2, &argv[2]); } - fprintf (stderr, "Error: Unknown command '%s'\n\n", argv[1]); + /* 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]); + } usage (); exit (1);