04cb5cac092a9cf08def0af2645f89a5d0394c5f
[notmuch] / notmuch-new.c
1 /* notmuch - Not much of an email program, (just index and search)
2  *
3  * Copyright © 2009 Carl Worth
4  *
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.
9  *
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.
14  *
15  * You should have received a copy of the GNU General Public License
16  * along with this program.  If not, see http://www.gnu.org/licenses/ .
17  *
18  * Author: Carl Worth <cworth@cworth.org>
19  */
20
21 #include "notmuch-client.h"
22 #include "tag-util.h"
23
24 #include <unistd.h>
25
26 typedef struct _filename_node {
27     char *filename;
28     time_t mtime;
29     struct _filename_node *next;
30 } _filename_node_t;
31
32 typedef struct _filename_list {
33     unsigned count;
34     _filename_node_t *head;
35     _filename_node_t **tail;
36 } _filename_list_t;
37
38 enum verbosity {
39     VERBOSITY_QUIET,
40     VERBOSITY_NORMAL,
41     VERBOSITY_VERBOSE,
42 };
43
44 typedef struct {
45     int output_is_a_tty;
46     enum verbosity verbosity;
47     notmuch_bool_t debug;
48     const char **new_tags;
49     size_t new_tags_length;
50     const char **new_ignore;
51     size_t new_ignore_length;
52
53     int total_files;
54     int processed_files;
55     int added_messages, removed_messages, renamed_messages;
56     struct timeval tv_start;
57
58     _filename_list_t *removed_files;
59     _filename_list_t *removed_directories;
60     _filename_list_t *directory_mtimes;
61
62     notmuch_bool_t synchronize_flags;
63 } add_files_state_t;
64
65 static volatile sig_atomic_t do_print_progress = 0;
66
67 static void
68 handle_sigalrm (unused (int signal))
69 {
70     do_print_progress = 1;
71 }
72
73 static volatile sig_atomic_t interrupted;
74
75 static void
76 handle_sigint (unused (int sig))
77 {
78     static char msg[] = "Stopping...         \n";
79
80     /* This write is "opportunistic", so it's okay to ignore the
81      * result.  It is not required for correctness, and if it does
82      * fail or produce a short write, we want to get out of the signal
83      * handler as quickly as possible, not retry it. */
84     IGNORE_RESULT (write (2, msg, sizeof(msg)-1));
85     interrupted = 1;
86 }
87
88 static _filename_list_t *
89 _filename_list_create (const void *ctx)
90 {
91     _filename_list_t *list;
92
93     list = talloc (ctx, _filename_list_t);
94     if (list == NULL)
95         return NULL;
96
97     list->head = NULL;
98     list->tail = &list->head;
99     list->count = 0;
100
101     return list;
102 }
103
104 static _filename_node_t *
105 _filename_list_add (_filename_list_t *list,
106                     const char *filename)
107 {
108     _filename_node_t *node = talloc (list, _filename_node_t);
109
110     list->count++;
111
112     node->filename = talloc_strdup (list, filename);
113     node->next = NULL;
114
115     *(list->tail) = node;
116     list->tail = &node->next;
117
118     return node;
119 }
120
121 static void
122 generic_print_progress (const char *action, const char *object,
123                         struct timeval tv_start, unsigned processed, unsigned total)
124 {
125     struct timeval tv_now;
126     double elapsed_overall, rate_overall;
127
128     gettimeofday (&tv_now, NULL);
129
130     elapsed_overall = notmuch_time_elapsed (tv_start, tv_now);
131     rate_overall = processed / elapsed_overall;
132
133     printf ("%s %d ", action, processed);
134
135     if (total) {
136         printf ("of %d %s", total, object);
137         if (processed > 0 && elapsed_overall > 0.5) {
138             double time_remaining = ((total - processed) / rate_overall);
139             printf (" (");
140             notmuch_time_print_formatted_seconds (time_remaining);
141             printf (" remaining)");
142         }
143     } else {
144         printf ("%s", object);
145         if (elapsed_overall > 0.5)
146             printf (" (%d %s/sec.)", (int) rate_overall, object);
147     }
148     printf (".\033[K\r");
149
150     fflush (stdout);
151 }
152
153 static int
154 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
155 {
156     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
157 }
158
159 static int
160 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
161 {
162     return strcmp ((*a)->d_name, (*b)->d_name);
163 }
164
165 /* Return the type of a directory entry relative to path as a stat(2)
166  * mode.  Like stat, this follows symlinks.  Returns -1 and sets errno
167  * if the file's type cannot be determined (which includes dangling
168  * symlinks).
169  */
170 static int
171 dirent_type (const char *path, const struct dirent *entry)
172 {
173     struct stat statbuf;
174     char *abspath;
175     int err, saved_errno;
176
177 #if HAVE_D_TYPE
178     /* Mapping from d_type to stat mode_t.  We omit DT_LNK so that
179      * we'll fall through to stat and get the real file type. */
180     static const mode_t modes[] = {
181         [DT_BLK]  = S_IFBLK,
182         [DT_CHR]  = S_IFCHR,
183         [DT_DIR]  = S_IFDIR,
184         [DT_FIFO] = S_IFIFO,
185         [DT_REG]  = S_IFREG,
186         [DT_SOCK] = S_IFSOCK
187     };
188     if (entry->d_type < ARRAY_SIZE(modes) && modes[entry->d_type])
189         return modes[entry->d_type];
190 #endif
191
192     abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);
193     if (!abspath) {
194         errno = ENOMEM;
195         return -1;
196     }
197     err = stat(abspath, &statbuf);
198     saved_errno = errno;
199     talloc_free (abspath);
200     if (err < 0) {
201         errno = saved_errno;
202         return -1;
203     }
204     return statbuf.st_mode & S_IFMT;
205 }
206
207 /* Test if the directory looks like a Maildir directory.
208  *
209  * Search through the array of directory entries to see if we can find all
210  * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
211  *
212  * Return 1 if the directory looks like a Maildir and 0 otherwise.
213  */
214 static int
215 _entries_resemble_maildir (const char *path, struct dirent **entries, int count)
216 {
217     int i, found = 0;
218
219     for (i = 0; i < count; i++) {
220         if (dirent_type (path, entries[i]) != S_IFDIR)
221             continue;
222
223         if (strcmp(entries[i]->d_name, "new") == 0 ||
224             strcmp(entries[i]->d_name, "cur") == 0 ||
225             strcmp(entries[i]->d_name, "tmp") == 0)
226         {
227             found++;
228             if (found == 3)
229                 return 1;
230         }
231     }
232
233     return 0;
234 }
235
236 /* Test if the file/directory is to be ignored.
237  */
238 static notmuch_bool_t
239 _entry_in_ignore_list (const char *entry, add_files_state_t *state)
240 {
241     size_t i;
242
243     for (i = 0; i < state->new_ignore_length; i++)
244         if (strcmp (entry, state->new_ignore[i]) == 0)
245             return TRUE;
246
247     return FALSE;
248 }
249
250 /* Add a single file to the database. */
251 static notmuch_status_t
252 add_file (notmuch_database_t *notmuch, const char *filename,
253           add_files_state_t *state)
254 {
255     notmuch_message_t *message = NULL;
256     const char **tag;
257     notmuch_status_t status;
258
259     status = notmuch_database_begin_atomic (notmuch);
260     if (status)
261         goto DONE;
262
263     status = notmuch_database_add_message (notmuch, filename, &message);
264     switch (status) {
265     /* Success. */
266     case NOTMUCH_STATUS_SUCCESS:
267         state->added_messages++;
268         notmuch_message_freeze (message);
269         for (tag = state->new_tags; *tag != NULL; tag++)
270             notmuch_message_add_tag (message, *tag);
271         if (state->synchronize_flags)
272             notmuch_message_maildir_flags_to_tags (message);
273         notmuch_message_thaw (message);
274         break;
275     /* Non-fatal issues (go on to next file). */
276     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
277         if (state->synchronize_flags)
278             notmuch_message_maildir_flags_to_tags (message);
279         break;
280     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
281         fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
282         break;
283     /* Fatal issues. Don't process anymore. */
284     case NOTMUCH_STATUS_FILE_ERROR:
285         fprintf (stderr, "Unexpected error with file %s\n", filename);
286         (void) print_status_database ("add_file", notmuch, status);
287         goto DONE;
288     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
289     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
290     case NOTMUCH_STATUS_OUT_OF_MEMORY:
291         fprintf (stderr, "Error: %s. Halting processing.\n",
292                  notmuch_status_to_string (status));
293         goto DONE;
294     default:
295         INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
296         goto DONE;
297     }
298
299     status = notmuch_database_end_atomic (notmuch);
300
301   DONE:
302     if (message)
303         notmuch_message_destroy (message);
304
305     return status;
306 }
307
308 /* Examine 'path' recursively as follows:
309  *
310  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
311  *   o Ask the database for its timestamp of 'path' (db_mtime)
312  *
313  *   o Ask the filesystem for files and directories within 'path'
314  *     (via scandir and stored in fs_entries)
315  *
316  *   o Pass 1: For each directory in fs_entries, recursively call into
317  *     this same function.
318  *
319  *   o Compare fs_mtime to db_mtime. If they are equivalent, terminate
320  *     the algorithm at this point, (this directory has not been
321  *     updated in the filesystem since the last database scan of PASS
322  *     2).
323  *
324  *   o Ask the database for files and directories within 'path'
325  *     (db_files and db_subdirs)
326  *
327  *   o Pass 2: Walk fs_entries simultaneously with db_files and
328  *     db_subdirs. Look for one of three interesting cases:
329  *
330  *         1. Regular file in fs_entries and not in db_files
331  *            This is a new file to add_message into the database.
332  *
333  *         2. Filename in db_files not in fs_entries.
334  *            This is a file that has been removed from the mail store.
335  *
336  *         3. Directory in db_subdirs not in fs_entries
337  *            This is a directory that has been removed from the mail store.
338  *
339  *     Note that the addition of a directory is not interesting here,
340  *     since that will have been taken care of in pass 1. Also, we
341  *     don't immediately act on file/directory removal since we must
342  *     ensure that in the case of a rename that the new filename is
343  *     added before the old filename is removed, (so that no
344  *     information is lost from the database).
345  *
346  *   o Tell the database to update its time of 'path' to 'fs_mtime'
347  *     if fs_mtime isn't the current wall-clock time.
348  */
349 static notmuch_status_t
350 add_files (notmuch_database_t *notmuch,
351            const char *path,
352            add_files_state_t *state)
353 {
354     DIR *dir = NULL;
355     struct dirent *entry = NULL;
356     char *next = NULL;
357     time_t fs_mtime, db_mtime;
358     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
359     struct dirent **fs_entries = NULL;
360     int i, num_fs_entries = 0, entry_type;
361     notmuch_directory_t *directory;
362     notmuch_filenames_t *db_files = NULL;
363     notmuch_filenames_t *db_subdirs = NULL;
364     time_t stat_time;
365     struct stat st;
366     notmuch_bool_t is_maildir;
367
368     if (stat (path, &st)) {
369         fprintf (stderr, "Error reading directory %s: %s\n",
370                  path, strerror (errno));
371         return NOTMUCH_STATUS_FILE_ERROR;
372     }
373     stat_time = time (NULL);
374
375     if (! S_ISDIR (st.st_mode)) {
376         fprintf (stderr, "Error: %s is not a directory.\n", path);
377         return NOTMUCH_STATUS_FILE_ERROR;
378     }
379
380     fs_mtime = st.st_mtime;
381
382     status = notmuch_database_get_directory (notmuch, path, &directory);
383     if (status) {
384         ret = status;
385         goto DONE;
386     }
387     db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
388
389     /* If the directory is unchanged from our last scan and has no
390      * sub-directories, then return without scanning it at all.  In
391      * some situations, skipping the scan can substantially reduce the
392      * cost of notmuch new, especially since the huge numbers of files
393      * in Maildirs make scans expensive, but all files live in leaf
394      * directories.
395      *
396      * To check for sub-directories, we borrow a trick from find,
397      * kpathsea, and many other UNIX tools: since a directory's link
398      * count is the number of sub-directories (specifically, their
399      * '..' entries) plus 2 (the link from the parent and the link for
400      * '.').  This check is safe even on weird file systems, since
401      * file systems that can't compute this will return 0 or 1.  This
402      * is safe even on *really* weird file systems like HFS+ that
403      * mistakenly return the total number of directory entries, since
404      * that only inflates the count beyond 2.
405      */
406     if (directory && fs_mtime == db_mtime && st.st_nlink == 2) {
407         /* There's one catch: pass 1 below considers symlinks to
408          * directories to be directories, but these don't increase the
409          * file system link count.  So, only bail early if the
410          * database agrees that there are no sub-directories. */
411         db_subdirs = notmuch_directory_get_child_directories (directory);
412         if (!notmuch_filenames_valid (db_subdirs))
413             goto DONE;
414         notmuch_filenames_destroy (db_subdirs);
415         db_subdirs = NULL;
416     }
417
418     /* If the database knows about this directory, then we sort based
419      * on strcmp to match the database sorting. Otherwise, we can do
420      * inode-based sorting for faster filesystem operation. */
421     num_fs_entries = scandir (path, &fs_entries, 0,
422                               directory ?
423                               dirent_sort_strcmp_name : dirent_sort_inode);
424
425     if (num_fs_entries == -1) {
426         fprintf (stderr, "Error opening directory %s: %s\n",
427                  path, strerror (errno));
428         /* We consider this a fatal error because, if a user moved a
429          * message from another directory that we were able to scan
430          * into this directory, skipping this directory will cause
431          * that message to be lost. */
432         ret = NOTMUCH_STATUS_FILE_ERROR;
433         goto DONE;
434     }
435
436     /* Pass 1: Recurse into all sub-directories. */
437     is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
438
439     for (i = 0; i < num_fs_entries; i++) {
440         if (interrupted)
441             break;
442
443         entry = fs_entries[i];
444
445         /* Ignore any files/directories the user has configured to
446          * ignore.  We do this before dirent_type both for performance
447          * and because we don't care if dirent_type fails on entries
448          * that are explicitly ignored.
449          */
450         if (_entry_in_ignore_list (entry->d_name, state)) {
451             if (state->debug)
452                 printf ("(D) add_files, pass 1: explicitly ignoring %s/%s\n",
453                         path, entry->d_name);
454             continue;
455         }
456
457         /* We only want to descend into directories (and symlinks to
458          * directories). */
459         entry_type = dirent_type (path, entry);
460         if (entry_type == -1) {
461             /* Be pessimistic, e.g. so we don't lose lots of mail just
462              * because a user broke a symlink. */
463             fprintf (stderr, "Error reading file %s/%s: %s\n",
464                      path, entry->d_name, strerror (errno));
465             return NOTMUCH_STATUS_FILE_ERROR;
466         } else if (entry_type != S_IFDIR) {
467             continue;
468         }
469
470         /* Ignore special directories to avoid infinite recursion.
471          * Also ignore the .notmuch directory and any "tmp" directory
472          * that appears within a maildir.
473          */
474         if (strcmp (entry->d_name, ".") == 0 ||
475             strcmp (entry->d_name, "..") == 0 ||
476             (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
477             strcmp (entry->d_name, ".notmuch") == 0)
478             continue;
479
480         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
481         status = add_files (notmuch, next, state);
482         if (status) {
483             ret = status;
484             goto DONE;
485         }
486         talloc_free (next);
487         next = NULL;
488     }
489
490     /* If the directory's modification time in the filesystem is the
491      * same as what we recorded in the database the last time we
492      * scanned it, then we can skip the second pass entirely.
493      *
494      * We test for strict equality here to avoid a bug that can happen
495      * if the system clock jumps backward, (preventing new mail from
496      * being discovered until the clock catches up and the directory
497      * is modified again).
498      */
499     if (directory && fs_mtime == db_mtime)
500         goto DONE;
501
502     /* If the database has never seen this directory before, we can
503      * simply leave db_files and db_subdirs NULL. */
504     if (directory) {
505         db_files = notmuch_directory_get_child_files (directory);
506         db_subdirs = notmuch_directory_get_child_directories (directory);
507     }
508
509     /* Pass 2: Scan for new files, removed files, and removed directories. */
510     for (i = 0; i < num_fs_entries; i++)
511     {
512         if (interrupted)
513             break;
514
515         entry = fs_entries[i];
516
517         /* Ignore files & directories user has configured to be ignored */
518         if (_entry_in_ignore_list (entry->d_name, state)) {
519             if (state->debug)
520                 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
521                         path, entry->d_name);
522             continue;
523         }
524
525         /* Check if we've walked past any names in db_files or
526          * db_subdirs. If so, these have been deleted. */
527         while (notmuch_filenames_valid (db_files) &&
528                strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
529         {
530             char *absolute = talloc_asprintf (state->removed_files,
531                                               "%s/%s", path,
532                                               notmuch_filenames_get (db_files));
533
534             if (state->debug)
535                 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
536                         absolute);
537
538             _filename_list_add (state->removed_files, absolute);
539
540             notmuch_filenames_move_to_next (db_files);
541         }
542
543         while (notmuch_filenames_valid (db_subdirs) &&
544                strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
545         {
546             const char *filename = notmuch_filenames_get (db_subdirs);
547
548             if (strcmp (filename, entry->d_name) < 0)
549             {
550                 char *absolute = talloc_asprintf (state->removed_directories,
551                                                   "%s/%s", path, filename);
552                 if (state->debug)
553                     printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
554                         absolute);
555
556                 _filename_list_add (state->removed_directories, absolute);
557             }
558
559             notmuch_filenames_move_to_next (db_subdirs);
560         }
561
562         /* Only add regular files (and symlinks to regular files). */
563         entry_type = dirent_type (path, entry);
564         if (entry_type == -1) {
565             fprintf (stderr, "Error reading file %s/%s: %s\n",
566                      path, entry->d_name, strerror (errno));
567             return NOTMUCH_STATUS_FILE_ERROR;
568         } else if (entry_type != S_IFREG) {
569             continue;
570         }
571
572         /* Don't add a file that we've added before. */
573         if (notmuch_filenames_valid (db_files) &&
574             strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
575         {
576             notmuch_filenames_move_to_next (db_files);
577             continue;
578         }
579
580         /* We're now looking at a regular file that doesn't yet exist
581          * in the database, so add it. */
582         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
583
584         state->processed_files++;
585
586         if (state->verbosity >= VERBOSITY_VERBOSE) {
587             if (state->output_is_a_tty)
588                 printf("\r\033[K");
589
590             printf ("%i/%i: %s", state->processed_files, state->total_files,
591                     next);
592
593             putchar((state->output_is_a_tty) ? '\r' : '\n');
594             fflush (stdout);
595         }
596
597         status = add_file (notmuch, next, state);
598         if (status) {
599             ret = status;
600             goto DONE;
601         }
602
603         if (do_print_progress) {
604             do_print_progress = 0;
605             generic_print_progress ("Processed", "files", state->tv_start,
606                                     state->processed_files, state->total_files);
607         }
608
609         talloc_free (next);
610         next = NULL;
611     }
612
613     if (interrupted)
614         goto DONE;
615
616     /* Now that we've walked the whole filesystem list, anything left
617      * over in the database lists has been deleted. */
618     while (notmuch_filenames_valid (db_files))
619     {
620         char *absolute = talloc_asprintf (state->removed_files,
621                                           "%s/%s", path,
622                                           notmuch_filenames_get (db_files));
623         if (state->debug)
624             printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
625                     absolute);
626
627         _filename_list_add (state->removed_files, absolute);
628
629         notmuch_filenames_move_to_next (db_files);
630     }
631
632     while (notmuch_filenames_valid (db_subdirs))
633     {
634         char *absolute = talloc_asprintf (state->removed_directories,
635                                           "%s/%s", path,
636                                           notmuch_filenames_get (db_subdirs));
637
638         if (state->debug)
639             printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
640                     absolute);
641
642         _filename_list_add (state->removed_directories, absolute);
643
644         notmuch_filenames_move_to_next (db_subdirs);
645     }
646
647     /* If the directory's mtime is the same as the wall-clock time
648      * when we stat'ed the directory, we skip updating the mtime in
649      * the database because a message could be delivered later in this
650      * same second.  This may lead to unnecessary re-scans, but it
651      * avoids overlooking messages. */
652     if (fs_mtime != stat_time)
653         _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
654
655   DONE:
656     if (next)
657         talloc_free (next);
658     if (dir)
659         closedir (dir);
660     if (fs_entries) {
661         for (i = 0; i < num_fs_entries; i++)
662             free (fs_entries[i]);
663
664         free (fs_entries);
665     }
666     if (db_subdirs)
667         notmuch_filenames_destroy (db_subdirs);
668     if (db_files)
669         notmuch_filenames_destroy (db_files);
670     if (directory)
671         notmuch_directory_destroy (directory);
672
673     return ret;
674 }
675
676 static void
677 setup_progress_printing_timer (void)
678 {
679     struct sigaction action;
680     struct itimerval timerval;
681
682     /* Set up our handler for SIGALRM */
683     memset (&action, 0, sizeof (struct sigaction));
684     action.sa_handler = handle_sigalrm;
685     sigemptyset (&action.sa_mask);
686     action.sa_flags = SA_RESTART;
687     sigaction (SIGALRM, &action, NULL);
688
689     /* Then start a timer to send SIGALRM once per second. */
690     timerval.it_interval.tv_sec = 1;
691     timerval.it_interval.tv_usec = 0;
692     timerval.it_value.tv_sec = 1;
693     timerval.it_value.tv_usec = 0;
694     setitimer (ITIMER_REAL, &timerval, NULL);
695 }
696
697 static void
698 stop_progress_printing_timer (void)
699 {
700     struct sigaction action;
701     struct itimerval timerval;
702
703     /* Now stop the timer. */
704     timerval.it_interval.tv_sec = 0;
705     timerval.it_interval.tv_usec = 0;
706     timerval.it_value.tv_sec = 0;
707     timerval.it_value.tv_usec = 0;
708     setitimer (ITIMER_REAL, &timerval, NULL);
709
710     /* And disable the signal handler. */
711     action.sa_handler = SIG_IGN;
712     sigaction (SIGALRM, &action, NULL);
713 }
714
715
716 /* XXX: This should be merged with the add_files function since it
717  * shares a lot of logic with it. */
718 /* Recursively count all regular files in path and all sub-directories
719  * of path.  The result is added to *count (which should be
720  * initialized to zero by the top-level caller before calling
721  * count_files). */
722 static void
723 count_files (const char *path, int *count, add_files_state_t *state)
724 {
725     struct dirent *entry = NULL;
726     char *next;
727     struct dirent **fs_entries = NULL;
728     int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
729     int entry_type, i;
730
731     if (num_fs_entries == -1) {
732         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
733                  path, strerror (errno));
734         goto DONE;
735     }
736
737     for (i = 0; i < num_fs_entries && ! interrupted; i++) {
738         entry = fs_entries[i];
739
740         /* Ignore special directories to avoid infinite recursion.
741          * Also ignore the .notmuch directory and files/directories
742          * the user has configured to be ignored.
743          */
744         if (strcmp (entry->d_name, ".") == 0 ||
745             strcmp (entry->d_name, "..") == 0 ||
746             strcmp (entry->d_name, ".notmuch") == 0 ||
747             _entry_in_ignore_list (entry->d_name, state))
748         {
749             if (state->debug && _entry_in_ignore_list (entry->d_name, state))
750                 printf ("(D) count_files: explicitly ignoring %s/%s\n",
751                         path,
752                         entry->d_name);
753             continue;
754         }
755
756         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
757             next = NULL;
758             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
759                      path, entry->d_name);
760             continue;
761         }
762
763         entry_type = dirent_type (path, entry);
764         if (entry_type == S_IFREG) {
765             *count = *count + 1;
766             if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
767                 printf ("Found %d files so far.\r", *count);
768                 fflush (stdout);
769             }
770         } else if (entry_type == S_IFDIR) {
771             count_files (next, count, state);
772         }
773
774         free (next);
775     }
776
777   DONE:
778     if (fs_entries) {
779         for (i = 0; i < num_fs_entries; i++)
780             free (fs_entries[i]);
781
782         free (fs_entries);
783     }
784 }
785
786 static void
787 upgrade_print_progress (void *closure,
788                         double progress)
789 {
790     add_files_state_t *state = closure;
791
792     printf ("Upgrading database: %.2f%% complete", progress * 100.0);
793
794     if (progress > 0) {
795         struct timeval tv_now;
796         double elapsed, time_remaining;
797
798         gettimeofday (&tv_now, NULL);
799
800         elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
801         time_remaining = (elapsed / progress) * (1.0 - progress);
802         printf (" (");
803         notmuch_time_print_formatted_seconds (time_remaining);
804         printf (" remaining)");
805     }
806
807     printf (".      \r");
808
809     fflush (stdout);
810 }
811
812 /* Remove one message filename from the database. */
813 static notmuch_status_t
814 remove_filename (notmuch_database_t *notmuch,
815                  const char *path,
816                  add_files_state_t *add_files_state)
817 {
818     notmuch_status_t status;
819     notmuch_message_t *message;
820     status = notmuch_database_begin_atomic (notmuch);
821     if (status)
822         return status;
823     status = notmuch_database_find_message_by_filename (notmuch, path, &message);
824     if (status || message == NULL)
825         goto DONE;
826
827     status = notmuch_database_remove_message (notmuch, path);
828     if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
829         add_files_state->renamed_messages++;
830         if (add_files_state->synchronize_flags == TRUE)
831             notmuch_message_maildir_flags_to_tags (message);
832         status = NOTMUCH_STATUS_SUCCESS;
833     } else if (status == NOTMUCH_STATUS_SUCCESS) {
834         add_files_state->removed_messages++;
835     }
836     notmuch_message_destroy (message);
837
838   DONE:
839     notmuch_database_end_atomic (notmuch);
840     return status;
841 }
842
843 /* Recursively remove all filenames from the database referring to
844  * 'path' (or to any of its children). */
845 static notmuch_status_t
846 _remove_directory (void *ctx,
847                    notmuch_database_t *notmuch,
848                    const char *path,
849                    add_files_state_t *add_files_state)
850 {
851     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
852     notmuch_directory_t *directory;
853     notmuch_filenames_t *files, *subdirs;
854     char *absolute;
855
856     status = notmuch_database_get_directory (notmuch, path, &directory);
857     if (status || !directory)
858         return status;
859
860     for (files = notmuch_directory_get_child_files (directory);
861          notmuch_filenames_valid (files);
862          notmuch_filenames_move_to_next (files))
863     {
864         absolute = talloc_asprintf (ctx, "%s/%s", path,
865                                     notmuch_filenames_get (files));
866         status = remove_filename (notmuch, absolute, add_files_state);
867         talloc_free (absolute);
868         if (status)
869             goto DONE;
870     }
871
872     for (subdirs = notmuch_directory_get_child_directories (directory);
873          notmuch_filenames_valid (subdirs);
874          notmuch_filenames_move_to_next (subdirs))
875     {
876         absolute = talloc_asprintf (ctx, "%s/%s", path,
877                                     notmuch_filenames_get (subdirs));
878         status = _remove_directory (ctx, notmuch, absolute, add_files_state);
879         talloc_free (absolute);
880         if (status)
881             goto DONE;
882     }
883
884     status = notmuch_directory_delete (directory);
885
886   DONE:
887     if (status)
888         notmuch_directory_destroy (directory);
889     return status;
890 }
891
892 static void
893 print_results (const add_files_state_t *state)
894 {
895     double elapsed;
896     struct timeval tv_now;
897
898     gettimeofday (&tv_now, NULL);
899     elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
900
901     if (state->processed_files) {
902         printf ("Processed %d %s in ", state->processed_files,
903                 state->processed_files == 1 ? "file" : "total files");
904         notmuch_time_print_formatted_seconds (elapsed);
905         if (elapsed > 1)
906             printf (" (%d files/sec.).\033[K\n",
907                     (int) (state->processed_files / elapsed));
908         else
909             printf (".\033[K\n");
910     }
911
912     if (state->added_messages)
913         printf ("Added %d new %s to the database.", state->added_messages,
914                 state->added_messages == 1 ? "message" : "messages");
915     else
916         printf ("No new mail.");
917
918     if (state->removed_messages)
919         printf (" Removed %d %s.", state->removed_messages,
920                 state->removed_messages == 1 ? "message" : "messages");
921
922     if (state->renamed_messages)
923         printf (" Detected %d file %s.", state->renamed_messages,
924                 state->renamed_messages == 1 ? "rename" : "renames");
925
926     printf ("\n");
927 }
928
929 int
930 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
931 {
932     notmuch_database_t *notmuch;
933     add_files_state_t add_files_state = {
934         .verbosity = VERBOSITY_NORMAL,
935         .debug = FALSE,
936         .output_is_a_tty = isatty (fileno (stdout)),
937     };
938     struct timeval tv_start;
939     int ret = 0;
940     struct stat st;
941     const char *db_path;
942     char *dot_notmuch_path;
943     struct sigaction action;
944     _filename_node_t *f;
945     int opt_index;
946     unsigned int i;
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;
951
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 *) &notmuch_shared_options, NULL, 0, 0 },
958         { 0, 0, 0, 0, 0 }
959     };
960
961     opt_index = parse_arguments (argc, argv, options, 1);
962     if (opt_index < 0)
963         return EXIT_FAILURE;
964
965     notmuch_process_shared_options (argv[0]);
966
967     /* quiet trumps verbose */
968     if (quiet)
969         add_files_state.verbosity = VERBOSITY_QUIET;
970     else if (verbose)
971         add_files_state.verbosity = VERBOSITY_VERBOSE;
972
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);
977
978     for (i = 0; i < add_files_state.new_tags_length; i++) {
979         const char *error_msg;
980
981         error_msg = illegal_tag (add_files_state.new_tags[i], FALSE);
982         if (error_msg) {
983             fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
984                      add_files_state.new_tags[i], error_msg);
985             return EXIT_FAILURE;
986         }
987     }
988
989     if (!no_hooks) {
990         ret = notmuch_run_hook (db_path, "pre-new");
991         if (ret)
992             return EXIT_FAILURE;
993     }
994
995     dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
996
997     if (stat (dot_notmuch_path, &st)) {
998         int count;
999
1000         count = 0;
1001         count_files (db_path, &count, &add_files_state);
1002         if (interrupted)
1003             return EXIT_FAILURE;
1004
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, &notmuch))
1008             return EXIT_FAILURE;
1009         add_files_state.total_files = count;
1010     } else {
1011         char *status_string = NULL;
1012         if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1013                                            &notmuch, &status_string)) {
1014             if (status_string) {
1015                 fputs (status_string, stderr);
1016                 free (status_string);
1017             }
1018             return EXIT_FAILURE;
1019         }
1020
1021         notmuch_exit_if_unmatched_db_uuid (notmuch);
1022
1023         if (notmuch_database_needs_upgrade (notmuch)) {
1024             time_t now = time (NULL);
1025             struct tm *gm_time = gmtime (&now);
1026
1027             /* since dump files are written atomically, the amount of
1028              * harm from overwriting one within a second seems
1029              * relatively small. */
1030
1031             const char *backup_name =
1032                 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1033                                  dot_notmuch_path,
1034                                  gm_time->tm_year + 1900,
1035                                  gm_time->tm_mon + 1,
1036                                  gm_time->tm_mday,
1037                                  gm_time->tm_hour,
1038                                  gm_time->tm_min,
1039                                  gm_time->tm_sec);
1040
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);
1045             }
1046
1047             if (notmuch_database_dump (notmuch, backup_name, "",
1048                                        DUMP_FORMAT_BATCH_TAG, TRUE)) {
1049                 fprintf (stderr, "Backup failed. Aborting upgrade.");
1050                 return EXIT_FAILURE;
1051             }
1052
1053             gettimeofday (&add_files_state.tv_start, NULL);
1054             status = notmuch_database_upgrade (
1055                 notmuch,
1056                 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1057                 &add_files_state);
1058             if (status) {
1059                 printf ("Upgrade failed: %s\n",
1060                         notmuch_status_to_string (status));
1061                 notmuch_database_destroy (notmuch);
1062                 return EXIT_FAILURE;
1063             }
1064             if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1065                 printf ("Your notmuch database has now been upgraded.\n");
1066         }
1067
1068         add_files_state.total_files = 0;
1069     }
1070
1071     if (notmuch == NULL)
1072         return EXIT_FAILURE;
1073
1074     /* Set up our handler for SIGINT. We do this after having
1075      * potentially done a database upgrade we this interrupt handler
1076      * won't support. */
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);
1082
1083     talloc_free (dot_notmuch_path);
1084     dot_notmuch_path = NULL;
1085
1086     gettimeofday (&add_files_state.tv_start, NULL);
1087
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);
1091
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;
1096     }
1097
1098     ret = add_files (notmuch, db_path, &add_files_state);
1099     if (ret)
1100         goto DONE;
1101
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);
1105         if (ret)
1106             goto DONE;
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);
1112         }
1113     }
1114
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);
1118         if (ret)
1119             goto DONE;
1120         if (do_print_progress) {
1121             do_print_progress = 0;
1122             generic_print_progress ("Cleaned up", "directories",
1123                 tv_start, i,
1124                 add_files_state.removed_directories->count);
1125         }
1126     }
1127
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);
1134         }
1135     }
1136
1137   DONE:
1138     talloc_free (add_files_state.removed_files);
1139     talloc_free (add_files_state.removed_directories);
1140     talloc_free (add_files_state.directory_mtimes);
1141
1142     if (timer_is_active)
1143         stop_progress_printing_timer ();
1144
1145     if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1146         print_results (&add_files_state);
1147
1148     if (ret)
1149         fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1150                  notmuch_status_to_string (ret));
1151
1152     notmuch_database_destroy (notmuch);
1153
1154     if (!no_hooks && !ret && !interrupted)
1155         ret = notmuch_run_hook (db_path, "post-new");
1156
1157     return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS;
1158 }