]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-new.c
lib: Treat NULL as a valid (and empty) notmuch_filenames_t iterator.
[notmuch] / notmuch-new.c
index 58431b7cabb2c035a4eb55600b2b56e381a10cd9..7d15fe9184183401ab96556ff9f6d7c6168be8c9 100644 (file)
 
 #include <unistd.h>
 
+typedef struct _filename_node {
+    char *filename;
+    struct _filename_node *next;
+} _filename_node_t;
+
+typedef struct _filename_list {
+    _filename_node_t *head;
+    _filename_node_t **tail;
+} _filename_list_t;
+
 typedef struct {
     int output_is_a_tty;
     int verbose;
@@ -30,6 +40,9 @@ typedef struct {
     int processed_files;
     int added_messages;
     struct timeval tv_start;
+
+    _filename_list_t *removed_files;
+    _filename_list_t *removed_directories;
 } add_files_state_t;
 
 static volatile sig_atomic_t do_add_files_print_progress = 0;
@@ -52,6 +65,34 @@ handle_sigint (unused (int sig))
     interrupted = 1;
 }
 
+static _filename_list_t *
+_filename_list_create (const void *ctx)
+{
+    _filename_list_t *list;
+
+    list = talloc (ctx, _filename_list_t);
+    if (list == NULL)
+       return NULL;
+
+    list->head = NULL;
+    list->tail = &list->head;
+
+    return list;
+}
+
+static void
+_filename_list_add (_filename_list_t *list,
+                   const char *filename)
+{
+    _filename_node_t *node = talloc (list, _filename_node_t);
+
+    node->filename = talloc_strdup (list, filename);
+    node->next = NULL;
+
+    *(list->tail) = node;
+    list->tail = &node->next;
+}
+
 static void
 tag_inbox_and_unread (notmuch_message_t *message)
 {
@@ -87,11 +128,18 @@ add_files_print_progress (add_files_state_t *state)
     fflush (stdout);
 }
 
-static int ino_cmp(const struct dirent **a, const struct dirent **b)
+static int
+dirent_sort_inode (const struct dirent **a, const struct dirent **b)
 {
     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
 }
 
+static int
+dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
+{
+    return strcmp ((*a)->d_name, (*b)->d_name);
+}
+
 /* Test if the directory looks like a Maildir directory.
  *
  * Search through the array of directory entries to see if we can find all
@@ -100,12 +148,14 @@ static int ino_cmp(const struct dirent **a, const struct dirent **b)
  * Return 1 if the directory looks like a Maildir and 0 otherwise.
  */
 static int
-is_maildir (struct dirent **entries, int count)
+_entries_resemble_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 (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)
@@ -122,21 +172,37 @@ is_maildir (struct dirent **entries, int count)
 /* Examine 'path' recursively as follows:
  *
  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
- *
  *   o Ask the database for its timestamp of 'path' (db_mtime)
  *
- *   o If 'fs_mtime' > 'db_mtime'
+ *   o Ask the filesystem for files and directories within 'path'
+ *     (via scandir and stored in fs_entries)
+ *   o Ask the database for files and directories within 'path'
+ *     (db_files and db_subdirs)
  *
- *       o For each regular file directly within 'path', call
- *         add_message to add the file to the database.
+ *   o Pass 1: For each directory in fs_entries, recursively call into
+ *     this same function.
  *
- *   o For each sub-directory of path, recursively call into this
- *     same function.
+ *   o Pass 2: If 'fs_mtime' > 'db_mtime', then walk fs_entries
+ *     simultaneously with db_files and db_subdirs. Look for one of
+ *     three interesting cases:
  *
- *   o Tell the database to update its time of 'path' to 'fs_mtime'
+ *        1. Regular file in fs_entries and not in db_files
+ *            This is a new file to add_message into the database.
  *
- * The 'struct stat *st' must point to a structure that has already
- * been initialized for 'path' by calling stat().
+ *         2. Filename in db_files not in fs_entries.
+ *            This is a file that has been removed from the mail store.
+ *
+ *         3. Directory in db_subdirs not in fs_entries
+ *            This is a directory that has been removed from the mail store.
+ *
+ *     Note that the addition of a directory is not interesting here,
+ *     since that will have been taken care of in pass 1. Also, we
+ *     don't immediately act on file/directory removal since we must
+ *     ensure that in the case of a rename that the new filename is
+ *     added before the old filename is removed, (so that no
+ *     information is lost from the database).
+ *
+ *   o Tell the database to update its time of 'path' to 'fs_mtime'
  */
 static notmuch_status_t
 add_files_recursive (notmuch_database_t *notmuch,
@@ -150,9 +216,12 @@ add_files_recursive (notmuch_database_t *notmuch,
     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
     notmuch_message_t *message = NULL;
     struct dirent **fs_entries = NULL;
-    int num_fs_entries;
+    int i, num_fs_entries;
     notmuch_directory_t *directory;
+    notmuch_filenames_t *db_files = NULL;
+    notmuch_filenames_t *db_subdirs = NULL;
     struct stat st;
+    notmuch_bool_t is_maildir;
 
     if (stat (path, &st)) {
        fprintf (stderr, "Error reading directory %s: %s\n",
@@ -160,17 +229,25 @@ add_files_recursive (notmuch_database_t *notmuch,
        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;
-    }
+    /* This is not an error since we may have recursed based on a
+     * symlink to a regular file, not a directory, and we don't know
+     * that until this stat. */
+    if (! S_ISDIR (st.st_mode))
+       return NOTMUCH_STATUS_SUCCESS;
 
     fs_mtime = st.st_mtime;
 
     directory = notmuch_database_get_directory (notmuch, path);
     db_mtime = notmuch_directory_get_mtime (directory);
+    db_files = notmuch_directory_get_child_files (directory);
+    db_subdirs = notmuch_directory_get_child_directories (directory);
 
-    num_fs_entries = scandir (path, &fs_entries, 0, ino_cmp);
+    /* If the database knows about this directory, then we sort based
+     * on strcmp to match the database sorting. Otherwise, we can do
+     * inode-based sorting for faster filesystem operation. */
+    num_fs_entries = scandir (path, &fs_entries, 0,
+                             db_mtime ?
+                             dirent_sort_strcmp_name : dirent_sort_inode);
 
     if (num_fs_entries == -1) {
        fprintf (stderr, "Error opening directory %s: %s\n",
@@ -179,105 +256,203 @@ add_files_recursive (notmuch_database_t *notmuch,
        goto DONE;
     }
 
-    int i=0;
+    /* Pass 1: Recurse into all sub-directories. */
+    is_maildir = _entries_resemble_maildir (fs_entries, num_fs_entries);
 
-    while (!interrupted) {
-       if (i == num_fs_entries)
+    for (i = 0; i < num_fs_entries; i++) {
+       if (interrupted)
            break;
 
-        entry = fs_entries[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 (fs_mtime <= db_mtime && entry->d_type == DT_REG)
+       if (entry->d_type != DT_DIR && entry->d_type != DT_LNK)
            continue;
 
        /* Ignore special directories to avoid infinite recursion.
-        * Also ignore the .notmuch directory.
+        * Also ignore the .notmuch directory and any "tmp" directory
+        * that appears within a maildir.
         */
        /* 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 ||
-           (entry->d_type == DT_DIR &&
-            (strcmp (entry->d_name, "tmp") == 0) &&
-            is_maildir (fs_entries, num_fs_entries)) ||
+           (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
            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 (entry->d_type == DT_REG) {
-           state->processed_files++;
+    /* If this directory hasn't been modified since the last
+     * "notmuch new", then we can skip the second pass entirely. */
+    if (fs_mtime <= db_mtime)
+       goto DONE;
 
-           if (state->verbose) {
-               if (state->output_is_a_tty)
-                   printf("\r\033[K");
+    /* Pass 2: Scan for new files, removed files, and removed directories. */
+    for (i = 0; i < num_fs_entries; i++)
+    {
+       if (interrupted)
+           break;
 
-               printf ("%i/%i: %s",
-                       state->processed_files,
-                       state->total_files,
-                       next);
+        entry = fs_entries[i];
 
-               putchar((state->output_is_a_tty) ? '\r' : '\n');
-               fflush (stdout);
-           }
+       /* Check if we've walked past any names in db_files or
+        * db_subdirs. If so, these have been deleted. */
+       while (notmuch_filenames_has_more (db_files) &&
+              strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
+       {
+           char *absolute = talloc_asprintf (state->removed_files,
+                                             "%s/%s", path,
+                                             notmuch_filenames_get (db_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_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;
-           }
+           _filename_list_add (state->removed_files, absolute);
 
-           if (message) {
-               notmuch_message_destroy (message);
-               message = NULL;
-           }
+           notmuch_filenames_advance (db_files);
+       }
 
-           if (do_add_files_print_progress) {
-               do_add_files_print_progress = 0;
-               add_files_print_progress (state);
+       while (notmuch_filenames_has_more (db_subdirs) &&
+              strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
+       {
+           const char *filename = notmuch_filenames_get (db_subdirs);
+
+           if (strcmp (filename, entry->d_name) < 0)
+           {
+               char *absolute = talloc_asprintf (state->removed_directories,
+                                                 "%s/%s", path, filename);
+
+               _filename_list_add (state->removed_directories, absolute);
            }
-       } else if (entry->d_type == DT_DIR) {
-           status = add_files_recursive (notmuch, next, state);
-           if (status && ret == NOTMUCH_STATUS_SUCCESS)
-               ret = status;
+
+           notmuch_filenames_advance (db_subdirs);
+       }
+
+       /* If we're looking at a symlink, we only want to add it if it
+        * links to a regular file, (and not to a directory, say). */
+       if (entry->d_type == DT_LNK) {
+           int err;
+
+           next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
+           err = stat (next, &st);
+           talloc_free (next);
+           next = NULL;
+
+           /* Don't emit an error for a link pointing nowhere, since
+            * the directory-traversal pass will have already done
+            * that. */
+           if (err)
+               continue;
+
+           if (! S_ISREG (st.st_mode))
+               continue;
+       } else if (entry->d_type != DT_REG) {
+           continue;
+       }
+
+       /* Don't add a file that we've added before. */
+       if (notmuch_filenames_has_more (db_files) &&
+           strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
+       {
+           notmuch_filenames_advance (db_files);
+           continue;
+       }
+
+       /* We're now looking at a regular file that doesn't yet exist
+        * in the database, so add it. */
+       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);
+       }
+
+       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;
     }
 
+    /* Now that we've walked the whole filesystem list, anything left
+     * over in the database lists has been deleted. */
+    while (notmuch_filenames_has_more (db_files))
+    {
+       char *absolute = talloc_asprintf (state->removed_files,
+                                         "%s/%s", path,
+                                         notmuch_filenames_get (db_files));
+
+       _filename_list_add (state->removed_files, absolute);
+
+       notmuch_filenames_advance (db_files);
+    }
+
+    while (notmuch_filenames_has_more (db_subdirs))
+    {
+       char *absolute = talloc_asprintf (state->removed_directories,
+                                         "%s/%s", path,
+                                         notmuch_filenames_get (db_subdirs));
+
+       _filename_list_add (state->removed_directories, absolute);
+
+       notmuch_filenames_advance (db_subdirs);
+    }
+
     if (! interrupted) {
        status = notmuch_directory_set_mtime (directory, fs_mtime);
        if (status && ret == NOTMUCH_STATUS_SUCCESS)
@@ -293,6 +468,12 @@ add_files_recursive (notmuch_database_t *notmuch,
        closedir (dir);
     if (fs_entries)
        free (fs_entries);
+    if (db_subdirs)
+       notmuch_filenames_destroy (db_subdirs);
+    if (db_files)
+       notmuch_filenames_destroy (db_files);
+    if (directory)
+       notmuch_directory_destroy (directory);
 
     return ret;
 }
@@ -309,6 +490,7 @@ add_files (notmuch_database_t *notmuch,
     struct sigaction action;
     struct itimerval timerval;
     notmuch_bool_t timer_is_active = FALSE;
+    struct stat st;
 
     if (state->output_is_a_tty && ! debugger_is_active () && ! state->verbose) {
        /* Setup our handler for SIGALRM */
@@ -328,6 +510,17 @@ add_files (notmuch_database_t *notmuch,
        timer_is_active = TRUE;
     }
 
+    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;
+    }
+
     status = add_files_recursive (notmuch, path, state);
 
     if (timer_is_active) {
@@ -359,7 +552,7 @@ count_files (const char *path, int *count)
     char *next;
     struct stat st;
     struct dirent **fs_entries = NULL;
-    int num_fs_entries = scandir (path, &fs_entries, 0, ino_cmp);
+    int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
     int i = 0;
 
     if (num_fs_entries == -1) {
@@ -428,6 +621,9 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     const char *db_path;
     char *dot_notmuch_path;
     struct sigaction action;
+    _filename_node_t *f;
+    int renamed_files, removed_files;
+    notmuch_status_t status;
     int i;
 
     add_files_state.verbose = 0;
@@ -484,11 +680,53 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     add_files_state.added_messages = 0;
     gettimeofday (&add_files_state.tv_start, NULL);
 
+    add_files_state.removed_files = _filename_list_create (ctx);
+    add_files_state.removed_directories = _filename_list_create (ctx);
+
     ret = add_files (notmuch, db_path, &add_files_state);
 
+    removed_files = 0;
+    renamed_files = 0;
+    for (f = add_files_state.removed_files->head; f; f = f->next) {
+       status = notmuch_database_remove_message (notmuch, f->filename);
+       if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
+           renamed_files++;
+       else
+           removed_files++;
+    }
+
+    for (f = add_files_state.removed_directories->head; f; f = f->next) {
+       notmuch_directory_t *directory;
+       notmuch_filenames_t *files;
+
+       directory = notmuch_database_get_directory (notmuch, f->filename);
+
+       for (files = notmuch_directory_get_child_files (directory);
+            notmuch_filenames_has_more (files);
+            notmuch_filenames_advance (files))
+       {
+           char *absolute;
+
+           absolute = talloc_asprintf (ctx, "%s/%s", f->filename,
+                                       notmuch_filenames_get (files));
+           status = notmuch_database_remove_message (notmuch, absolute);
+           if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
+               renamed_files++;
+           else
+               removed_files++;
+           talloc_free (absolute);
+       }
+
+       notmuch_directory_destroy (directory);
+    }
+
+    talloc_free (add_files_state.removed_files);
+    talloc_free (add_files_state.removed_directories);
+
     gettimeofday (&tv_now, NULL);
     elapsed = notmuch_time_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 ?
@@ -501,15 +739,30 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
            printf (".                    \n");
        }
     }
+
     if (add_files_state.added_messages) {
-       printf ("Added %d new %s to the database.\n",
+       printf ("Added %d new %s to the database.",
                add_files_state.added_messages,
                add_files_state.added_messages == 1 ?
                "message" : "messages");
     } else {
-       printf ("No new mail.\n");
+       printf ("No new mail.");
+    }
+
+    if (removed_files) {
+       printf (" Removed %d %s.",
+               removed_files,
+               removed_files == 1 ? "message" : "messages");
     }
 
+    if (renamed_files) {
+       printf (" Detected %d file %s.",
+               renamed_files,
+               renamed_files == 1 ? "rename" : "renames");
+    }
+
+    printf ("\n");
+
     if (ret) {
        printf ("\nNote: At least one error was encountered: %s\n",
                notmuch_status_to_string (ret));