X-Git-Url: https://git.notmuchmail.org/git?p=notmuch;a=blobdiff_plain;f=notmuch.c;h=279d21a58013be7cff1e5547d42addd35034e3f8;hp=5853fe55fe0f3b6c9d2a8f842a72809269298e97;hb=edd37e68a96ada9187976dd0421b3f545fffbf78;hpb=c5eea2b77ef3fb90c8ddcb953f1086ba5bb123f3

diff --git a/notmuch.c b/notmuch.c
index 5853fe55..279d21a5 100644
--- a/notmuch.c
+++ b/notmuch.c
@@ -18,19 +18,30 @@
  * Author: Carl Worth <cworth@cworth.org>
  */
 
+#ifndef _GNU_SOURCE
+#define _GNU_SOURCE /* for getline */
+#endif
+#include <stdio.h>
+
 #include "notmuch.h"
 
-#include <stdio.h>
-#include <stdlib.h>
+/* 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 <stddef.h>
 #include <string.h>
-#include <sys/types.h>
 #include <sys/stat.h>
 #include <sys/time.h>
 #include <unistd.h>
 #include <dirent.h>
 #include <errno.h>
 
-#include <glib.h> /* GIOChannel */
+#include <talloc.h>
+
+#include <glib.h> /* g_strdup_printf */
 
 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
 
@@ -42,50 +53,19 @@ 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)
-{
-    char *result = NULL;
-    GError *error = NULL;
-    GIOStatus g_io_status;
-    gsize length;
-
-    GIOChannel *channel = g_io_channel_unix_new (fileno (stdin));
-
-    g_io_status = g_io_channel_read_line (channel, &result,
-					  &length, NULL, &error);
-
-    if (g_io_status == EOF)
-	goto DONE;
-
-    if (g_io_status != G_IO_STATUS_NORMAL) {
-	fprintf(stderr, "Read error: %s\n", error->message);
-	exit (1);
-    }
-
-    if (length && result[length - 1] == '\n')
-	result[length - 1] = '\0';
-
-  DONE:
-    g_io_channel_unref (channel);
-    return result;
-}
-
 typedef struct {
-    int messages_total;
+    int total_messages;
     int count;
-    int count_last;
     struct timeval tv_start;
-    struct timeval tv_last;
 } add_files_state_t;
 
+static void
+chomp_newline (char *str)
+{
+    if (str && str[strlen(str)-1] == '\n')
+	str[strlen(str)-1] = '\0';
+}
+
 /* Compute the number of seconds elapsed from start to end. */
 double
 tv_elapsed (struct timeval start, struct timeval end)
@@ -102,47 +82,37 @@ print_formatted_seconds (double seconds)
 
     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 ("%02ds", (int) seconds);
 }
 
 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->count) / 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 ("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);
-
-    state->tv_last = tv_now;
-    state->count_last = state->count;
 }
 
 /* Recursively find all regular files in 'path' and add them to the
@@ -157,6 +127,7 @@ add_files (notmuch_database_t *notmuch, const char *path,
     int err;
     char *next;
     struct stat st;
+    notmuch_status_t status;
 
     dir = opendir (path);
 
@@ -199,8 +170,13 @@ add_files (notmuch_database_t *notmuch, const char *path,
 	stat (next, &st);
 
 	if (S_ISREG (st.st_mode)) {
-	    notmuch_database_add_message (notmuch, next);
-	    state->count++;
+	    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)) {
@@ -291,10 +267,12 @@ int
 setup_command (int argc, char *argv[])
 {
     notmuch_database_t *notmuch;
-    char *mail_directory;
+    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");
 
@@ -304,9 +282,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"
@@ -314,25 +293,35 @@ 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);
+    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);
@@ -353,17 +342,15 @@ 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.total_messages = count;
     add_files_state.count = 0;
-    add_files_state.count_last = 0;
     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);
 
-    gettimeofday (&add_files_state.tv_last, NULL);
+    gettimeofday (&tv_now, NULL);
     elapsed = tv_elapsed (add_files_state.tv_start,
-			  add_files_state.tv_last);
+			  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));
@@ -385,19 +372,217 @@ 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[])
+{
+    FILE *input;
+    notmuch_database_t *notmuch = NULL;
+    char *line = NULL;
+    size_t line_size, 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 (&regex,
+	      "^([^ ]+) \\(([^)]*)\\)$",
+	      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 (&regex, 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 (",
+			 message_id);
+	    }
+
+	    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);
+		}
+	    }
+
+	    if (message)
+		notmuch_message_destroy (message);
+	    else
+		fprintf (stderr, ")\n");
+	}
+	free (message_id);
+	free (tags);
+    }
+
+    regfree (&regex);
+
+  DONE:
+    if (line)
+	free (line);
+    if (notmuch)
+	notmuch_database_close (notmuch);
+
+    return ret;
+}
+
 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." },
+      "<search-term> [...]\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')." }
+      "<thread-id>\n\n"
+      "\t\tShow the thread with the given thread ID (see 'search')." },
+    { "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\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,
+      "<filename>\n\n"
+      "\t\tRestore the tags from the given dump file (see 'dump')." }
 };
 
 void
@@ -408,7 +593,7 @@ usage (void)
 
     fprintf (stderr, "Usage: notmuch <command> [args...]\n");
     fprintf (stderr, "\n");
-    fprintf (stderr, "Where <command> is one of the following:\n");
+    fprintf (stderr, "Where <command> and [args...] are as follows:\n");
     fprintf (stderr, "\n");
 
     for (i = 0; i < ARRAY_SIZE (commands); i++) {
@@ -434,7 +619,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);