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;
46 enum verbosity verbosity;
48 const char **new_tags;
49 size_t new_tags_length;
50 const char **new_ignore;
51 size_t new_ignore_length;
55 int added_messages, removed_messages, renamed_messages;
57 struct timeval tv_start;
59 _filename_list_t *removed_files;
60 _filename_list_t *removed_directories;
61 _filename_list_t *directory_mtimes;
63 notmuch_bool_t synchronize_flags;
66 static volatile sig_atomic_t do_print_progress = 0;
69 handle_sigalrm (unused (int signal))
71 do_print_progress = 1;
74 static volatile sig_atomic_t interrupted;
77 handle_sigint (unused (int sig))
79 static char msg[] = "Stopping... \n";
81 /* This write is "opportunistic", so it's okay to ignore the
82 * result. It is not required for correctness, and if it does
83 * fail or produce a short write, we want to get out of the signal
84 * handler as quickly as possible, not retry it. */
85 IGNORE_RESULT (write (2, msg, sizeof(msg)-1));
89 static _filename_list_t *
90 _filename_list_create (const void *ctx)
92 _filename_list_t *list;
94 list = talloc (ctx, _filename_list_t);
99 list->tail = &list->head;
105 static _filename_node_t *
106 _filename_list_add (_filename_list_t *list,
107 const char *filename)
109 _filename_node_t *node = talloc (list, _filename_node_t);
113 node->filename = talloc_strdup (list, filename);
116 *(list->tail) = node;
117 list->tail = &node->next;
123 generic_print_progress (const char *action, const char *object,
124 struct timeval tv_start, unsigned processed, unsigned total)
126 struct timeval tv_now;
127 double elapsed_overall, rate_overall;
129 gettimeofday (&tv_now, NULL);
131 elapsed_overall = notmuch_time_elapsed (tv_start, tv_now);
132 rate_overall = processed / elapsed_overall;
134 printf ("%s %u ", action, processed);
137 printf ("of %u %s", total, object);
138 if (processed > 0 && elapsed_overall > 0.5) {
139 double time_remaining = ((total - processed) / rate_overall);
141 notmuch_time_print_formatted_seconds (time_remaining);
142 printf (" remaining)");
145 printf ("%s", object);
146 if (elapsed_overall > 0.5)
147 printf (" (%d %s/sec.)", (int) rate_overall, object);
149 printf (".\033[K\r");
155 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
157 return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
161 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
163 return strcmp ((*a)->d_name, (*b)->d_name);
166 /* Return the type of a directory entry relative to path as a stat(2)
167 * mode. Like stat, this follows symlinks. Returns -1 and sets errno
168 * if the file's type cannot be determined (which includes dangling
172 dirent_type (const char *path, const struct dirent *entry)
176 int err, saved_errno;
179 /* Mapping from d_type to stat mode_t. We omit DT_LNK so that
180 * we'll fall through to stat and get the real file type. */
181 static const mode_t modes[] = {
189 if (entry->d_type < ARRAY_SIZE(modes) && modes[entry->d_type])
190 return modes[entry->d_type];
193 abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);
198 err = stat(abspath, &statbuf);
200 talloc_free (abspath);
205 return statbuf.st_mode & S_IFMT;
208 /* Test if the directory looks like a Maildir directory.
210 * Search through the array of directory entries to see if we can find all
211 * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
213 * Return 1 if the directory looks like a Maildir and 0 otherwise.
216 _entries_resemble_maildir (const char *path, struct dirent **entries, int count)
220 for (i = 0; i < count; i++) {
221 if (dirent_type (path, entries[i]) != S_IFDIR)
224 if (strcmp(entries[i]->d_name, "new") == 0 ||
225 strcmp(entries[i]->d_name, "cur") == 0 ||
226 strcmp(entries[i]->d_name, "tmp") == 0)
237 /* Test if the file/directory is to be ignored.
239 static notmuch_bool_t
240 _entry_in_ignore_list (const char *entry, add_files_state_t *state)
244 for (i = 0; i < state->new_ignore_length; i++)
245 if (strcmp (entry, state->new_ignore[i]) == 0)
251 /* Add a single file to the database. */
252 static notmuch_status_t
253 add_file (notmuch_database_t *notmuch, const char *filename,
254 add_files_state_t *state)
256 notmuch_message_t *message = NULL;
258 notmuch_status_t status;
260 status = notmuch_database_begin_atomic (notmuch);
264 status = notmuch_database_index_file (notmuch, filename, NULL, &message);
267 case NOTMUCH_STATUS_SUCCESS:
268 state->added_messages++;
269 notmuch_message_freeze (message);
270 for (tag = state->new_tags; *tag != NULL; tag++)
271 notmuch_message_add_tag (message, *tag);
272 if (state->synchronize_flags)
273 notmuch_message_maildir_flags_to_tags (message);
274 notmuch_message_thaw (message);
276 /* Non-fatal issues (go on to next file). */
277 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
278 if (state->synchronize_flags)
279 notmuch_message_maildir_flags_to_tags (message);
281 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
282 fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
284 case NOTMUCH_STATUS_FILE_ERROR:
285 /* Someone renamed/removed the file between scandir and now. */
286 state->vanished_files++;
287 fprintf (stderr, "Unexpected error with file %s\n", filename);
288 (void) print_status_database ("add_file", notmuch, status);
290 /* Fatal issues. Don't process anymore. */
291 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
292 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
293 case NOTMUCH_STATUS_OUT_OF_MEMORY:
294 (void) print_status_database("add_file", notmuch, status);
297 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
301 status = notmuch_database_end_atomic (notmuch);
305 notmuch_message_destroy (message);
310 /* Examine 'path' recursively as follows:
312 * o Ask the filesystem for the mtime of 'path' (fs_mtime)
313 * o Ask the database for its timestamp of 'path' (db_mtime)
315 * o Ask the filesystem for files and directories within 'path'
316 * (via scandir and stored in fs_entries)
318 * o Pass 1: For each directory in fs_entries, recursively call into
319 * this same function.
321 * o Compare fs_mtime to db_mtime. If they are equivalent, terminate
322 * the algorithm at this point, (this directory has not been
323 * updated in the filesystem since the last database scan of PASS
326 * o Ask the database for files and directories within 'path'
327 * (db_files and db_subdirs)
329 * o Pass 2: Walk fs_entries simultaneously with db_files and
330 * db_subdirs. Look for one of three interesting cases:
332 * 1. Regular file in fs_entries and not in db_files
333 * This is a new file to add_message into the database.
335 * 2. Filename in db_files not in fs_entries.
336 * This is a file that has been removed from the mail store.
338 * 3. Directory in db_subdirs not in fs_entries
339 * This is a directory that has been removed from the mail store.
341 * Note that the addition of a directory is not interesting here,
342 * since that will have been taken care of in pass 1. Also, we
343 * don't immediately act on file/directory removal since we must
344 * ensure that in the case of a rename that the new filename is
345 * added before the old filename is removed, (so that no
346 * information is lost from the database).
348 * o Tell the database to update its time of 'path' to 'fs_mtime'
349 * if fs_mtime isn't the current wall-clock time.
351 static notmuch_status_t
352 add_files (notmuch_database_t *notmuch,
354 add_files_state_t *state)
356 struct dirent *entry = NULL;
358 time_t fs_mtime, db_mtime;
359 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
360 struct dirent **fs_entries = NULL;
361 int i, num_fs_entries = 0, entry_type;
362 notmuch_directory_t *directory;
363 notmuch_filenames_t *db_files = NULL;
364 notmuch_filenames_t *db_subdirs = NULL;
367 notmuch_bool_t is_maildir;
369 if (stat (path, &st)) {
370 fprintf (stderr, "Error reading directory %s: %s\n",
371 path, strerror (errno));
372 return NOTMUCH_STATUS_FILE_ERROR;
374 stat_time = time (NULL);
376 if (! S_ISDIR (st.st_mode)) {
377 fprintf (stderr, "Error: %s is not a directory.\n", path);
378 return NOTMUCH_STATUS_FILE_ERROR;
381 fs_mtime = st.st_mtime;
383 status = notmuch_database_get_directory (notmuch, path, &directory);
388 db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
390 /* If the directory is unchanged from our last scan and has no
391 * sub-directories, then return without scanning it at all. In
392 * some situations, skipping the scan can substantially reduce the
393 * cost of notmuch new, especially since the huge numbers of files
394 * in Maildirs make scans expensive, but all files live in leaf
397 * To check for sub-directories, we borrow a trick from find,
398 * kpathsea, and many other UNIX tools: since a directory's link
399 * count is the number of sub-directories (specifically, their
400 * '..' entries) plus 2 (the link from the parent and the link for
401 * '.'). This check is safe even on weird file systems, since
402 * file systems that can't compute this will return 0 or 1. This
403 * is safe even on *really* weird file systems like HFS+ that
404 * mistakenly return the total number of directory entries, since
405 * that only inflates the count beyond 2.
407 if (directory && fs_mtime == db_mtime && st.st_nlink == 2) {
408 /* There's one catch: pass 1 below considers symlinks to
409 * directories to be directories, but these don't increase the
410 * file system link count. So, only bail early if the
411 * database agrees that there are no sub-directories. */
412 db_subdirs = notmuch_directory_get_child_directories (directory);
413 if (!notmuch_filenames_valid (db_subdirs))
415 notmuch_filenames_destroy (db_subdirs);
419 /* If the database knows about this directory, then we sort based
420 * on strcmp to match the database sorting. Otherwise, we can do
421 * inode-based sorting for faster filesystem operation. */
422 num_fs_entries = scandir (path, &fs_entries, 0,
424 dirent_sort_strcmp_name : dirent_sort_inode);
426 if (num_fs_entries == -1) {
427 fprintf (stderr, "Error opening directory %s: %s\n",
428 path, strerror (errno));
429 /* We consider this a fatal error because, if a user moved a
430 * message from another directory that we were able to scan
431 * into this directory, skipping this directory will cause
432 * that message to be lost. */
433 ret = NOTMUCH_STATUS_FILE_ERROR;
437 /* Pass 1: Recurse into all sub-directories. */
438 is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
440 for (i = 0; i < num_fs_entries; i++) {
444 entry = fs_entries[i];
446 /* Ignore any files/directories the user has configured to
447 * ignore. We do this before dirent_type both for performance
448 * and because we don't care if dirent_type fails on entries
449 * that are explicitly ignored.
451 if (_entry_in_ignore_list (entry->d_name, state)) {
453 printf ("(D) add_files, pass 1: explicitly ignoring %s/%s\n",
454 path, entry->d_name);
458 /* We only want to descend into directories (and symlinks to
460 entry_type = dirent_type (path, entry);
461 if (entry_type == -1) {
462 /* Be pessimistic, e.g. so we don't lose lots of mail just
463 * because a user broke a symlink. */
464 fprintf (stderr, "Error reading file %s/%s: %s\n",
465 path, entry->d_name, strerror (errno));
466 return NOTMUCH_STATUS_FILE_ERROR;
467 } else if (entry_type != S_IFDIR) {
471 /* Ignore special directories to avoid infinite recursion.
472 * Also ignore the .notmuch directory and any "tmp" directory
473 * that appears within a maildir.
475 if (strcmp (entry->d_name, ".") == 0 ||
476 strcmp (entry->d_name, "..") == 0 ||
477 (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
478 strcmp (entry->d_name, ".notmuch") == 0)
481 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
482 status = add_files (notmuch, next, state);
491 /* If the directory's modification time in the filesystem is the
492 * same as what we recorded in the database the last time we
493 * scanned it, then we can skip the second pass entirely.
495 * We test for strict equality here to avoid a bug that can happen
496 * if the system clock jumps backward, (preventing new mail from
497 * being discovered until the clock catches up and the directory
498 * is modified again).
500 if (directory && fs_mtime == db_mtime)
503 /* If the database has never seen this directory before, we can
504 * simply leave db_files and db_subdirs NULL. */
506 db_files = notmuch_directory_get_child_files (directory);
507 db_subdirs = notmuch_directory_get_child_directories (directory);
510 /* Pass 2: Scan for new files, removed files, and removed directories. */
511 for (i = 0; i < num_fs_entries; i++)
516 entry = fs_entries[i];
518 /* Ignore files & directories user has configured to be ignored */
519 if (_entry_in_ignore_list (entry->d_name, state)) {
521 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
522 path, entry->d_name);
526 /* Check if we've walked past any names in db_files or
527 * db_subdirs. If so, these have been deleted. */
528 while (notmuch_filenames_valid (db_files) &&
529 strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
531 char *absolute = talloc_asprintf (state->removed_files,
533 notmuch_filenames_get (db_files));
536 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
539 _filename_list_add (state->removed_files, absolute);
541 notmuch_filenames_move_to_next (db_files);
544 while (notmuch_filenames_valid (db_subdirs) &&
545 strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
547 const char *filename = notmuch_filenames_get (db_subdirs);
549 if (strcmp (filename, entry->d_name) < 0)
551 char *absolute = talloc_asprintf (state->removed_directories,
552 "%s/%s", path, filename);
554 printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
557 _filename_list_add (state->removed_directories, absolute);
560 notmuch_filenames_move_to_next (db_subdirs);
563 /* Only add regular files (and symlinks to regular files). */
564 entry_type = dirent_type (path, entry);
565 if (entry_type == -1) {
566 fprintf (stderr, "Error reading file %s/%s: %s\n",
567 path, entry->d_name, strerror (errno));
568 return NOTMUCH_STATUS_FILE_ERROR;
569 } else if (entry_type != S_IFREG) {
573 /* Don't add a file that we've added before. */
574 if (notmuch_filenames_valid (db_files) &&
575 strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
577 notmuch_filenames_move_to_next (db_files);
581 /* We're now looking at a regular file that doesn't yet exist
582 * in the database, so add it. */
583 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
585 state->processed_files++;
587 if (state->verbosity >= VERBOSITY_VERBOSE) {
588 if (state->output_is_a_tty)
591 printf ("%i/%i: %s", state->processed_files, state->total_files,
594 putchar((state->output_is_a_tty) ? '\r' : '\n');
598 status = add_file (notmuch, next, state);
604 if (do_print_progress) {
605 do_print_progress = 0;
606 generic_print_progress ("Processed", "files", state->tv_start,
607 state->processed_files, state->total_files);
617 /* Now that we've walked the whole filesystem list, anything left
618 * over in the database lists has been deleted. */
619 while (notmuch_filenames_valid (db_files))
621 char *absolute = talloc_asprintf (state->removed_files,
623 notmuch_filenames_get (db_files));
625 printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
628 _filename_list_add (state->removed_files, absolute);
630 notmuch_filenames_move_to_next (db_files);
633 while (notmuch_filenames_valid (db_subdirs))
635 char *absolute = talloc_asprintf (state->removed_directories,
637 notmuch_filenames_get (db_subdirs));
640 printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
643 _filename_list_add (state->removed_directories, absolute);
645 notmuch_filenames_move_to_next (db_subdirs);
648 /* If the directory's mtime is the same as the wall-clock time
649 * when we stat'ed the directory, we skip updating the mtime in
650 * the database because a message could be delivered later in this
651 * same second. This may lead to unnecessary re-scans, but it
652 * avoids overlooking messages. */
653 if (fs_mtime != stat_time)
654 _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
660 for (i = 0; i < num_fs_entries; i++)
661 free (fs_entries[i]);
666 notmuch_filenames_destroy (db_subdirs);
668 notmuch_filenames_destroy (db_files);
670 notmuch_directory_destroy (directory);
676 setup_progress_printing_timer (void)
678 struct sigaction action;
679 struct itimerval timerval;
681 /* Set up our handler for SIGALRM */
682 memset (&action, 0, sizeof (struct sigaction));
683 action.sa_handler = handle_sigalrm;
684 sigemptyset (&action.sa_mask);
685 action.sa_flags = SA_RESTART;
686 sigaction (SIGALRM, &action, NULL);
688 /* Then start a timer to send SIGALRM once per second. */
689 timerval.it_interval.tv_sec = 1;
690 timerval.it_interval.tv_usec = 0;
691 timerval.it_value.tv_sec = 1;
692 timerval.it_value.tv_usec = 0;
693 setitimer (ITIMER_REAL, &timerval, NULL);
697 stop_progress_printing_timer (void)
699 struct sigaction action;
700 struct itimerval timerval;
702 /* Now stop the timer. */
703 timerval.it_interval.tv_sec = 0;
704 timerval.it_interval.tv_usec = 0;
705 timerval.it_value.tv_sec = 0;
706 timerval.it_value.tv_usec = 0;
707 setitimer (ITIMER_REAL, &timerval, NULL);
709 /* And disable the signal handler. */
710 action.sa_handler = SIG_IGN;
711 sigaction (SIGALRM, &action, NULL);
715 /* XXX: This should be merged with the add_files function since it
716 * shares a lot of logic with it. */
717 /* Recursively count all regular files in path and all sub-directories
718 * of path. The result is added to *count (which should be
719 * initialized to zero by the top-level caller before calling
722 count_files (const char *path, int *count, add_files_state_t *state)
724 struct dirent *entry = NULL;
726 struct dirent **fs_entries = NULL;
727 int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
730 if (num_fs_entries == -1) {
731 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
732 path, strerror (errno));
736 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
737 entry = fs_entries[i];
739 /* Ignore special directories to avoid infinite recursion.
740 * Also ignore the .notmuch directory.
742 if (strcmp (entry->d_name, ".") == 0 ||
743 strcmp (entry->d_name, "..") == 0 ||
744 strcmp (entry->d_name, ".notmuch") == 0)
747 /* Ignore any files/directories the user has configured to be
750 if (_entry_in_ignore_list (entry->d_name, state)) {
752 printf ("(D) count_files: explicitly ignoring %s/%s\n",
753 path, entry->d_name);
757 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
759 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
760 path, entry->d_name);
764 entry_type = dirent_type (path, entry);
765 if (entry_type == S_IFREG) {
767 if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
768 printf ("Found %d files so far.\r", *count);
771 } else if (entry_type == S_IFDIR) {
772 count_files (next, count, state);
780 for (i = 0; i < num_fs_entries; i++)
781 free (fs_entries[i]);
788 upgrade_print_progress (void *closure,
791 add_files_state_t *state = closure;
793 printf ("Upgrading database: %.2f%% complete", progress * 100.0);
796 struct timeval tv_now;
797 double elapsed, time_remaining;
799 gettimeofday (&tv_now, NULL);
801 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
802 time_remaining = (elapsed / progress) * (1.0 - progress);
804 notmuch_time_print_formatted_seconds (time_remaining);
805 printf (" remaining)");
813 /* Remove one message filename from the database. */
814 static notmuch_status_t
815 remove_filename (notmuch_database_t *notmuch,
817 add_files_state_t *add_files_state)
819 notmuch_status_t status;
820 notmuch_message_t *message;
821 status = notmuch_database_begin_atomic (notmuch);
824 status = notmuch_database_find_message_by_filename (notmuch, path, &message);
825 if (status || message == NULL)
828 status = notmuch_database_remove_message (notmuch, path);
829 if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
830 add_files_state->renamed_messages++;
831 if (add_files_state->synchronize_flags == TRUE)
832 notmuch_message_maildir_flags_to_tags (message);
833 status = NOTMUCH_STATUS_SUCCESS;
834 } else if (status == NOTMUCH_STATUS_SUCCESS) {
835 add_files_state->removed_messages++;
837 notmuch_message_destroy (message);
840 notmuch_database_end_atomic (notmuch);
844 /* Recursively remove all filenames from the database referring to
845 * 'path' (or to any of its children). */
846 static notmuch_status_t
847 _remove_directory (void *ctx,
848 notmuch_database_t *notmuch,
850 add_files_state_t *add_files_state)
852 notmuch_status_t status;
853 notmuch_directory_t *directory;
854 notmuch_filenames_t *files, *subdirs;
857 status = notmuch_database_get_directory (notmuch, path, &directory);
858 if (status || !directory)
861 for (files = notmuch_directory_get_child_files (directory);
862 notmuch_filenames_valid (files);
863 notmuch_filenames_move_to_next (files))
865 absolute = talloc_asprintf (ctx, "%s/%s", path,
866 notmuch_filenames_get (files));
867 status = remove_filename (notmuch, absolute, add_files_state);
868 talloc_free (absolute);
873 for (subdirs = notmuch_directory_get_child_directories (directory);
874 notmuch_filenames_valid (subdirs);
875 notmuch_filenames_move_to_next (subdirs))
877 absolute = talloc_asprintf (ctx, "%s/%s", path,
878 notmuch_filenames_get (subdirs));
879 status = _remove_directory (ctx, notmuch, absolute, add_files_state);
880 talloc_free (absolute);
885 status = notmuch_directory_delete (directory);
889 notmuch_directory_destroy (directory);
894 print_results (const add_files_state_t *state)
897 struct timeval tv_now;
899 gettimeofday (&tv_now, NULL);
900 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
902 if (state->processed_files) {
903 printf ("Processed %d %s in ", state->processed_files,
904 state->processed_files == 1 ? "file" : "total files");
905 notmuch_time_print_formatted_seconds (elapsed);
907 printf (" (%d files/sec.)",
908 (int) (state->processed_files / elapsed));
909 printf (".%s\n", (state->output_is_a_tty) ? "\033[K" : "");
912 if (state->added_messages)
913 printf ("Added %d new %s to the database.", state->added_messages,
914 state->added_messages == 1 ? "message" : "messages");
916 printf ("No new mail.");
918 if (state->removed_messages)
919 printf (" Removed %d %s.", state->removed_messages,
920 state->removed_messages == 1 ? "message" : "messages");
922 if (state->renamed_messages)
923 printf (" Detected %d file %s.", state->renamed_messages,
924 state->renamed_messages == 1 ? "rename" : "renames");
930 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
932 notmuch_database_t *notmuch;
933 add_files_state_t add_files_state = {
934 .verbosity = VERBOSITY_NORMAL,
936 .output_is_a_tty = isatty (fileno (stdout)),
938 struct timeval tv_start;
942 char *dot_notmuch_path;
943 struct sigaction action;
947 notmuch_bool_t timer_is_active = FALSE;
948 notmuch_bool_t no_hooks = FALSE;
949 notmuch_bool_t quiet = FALSE, verbose = FALSE;
950 notmuch_status_t status;
952 notmuch_opt_desc_t options[] = {
953 { NOTMUCH_OPT_BOOLEAN, &quiet, "quiet", 'q', 0 },
954 { NOTMUCH_OPT_BOOLEAN, &verbose, "verbose", 'v', 0 },
955 { NOTMUCH_OPT_BOOLEAN, &add_files_state.debug, "debug", 'd', 0 },
956 { NOTMUCH_OPT_BOOLEAN, &no_hooks, "no-hooks", 'n', 0 },
957 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
961 opt_index = parse_arguments (argc, argv, options, 1);
965 notmuch_process_shared_options (argv[0]);
967 /* quiet trumps verbose */
969 add_files_state.verbosity = VERBOSITY_QUIET;
971 add_files_state.verbosity = VERBOSITY_VERBOSE;
973 add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
974 add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
975 add_files_state.synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
976 db_path = notmuch_config_get_database_path (config);
978 for (i = 0; i < add_files_state.new_tags_length; i++) {
979 const char *error_msg;
981 error_msg = illegal_tag (add_files_state.new_tags[i], FALSE);
983 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
984 add_files_state.new_tags[i], error_msg);
990 ret = notmuch_run_hook (db_path, "pre-new");
995 dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
997 if (stat (dot_notmuch_path, &st)) {
1001 count_files (db_path, &count, &add_files_state);
1003 return EXIT_FAILURE;
1005 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1006 printf ("Found %d total files (that's not much mail).\n", count);
1007 if (notmuch_database_create (db_path, ¬much))
1008 return EXIT_FAILURE;
1009 add_files_state.total_files = count;
1011 char *status_string = NULL;
1012 if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1013 ¬much, &status_string)) {
1014 if (status_string) {
1015 fputs (status_string, stderr);
1016 free (status_string);
1018 return EXIT_FAILURE;
1021 notmuch_exit_if_unmatched_db_uuid (notmuch);
1023 if (notmuch_database_needs_upgrade (notmuch)) {
1024 time_t now = time (NULL);
1025 struct tm *gm_time = gmtime (&now);
1027 /* since dump files are written atomically, the amount of
1028 * harm from overwriting one within a second seems
1029 * relatively small. */
1031 const char *backup_name =
1032 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1034 gm_time->tm_year + 1900,
1035 gm_time->tm_mon + 1,
1041 if (add_files_state.verbosity >= VERBOSITY_NORMAL) {
1042 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1043 printf ("This process is safe to interrupt.\n");
1044 printf ("Backing up tags to %s...\n", backup_name);
1047 if (notmuch_database_dump (notmuch, backup_name, "",
1048 DUMP_FORMAT_BATCH_TAG, DUMP_INCLUDE_DEFAULT, TRUE)) {
1049 fprintf (stderr, "Backup failed. Aborting upgrade.");
1050 return EXIT_FAILURE;
1053 gettimeofday (&add_files_state.tv_start, NULL);
1054 status = notmuch_database_upgrade (
1056 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1059 printf ("Upgrade failed: %s\n",
1060 notmuch_status_to_string (status));
1061 notmuch_database_destroy (notmuch);
1062 return EXIT_FAILURE;
1064 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1065 printf ("Your notmuch database has now been upgraded.\n");
1068 add_files_state.total_files = 0;
1071 if (notmuch == NULL)
1072 return EXIT_FAILURE;
1074 /* Set up our handler for SIGINT. We do this after having
1075 * potentially done a database upgrade we this interrupt handler
1077 memset (&action, 0, sizeof (struct sigaction));
1078 action.sa_handler = handle_sigint;
1079 sigemptyset (&action.sa_mask);
1080 action.sa_flags = SA_RESTART;
1081 sigaction (SIGINT, &action, NULL);
1083 talloc_free (dot_notmuch_path);
1084 dot_notmuch_path = NULL;
1086 gettimeofday (&add_files_state.tv_start, NULL);
1088 add_files_state.removed_files = _filename_list_create (config);
1089 add_files_state.removed_directories = _filename_list_create (config);
1090 add_files_state.directory_mtimes = _filename_list_create (config);
1092 if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1093 add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1094 setup_progress_printing_timer ();
1095 timer_is_active = TRUE;
1098 ret = add_files (notmuch, db_path, &add_files_state);
1102 gettimeofday (&tv_start, NULL);
1103 for (f = add_files_state.removed_files->head; f && !interrupted; f = f->next) {
1104 ret = remove_filename (notmuch, f->filename, &add_files_state);
1107 if (do_print_progress) {
1108 do_print_progress = 0;
1109 generic_print_progress ("Cleaned up", "messages",
1110 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1111 add_files_state.removed_files->count);
1115 gettimeofday (&tv_start, NULL);
1116 for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
1117 ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
1120 if (do_print_progress) {
1121 do_print_progress = 0;
1122 generic_print_progress ("Cleaned up", "directories",
1124 add_files_state.removed_directories->count);
1128 for (f = add_files_state.directory_mtimes->head; f && !interrupted; f = f->next) {
1129 notmuch_directory_t *directory;
1130 status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1131 if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1132 notmuch_directory_set_mtime (directory, f->mtime);
1133 notmuch_directory_destroy (directory);
1138 talloc_free (add_files_state.removed_files);
1139 talloc_free (add_files_state.removed_directories);
1140 talloc_free (add_files_state.directory_mtimes);
1142 if (timer_is_active)
1143 stop_progress_printing_timer ();
1145 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1146 print_results (&add_files_state);
1149 fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1150 notmuch_status_to_string (ret));
1152 notmuch_database_destroy (notmuch);
1154 if (!no_hooks && !ret && !interrupted)
1155 ret = notmuch_run_hook (db_path, "post-new");
1157 if (ret || interrupted)
1158 return EXIT_FAILURE;
1160 if (add_files_state.vanished_files)
1161 return NOTMUCH_EXIT_TEMPFAIL;
1163 return EXIT_SUCCESS;