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