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 bool 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)
238 _special_directory (const char *entry)
240 return strcmp (entry, ".") == 0 || strcmp (entry, "..") == 0;
243 /* Test if the file/directory is to be ignored.
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;
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 special directories early. */
525 if (_special_directory (entry->d_name))
528 /* Ignore files & directories user has configured to be ignored */
529 if (_entry_in_ignore_list (entry->d_name, state)) {
531 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
532 path, entry->d_name);
536 /* Check if we've walked past any names in db_files or
537 * db_subdirs. If so, these have been deleted. */
538 while (notmuch_filenames_valid (db_files) &&
539 strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
541 char *absolute = talloc_asprintf (state->removed_files,
543 notmuch_filenames_get (db_files));
546 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
549 _filename_list_add (state->removed_files, absolute);
551 notmuch_filenames_move_to_next (db_files);
554 while (notmuch_filenames_valid (db_subdirs) &&
555 strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
557 const char *filename = notmuch_filenames_get (db_subdirs);
559 if (strcmp (filename, entry->d_name) < 0)
561 char *absolute = talloc_asprintf (state->removed_directories,
562 "%s/%s", path, filename);
564 printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
567 _filename_list_add (state->removed_directories, absolute);
570 notmuch_filenames_move_to_next (db_subdirs);
573 /* Only add regular files (and symlinks to regular files). */
574 entry_type = dirent_type (path, entry);
575 if (entry_type == -1) {
576 fprintf (stderr, "Error reading file %s/%s: %s\n",
577 path, entry->d_name, strerror (errno));
578 return NOTMUCH_STATUS_FILE_ERROR;
579 } else if (entry_type != S_IFREG) {
583 /* Don't add a file that we've added before. */
584 if (notmuch_filenames_valid (db_files) &&
585 strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
587 notmuch_filenames_move_to_next (db_files);
591 /* We're now looking at a regular file that doesn't yet exist
592 * in the database, so add it. */
593 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
595 state->processed_files++;
597 if (state->verbosity >= VERBOSITY_VERBOSE) {
598 if (state->output_is_a_tty)
601 printf ("%i/%i: %s", state->processed_files, state->total_files,
604 putchar((state->output_is_a_tty) ? '\r' : '\n');
608 status = add_file (notmuch, next, state);
614 if (do_print_progress) {
615 do_print_progress = 0;
616 generic_print_progress ("Processed", "files", state->tv_start,
617 state->processed_files, state->total_files);
627 /* Now that we've walked the whole filesystem list, anything left
628 * over in the database lists has been deleted. */
629 while (notmuch_filenames_valid (db_files))
631 char *absolute = talloc_asprintf (state->removed_files,
633 notmuch_filenames_get (db_files));
635 printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
638 _filename_list_add (state->removed_files, absolute);
640 notmuch_filenames_move_to_next (db_files);
643 while (notmuch_filenames_valid (db_subdirs))
645 char *absolute = talloc_asprintf (state->removed_directories,
647 notmuch_filenames_get (db_subdirs));
650 printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
653 _filename_list_add (state->removed_directories, absolute);
655 notmuch_filenames_move_to_next (db_subdirs);
658 /* If the directory's mtime is the same as the wall-clock time
659 * when we stat'ed the directory, we skip updating the mtime in
660 * the database because a message could be delivered later in this
661 * same second. This may lead to unnecessary re-scans, but it
662 * avoids overlooking messages. */
663 if (fs_mtime != stat_time)
664 _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
670 for (i = 0; i < num_fs_entries; i++)
671 free (fs_entries[i]);
676 notmuch_filenames_destroy (db_subdirs);
678 notmuch_filenames_destroy (db_files);
680 notmuch_directory_destroy (directory);
686 setup_progress_printing_timer (void)
688 struct sigaction action;
689 struct itimerval timerval;
691 /* Set up our handler for SIGALRM */
692 memset (&action, 0, sizeof (struct sigaction));
693 action.sa_handler = handle_sigalrm;
694 sigemptyset (&action.sa_mask);
695 action.sa_flags = SA_RESTART;
696 sigaction (SIGALRM, &action, NULL);
698 /* Then start a timer to send SIGALRM once per second. */
699 timerval.it_interval.tv_sec = 1;
700 timerval.it_interval.tv_usec = 0;
701 timerval.it_value.tv_sec = 1;
702 timerval.it_value.tv_usec = 0;
703 setitimer (ITIMER_REAL, &timerval, NULL);
707 stop_progress_printing_timer (void)
709 struct sigaction action;
710 struct itimerval timerval;
712 /* Now stop the timer. */
713 timerval.it_interval.tv_sec = 0;
714 timerval.it_interval.tv_usec = 0;
715 timerval.it_value.tv_sec = 0;
716 timerval.it_value.tv_usec = 0;
717 setitimer (ITIMER_REAL, &timerval, NULL);
719 /* And disable the signal handler. */
720 action.sa_handler = SIG_IGN;
721 sigaction (SIGALRM, &action, NULL);
725 /* XXX: This should be merged with the add_files function since it
726 * shares a lot of logic with it. */
727 /* Recursively count all regular files in path and all sub-directories
728 * of path. The result is added to *count (which should be
729 * initialized to zero by the top-level caller before calling
732 count_files (const char *path, int *count, add_files_state_t *state)
734 struct dirent *entry = NULL;
736 struct dirent **fs_entries = NULL;
737 int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
740 if (num_fs_entries == -1) {
741 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
742 path, strerror (errno));
746 for (i = 0; i < num_fs_entries && ! interrupted; i++) {
747 entry = fs_entries[i];
749 /* Ignore special directories to avoid infinite recursion.
750 * Also ignore the .notmuch directory.
752 if (_special_directory (entry->d_name) ||
753 strcmp (entry->d_name, ".notmuch") == 0)
756 /* Ignore any files/directories the user has configured to be
759 if (_entry_in_ignore_list (entry->d_name, state)) {
761 printf ("(D) count_files: explicitly ignoring %s/%s\n",
762 path, entry->d_name);
766 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
768 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
769 path, entry->d_name);
773 entry_type = dirent_type (path, entry);
774 if (entry_type == S_IFREG) {
776 if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
777 printf ("Found %d files so far.\r", *count);
780 } else if (entry_type == S_IFDIR) {
781 count_files (next, count, state);
789 for (i = 0; i < num_fs_entries; i++)
790 free (fs_entries[i]);
797 upgrade_print_progress (void *closure,
800 add_files_state_t *state = closure;
802 printf ("Upgrading database: %.2f%% complete", progress * 100.0);
805 struct timeval tv_now;
806 double elapsed, time_remaining;
808 gettimeofday (&tv_now, NULL);
810 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
811 time_remaining = (elapsed / progress) * (1.0 - progress);
813 notmuch_time_print_formatted_seconds (time_remaining);
814 printf (" remaining)");
822 /* Remove one message filename from the database. */
823 static notmuch_status_t
824 remove_filename (notmuch_database_t *notmuch,
826 add_files_state_t *add_files_state)
828 notmuch_status_t status;
829 notmuch_message_t *message;
830 status = notmuch_database_begin_atomic (notmuch);
833 status = notmuch_database_find_message_by_filename (notmuch, path, &message);
834 if (status || message == NULL)
837 status = notmuch_database_remove_message (notmuch, path);
838 if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
839 add_files_state->renamed_messages++;
840 if (add_files_state->synchronize_flags == true)
841 notmuch_message_maildir_flags_to_tags (message);
842 status = NOTMUCH_STATUS_SUCCESS;
843 } else if (status == NOTMUCH_STATUS_SUCCESS) {
844 add_files_state->removed_messages++;
846 notmuch_message_destroy (message);
849 notmuch_database_end_atomic (notmuch);
853 /* Recursively remove all filenames from the database referring to
854 * 'path' (or to any of its children). */
855 static notmuch_status_t
856 _remove_directory (void *ctx,
857 notmuch_database_t *notmuch,
859 add_files_state_t *add_files_state)
861 notmuch_status_t status;
862 notmuch_directory_t *directory;
863 notmuch_filenames_t *files, *subdirs;
866 status = notmuch_database_get_directory (notmuch, path, &directory);
867 if (status || !directory)
870 for (files = notmuch_directory_get_child_files (directory);
871 notmuch_filenames_valid (files);
872 notmuch_filenames_move_to_next (files))
874 absolute = talloc_asprintf (ctx, "%s/%s", path,
875 notmuch_filenames_get (files));
876 status = remove_filename (notmuch, absolute, add_files_state);
877 talloc_free (absolute);
882 for (subdirs = notmuch_directory_get_child_directories (directory);
883 notmuch_filenames_valid (subdirs);
884 notmuch_filenames_move_to_next (subdirs))
886 absolute = talloc_asprintf (ctx, "%s/%s", path,
887 notmuch_filenames_get (subdirs));
888 status = _remove_directory (ctx, notmuch, absolute, add_files_state);
889 talloc_free (absolute);
894 status = notmuch_directory_delete (directory);
898 notmuch_directory_destroy (directory);
903 print_results (const add_files_state_t *state)
906 struct timeval tv_now;
908 gettimeofday (&tv_now, NULL);
909 elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
911 if (state->processed_files) {
912 printf ("Processed %d %s in ", state->processed_files,
913 state->processed_files == 1 ? "file" : "total files");
914 notmuch_time_print_formatted_seconds (elapsed);
916 printf (" (%d files/sec.)",
917 (int) (state->processed_files / elapsed));
918 printf (".%s\n", (state->output_is_a_tty) ? "\033[K" : "");
921 if (state->added_messages)
922 printf ("Added %d new %s to the database.", state->added_messages,
923 state->added_messages == 1 ? "message" : "messages");
925 printf ("No new mail.");
927 if (state->removed_messages)
928 printf (" Removed %d %s.", state->removed_messages,
929 state->removed_messages == 1 ? "message" : "messages");
931 if (state->renamed_messages)
932 printf (" Detected %d file %s.", state->renamed_messages,
933 state->renamed_messages == 1 ? "rename" : "renames");
939 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
941 notmuch_database_t *notmuch;
942 add_files_state_t add_files_state = {
943 .verbosity = VERBOSITY_NORMAL,
945 .output_is_a_tty = isatty (fileno (stdout)),
947 struct timeval tv_start;
951 char *dot_notmuch_path;
952 struct sigaction action;
956 bool timer_is_active = false;
957 bool no_hooks = false;
958 bool quiet = false, verbose = false;
959 notmuch_status_t status;
961 notmuch_opt_desc_t options[] = {
962 { .opt_bool = &quiet, .name = "quiet" },
963 { .opt_bool = &verbose, .name = "verbose" },
964 { .opt_bool = &add_files_state.debug, .name = "debug" },
965 { .opt_bool = &no_hooks, .name = "no-hooks" },
966 { .opt_inherit = notmuch_shared_options },
970 opt_index = parse_arguments (argc, argv, options, 1);
974 notmuch_process_shared_options (argv[0]);
976 /* quiet trumps verbose */
978 add_files_state.verbosity = VERBOSITY_QUIET;
980 add_files_state.verbosity = VERBOSITY_VERBOSE;
982 add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
983 add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
984 add_files_state.synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
985 db_path = notmuch_config_get_database_path (config);
987 for (i = 0; i < add_files_state.new_tags_length; i++) {
988 const char *error_msg;
990 error_msg = illegal_tag (add_files_state.new_tags[i], false);
992 fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
993 add_files_state.new_tags[i], error_msg);
999 ret = notmuch_run_hook (db_path, "pre-new");
1001 return EXIT_FAILURE;
1004 dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
1006 if (stat (dot_notmuch_path, &st)) {
1010 count_files (db_path, &count, &add_files_state);
1012 return EXIT_FAILURE;
1014 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1015 printf ("Found %d total files (that's not much mail).\n", count);
1016 if (notmuch_database_create (db_path, ¬much))
1017 return EXIT_FAILURE;
1018 add_files_state.total_files = count;
1020 char *status_string = NULL;
1021 if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1022 ¬much, &status_string)) {
1023 if (status_string) {
1024 fputs (status_string, stderr);
1025 free (status_string);
1027 return EXIT_FAILURE;
1030 notmuch_exit_if_unmatched_db_uuid (notmuch);
1032 if (notmuch_database_needs_upgrade (notmuch)) {
1033 time_t now = time (NULL);
1034 struct tm *gm_time = gmtime (&now);
1036 /* since dump files are written atomically, the amount of
1037 * harm from overwriting one within a second seems
1038 * relatively small. */
1040 const char *backup_name =
1041 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1043 gm_time->tm_year + 1900,
1044 gm_time->tm_mon + 1,
1050 if (add_files_state.verbosity >= VERBOSITY_NORMAL) {
1051 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1052 printf ("This process is safe to interrupt.\n");
1053 printf ("Backing up tags to %s...\n", backup_name);
1056 if (notmuch_database_dump (notmuch, backup_name, "",
1057 DUMP_FORMAT_BATCH_TAG, DUMP_INCLUDE_DEFAULT, true)) {
1058 fprintf (stderr, "Backup failed. Aborting upgrade.");
1059 return EXIT_FAILURE;
1062 gettimeofday (&add_files_state.tv_start, NULL);
1063 status = notmuch_database_upgrade (
1065 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1068 printf ("Upgrade failed: %s\n",
1069 notmuch_status_to_string (status));
1070 notmuch_database_destroy (notmuch);
1071 return EXIT_FAILURE;
1073 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1074 printf ("Your notmuch database has now been upgraded.\n");
1077 add_files_state.total_files = 0;
1080 if (notmuch == NULL)
1081 return EXIT_FAILURE;
1083 /* Set up our handler for SIGINT. We do this after having
1084 * potentially done a database upgrade we this interrupt handler
1086 memset (&action, 0, sizeof (struct sigaction));
1087 action.sa_handler = handle_sigint;
1088 sigemptyset (&action.sa_mask);
1089 action.sa_flags = SA_RESTART;
1090 sigaction (SIGINT, &action, NULL);
1092 talloc_free (dot_notmuch_path);
1093 dot_notmuch_path = NULL;
1095 gettimeofday (&add_files_state.tv_start, NULL);
1097 add_files_state.removed_files = _filename_list_create (config);
1098 add_files_state.removed_directories = _filename_list_create (config);
1099 add_files_state.directory_mtimes = _filename_list_create (config);
1101 if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1102 add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1103 setup_progress_printing_timer ();
1104 timer_is_active = true;
1107 ret = add_files (notmuch, db_path, &add_files_state);
1111 gettimeofday (&tv_start, NULL);
1112 for (f = add_files_state.removed_files->head; f && !interrupted; f = f->next) {
1113 ret = remove_filename (notmuch, f->filename, &add_files_state);
1116 if (do_print_progress) {
1117 do_print_progress = 0;
1118 generic_print_progress ("Cleaned up", "messages",
1119 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1120 add_files_state.removed_files->count);
1124 gettimeofday (&tv_start, NULL);
1125 for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
1126 ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
1129 if (do_print_progress) {
1130 do_print_progress = 0;
1131 generic_print_progress ("Cleaned up", "directories",
1133 add_files_state.removed_directories->count);
1137 for (f = add_files_state.directory_mtimes->head; f && !interrupted; f = f->next) {
1138 notmuch_directory_t *directory;
1139 status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1140 if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1141 notmuch_directory_set_mtime (directory, f->mtime);
1142 notmuch_directory_destroy (directory);
1147 talloc_free (add_files_state.removed_files);
1148 talloc_free (add_files_state.removed_directories);
1149 talloc_free (add_files_state.directory_mtimes);
1151 if (timer_is_active)
1152 stop_progress_printing_timer ();
1154 if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1155 print_results (&add_files_state);
1158 fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1159 notmuch_status_to_string (ret));
1161 notmuch_database_destroy (notmuch);
1163 if (!no_hooks && !ret && !interrupted)
1164 ret = notmuch_run_hook (db_path, "post-new");
1166 if (ret || interrupted)
1167 return EXIT_FAILURE;
1169 if (add_files_state.vanished_files)
1170 return NOTMUCH_EXIT_TEMPFAIL;
1172 return EXIT_SUCCESS;