]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-new.c
notmuch new: Avoid updating directory timestamp if interrupted.
[notmuch] / notmuch-new.c
index 7603d3d7b57f0a61236cef9f76afe5e8bd98740e..4adbdc7f60ff4280e7fe2255975afa17bf689a87 100644 (file)
 
 #include "notmuch-client.h"
 
+#include <unistd.h>
+
+typedef struct {
+    int output_is_a_tty;
+    int verbose;
+
+    int total_files;
+    int processed_files;
+    int added_messages;
+    struct timeval tv_start;
+} add_files_state_t;
+
 static volatile sig_atomic_t do_add_files_print_progress = 0;
 
 static void
@@ -28,6 +40,18 @@ handle_sigalrm (unused (int signal))
     do_add_files_print_progress = 1;
 }
 
+static volatile sig_atomic_t interrupted;
+
+static void
+handle_sigint (unused (int sig))
+{
+    ssize_t ignored;
+    static char msg[] = "Stopping...         \n";
+
+    ignored = write(2, msg, sizeof(msg)-1);
+    interrupted = 1;
+}
+
 static void
 tag_inbox_and_unread (notmuch_message_t *message)
 {
@@ -63,6 +87,38 @@ add_files_print_progress (add_files_state_t *state)
     fflush (stdout);
 }
 
+static int ino_cmp(const struct dirent **a, const struct dirent **b)
+{
+    return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
+}
+
+/* Test if the directory looks like a Maildir directory.
+ *
+ * Search through the array of directory entries to see if we can find all
+ * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
+ *
+ * Return 1 if the directory looks like a Maildir and 0 otherwise.
+ */
+static int
+is_maildir (struct dirent **entries, int count)
+{
+    int i, found = 0;
+
+    for (i = 0; i < count; i++) {
+       if (entries[i]->d_type != DT_DIR) continue;
+       if (strcmp(entries[i]->d_name, "new") == 0 ||
+           strcmp(entries[i]->d_name, "cur") == 0 ||
+           strcmp(entries[i]->d_name, "tmp") == 0)
+       {
+           found++;
+           if (found == 3)
+               return 1;
+       }
+    }
+
+    return 0;
+}
+
 /* Examine 'path' recursively as follows:
  *
  *   o Ask the filesystem for the mtime of 'path' (path_mtime)
@@ -90,57 +146,41 @@ add_files_recursive (notmuch_database_t *notmuch,
                     add_files_state_t *state)
 {
     DIR *dir = NULL;
-    struct dirent *e, *entry = NULL;
-    int entry_length;
-    int err;
+    struct dirent *entry = NULL;
     char *next = NULL;
     time_t path_mtime, path_dbtime;
     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
     notmuch_message_t *message = NULL;
-
-    /* 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;
-    }
+    struct dirent **namelist = NULL;
+    int num_entries;
+    notmuch_directory_t *directory;
 
     path_mtime = st->st_mtime;
 
-    path_dbtime = notmuch_database_get_timestamp (notmuch, path);
+    directory = notmuch_database_get_directory (notmuch, path);
+    path_dbtime = notmuch_directory_get_mtime (directory);
 
-    dir = opendir (path);
-    if (dir == NULL) {
+    num_entries = scandir (path, &namelist, 0, ino_cmp);
+
+    if (num_entries == -1) {
        fprintf (stderr, "Error opening directory %s: %s\n",
                 path, strerror (errno));
        ret = NOTMUCH_STATUS_FILE_ERROR;
        goto DONE;
     }
 
-    entry_length = offsetof (struct dirent, d_name) +
-       pathconf (path, _PC_NAME_MAX) + 1;
-    entry = malloc (entry_length);
-
-    while (1) {
-       err = readdir_r (dir, entry, &e);
-       if (err) {
-           fprintf (stderr, "Error reading directory: %s\n",
-                    strerror (errno));
-           ret = NOTMUCH_STATUS_FILE_ERROR;
-           goto DONE;
-       }
+    int i=0;
 
-       if (e == NULL)
+    while (!interrupted) {
+       if (i == num_entries)
            break;
 
+        entry= namelist[i++];
+
        /* 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)
+       if (path_mtime <= path_dbtime && entry->d_type == DT_REG)
            continue;
 
        /* Ignore special directories to avoid infinite recursion.
@@ -150,6 +190,9 @@ add_files_recursive (notmuch_database_t *notmuch,
         * user specify files to be ignored. */
        if (strcmp (entry->d_name, ".") == 0 ||
            strcmp (entry->d_name, "..") == 0 ||
+           (entry->d_type == DT_DIR &&
+            (strcmp (entry->d_name, "tmp") == 0) &&
+            is_maildir (namelist, num_entries)) ||
            strcmp (entry->d_name, ".notmuch") ==0)
        {
            continue;
@@ -158,18 +201,42 @@ add_files_recursive (notmuch_database_t *notmuch,
        next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
 
        if (stat (next, st)) {
+           int err = errno;
+
+           switch (err) {
+           case ENOENT:
+               /* The file was removed between scandir and now... */
+           case EPERM:
+           case EACCES:
+               /* We can't read this file so don't add it to the cache. */
+               continue;
+           }
+
            fprintf (stderr, "Error reading %s: %s\n",
                     next, strerror (errno));
            ret = NOTMUCH_STATUS_FILE_ERROR;
-           continue;
+           goto DONE;
        }
 
        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) {
+           if (path_dbtime == 0 || st->st_mtime > path_dbtime) {
                state->processed_files++;
 
+               if (state->verbose) {
+                   if (state->output_is_a_tty)
+                       printf("\r\033[K");
+
+                   printf ("%i/%i: %s",
+                           state->processed_files,
+                           state->total_files,
+                           next);
+
+                   putchar((state->output_is_a_tty) ? '\r' : '\n');
+                   fflush (stdout);
+               }
+
                status = notmuch_database_add_message (notmuch, next, &message);
                switch (status) {
                    /* success */
@@ -186,6 +253,7 @@ add_files_recursive (notmuch_database_t *notmuch,
                                 next);
                        break;
                    /* Fatal issues. Don't process anymore. */
+                   case NOTMUCH_STATUS_READONLY_DATABASE:
                    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
                    case NOTMUCH_STATUS_OUT_OF_MEMORY:
                        fprintf (stderr, "Error: %s. Halting processing.\n",
@@ -222,9 +290,11 @@ add_files_recursive (notmuch_database_t *notmuch,
        next = NULL;
     }
 
-    status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
-    if (status && ret == NOTMUCH_STATUS_SUCCESS)
-       ret = status;
+    if (! interrupted) {
+       status = notmuch_directory_set_mtime (directory, path_mtime);
+       if (status && ret == NOTMUCH_STATUS_SUCCESS)
+           ret = status;
+    }
 
   DONE:
     if (next)
@@ -233,6 +303,8 @@ add_files_recursive (notmuch_database_t *notmuch,
        free (entry);
     if (dir)
        closedir (dir);
+    if (namelist)
+       free (namelist);
 
     return ret;
 }
@@ -240,7 +312,7 @@ add_files_recursive (notmuch_database_t *notmuch,
 /* This is the top-level entry point for add_files. It does a couple
  * of error checks, sets up the progress-printing timer and then calls
  * into the recursive function. */
-notmuch_status_t
+static notmuch_status_t
 add_files (notmuch_database_t *notmuch,
           const char *path,
           add_files_state_t *state)
@@ -249,6 +321,7 @@ add_files (notmuch_database_t *notmuch,
     notmuch_status_t status;
     struct sigaction action;
     struct itimerval timerval;
+    notmuch_bool_t timer_is_active = FALSE;
 
     if (stat (path, &st)) {
        fprintf (stderr, "Error reading directory %s: %s\n",
@@ -261,76 +334,70 @@ add_files (notmuch_database_t *notmuch,
        return NOTMUCH_STATUS_FILE_ERROR;
     }
 
-    /* Setup our handler for SIGALRM */
-    memset (&action, 0, sizeof (struct sigaction));
-    action.sa_handler = handle_sigalrm;
-    sigemptyset (&action.sa_mask);
-    action.sa_flags = SA_RESTART;
-    sigaction (SIGALRM, &action, NULL);
-
-    /* Then start a timer to send SIGALRM once per second. */
-    timerval.it_interval.tv_sec = 1;
-    timerval.it_interval.tv_usec = 0;
-    timerval.it_value.tv_sec = 1;
-    timerval.it_value.tv_usec = 0;
-    setitimer (ITIMER_REAL, &timerval, NULL);
+    if (state->output_is_a_tty && ! debugger_is_active () && ! state->verbose) {
+       /* Setup our handler for SIGALRM */
+       memset (&action, 0, sizeof (struct sigaction));
+       action.sa_handler = handle_sigalrm;
+       sigemptyset (&action.sa_mask);
+       action.sa_flags = SA_RESTART;
+       sigaction (SIGALRM, &action, NULL);
+
+       /* Then start a timer to send SIGALRM once per second. */
+       timerval.it_interval.tv_sec = 1;
+       timerval.it_interval.tv_usec = 0;
+       timerval.it_value.tv_sec = 1;
+       timerval.it_value.tv_usec = 0;
+       setitimer (ITIMER_REAL, &timerval, NULL);
+
+       timer_is_active = TRUE;
+    }
 
     status = add_files_recursive (notmuch, path, &st, state);
 
-    /* Now stop the timer. */
-    timerval.it_interval.tv_sec = 0;
-    timerval.it_interval.tv_usec = 0;
-    timerval.it_value.tv_sec = 0;
-    timerval.it_value.tv_usec = 0;
-    setitimer (ITIMER_REAL, &timerval, NULL);
-
-    /* And disable the signal handler. */
-    action.sa_handler = SIG_IGN;
-    sigaction (SIGALRM, &action, NULL);
+    if (timer_is_active) {
+       /* Now stop the timer. */
+       timerval.it_interval.tv_sec = 0;
+       timerval.it_interval.tv_usec = 0;
+       timerval.it_value.tv_sec = 0;
+       timerval.it_value.tv_usec = 0;
+       setitimer (ITIMER_REAL, &timerval, NULL);
+
+       /* And disable the signal handler. */
+       action.sa_handler = SIG_IGN;
+       sigaction (SIGALRM, &action, NULL);
+    }
 
     return status;
 }
 
 /* XXX: This should be merged with the add_files function since it
  * shares a lot of logic with it. */
-/* Recursively count all regular files in path and all sub-direcotries
+/* Recursively count all regular files in path and all sub-directories
  * of path.  The result is added to *count (which should be
  * initialized to zero by the top-level caller before calling
  * count_files). */
 static void
 count_files (const char *path, int *count)
 {
-    DIR *dir;
-    struct dirent *e, *entry = NULL;
-    int entry_length;
-    int err;
+    struct dirent *entry = NULL;
     char *next;
     struct stat st;
+    struct dirent **namelist = NULL;
+    int n_entries = scandir (path, &namelist, 0, ino_cmp);
+    int i = 0;
 
-    dir = opendir (path);
-
-    if (dir == NULL) {
+    if (n_entries == -1) {
        fprintf (stderr, "Warning: failed to open directory %s: %s\n",
                 path, strerror (errno));
        goto DONE;
     }
 
-    entry_length = offsetof (struct dirent, d_name) +
-       pathconf (path, _PC_NAME_MAX) + 1;
-    entry = malloc (entry_length);
-
-    while (1) {
-       err = readdir_r (dir, entry, &e);
-       if (err) {
-           fprintf (stderr, "Error reading directory: %s\n",
-                    strerror (errno));
-           free (entry);
-           goto DONE;
-       }
-
-       if (e == NULL)
+    while (!interrupted) {
+        if (i == n_entries)
            break;
 
+        entry= namelist[i++];
+
        /* Ignore special directories to avoid infinite recursion.
         * Also ignore the .notmuch directory.
         */
@@ -368,13 +435,12 @@ count_files (const char *path, int *count)
   DONE:
     if (entry)
        free (entry);
-
-    closedir (dir);
+    if (namelist)
+        free (namelist);
 }
 
 int
-notmuch_new_command (void *ctx,
-                    unused (int argc), unused (char *argv[]))
+notmuch_new_command (void *ctx, int argc, char *argv[])
 {
     notmuch_config_t *config;
     notmuch_database_t *notmuch;
@@ -385,7 +451,27 @@ notmuch_new_command (void *ctx,
     struct stat st;
     const char *db_path;
     char *dot_notmuch_path;
-    int new_database = 0;
+    struct sigaction action;
+    int i;
+
+    add_files_state.verbose = 0;
+    add_files_state.output_is_a_tty = isatty (fileno (stdout));
+
+    for (i = 0; i < argc && argv[i][0] == '-'; i++) {
+       if (STRNCMP_LITERAL (argv[i], "--verbose") == 0) {
+           add_files_state.verbose = 1;
+       } else {
+           fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
+           return 1;
+       }
+    }
+
+    /* Setup our handler for SIGINT */
+    memset (&action, 0, sizeof (struct sigaction));
+    action.sa_handler = handle_sigint;
+    sigemptyset (&action.sa_mask);
+    action.sa_flags = SA_RESTART;
+    sigaction (SIGINT, &action, NULL);
 
     config = notmuch_config_open (ctx, NULL, NULL);
     if (config == NULL)
@@ -396,10 +482,20 @@ notmuch_new_command (void *ctx,
     dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
 
     if (stat (dot_notmuch_path, &st)) {
-       new_database = 1;
+       int count;
+
+       count = 0;
+       count_files (db_path, &count);
+       if (interrupted)
+           return 1;
+
+       printf ("Found %d total files (that's not much mail).\n", count);
        notmuch = notmuch_database_create (db_path);
+       add_files_state.total_files = count;
     } else {
-       notmuch = notmuch_database_open (db_path);
+       notmuch = notmuch_database_open (db_path,
+                                        NOTMUCH_DATABASE_MODE_READ_WRITE);
+       add_files_state.total_files = 0;
     }
 
     if (notmuch == NULL)
@@ -408,18 +504,6 @@ notmuch_new_command (void *ctx,
     talloc_free (dot_notmuch_path);
     dot_notmuch_path = NULL;
 
-    if (new_database) {
-       int count;
-       count_files (db_path, &count);
-       add_files_state.ignore_read_only_directories = FALSE;
-       add_files_state.total_files = count;
-    } else {
-       add_files_state.ignore_read_only_directories = TRUE;
-       add_files_state.total_files = 0;
-    }
-
-    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;
     gettimeofday (&add_files_state.tv_start, NULL);
@@ -442,19 +526,12 @@ notmuch_new_command (void *ctx,
        }
     }
     if (add_files_state.added_messages) {
-       printf ("Added %d new %s to the database (not much, really).\n",
+       printf ("Added %d new %s to the database.\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");
+       printf ("No new mail.\n");
     }
 
     if (ret) {
@@ -464,5 +541,5 @@ notmuch_new_command (void *ctx,
 
     notmuch_database_close (notmuch);
 
-    return ret;
+    return ret || interrupted;
 }