]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-new.c
add_files_recursive: Separate scanning for directories and files for legibility.
[notmuch] / notmuch-new.c
index 316d26b5c09181859fbb68c996419cf11c6a80b1..f34d4676cbc95c724fbbe93901b80012ff172f2c 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
@@ -33,8 +45,10 @@ static volatile sig_atomic_t interrupted;
 static void
 handle_sigint (unused (int sig))
 {
+    ssize_t ignored;
     static char msg[] = "Stopping...         \n";
-    write(2, msg, sizeof(msg)-1);
+
+    ignored = write(2, msg, sizeof(msg)-1);
     interrupted = 1;
 }
 
@@ -78,22 +92,48 @@ 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)
+ *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
  *
- *   o Ask the database for its timestamp of 'path' (path_dbtime)
+ *   o Ask the database for its timestamp of 'path' (db_mtime)
  *
- *   o If 'path_mtime' > 'path_dbtime'
+ *   o For each sub-directory of path, recursively call into this
+ *     same function.
  *
- *       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 If 'fs_mtime' > 'db_mtime'
  *
- *       o For each sub-directory of path, recursively call into this
- *         same function.
+ *       o For each regular file directly within 'path', call
+ *         add_message to add the file to the database.
  *
- *   o Tell the database to update its time of 'path' to 'path_mtime'
+ *   o Tell the database to update its time of 'path' to 'fs_mtime'
  *
  * The 'struct stat *st' must point to a structure that has already
  * been initialized for 'path' by calling stat().
@@ -101,53 +141,52 @@ static int ino_cmp(const struct dirent **a, const struct dirent **b)
 static notmuch_status_t
 add_files_recursive (notmuch_database_t *notmuch,
                     const char *path,
-                    struct stat *st,
                     add_files_state_t *state)
 {
     DIR *dir = NULL;
     struct dirent *entry = NULL;
     char *next = NULL;
-    time_t path_mtime, path_dbtime;
+    time_t fs_mtime, db_mtime;
     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
     notmuch_message_t *message = NULL;
-    struct dirent **namelist = NULL;
-    int num_entries;
-
-    /* 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 **fs_entries = NULL;
+    int i, num_fs_entries;
+    notmuch_directory_t *directory;
+    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;
     }
 
-    path_mtime = st->st_mtime;
+    fs_mtime = st.st_mtime;
+
+    directory = notmuch_database_get_directory (notmuch, path);
+    db_mtime = notmuch_directory_get_mtime (directory);
 
-    path_dbtime = notmuch_database_get_timestamp (notmuch, path);
-    num_entries = scandir (path, &namelist, 0, ino_cmp);
+    num_fs_entries = scandir (path, &fs_entries, 0, ino_cmp);
 
-    if (num_entries == -1) {
+    if (num_fs_entries == -1) {
        fprintf (stderr, "Error opening directory %s: %s\n",
                 path, strerror (errno));
        ret = NOTMUCH_STATUS_FILE_ERROR;
        goto DONE;
     }
 
-    int i=0;
-
-    while (!interrupted) {
-       if (i == num_entries)
+    /* First, recurse into all sub-directories. */
+    for (i = 0; i < num_fs_entries; i++) {
+       if (interrupted)
            break;
 
-        entry= namelist[i++];
+       entry = fs_entries[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 (entry->d_type != DT_DIR)
            continue;
 
        /* Ignore special directories to avoid infinite recursion.
@@ -157,81 +196,107 @@ 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 (fs_entries, num_fs_entries)) ||
            strcmp (entry->d_name, ".notmuch") ==0)
        {
            continue;
        }
 
        next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
+       status = add_files_recursive (notmuch, next, state);
+       if (status && ret == NOTMUCH_STATUS_SUCCESS)
+           ret = status;
+       talloc_free (next);
+       next = NULL;
+    }
+
+    /* If this directory hasn't been modified since the last
+     * add_files, then we can skip the second pass where we look for
+     * new files in this directory. */
+    if (fs_mtime <= db_mtime)
+       goto DONE;
 
-       if (stat (next, st)) {
-           fprintf (stderr, "Error reading %s: %s\n",
-                    next, strerror (errno));
-           ret = NOTMUCH_STATUS_FILE_ERROR;
+    /* Second, scan the regular files in this directory. */
+    for (i = 0; i < num_fs_entries; i++) {
+       if (interrupted)
+           break;
+
+        entry = fs_entries[i];
+
+       if (entry->d_type != DT_REG)
            continue;
+
+       next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
+
+       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);
        }
 
-       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 (path_dbtime == 0 || st->st_mtime > path_dbtime) {
-               state->processed_files++;
-
-               status = notmuch_database_add_message (notmuch, next, &message);
-               switch (status) {
-                   /* success */
-                   case NOTMUCH_STATUS_SUCCESS:
-                       state->added_messages++;
-                       tag_inbox_and_unread (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 (do_add_files_print_progress) {
-                   do_add_files_print_progress = 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;
+       status = notmuch_database_add_message (notmuch, next, &message);
+       switch (status) {
+       /* success */
+       case NOTMUCH_STATUS_SUCCESS:
+           state->added_messages++;
+           tag_inbox_and_unread (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_READONLY_DATABASE:
+       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 (do_add_files_print_progress) {
+           do_add_files_print_progress = 0;
+           add_files_print_progress (state);
        }
 
        talloc_free (next);
        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, fs_mtime);
+       if (status && ret == NOTMUCH_STATUS_SUCCESS)
+           ret = status;
+    }
 
   DONE:
     if (next)
@@ -240,8 +305,8 @@ add_files_recursive (notmuch_database_t *notmuch,
        free (entry);
     if (dir)
        closedir (dir);
-    if (namelist)
-       free (namelist);
+    if (fs_entries)
+       free (fs_entries);
 
     return ret;
 }
@@ -249,53 +314,48 @@ 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)
 {
-    struct stat st;
     notmuch_status_t status;
     struct sigaction action;
     struct itimerval timerval;
-
-    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;
+    notmuch_bool_t timer_is_active = FALSE;
+
+    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;
     }
 
-    /* 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);
+    status = add_files_recursive (notmuch, path, state);
 
-    status = add_files_recursive (notmuch, path, &st, state);
+    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);
 
-    /* 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);
+       /* And disable the signal handler. */
+       action.sa_handler = SIG_IGN;
+       sigaction (SIGALRM, &action, NULL);
+    }
 
     return status;
 }
@@ -312,21 +372,21 @@ count_files (const char *path, int *count)
     struct dirent *entry = NULL;
     char *next;
     struct stat st;
-    struct dirent **namelist = NULL;
-    int n_entries = scandir (path, &namelist, 0, ino_cmp);
+    struct dirent **fs_entries = NULL;
+    int num_fs_entries = scandir (path, &fs_entries, 0, ino_cmp);
     int i = 0;
 
-    if (n_entries == -1) {
+    if (num_fs_entries == -1) {
        fprintf (stderr, "Warning: failed to open directory %s: %s\n",
                 path, strerror (errno));
        goto DONE;
     }
 
     while (!interrupted) {
-        if (i == n_entries)
+        if (i == num_fs_entries)
            break;
 
-        entry= namelist[i++];
+        entry = fs_entries[i++];
 
        /* Ignore special directories to avoid infinite recursion.
         * Also ignore the .notmuch directory.
@@ -365,13 +425,12 @@ count_files (const char *path, int *count)
   DONE:
     if (entry)
        free (entry);
-    if (namelist)
-        free (namelist);
+    if (fs_entries)
+        free (fs_entries);
 }
 
 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;
@@ -383,6 +442,19 @@ notmuch_new_command (void *ctx,
     const char *db_path;
     char *dot_notmuch_path;
     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));
@@ -407,12 +479,12 @@ notmuch_new_command (void *ctx,
        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.ignore_read_only_directories = FALSE;
        add_files_state.total_files = count;
     } else {
-       notmuch = notmuch_database_open (db_path);
-       add_files_state.ignore_read_only_directories = TRUE;
+       notmuch = notmuch_database_open (db_path,
+                                        NOTMUCH_DATABASE_MODE_READ_WRITE);
        add_files_state.total_files = 0;
     }
 
@@ -422,7 +494,6 @@ notmuch_new_command (void *ctx,
     talloc_free (dot_notmuch_path);
     dot_notmuch_path = NULL;
 
-    add_files_state.saw_read_only_directory = FALSE;
     add_files_state.processed_files = 0;
     add_files_state.added_messages = 0;
     gettimeofday (&add_files_state.tv_start, NULL);
@@ -445,19 +516,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 directories 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) {