1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
26 typedef struct _filename_node {
29 struct _filename_node *next;
32 typedef struct _filename_list {
34 _filename_node_t *head;
35 _filename_node_t **tail;
48 enum verbosity verbosity;
51 notmuch_config_values_t *new_tags;
52 const char **ignore_verbatim;
53 size_t ignore_verbatim_length;
54 regex_t *ignore_regex;
55 size_t ignore_regex_length;
59 int added_messages, removed_messages, renamed_messages;
61 struct timeval tv_start;
63 _filename_list_t *removed_files;
64 _filename_list_t *removed_directories;
65 _filename_list_t *directory_mtimes;
67 notmuch_bool_t synchronize_flags;
70 static volatile sig_atomic_t do_print_progress = 0;
73 handle_sigalrm (unused (int signal))
75 do_print_progress = 1;
78 static volatile sig_atomic_t interrupted;
81 handle_sigint (unused (int sig))
83 static char msg[] = "Stopping... \n";
85 /* This write is "opportunistic", so it's okay to ignore the
86 * result. It is not required for correctness, and if it does
87 * fail or produce a short write, we want to get out of the signal
88 * handler as quickly as possible, not retry it. */
89 IGNORE_RESULT (write (2, msg, sizeof (msg) - 1));
93 static _filename_list_t *
94 _filename_list_create (const void *ctx)
96 _filename_list_t *list;
98 list = talloc (ctx, _filename_list_t);
103 list->tail = &list->head;
109 static _filename_node_t *
110 _filename_list_add (_filename_list_t *list,
111 const char *filename)
113 _filename_node_t *node = talloc (list, _filename_node_t);
117 node->filename = talloc_strdup (list, filename);
120 *(list->tail) = node;
121 list->tail = &node->next;
127 generic_print_progress (const char *action, const char *object,
128 struct timeval tv_start, unsigned processed, unsigned total)
130 struct timeval tv_now;
131 double elapsed_overall, rate_overall;
133 gettimeofday (&tv_now, NULL);
135 elapsed_overall = notmuch_time_elapsed (tv_start, tv_now);
136 rate_overall = processed / elapsed_overall;
138 printf ("%s %u ", action, processed);
141 printf ("of %u %s", total, object);
142 if (processed > 0 && elapsed_overall > 0.5) {
143 double time_remaining = ((total - processed) / rate_overall);
145 notmuch_time_print_formatted_seconds (time_remaining);
146 printf (" remaining)");
149 printf ("%s", object);
150 if (elapsed_overall > 0.5)
151 printf (" (%d %s/sec.)", (int) rate_overall, object);
153 printf (".\033[K\r");
159 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
161 return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
165 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
167 return strcmp ((*a)->d_name, (*b)->d_name);
170 /* Return the type of a directory entry relative to path as a stat(2)
171 * mode. Like stat, this follows symlinks. Returns -1 and sets errno
172 * if the file's type cannot be determined (which includes dangling
176 dirent_type (const char *path, const struct dirent *entry)
180 int err, saved_errno;
183 /* Mapping from d_type to stat mode_t. We omit DT_LNK so that
184 * we'll fall through to stat and get the real file type. */
185 static const mode_t modes[] = {
193 if (entry->d_type < ARRAY_SIZE (modes) && modes[entry->d_type])
194 return modes[entry->d_type];
197 abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);
202 err = stat (abspath, &statbuf);
204 talloc_free (abspath);
209 return statbuf.st_mode & S_IFMT;
212 /* Test if the directory looks like a Maildir directory.
214 * Search through the array of directory entries to see if we can find all
215 * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
217 * Return 1 if the directory looks like a Maildir and 0 otherwise.
220 _entries_resemble_maildir (const char *path, struct dirent **entries, int count)
224 for (i = 0; i < count; i++) {
225 if (dirent_type (path, entries[i]) != S_IFDIR)
228 if (strcmp (entries[i]->d_name, "new") == 0 ||
229 strcmp (entries[i]->d_name, "cur") == 0 ||
230 strcmp (entries[i]->d_name, "tmp") == 0) {
241 _special_directory (const char *entry)
243 return strcmp (entry, ".") == 0 || strcmp (entry, "..") == 0;
247 _setup_ignore (notmuch_database_t *notmuch, add_files_state_t *state)
249 notmuch_config_values_t *ignore_list;
250 int nregex = 0, nverbatim = 0;
251 const char **verbatim = NULL;
252 regex_t *regex = NULL;
254 for (ignore_list = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_NEW_IGNORE);
255 notmuch_config_values_valid (ignore_list);
256 notmuch_config_values_move_to_next (ignore_list)) {
257 const char *s = notmuch_config_values_get (ignore_list);
258 size_t len = strlen (s);
261 fprintf (stderr, "Error: Empty string in new.ignore list\n");
270 if (len < 3 || s[len - 1] != '/') {
271 fprintf (stderr, "Error: Malformed pattern '%s' in new.ignore\n",
276 r = talloc_strndup (notmuch, s + 1, len - 2);
277 regex = talloc_realloc (notmuch, regex, regex_t, nregex + 1);
278 preg = ®ex[nregex];
280 rerr = regcomp (preg, r, REG_EXTENDED | REG_NOSUB);
282 size_t error_size = regerror (rerr, preg, NULL, 0);
283 char *error = talloc_size (r, error_size);
285 regerror (rerr, preg, error, error_size);
287 fprintf (stderr, "Error: Invalid regex '%s' in new.ignore: %s\n",
295 verbatim = talloc_realloc (notmuch, verbatim, const char *,
297 verbatim[nverbatim++] = s;
301 state->ignore_regex = regex;
302 state->ignore_regex_length = nregex;
303 state->ignore_verbatim = verbatim;
304 state->ignore_verbatim_length = nverbatim;
310 _get_relative_path (const char *db_path, const char *dirpath, const char *entry)
312 size_t db_path_len = strlen (db_path);
315 if (strncmp (dirpath, db_path, db_path_len) != 0) {
316 fprintf (stderr, "Warning: '%s' is not a subdirectory of '%s'\n",
321 dirpath += db_path_len;
322 while (*dirpath == '/')
326 return talloc_asprintf (NULL, "%s/%s", dirpath, entry);
328 return talloc_strdup (NULL, entry);
331 /* Test if the file/directory is to be ignored.
334 _entry_in_ignore_list (add_files_state_t *state, const char *dirpath,
341 for (i = 0; i < state->ignore_verbatim_length; i++) {
342 if (strcmp (entry, state->ignore_verbatim[i]) == 0)
346 if (state->ignore_regex_length == 0)
349 path = _get_relative_path (state->db_path, dirpath, entry);
353 for (i = 0; i < state->ignore_regex_length; i++) {
354 if (regexec (&state->ignore_regex[i], path, 0, NULL, 0) == 0) {
365 /* Add a single file to the database. */
366 static notmuch_status_t
367 add_file (notmuch_database_t *notmuch, const char *filename,
368 add_files_state_t *state)
370 notmuch_message_t *message = NULL;
372 notmuch_status_t status;
374 status = notmuch_database_begin_atomic (notmuch);
378 status = notmuch_database_index_file (notmuch, filename, indexing_cli_choices.opts, &message);
381 case NOTMUCH_STATUS_SUCCESS:
382 state->added_messages++;
383 notmuch_message_freeze (message);
384 if (state->synchronize_flags)
385 notmuch_message_maildir_flags_to_tags (message);
387 for (notmuch_config_values_start (state->new_tags);
388 notmuch_config_values_valid (state->new_tags);
389 notmuch_config_values_move_to_next (state->new_tags)) {
390 notmuch_bool_t is_set;
392 tag = notmuch_config_values_get (state->new_tags);
393 /* Currently all errors from has_maildir_flag are fatal */
394 if ((status = notmuch_message_has_maildir_flag_st (message, 'S', &is_set)))
396 if (strcmp ("unread", tag) != 0 || ! is_set) {
397 notmuch_message_add_tag (message, tag);
401 notmuch_message_thaw (message);
403 /* Non-fatal issues (go on to next file). */
404 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
405 if (state->synchronize_flags)
406 notmuch_message_maildir_flags_to_tags (message);
408 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
409 fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
411 case NOTMUCH_STATUS_FILE_ERROR:
412 /* Someone renamed/removed the file between scandir and now. */
413 state->vanished_files++;
414 fprintf (stderr, "Unexpected error with file %s\n", filename);
415 (void) print_status_database ("add_file", notmuch, status);
417 /* Fatal issues. Don't process anymore. */
418 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
419 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
420 case NOTMUCH_STATUS_OUT_OF_MEMORY:
421 (void) print_status_database ("add_file", notmuch, status);
424 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
428 status = notmuch_database_end_atomic (notmuch);
432 notmuch_message_destroy (message);
437 /* Examine 'path' recursively as follows:
439 * o Ask the filesystem for the mtime of 'path' (fs_mtime)
440 * o Ask the database for its timestamp of 'path' (db_mtime)
442 * o Ask the filesystem for files and directories within 'path'
443 * (via scandir and stored in fs_entries)
445 * o Pass 1: For each directory in fs_entries, recursively call into
446 * this same function.
448 * o Compare fs_mtime to db_mtime. If they are equivalent, terminate
449 * the algorithm at this point, (this directory has not been
450 * updated in the filesystem since the last database scan of PASS
453 * o Ask the database for files and directories within 'path'
454 * (db_files and db_subdirs)
456 * o Pass 2: Walk fs_entries simultaneously with db_files and
457 * db_subdirs. Look for one of three interesting cases:
459 * 1. Regular file in fs_entries and not in db_files
460 * This is a new file to add_message into the database.
462 * 2. Filename in db_files not in fs_entries.
463 * This is a file that has been removed from the mail store.
465 * 3. Directory in db_subdirs not in fs_entries
466 * This is a directory that has been removed from the mail store.
468 * Note that the addition of a directory is not interesting here,
469 * since that will have been taken care of in pass 1. Also, we
470 * don't immediately act on file/directory removal since we must
471 * ensure that in the case of a rename that the new filename is
472 * added before the old filename is removed, (so that no
473 * information is lost from the database).
475 * o Tell the database to update its time of 'path' to 'fs_mtime'
476 * if fs_mtime isn't the current wall-clock time.
478 static notmuch_status_t
479 add_files (notmuch_database_t *notmuch,
481 add_files_state_t *state)
483 struct dirent *entry = NULL;
485 time_t fs_mtime, db_mtime;
486 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
487 struct dirent **fs_entries = NULL;
488 int i, num_fs_entries = 0, entry_type;
489 notmuch_directory_t *directory;
490 notmuch_filenames_t *db_files = NULL;
491 notmuch_filenames_t *db_subdirs = NULL;
496 if (stat (path, &st)) {
497 fprintf (stderr, "Error reading directory %s: %s\n",
498 path, strerror (errno));
499 return NOTMUCH_STATUS_FILE_ERROR;
501 stat_time = time (NULL);
503 if (! S_ISDIR (st.st_mode)) {
504 fprintf (stderr, "Error: %s is not a directory.\n", path);
505 return NOTMUCH_STATUS_FILE_ERROR;
508 fs_mtime = st.st_mtime;
510 status = notmuch_database_get_directory (notmuch, path, &directory);
515 db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
517 /* If the directory is unchanged from our last scan and has no
518 * sub-directories, then return without scanning it at all. In
519 * some situations, skipping the scan can substantially reduce the
520 * cost of notmuch new, especially since the huge numbers of files
521 * in Maildirs make scans expensive, but all files live in leaf
524 * To check for sub-directories, we borrow a trick from find,
525 * kpathsea, and many other UNIX tools: since a directory's link
526 * count is the number of sub-directories (specifically, their
527 * '..' entries) plus 2 (the link from the parent and the link for
528 * '.'). This check is safe even on weird file systems, since
529 * file systems that can't compute this will return 0 or 1. This
530 * is safe even on *really* weird file systems like HFS+ that
531 * mistakenly return the total number of directory entries, since
532 * that only inflates the count beyond 2.
534 if (directory && (! state->full_scan) && fs_mtime == db_mtime && st.st_nlink == 2) {
535 /* There's one catch: pass 1 below considers symlinks to
536 * directories to be directories, but these don't increase the
537 * file system link count. So, only bail early if the
538 * database agrees that there are no sub-directories. */
539 db_subdirs = notmuch_directory_get_child_directories (directory);
540 if (! notmuch_filenames_valid (db_subdirs))
542 notmuch_filenames_destroy (db_subdirs);
546 /* If the database knows about this directory, then we sort based
547 * on strcmp to match the database sorting. Otherwise, we can do
548 * inode-based sorting for faster filesystem operation. */
549 num_fs_entries = scandir (path, &fs_entries, 0,
551 dirent_sort_strcmp_name : dirent_sort_inode);
553 if (num_fs_entries == -1) {
554 fprintf (stderr, "Error opening directory %s: %s\n",
555 path, strerror (errno));
556 /* We consider this a fatal error because, if a user moved a
557 * message from another directory that we were able to scan
558 * into this directory, skipping this directory will cause
559 * that message to be lost. */
560 ret = NOTMUCH_STATUS_FILE_ERROR;
564 /* Pass 1: Recurse into all sub-directories. */
565 is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
567 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
568 entry = fs_entries[i];
570 /* Ignore special directories to avoid infinite recursion. */
571 if (_special_directory (entry->d_name))
574 /* Ignore any files/directories the user has configured to
575 * ignore. We do this before dirent_type both for performance
576 * and because we don't care if dirent_type fails on entries
577 * that are explicitly ignored.
579 if (_entry_in_ignore_list (state, path, entry->d_name)) {
581 printf ("(D) add_files, pass 1: explicitly ignoring %s/%s\n",
582 path, entry->d_name);
586 /* We only want to descend into directories (and symlinks to
588 entry_type = dirent_type (path, entry);
589 if (entry_type == -1) {
590 /* Be pessimistic, e.g. so we don't lose lots of mail just
591 * because a user broke a symlink. */
592 fprintf (stderr, "Error reading file %s/%s: %s\n",
593 path, entry->d_name, strerror (errno));
594 return NOTMUCH_STATUS_FILE_ERROR;
595 } else if (entry_type != S_IFDIR) {
599 /* Ignore the .notmuch directory and any "tmp" directory
600 * that appears within a maildir.
602 if ((is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
603 strcmp (entry->d_name, ".notmuch") == 0)
606 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
607 status = add_files (notmuch, next, state);
616 /* If the directory's modification time in the filesystem is the
617 * same as what we recorded in the database the last time we
618 * scanned it, then we can skip the second pass entirely.
620 * We test for strict equality here to avoid a bug that can happen
621 * if the system clock jumps backward, (preventing new mail from
622 * being discovered until the clock catches up and the directory
623 * is modified again).
625 if (directory && (! state->full_scan) && fs_mtime == db_mtime)
628 /* If the database has never seen this directory before, we can
629 * simply leave db_files and db_subdirs NULL. */
631 db_files = notmuch_directory_get_child_files (directory);
632 db_subdirs = notmuch_directory_get_child_directories (directory);
635 /* Pass 2: Scan for new files, removed files, and removed directories. */
636 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
637 entry = fs_entries[i];
639 /* Ignore special directories early. */
640 if (_special_directory (entry->d_name))
643 /* Ignore files & directories user has configured to be ignored */
644 if (_entry_in_ignore_list (state, path, entry->d_name)) {
646 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
647 path, entry->d_name);
651 /* Check if we've walked past any names in db_files or
652 * db_subdirs. If so, these have been deleted. */
653 while (notmuch_filenames_valid (db_files) &&
654 strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0) {
655 char *absolute = talloc_asprintf (state->removed_files,
657 notmuch_filenames_get (db_files));
660 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
663 _filename_list_add (state->removed_files, absolute);
665 notmuch_filenames_move_to_next (db_files);
668 while (notmuch_filenames_valid (db_subdirs) &&
669 strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0) {
670 const char *filename = notmuch_filenames_get (db_subdirs);
672 if (strcmp (filename, entry->d_name) < 0) {
673 char *absolute = talloc_asprintf (state->removed_directories,
674 "%s/%s", path, filename);
676 printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
679 _filename_list_add (state->removed_directories, absolute);
682 notmuch_filenames_move_to_next (db_subdirs);
685 /* Only add regular files (and symlinks to regular files). */
686 entry_type = dirent_type (path, entry);
687 if (entry_type == -1) {
688 fprintf (stderr, "Error reading file %s/%s: %s\n",
689 path, entry->d_name, strerror (errno));
690 return NOTMUCH_STATUS_FILE_ERROR;
691 } else if (entry_type != S_IFREG) {
695 /* Don't add a file that we've added before. */
696 if (notmuch_filenames_valid (db_files) &&
697 strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0) {
698 notmuch_filenames_move_to_next (db_files);
702 /* We're now looking at a regular file that doesn't yet exist
703 * in the database, so add it. */
704 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
706 state->processed_files++;
708 if (state->verbosity >= VERBOSITY_VERBOSE) {
709 if (state->output_is_a_tty)
712 printf ("%i/%i: %s", state->processed_files, state->total_files,
715 putchar ((state->output_is_a_tty) ? '\r' : '\n');
719 status = add_file (notmuch, next, state);
725 if (do_print_progress) {
726 do_print_progress = 0;
727 generic_print_progress ("Processed", "files", state->tv_start,
728 state->processed_files, state->total_files);
738 /* Now that we've walked the whole filesystem list, anything left
739 * over in the database lists has been deleted. */
740 while (notmuch_filenames_valid (db_files)) {
741 char *absolute = talloc_asprintf (state->removed_files,
743 notmuch_filenames_get (db_files));
745 printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
748 _filename_list_add (state->removed_files, absolute);
750 notmuch_filenames_move_to_next (db_files);
753 while (notmuch_filenames_valid (db_subdirs)) {
754 char *absolute = talloc_asprintf (state->removed_directories,
756 notmuch_filenames_get (db_subdirs));
759 printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
762 _filename_list_add (state->removed_directories, absolute);
764 notmuch_filenames_move_to_next (db_subdirs);
767 /* If the directory's mtime is the same as the wall-clock time
768 * when we stat'ed the directory, we skip updating the mtime in
769 * the database because a message could be delivered later in this
770 * same second. This may lead to unnecessary re-scans, but it
771 * avoids overlooking messages. */
772 if (fs_mtime != stat_time)
773 _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
779 for (i = 0; i < num_fs_entries; i++)
780 free (fs_entries[i]);
785 notmuch_filenames_destroy (db_subdirs);
787 notmuch_filenames_destroy (db_files);
789 notmuch_directory_destroy (directory);
795 setup_progress_printing_timer (void)
797 struct sigaction action;
798 struct itimerval timerval;
800 /* Set up our handler for SIGALRM */
801 memset (&action, 0, sizeof (struct sigaction));
802 action.sa_handler = handle_sigalrm;
803 sigemptyset (&action.sa_mask);
804 action.sa_flags = SA_RESTART;
805 sigaction (SIGALRM, &action, NULL);
807 /* Then start a timer to send SIGALRM once per second. */
808 timerval.it_interval.tv_sec = 1;
809 timerval.it_interval.tv_usec = 0;
810 timerval.it_value.tv_sec = 1;
811 timerval.it_value.tv_usec = 0;
812 setitimer (ITIMER_REAL, &timerval, NULL);
816 stop_progress_printing_timer (void)
818 struct sigaction action;
819 struct itimerval timerval;
821 /* Now stop the timer. */
822 timerval.it_interval.tv_sec = 0;
823 timerval.it_interval.tv_usec = 0;
824 timerval.it_value.tv_sec = 0;
825 timerval.it_value.tv_usec = 0;
826 setitimer (ITIMER_REAL, &timerval, NULL);
828 /* And disable the signal handler. */
829 action.sa_handler = SIG_IGN;
830 sigaction (SIGALRM, &action, NULL);
834 /* XXX: This should be merged with the add_files function since it
835 * shares a lot of logic with it. */
836 /* Recursively count all regular files in path and all sub-directories
837 * of path. The result is added to *count (which should be
838 * initialized to zero by the top-level caller before calling
841 count_files (const char *path, int *count, add_files_state_t *state)
843 struct dirent *entry = NULL;
845 struct dirent **fs_entries = NULL;
846 int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
849 if (num_fs_entries == -1) {
850 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
851 path, strerror (errno));
855 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
856 entry = fs_entries[i];
858 /* Ignore special directories to avoid infinite recursion.
859 * Also ignore the .notmuch directory.
861 if (_special_directory (entry->d_name) ||
862 strcmp (entry->d_name, ".notmuch") == 0)
865 /* Ignore any files/directories the user has configured to be
868 if (_entry_in_ignore_list (state, path, entry->d_name)) {
870 printf ("(D) count_files: explicitly ignoring %s/%s\n",
871 path, entry->d_name);
875 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
877 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
878 path, entry->d_name);
882 entry_type = dirent_type (path, entry);
883 if (entry_type == S_IFREG) {
885 if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
886 printf ("Found %d files so far.\r", *count);
889 } else if (entry_type == S_IFDIR) {
890 count_files (next, count, state);
898 for (i = 0; i < num_fs_entries; i++)
899 free (fs_entries[i]);
906 upgrade_print_progress (void *closure,
909 add_files_state_t *state = closure;
911 printf ("Upgrading database: %.2f%% complete", progress * 100.0);
914 struct timeval tv_now;
915 double elapsed, time_remaining;
917 gettimeofday (&tv_now, NULL);
919 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
920 time_remaining = (elapsed / progress) * (1.0 - progress);
922 notmuch_time_print_formatted_seconds (time_remaining);
923 printf (" remaining)");
931 /* Remove one message filename from the database. */
932 static notmuch_status_t
933 remove_filename (notmuch_database_t *notmuch,
935 add_files_state_t *add_files_state)
937 notmuch_status_t status;
938 notmuch_message_t *message;
940 status = notmuch_database_begin_atomic (notmuch);
943 status = notmuch_database_find_message_by_filename (notmuch, path, &message);
944 if (status || message == NULL)
947 status = notmuch_database_remove_message (notmuch, path);
948 if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
949 add_files_state->renamed_messages++;
950 if (add_files_state->synchronize_flags == true)
951 notmuch_message_maildir_flags_to_tags (message);
952 status = NOTMUCH_STATUS_SUCCESS;
953 } else if (status == NOTMUCH_STATUS_SUCCESS) {
954 add_files_state->removed_messages++;
956 notmuch_message_destroy (message);
959 notmuch_database_end_atomic (notmuch);
963 /* Recursively remove all filenames from the database referring to
964 * 'path' (or to any of its children). */
965 static notmuch_status_t
966 _remove_directory (notmuch_database_t *notmuch,
968 add_files_state_t *add_files_state)
970 notmuch_status_t status;
971 notmuch_directory_t *directory;
972 notmuch_filenames_t *files, *subdirs;
975 status = notmuch_database_get_directory (notmuch, path, &directory);
976 if (status || ! directory)
979 for (files = notmuch_directory_get_child_files (directory);
980 notmuch_filenames_valid (files);
981 notmuch_filenames_move_to_next (files)) {
982 absolute = talloc_asprintf (notmuch, "%s/%s", path,
983 notmuch_filenames_get (files));
984 status = remove_filename (notmuch, absolute, add_files_state);
985 talloc_free (absolute);
990 for (subdirs = notmuch_directory_get_child_directories (directory);
991 notmuch_filenames_valid (subdirs);
992 notmuch_filenames_move_to_next (subdirs)) {
993 absolute = talloc_asprintf (notmuch, "%s/%s", path,
994 notmuch_filenames_get (subdirs));
995 status = _remove_directory (notmuch, absolute, add_files_state);
996 talloc_free (absolute);
1001 status = notmuch_directory_delete (directory);
1005 notmuch_directory_destroy (directory);
1010 print_results (const add_files_state_t *state)
1013 struct timeval tv_now;
1015 gettimeofday (&tv_now, NULL);
1016 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
1018 if (state->processed_files) {
1019 printf ("Processed %d %s in ", state->processed_files,
1020 state->processed_files == 1 ? "file" : "total files");
1021 notmuch_time_print_formatted_seconds (elapsed);
1023 printf (" (%d files/sec.)",
1024 (int) (state->processed_files / elapsed));
1025 printf (".%s\n", (state->output_is_a_tty) ? "\033[K" : "");
1028 if (state->added_messages)
1029 printf ("Added %d new %s to the database.", state->added_messages,
1030 state->added_messages == 1 ? "message" : "messages");
1032 printf ("No new mail.");
1034 if (state->removed_messages)
1035 printf (" Removed %d %s.", state->removed_messages,
1036 state->removed_messages == 1 ? "message" : "messages");
1038 if (state->renamed_messages)
1039 printf (" Detected %d file %s.", state->renamed_messages,
1040 state->renamed_messages == 1 ? "rename" : "renames");
1046 _maybe_upgrade (notmuch_database_t *notmuch, add_files_state_t *state) {
1047 if (notmuch_database_needs_upgrade (notmuch)) {
1048 time_t now = time (NULL);
1049 struct tm *gm_time = gmtime (&now);
1050 notmuch_status_t status;
1051 char *dot_notmuch_path = talloc_asprintf (notmuch, "%s/%s", state->db_path, ".notmuch");
1053 /* since dump files are written atomically, the amount of
1054 * harm from overwriting one within a second seems
1055 * relatively small. */
1057 const char *backup_name =
1058 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1060 gm_time->tm_year + 1900,
1061 gm_time->tm_mon + 1,
1067 if (state->verbosity >= VERBOSITY_NORMAL) {
1068 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1069 printf ("This process is safe to interrupt.\n");
1070 printf ("Backing up tags to %s...\n", backup_name);
1073 if (notmuch_database_dump (notmuch, backup_name, "",
1074 DUMP_FORMAT_BATCH_TAG, DUMP_INCLUDE_DEFAULT, true)) {
1075 fprintf (stderr, "Backup failed. Aborting upgrade.");
1076 return EXIT_FAILURE;
1079 gettimeofday (&state->tv_start, NULL);
1080 status = notmuch_database_upgrade (
1082 state->verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1085 printf ("Upgrade failed: %s\n",
1086 notmuch_status_to_string (status));
1087 notmuch_database_destroy (notmuch);
1088 return EXIT_FAILURE;
1090 if (state->verbosity >= VERBOSITY_NORMAL)
1091 printf ("Your notmuch database has now been upgraded.\n");
1093 return EXIT_SUCCESS;
1097 notmuch_new_command (unused(notmuch_config_t *config), notmuch_database_t *notmuch, int argc, char *argv[])
1099 add_files_state_t add_files_state = {
1100 .verbosity = VERBOSITY_NORMAL,
1103 .output_is_a_tty = isatty (fileno (stdout)),
1105 struct timeval tv_start;
1107 const char *db_path;
1108 char *dot_notmuch_path;
1109 struct sigaction action;
1110 _filename_node_t *f;
1113 bool timer_is_active = false;
1115 bool quiet = false, verbose = false;
1116 notmuch_status_t status;
1118 notmuch_opt_desc_t options[] = {
1119 { .opt_bool = &quiet, .name = "quiet" },
1120 { .opt_bool = &verbose, .name = "verbose" },
1121 { .opt_bool = &add_files_state.debug, .name = "debug" },
1122 { .opt_bool = &add_files_state.full_scan, .name = "full-scan" },
1123 { .opt_bool = &hooks, .name = "hooks" },
1124 { .opt_inherit = notmuch_shared_indexing_options },
1125 { .opt_inherit = notmuch_shared_options },
1129 opt_index = parse_arguments (argc, argv, options, 1);
1131 return EXIT_FAILURE;
1133 notmuch_process_shared_options (argv[0]);
1135 /* quiet trumps verbose */
1137 add_files_state.verbosity = VERBOSITY_QUIET;
1139 add_files_state.verbosity = VERBOSITY_VERBOSE;
1141 add_files_state.new_tags = notmuch_config_get_values (notmuch, NOTMUCH_CONFIG_NEW_TAGS);
1143 if (print_status_database (
1146 notmuch_config_get_bool (notmuch, NOTMUCH_CONFIG_SYNC_MAILDIR_FLAGS,
1147 &add_files_state.synchronize_flags)))
1148 return EXIT_FAILURE;
1150 db_path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
1151 add_files_state.db_path = db_path;
1153 if (! _setup_ignore (notmuch, &add_files_state))
1154 return EXIT_FAILURE;
1156 for (notmuch_config_values_start (add_files_state.new_tags);
1157 notmuch_config_values_valid (add_files_state.new_tags);
1158 notmuch_config_values_move_to_next (add_files_state.new_tags)) {
1159 const char *tag,*error_msg;
1161 tag = notmuch_config_values_get (add_files_state.new_tags);
1162 error_msg = illegal_tag (tag, false);
1164 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n", tag, error_msg);
1165 return EXIT_FAILURE;
1170 ret = notmuch_run_hook (db_path, "pre-new");
1172 return EXIT_FAILURE;
1175 dot_notmuch_path = talloc_asprintf (notmuch, "%s/%s", db_path, ".notmuch");
1177 notmuch_exit_if_unmatched_db_uuid (notmuch);
1179 if (notmuch_database_get_revision (notmuch, NULL) == 0) {
1181 count_files (db_path, &count, &add_files_state);
1183 return EXIT_FAILURE;
1185 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1186 printf ("Found %d total files (that's not much mail).\n", count);
1188 add_files_state.total_files = count;
1190 if (_maybe_upgrade (notmuch, &add_files_state))
1191 return EXIT_FAILURE;
1193 add_files_state.total_files = 0;
1196 if (notmuch == NULL)
1197 return EXIT_FAILURE;
1199 status = notmuch_process_shared_indexing_options (notmuch);
1200 if (status != NOTMUCH_STATUS_SUCCESS) {
1201 fprintf (stderr, "Error: Failed to process index options. (%s)\n",
1202 notmuch_status_to_string (status));
1203 return EXIT_FAILURE;
1206 /* Set up our handler for SIGINT. We do this after having
1207 * potentially done a database upgrade we this interrupt handler
1209 memset (&action, 0, sizeof (struct sigaction));
1210 action.sa_handler = handle_sigint;
1211 sigemptyset (&action.sa_mask);
1212 action.sa_flags = SA_RESTART;
1213 sigaction (SIGINT, &action, NULL);
1215 talloc_free (dot_notmuch_path);
1216 dot_notmuch_path = NULL;
1218 gettimeofday (&add_files_state.tv_start, NULL);
1220 add_files_state.removed_files = _filename_list_create (notmuch);
1221 add_files_state.removed_directories = _filename_list_create (notmuch);
1222 add_files_state.directory_mtimes = _filename_list_create (notmuch);
1224 if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1225 add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1226 setup_progress_printing_timer ();
1227 timer_is_active = true;
1230 ret = add_files (notmuch, db_path, &add_files_state);
1234 gettimeofday (&tv_start, NULL);
1235 for (f = add_files_state.removed_files->head; f && ! interrupted; f = f->next) {
1236 ret = remove_filename (notmuch, f->filename, &add_files_state);
1239 if (do_print_progress) {
1240 do_print_progress = 0;
1241 generic_print_progress ("Cleaned up", "messages",
1242 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1243 add_files_state.removed_files->count);
1247 gettimeofday (&tv_start, NULL);
1248 for (f = add_files_state.removed_directories->head, i = 0; f && ! interrupted; f = f->next, i++) {
1249 ret = _remove_directory (notmuch, f->filename, &add_files_state);
1252 if (do_print_progress) {
1253 do_print_progress = 0;
1254 generic_print_progress ("Cleaned up", "directories",
1256 add_files_state.removed_directories->count);
1260 for (f = add_files_state.directory_mtimes->head; f && ! interrupted; f = f->next) {
1261 notmuch_directory_t *directory;
1262 status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1263 if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1264 notmuch_directory_set_mtime (directory, f->mtime);
1265 notmuch_directory_destroy (directory);
1270 talloc_free (add_files_state.removed_files);
1271 talloc_free (add_files_state.removed_directories);
1272 talloc_free (add_files_state.directory_mtimes);
1274 if (timer_is_active)
1275 stop_progress_printing_timer ();
1277 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1278 print_results (&add_files_state);
1281 fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1282 notmuch_status_to_string (ret));
1284 notmuch_database_close (notmuch);
1286 if (hooks && ! ret && ! interrupted)
1287 ret = notmuch_run_hook (db_path, "post-new");
1289 notmuch_database_destroy (notmuch);
1291 if (ret || interrupted)
1292 return EXIT_FAILURE;
1294 if (add_files_state.vanished_files)
1295 return NOTMUCH_EXIT_TEMPFAIL;
1297 return EXIT_SUCCESS;