]> git.notmuchmail.org Git - notmuch/blobdiff - notmuch-new.c
cli: abstract notmuch new result printing
[notmuch] / notmuch-new.c
index feb9c32fda52e6b9d6d5490320e86f5a107b03ac..c4431819dd79a3075869d6dab2a4503de8cc2922 100644 (file)
@@ -240,6 +240,60 @@ _entry_in_ignore_list (const char *entry, add_files_state_t *state)
     return FALSE;
 }
 
+/* Add a single file to the database. */
+static notmuch_status_t
+add_file (notmuch_database_t *notmuch, const char *filename,
+         add_files_state_t *state)
+{
+    notmuch_message_t *message = NULL;
+    const char **tag;
+    notmuch_status_t status;
+
+    status = notmuch_database_begin_atomic (notmuch);
+    if (status)
+       goto DONE;
+
+    status = notmuch_database_add_message (notmuch, filename, &message);
+    switch (status) {
+    /* Success. */
+    case NOTMUCH_STATUS_SUCCESS:
+       state->added_messages++;
+       notmuch_message_freeze (message);
+       for (tag = state->new_tags; *tag != NULL; tag++)
+           notmuch_message_add_tag (message, *tag);
+       if (state->synchronize_flags)
+           notmuch_message_maildir_flags_to_tags (message);
+       notmuch_message_thaw (message);
+       break;
+    /* Non-fatal issues (go on to next file). */
+    case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
+       if (state->synchronize_flags)
+           notmuch_message_maildir_flags_to_tags (message);
+       break;
+    case NOTMUCH_STATUS_FILE_NOT_EMAIL:
+       fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
+       break;
+    /* Fatal issues. Don't process anymore. */
+    case NOTMUCH_STATUS_READ_ONLY_DATABASE:
+    case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
+    case NOTMUCH_STATUS_OUT_OF_MEMORY:
+       fprintf (stderr, "Error: %s. Halting processing.\n",
+                notmuch_status_to_string (status));
+       goto DONE;
+    default:
+       INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
+       goto DONE;
+    }
+
+    status = notmuch_database_end_atomic (notmuch);
+
+  DONE:
+    if (message)
+       notmuch_message_destroy (message);
+
+    return status;
+}
+
 /* Examine 'path' recursively as follows:
  *
  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
@@ -291,7 +345,6 @@ add_files (notmuch_database_t *notmuch,
     char *next = NULL;
     time_t fs_mtime, db_mtime;
     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
-    notmuch_message_t *message = NULL;
     struct dirent **fs_entries = NULL;
     int i, num_fs_entries = 0, entry_type;
     notmuch_directory_t *directory;
@@ -300,7 +353,6 @@ add_files (notmuch_database_t *notmuch,
     time_t stat_time;
     struct stat st;
     notmuch_bool_t is_maildir;
-    const char **tag;
 
     if (stat (path, &st)) {
        fprintf (stderr, "Error reading directory %s: %s\n",
@@ -323,6 +375,35 @@ add_files (notmuch_database_t *notmuch,
     }
     db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
 
+    /* If the directory is unchanged from our last scan and has no
+     * sub-directories, then return without scanning it at all.  In
+     * some situations, skipping the scan can substantially reduce the
+     * cost of notmuch new, especially since the huge numbers of files
+     * in Maildirs make scans expensive, but all files live in leaf
+     * directories.
+     *
+     * To check for sub-directories, we borrow a trick from find,
+     * kpathsea, and many other UNIX tools: since a directory's link
+     * count is the number of sub-directories (specifically, their
+     * '..' entries) plus 2 (the link from the parent and the link for
+     * '.').  This check is safe even on weird file systems, since
+     * file systems that can't compute this will return 0 or 1.  This
+     * is safe even on *really* weird file systems like HFS+ that
+     * mistakenly return the total number of directory entries, since
+     * that only inflates the count beyond 2.
+     */
+    if (directory && fs_mtime == db_mtime && st.st_nlink == 2) {
+       /* There's one catch: pass 1 below considers symlinks to
+        * directories to be directories, but these don't increase the
+        * file system link count.  So, only bail early if the
+        * database agrees that there are no sub-directories. */
+       db_subdirs = notmuch_directory_get_child_directories (directory);
+       if (!notmuch_filenames_valid (db_subdirs))
+           goto DONE;
+       notmuch_filenames_destroy (db_subdirs);
+       db_subdirs = NULL;
+    }
+
     /* 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. */
@@ -498,63 +579,12 @@ add_files (notmuch_database_t *notmuch,
            fflush (stdout);
        }
 
-       status = notmuch_database_begin_atomic (notmuch);
+       status = add_file (notmuch, next, state);
        if (status) {
            ret = status;
            goto DONE;
        }
 
-       status = notmuch_database_add_message (notmuch, next, &message);
-       switch (status) {
-       /* success */
-       case NOTMUCH_STATUS_SUCCESS:
-           state->added_messages++;
-           notmuch_message_freeze (message);
-           for (tag=state->new_tags; *tag != NULL; tag++)
-               notmuch_message_add_tag (message, *tag);
-           if (state->synchronize_flags == TRUE)
-               notmuch_message_maildir_flags_to_tags (message);
-           notmuch_message_thaw (message);
-           break;
-       /* Non-fatal issues (go on to next file) */
-       case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
-           if (state->synchronize_flags == TRUE)
-               notmuch_message_maildir_flags_to_tags (message);
-           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_READ_ONLY_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_UNBALANCED_ATOMIC:
-       case NOTMUCH_STATUS_LAST_STATUS:
-           INTERNAL_ERROR ("add_message returned unexpected value: %d",  status);
-           goto DONE;
-       }
-
-       status = notmuch_database_end_atomic (notmuch);
-       if (status) {
-           ret = status;
-           goto DONE;
-       }
-
-       if (message) {
-           notmuch_message_destroy (message);
-           message = NULL;
-       }
-
        if (do_print_progress) {
            do_print_progress = 0;
            generic_print_progress ("Processed", "files", state->tv_start,
@@ -672,10 +702,9 @@ count_files (const char *path, int *count, add_files_state_t *state)
 {
     struct dirent *entry = NULL;
     char *next;
-    struct stat st;
     struct dirent **fs_entries = NULL;
     int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
-    int i = 0;
+    int entry_type, i;
 
     if (num_fs_entries == -1) {
        fprintf (stderr, "Warning: failed to open directory %s: %s\n",
@@ -683,11 +712,8 @@ count_files (const char *path, int *count, add_files_state_t *state)
        goto DONE;
     }
 
-    while (!interrupted) {
-        if (i == num_fs_entries)
-           break;
-
-        entry = fs_entries[i++];
+    for (i = 0; i < num_fs_entries && ! interrupted; i++) {
+        entry = fs_entries[i];
 
        /* Ignore special directories to avoid infinite recursion.
         * Also ignore the .notmuch directory and files/directories
@@ -698,7 +724,7 @@ count_files (const char *path, int *count, add_files_state_t *state)
            strcmp (entry->d_name, ".notmuch") == 0 ||
            _entry_in_ignore_list (entry->d_name, state))
        {
-           if (_entry_in_ignore_list (entry->d_name, state) && state->debug)
+           if (state->debug && _entry_in_ignore_list (entry->d_name, state))
                printf ("(D) count_files: explicitly ignoring %s/%s\n",
                        path,
                        entry->d_name);
@@ -712,15 +738,14 @@ count_files (const char *path, int *count, add_files_state_t *state)
            continue;
        }
 
-       stat (next, &st);
-
-       if (S_ISREG (st.st_mode)) {
+       entry_type = dirent_type (path, entry);
+       if (entry_type == S_IFREG) {
            *count = *count + 1;
            if (*count % 1000 == 0) {
                printf ("Found %d files so far.\r", *count);
                fflush (stdout);
            }
-       } else if (S_ISDIR (st.st_mode)) {
+       } else if (entry_type == S_IFDIR) {
            count_files (next, count, state);
        }
 
@@ -839,14 +864,49 @@ _remove_directory (void *ctx,
     return status;
 }
 
+static void
+print_results (const add_files_state_t *state)
+{
+    double elapsed;
+    struct timeval tv_now;
+
+    gettimeofday (&tv_now, NULL);
+    elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
+
+    if (state->processed_files) {
+       printf ("Processed %d %s in ", state->processed_files,
+               state->processed_files == 1 ? "file" : "total files");
+       notmuch_time_print_formatted_seconds (elapsed);
+       if (elapsed > 1)
+           printf (" (%d files/sec.).\033[K\n",
+                   (int) (state->processed_files / elapsed));
+       else
+           printf (".\033[K\n");
+    }
+
+    if (state->added_messages)
+       printf ("Added %d new %s to the database.", state->added_messages,
+               state->added_messages == 1 ? "message" : "messages");
+    else
+       printf ("No new mail.");
+
+    if (state->removed_messages)
+       printf (" Removed %d %s.", state->removed_messages,
+               state->removed_messages == 1 ? "message" : "messages");
+
+    if (state->renamed_messages)
+       printf (" Detected %d file %s.", state->renamed_messages,
+               state->renamed_messages == 1 ? "rename" : "renames");
+
+    printf ("\n");
+}
+
 int
-notmuch_new_command (void *ctx, int argc, char *argv[])
+notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
 {
-    notmuch_config_t *config;
     notmuch_database_t *notmuch;
     add_files_state_t add_files_state;
-    double elapsed;
-    struct timeval tv_now, tv_start;
+    struct timeval tv_start;
     int ret = 0;
     struct stat st;
     const char *db_path;
@@ -870,14 +930,8 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     };
 
     opt_index = parse_arguments (argc, argv, options, 1);
-    if (opt_index < 0) {
-       /* diagnostics already printed */
-       return 1;
-    }
-
-    config = notmuch_config_open (ctx, NULL, NULL);
-    if (config == NULL)
-       return 1;
+    if (opt_index < 0)
+       return EXIT_FAILURE;
 
     add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
     add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
@@ -887,10 +941,10 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     if (!no_hooks) {
        ret = notmuch_run_hook (db_path, "pre-new");
        if (ret)
-           return ret;
+           return EXIT_FAILURE;
     }
 
-    dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
+    dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
 
     if (stat (dot_notmuch_path, &st)) {
        int count;
@@ -898,16 +952,16 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
        count = 0;
        count_files (db_path, &count, &add_files_state);
        if (interrupted)
-           return 1;
+           return EXIT_FAILURE;
 
        printf ("Found %d total files (that's not much mail).\n", count);
        if (notmuch_database_create (db_path, &notmuch))
-           return 1;
+           return EXIT_FAILURE;
        add_files_state.total_files = count;
     } else {
        if (notmuch_database_open (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
                                   &notmuch))
-           return 1;
+           return EXIT_FAILURE;
 
        if (notmuch_database_needs_upgrade (notmuch)) {
            printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
@@ -922,7 +976,7 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     }
 
     if (notmuch == NULL)
-       return 1;
+       return EXIT_FAILURE;
 
     /* Setup our handler for SIGINT. We do this after having
      * potentially done a database upgrade we this interrupt handler
@@ -941,9 +995,9 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     add_files_state.removed_messages = add_files_state.renamed_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);
-    add_files_state.directory_mtimes = _filename_list_create (ctx);
+    add_files_state.removed_files = _filename_list_create (config);
+    add_files_state.removed_directories = _filename_list_create (config);
+    add_files_state.directory_mtimes = _filename_list_create (config);
 
     if (! debugger_is_active () && add_files_state.output_is_a_tty
        && ! add_files_state.verbose) {
@@ -970,7 +1024,7 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
 
     gettimeofday (&tv_start, NULL);
     for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
-       ret = _remove_directory (ctx, notmuch, f->filename, &add_files_state);
+       ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
        if (ret)
            goto DONE;
        if (do_print_progress) {
@@ -999,45 +1053,7 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     if (timer_is_active)
        stop_progress_printing_timer ();
 
-    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 ?
-               "file" : "total files");
-       notmuch_time_print_formatted_seconds (elapsed);
-       if (elapsed > 1) {
-           printf (" (%d files/sec.).\033[K\n",
-                   (int) (add_files_state.processed_files / elapsed));
-       } else {
-           printf (".\033[K\n");
-       }
-    }
-
-    if (add_files_state.added_messages) {
-       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.");
-    }
-
-    if (add_files_state.removed_messages) {
-       printf (" Removed %d %s.",
-               add_files_state.removed_messages,
-               add_files_state.removed_messages == 1 ? "message" : "messages");
-    }
-
-    if (add_files_state.renamed_messages) {
-       printf (" Detected %d file %s.",
-               add_files_state.renamed_messages,
-               add_files_state.renamed_messages == 1 ? "rename" : "renames");
-    }
-
-    printf ("\n");
+    print_results (&add_files_state);
 
     if (ret)
        fprintf (stderr, "Note: A fatal error was encountered: %s\n",
@@ -1048,5 +1064,5 @@ notmuch_new_command (void *ctx, int argc, char *argv[])
     if (!no_hooks && !ret && !interrupted)
        ret = notmuch_run_hook (db_path, "post-new");
 
-    return ret || interrupted;
+    return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS;
 }