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 static notmuch_bool_t
238 _special_directory (const char *entry)
240 return strcmp (entry, ".") == 0 || strcmp (entry, "..") == 0;
243 /* Test if the file/directory is to be ignored.
245 static notmuch_bool_t
246 _entry_in_ignore_list (const char *entry, add_files_state_t *state)
250 for (i = 0; i < state->new_ignore_length; i++)
251 if (strcmp (entry, state->new_ignore[i]) == 0)
257 /* Add a single file to the database. */
258 static notmuch_status_t
259 add_file (notmuch_database_t *notmuch, const char *filename,
260 add_files_state_t *state)
262 notmuch_message_t *message = NULL;
264 notmuch_status_t status;
266 status = notmuch_database_begin_atomic (notmuch);
270 status = notmuch_database_index_file (notmuch, filename, NULL, &message);
273 case NOTMUCH_STATUS_SUCCESS:
274 state->added_messages++;
275 notmuch_message_freeze (message);
276 if (state->synchronize_flags)
277 notmuch_message_maildir_flags_to_tags (message);
279 for (tag = state->new_tags; *tag != NULL; tag++) {
280 if (strcmp ("unread", *tag) !=0 ||
281 !notmuch_message_has_maildir_flag (message, 'S')) {
282 notmuch_message_add_tag (message, *tag);
286 notmuch_message_thaw (message);
288 /* Non-fatal issues (go on to next file). */
289 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
290 if (state->synchronize_flags)
291 notmuch_message_maildir_flags_to_tags (message);
293 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
294 fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
296 case NOTMUCH_STATUS_FILE_ERROR:
297 /* Someone renamed/removed the file between scandir and now. */
298 state->vanished_files++;
299 fprintf (stderr, "Unexpected error with file %s\n", filename);
300 (void) print_status_database ("add_file", notmuch, status);
302 /* Fatal issues. Don't process anymore. */
303 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
304 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
305 case NOTMUCH_STATUS_OUT_OF_MEMORY:
306 (void) print_status_database("add_file", notmuch, status);
309 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
313 status = notmuch_database_end_atomic (notmuch);
317 notmuch_message_destroy (message);
322 /* Examine 'path' recursively as follows:
324 * o Ask the filesystem for the mtime of 'path' (fs_mtime)
325 * o Ask the database for its timestamp of 'path' (db_mtime)
327 * o Ask the filesystem for files and directories within 'path'
328 * (via scandir and stored in fs_entries)
330 * o Pass 1: For each directory in fs_entries, recursively call into
331 * this same function.
333 * o Compare fs_mtime to db_mtime. If they are equivalent, terminate
334 * the algorithm at this point, (this directory has not been
335 * updated in the filesystem since the last database scan of PASS
338 * o Ask the database for files and directories within 'path'
339 * (db_files and db_subdirs)
341 * o Pass 2: Walk fs_entries simultaneously with db_files and
342 * db_subdirs. Look for one of three interesting cases:
344 * 1. Regular file in fs_entries and not in db_files
345 * This is a new file to add_message into the database.
347 * 2. Filename in db_files not in fs_entries.
348 * This is a file that has been removed from the mail store.
350 * 3. Directory in db_subdirs not in fs_entries
351 * This is a directory that has been removed from the mail store.
353 * Note that the addition of a directory is not interesting here,
354 * since that will have been taken care of in pass 1. Also, we
355 * don't immediately act on file/directory removal since we must
356 * ensure that in the case of a rename that the new filename is
357 * added before the old filename is removed, (so that no
358 * information is lost from the database).
360 * o Tell the database to update its time of 'path' to 'fs_mtime'
361 * if fs_mtime isn't the current wall-clock time.
363 static notmuch_status_t
364 add_files (notmuch_database_t *notmuch,
366 add_files_state_t *state)
368 struct dirent *entry = NULL;
370 time_t fs_mtime, db_mtime;
371 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
372 struct dirent **fs_entries = NULL;
373 int i, num_fs_entries = 0, entry_type;
374 notmuch_directory_t *directory;
375 notmuch_filenames_t *db_files = NULL;
376 notmuch_filenames_t *db_subdirs = NULL;
379 notmuch_bool_t is_maildir;
381 if (stat (path, &st)) {
382 fprintf (stderr, "Error reading directory %s: %s\n",
383 path, strerror (errno));
384 return NOTMUCH_STATUS_FILE_ERROR;
386 stat_time = time (NULL);
388 if (! S_ISDIR (st.st_mode)) {
389 fprintf (stderr, "Error: %s is not a directory.\n", path);
390 return NOTMUCH_STATUS_FILE_ERROR;
393 fs_mtime = st.st_mtime;
395 status = notmuch_database_get_directory (notmuch, path, &directory);
400 db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
402 /* If the directory is unchanged from our last scan and has no
403 * sub-directories, then return without scanning it at all. In
404 * some situations, skipping the scan can substantially reduce the
405 * cost of notmuch new, especially since the huge numbers of files
406 * in Maildirs make scans expensive, but all files live in leaf
409 * To check for sub-directories, we borrow a trick from find,
410 * kpathsea, and many other UNIX tools: since a directory's link
411 * count is the number of sub-directories (specifically, their
412 * '..' entries) plus 2 (the link from the parent and the link for
413 * '.'). This check is safe even on weird file systems, since
414 * file systems that can't compute this will return 0 or 1. This
415 * is safe even on *really* weird file systems like HFS+ that
416 * mistakenly return the total number of directory entries, since
417 * that only inflates the count beyond 2.
419 if (directory && fs_mtime == db_mtime && st.st_nlink == 2) {
420 /* There's one catch: pass 1 below considers symlinks to
421 * directories to be directories, but these don't increase the
422 * file system link count. So, only bail early if the
423 * database agrees that there are no sub-directories. */
424 db_subdirs = notmuch_directory_get_child_directories (directory);
425 if (!notmuch_filenames_valid (db_subdirs))
427 notmuch_filenames_destroy (db_subdirs);
431 /* If the database knows about this directory, then we sort based
432 * on strcmp to match the database sorting. Otherwise, we can do
433 * inode-based sorting for faster filesystem operation. */
434 num_fs_entries = scandir (path, &fs_entries, 0,
436 dirent_sort_strcmp_name : dirent_sort_inode);
438 if (num_fs_entries == -1) {
439 fprintf (stderr, "Error opening directory %s: %s\n",
440 path, strerror (errno));
441 /* We consider this a fatal error because, if a user moved a
442 * message from another directory that we were able to scan
443 * into this directory, skipping this directory will cause
444 * that message to be lost. */
445 ret = NOTMUCH_STATUS_FILE_ERROR;
449 /* Pass 1: Recurse into all sub-directories. */
450 is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
452 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
453 entry = fs_entries[i];
455 /* Ignore special directories to avoid infinite recursion. */
456 if (_special_directory (entry->d_name))
459 /* Ignore any files/directories the user has configured to
460 * ignore. We do this before dirent_type both for performance
461 * and because we don't care if dirent_type fails on entries
462 * that are explicitly ignored.
464 if (_entry_in_ignore_list (entry->d_name, state)) {
466 printf ("(D) add_files, pass 1: explicitly ignoring %s/%s\n",
467 path, entry->d_name);
471 /* We only want to descend into directories (and symlinks to
473 entry_type = dirent_type (path, entry);
474 if (entry_type == -1) {
475 /* Be pessimistic, e.g. so we don't lose lots of mail just
476 * because a user broke a symlink. */
477 fprintf (stderr, "Error reading file %s/%s: %s\n",
478 path, entry->d_name, strerror (errno));
479 return NOTMUCH_STATUS_FILE_ERROR;
480 } else if (entry_type != S_IFDIR) {
484 /* Ignore the .notmuch directory and any "tmp" directory
485 * that appears within a maildir.
487 if ((is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
488 strcmp (entry->d_name, ".notmuch") == 0)
491 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
492 status = add_files (notmuch, next, state);
501 /* If the directory's modification time in the filesystem is the
502 * same as what we recorded in the database the last time we
503 * scanned it, then we can skip the second pass entirely.
505 * We test for strict equality here to avoid a bug that can happen
506 * if the system clock jumps backward, (preventing new mail from
507 * being discovered until the clock catches up and the directory
508 * is modified again).
510 if (directory && fs_mtime == db_mtime)
513 /* If the database has never seen this directory before, we can
514 * simply leave db_files and db_subdirs NULL. */
516 db_files = notmuch_directory_get_child_files (directory);
517 db_subdirs = notmuch_directory_get_child_directories (directory);
520 /* Pass 2: Scan for new files, removed files, and removed directories. */
521 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
522 entry = fs_entries[i];
524 /* Ignore files & directories user has configured to be ignored */
525 if (_entry_in_ignore_list (entry->d_name, state)) {
527 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
528 path, entry->d_name);
532 /* Check if we've walked past any names in db_files or
533 * db_subdirs. If so, these have been deleted. */
534 while (notmuch_filenames_valid (db_files) &&
535 strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
537 char *absolute = talloc_asprintf (state->removed_files,
539 notmuch_filenames_get (db_files));
542 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
545 _filename_list_add (state->removed_files, absolute);
547 notmuch_filenames_move_to_next (db_files);
550 while (notmuch_filenames_valid (db_subdirs) &&
551 strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
553 const char *filename = notmuch_filenames_get (db_subdirs);
555 if (strcmp (filename, entry->d_name) < 0)
557 char *absolute = talloc_asprintf (state->removed_directories,
558 "%s/%s", path, filename);
560 printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
563 _filename_list_add (state->removed_directories, absolute);
566 notmuch_filenames_move_to_next (db_subdirs);
569 /* Only add regular files (and symlinks to regular files). */
570 entry_type = dirent_type (path, entry);
571 if (entry_type == -1) {
572 fprintf (stderr, "Error reading file %s/%s: %s\n",
573 path, entry->d_name, strerror (errno));
574 return NOTMUCH_STATUS_FILE_ERROR;
575 } else if (entry_type != S_IFREG) {
579 /* Don't add a file that we've added before. */
580 if (notmuch_filenames_valid (db_files) &&
581 strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
583 notmuch_filenames_move_to_next (db_files);
587 /* We're now looking at a regular file that doesn't yet exist
588 * in the database, so add it. */
589 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
591 state->processed_files++;
593 if (state->verbosity >= VERBOSITY_VERBOSE) {
594 if (state->output_is_a_tty)
597 printf ("%i/%i: %s", state->processed_files, state->total_files,
600 putchar((state->output_is_a_tty) ? '\r' : '\n');
604 status = add_file (notmuch, next, state);
610 if (do_print_progress) {
611 do_print_progress = 0;
612 generic_print_progress ("Processed", "files", state->tv_start,
613 state->processed_files, state->total_files);
623 /* Now that we've walked the whole filesystem list, anything left
624 * over in the database lists has been deleted. */
625 while (notmuch_filenames_valid (db_files))
627 char *absolute = talloc_asprintf (state->removed_files,
629 notmuch_filenames_get (db_files));
631 printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
634 _filename_list_add (state->removed_files, absolute);
636 notmuch_filenames_move_to_next (db_files);
639 while (notmuch_filenames_valid (db_subdirs))
641 char *absolute = talloc_asprintf (state->removed_directories,
643 notmuch_filenames_get (db_subdirs));
646 printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
649 _filename_list_add (state->removed_directories, absolute);
651 notmuch_filenames_move_to_next (db_subdirs);
654 /* If the directory's mtime is the same as the wall-clock time
655 * when we stat'ed the directory, we skip updating the mtime in
656 * the database because a message could be delivered later in this
657 * same second. This may lead to unnecessary re-scans, but it
658 * avoids overlooking messages. */
659 if (fs_mtime != stat_time)
660 _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
666 for (i = 0; i < num_fs_entries; i++)
667 free (fs_entries[i]);
672 notmuch_filenames_destroy (db_subdirs);
674 notmuch_filenames_destroy (db_files);
676 notmuch_directory_destroy (directory);
682 setup_progress_printing_timer (void)
684 struct sigaction action;
685 struct itimerval timerval;
687 /* Set up our handler for SIGALRM */
688 memset (&action, 0, sizeof (struct sigaction));
689 action.sa_handler = handle_sigalrm;
690 sigemptyset (&action.sa_mask);
691 action.sa_flags = SA_RESTART;
692 sigaction (SIGALRM, &action, NULL);
694 /* Then start a timer to send SIGALRM once per second. */
695 timerval.it_interval.tv_sec = 1;
696 timerval.it_interval.tv_usec = 0;
697 timerval.it_value.tv_sec = 1;
698 timerval.it_value.tv_usec = 0;
699 setitimer (ITIMER_REAL, &timerval, NULL);
703 stop_progress_printing_timer (void)
705 struct sigaction action;
706 struct itimerval timerval;
708 /* Now stop the timer. */
709 timerval.it_interval.tv_sec = 0;
710 timerval.it_interval.tv_usec = 0;
711 timerval.it_value.tv_sec = 0;
712 timerval.it_value.tv_usec = 0;
713 setitimer (ITIMER_REAL, &timerval, NULL);
715 /* And disable the signal handler. */
716 action.sa_handler = SIG_IGN;
717 sigaction (SIGALRM, &action, NULL);
721 /* XXX: This should be merged with the add_files function since it
722 * shares a lot of logic with it. */
723 /* Recursively count all regular files in path and all sub-directories
724 * of path. The result is added to *count (which should be
725 * initialized to zero by the top-level caller before calling
728 count_files (const char *path, int *count, add_files_state_t *state)
730 struct dirent *entry = NULL;
732 struct dirent **fs_entries = NULL;
733 int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
736 if (num_fs_entries == -1) {
737 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
738 path, strerror (errno));
742 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
743 entry = fs_entries[i];
745 /* Ignore special directories to avoid infinite recursion.
746 * Also ignore the .notmuch directory.
748 if (_special_directory (entry->d_name) ||
749 strcmp (entry->d_name, ".notmuch") == 0)
752 /* Ignore any files/directories the user has configured to be
755 if (_entry_in_ignore_list (entry->d_name, state)) {
757 printf ("(D) count_files: explicitly ignoring %s/%s\n",
758 path, entry->d_name);
762 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
764 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
765 path, entry->d_name);
769 entry_type = dirent_type (path, entry);
770 if (entry_type == S_IFREG) {
772 if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
773 printf ("Found %d files so far.\r", *count);
776 } else if (entry_type == S_IFDIR) {
777 count_files (next, count, state);
785 for (i = 0; i < num_fs_entries; i++)
786 free (fs_entries[i]);
793 upgrade_print_progress (void *closure,
796 add_files_state_t *state = closure;
798 printf ("Upgrading database: %.2f%% complete", progress * 100.0);
801 struct timeval tv_now;
802 double elapsed, time_remaining;
804 gettimeofday (&tv_now, NULL);
806 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
807 time_remaining = (elapsed / progress) * (1.0 - progress);
809 notmuch_time_print_formatted_seconds (time_remaining);
810 printf (" remaining)");
818 /* Remove one message filename from the database. */
819 static notmuch_status_t
820 remove_filename (notmuch_database_t *notmuch,
822 add_files_state_t *add_files_state)
824 notmuch_status_t status;
825 notmuch_message_t *message;
826 status = notmuch_database_begin_atomic (notmuch);
829 status = notmuch_database_find_message_by_filename (notmuch, path, &message);
830 if (status || message == NULL)
833 status = notmuch_database_remove_message (notmuch, path);
834 if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
835 add_files_state->renamed_messages++;
836 if (add_files_state->synchronize_flags == TRUE)
837 notmuch_message_maildir_flags_to_tags (message);
838 status = NOTMUCH_STATUS_SUCCESS;
839 } else if (status == NOTMUCH_STATUS_SUCCESS) {
840 add_files_state->removed_messages++;
842 notmuch_message_destroy (message);
845 notmuch_database_end_atomic (notmuch);
849 /* Recursively remove all filenames from the database referring to
850 * 'path' (or to any of its children). */
851 static notmuch_status_t
852 _remove_directory (void *ctx,
853 notmuch_database_t *notmuch,
855 add_files_state_t *add_files_state)
857 notmuch_status_t status;
858 notmuch_directory_t *directory;
859 notmuch_filenames_t *files, *subdirs;
862 status = notmuch_database_get_directory (notmuch, path, &directory);
863 if (status || !directory)
866 for (files = notmuch_directory_get_child_files (directory);
867 notmuch_filenames_valid (files);
868 notmuch_filenames_move_to_next (files))
870 absolute = talloc_asprintf (ctx, "%s/%s", path,
871 notmuch_filenames_get (files));
872 status = remove_filename (notmuch, absolute, add_files_state);
873 talloc_free (absolute);
878 for (subdirs = notmuch_directory_get_child_directories (directory);
879 notmuch_filenames_valid (subdirs);
880 notmuch_filenames_move_to_next (subdirs))
882 absolute = talloc_asprintf (ctx, "%s/%s", path,
883 notmuch_filenames_get (subdirs));
884 status = _remove_directory (ctx, notmuch, absolute, add_files_state);
885 talloc_free (absolute);
890 status = notmuch_directory_delete (directory);
894 notmuch_directory_destroy (directory);
899 print_results (const add_files_state_t *state)
902 struct timeval tv_now;
904 gettimeofday (&tv_now, NULL);
905 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
907 if (state->processed_files) {
908 printf ("Processed %d %s in ", state->processed_files,
909 state->processed_files == 1 ? "file" : "total files");
910 notmuch_time_print_formatted_seconds (elapsed);
912 printf (" (%d files/sec.)",
913 (int) (state->processed_files / elapsed));
914 printf (".%s\n", (state->output_is_a_tty) ? "\033[K" : "");
917 if (state->added_messages)
918 printf ("Added %d new %s to the database.", state->added_messages,
919 state->added_messages == 1 ? "message" : "messages");
921 printf ("No new mail.");
923 if (state->removed_messages)
924 printf (" Removed %d %s.", state->removed_messages,
925 state->removed_messages == 1 ? "message" : "messages");
927 if (state->renamed_messages)
928 printf (" Detected %d file %s.", state->renamed_messages,
929 state->renamed_messages == 1 ? "rename" : "renames");
935 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
937 notmuch_database_t *notmuch;
938 add_files_state_t add_files_state = {
939 .verbosity = VERBOSITY_NORMAL,
941 .output_is_a_tty = isatty (fileno (stdout)),
943 struct timeval tv_start;
947 char *dot_notmuch_path;
948 struct sigaction action;
952 notmuch_bool_t timer_is_active = FALSE;
953 notmuch_bool_t no_hooks = FALSE;
954 notmuch_bool_t quiet = FALSE, verbose = FALSE;
955 notmuch_status_t status;
957 notmuch_opt_desc_t options[] = {
958 { NOTMUCH_OPT_BOOLEAN, &quiet, "quiet", 'q', 0 },
959 { NOTMUCH_OPT_BOOLEAN, &verbose, "verbose", 'v', 0 },
960 { NOTMUCH_OPT_BOOLEAN, &add_files_state.debug, "debug", 'd', 0 },
961 { NOTMUCH_OPT_BOOLEAN, &no_hooks, "no-hooks", 'n', 0 },
962 { NOTMUCH_OPT_INHERIT, (void *) ¬much_shared_options, NULL, 0, 0 },
966 opt_index = parse_arguments (argc, argv, options, 1);
970 notmuch_process_shared_options (argv[0]);
972 /* quiet trumps verbose */
974 add_files_state.verbosity = VERBOSITY_QUIET;
976 add_files_state.verbosity = VERBOSITY_VERBOSE;
978 add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
979 add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
980 add_files_state.synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
981 db_path = notmuch_config_get_database_path (config);
983 for (i = 0; i < add_files_state.new_tags_length; i++) {
984 const char *error_msg;
986 error_msg = illegal_tag (add_files_state.new_tags[i], FALSE);
988 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
989 add_files_state.new_tags[i], error_msg);
995 ret = notmuch_run_hook (db_path, "pre-new");
1000 dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
1002 if (stat (dot_notmuch_path, &st)) {
1006 count_files (db_path, &count, &add_files_state);
1008 return EXIT_FAILURE;
1010 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1011 printf ("Found %d total files (that's not much mail).\n", count);
1012 if (notmuch_database_create (db_path, ¬much))
1013 return EXIT_FAILURE;
1014 add_files_state.total_files = count;
1016 char *status_string = NULL;
1017 if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1018 ¬much, &status_string)) {
1019 if (status_string) {
1020 fputs (status_string, stderr);
1021 free (status_string);
1023 return EXIT_FAILURE;
1026 notmuch_exit_if_unmatched_db_uuid (notmuch);
1028 if (notmuch_database_needs_upgrade (notmuch)) {
1029 time_t now = time (NULL);
1030 struct tm *gm_time = gmtime (&now);
1032 /* since dump files are written atomically, the amount of
1033 * harm from overwriting one within a second seems
1034 * relatively small. */
1036 const char *backup_name =
1037 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1039 gm_time->tm_year + 1900,
1040 gm_time->tm_mon + 1,
1046 if (add_files_state.verbosity >= VERBOSITY_NORMAL) {
1047 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1048 printf ("This process is safe to interrupt.\n");
1049 printf ("Backing up tags to %s...\n", backup_name);
1052 if (notmuch_database_dump (notmuch, backup_name, "",
1053 DUMP_FORMAT_BATCH_TAG, DUMP_INCLUDE_DEFAULT, TRUE)) {
1054 fprintf (stderr, "Backup failed. Aborting upgrade.");
1055 return EXIT_FAILURE;
1058 gettimeofday (&add_files_state.tv_start, NULL);
1059 status = notmuch_database_upgrade (
1061 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1064 printf ("Upgrade failed: %s\n",
1065 notmuch_status_to_string (status));
1066 notmuch_database_destroy (notmuch);
1067 return EXIT_FAILURE;
1069 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1070 printf ("Your notmuch database has now been upgraded.\n");
1073 add_files_state.total_files = 0;
1076 if (notmuch == NULL)
1077 return EXIT_FAILURE;
1079 /* Set up our handler for SIGINT. We do this after having
1080 * potentially done a database upgrade we this interrupt handler
1082 memset (&action, 0, sizeof (struct sigaction));
1083 action.sa_handler = handle_sigint;
1084 sigemptyset (&action.sa_mask);
1085 action.sa_flags = SA_RESTART;
1086 sigaction (SIGINT, &action, NULL);
1088 talloc_free (dot_notmuch_path);
1089 dot_notmuch_path = NULL;
1091 gettimeofday (&add_files_state.tv_start, NULL);
1093 add_files_state.removed_files = _filename_list_create (config);
1094 add_files_state.removed_directories = _filename_list_create (config);
1095 add_files_state.directory_mtimes = _filename_list_create (config);
1097 if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1098 add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1099 setup_progress_printing_timer ();
1100 timer_is_active = TRUE;
1103 ret = add_files (notmuch, db_path, &add_files_state);
1107 gettimeofday (&tv_start, NULL);
1108 for (f = add_files_state.removed_files->head; f && !interrupted; f = f->next) {
1109 ret = remove_filename (notmuch, f->filename, &add_files_state);
1112 if (do_print_progress) {
1113 do_print_progress = 0;
1114 generic_print_progress ("Cleaned up", "messages",
1115 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1116 add_files_state.removed_files->count);
1120 gettimeofday (&tv_start, NULL);
1121 for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
1122 ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
1125 if (do_print_progress) {
1126 do_print_progress = 0;
1127 generic_print_progress ("Cleaned up", "directories",
1129 add_files_state.removed_directories->count);
1133 for (f = add_files_state.directory_mtimes->head; f && !interrupted; f = f->next) {
1134 notmuch_directory_t *directory;
1135 status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1136 if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1137 notmuch_directory_set_mtime (directory, f->mtime);
1138 notmuch_directory_destroy (directory);
1143 talloc_free (add_files_state.removed_files);
1144 talloc_free (add_files_state.removed_directories);
1145 talloc_free (add_files_state.directory_mtimes);
1147 if (timer_is_active)
1148 stop_progress_printing_timer ();
1150 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1151 print_results (&add_files_state);
1154 fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1155 notmuch_status_to_string (ret));
1157 notmuch_database_destroy (notmuch);
1159 if (!no_hooks && !ret && !interrupted)
1160 ret = notmuch_run_hook (db_path, "post-new");
1162 if (ret || interrupted)
1163 return EXIT_FAILURE;
1165 if (add_files_state.vanished_files)
1166 return NOTMUCH_EXIT_TEMPFAIL;
1168 return EXIT_SUCCESS;