]> git.notmuchmail.org Git - notmuch/blob - notmuch-new.c
cli/new: abstract special directory check
[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     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     int vanished_files;
57     struct timeval tv_start;
58
59     _filename_list_t *removed_files;
60     _filename_list_t *removed_directories;
61     _filename_list_t *directory_mtimes;
62
63     notmuch_bool_t synchronize_flags;
64 } add_files_state_t;
65
66 static volatile sig_atomic_t do_print_progress = 0;
67
68 static void
69 handle_sigalrm (unused (int signal))
70 {
71     do_print_progress = 1;
72 }
73
74 static volatile sig_atomic_t interrupted;
75
76 static void
77 handle_sigint (unused (int sig))
78 {
79     static char msg[] = "Stopping...         \n";
80
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));
86     interrupted = 1;
87 }
88
89 static _filename_list_t *
90 _filename_list_create (const void *ctx)
91 {
92     _filename_list_t *list;
93
94     list = talloc (ctx, _filename_list_t);
95     if (list == NULL)
96         return NULL;
97
98     list->head = NULL;
99     list->tail = &list->head;
100     list->count = 0;
101
102     return list;
103 }
104
105 static _filename_node_t *
106 _filename_list_add (_filename_list_t *list,
107                     const char *filename)
108 {
109     _filename_node_t *node = talloc (list, _filename_node_t);
110
111     list->count++;
112
113     node->filename = talloc_strdup (list, filename);
114     node->next = NULL;
115
116     *(list->tail) = node;
117     list->tail = &node->next;
118
119     return node;
120 }
121
122 static void
123 generic_print_progress (const char *action, const char *object,
124                         struct timeval tv_start, unsigned processed, unsigned total)
125 {
126     struct timeval tv_now;
127     double elapsed_overall, rate_overall;
128
129     gettimeofday (&tv_now, NULL);
130
131     elapsed_overall = notmuch_time_elapsed (tv_start, tv_now);
132     rate_overall = processed / elapsed_overall;
133
134     printf ("%s %u ", action, processed);
135
136     if (total) {
137         printf ("of %u %s", total, object);
138         if (processed > 0 && elapsed_overall > 0.5) {
139             double time_remaining = ((total - processed) / rate_overall);
140             printf (" (");
141             notmuch_time_print_formatted_seconds (time_remaining);
142             printf (" remaining)");
143         }
144     } else {
145         printf ("%s", object);
146         if (elapsed_overall > 0.5)
147             printf (" (%d %s/sec.)", (int) rate_overall, object);
148     }
149     printf (".\033[K\r");
150
151     fflush (stdout);
152 }
153
154 static int
155 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
156 {
157     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
158 }
159
160 static int
161 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
162 {
163     return strcmp ((*a)->d_name, (*b)->d_name);
164 }
165
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
169  * symlinks).
170  */
171 static int
172 dirent_type (const char *path, const struct dirent *entry)
173 {
174     struct stat statbuf;
175     char *abspath;
176     int err, saved_errno;
177
178 #if HAVE_D_TYPE
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[] = {
182         [DT_BLK]  = S_IFBLK,
183         [DT_CHR]  = S_IFCHR,
184         [DT_DIR]  = S_IFDIR,
185         [DT_FIFO] = S_IFIFO,
186         [DT_REG]  = S_IFREG,
187         [DT_SOCK] = S_IFSOCK
188     };
189     if (entry->d_type < ARRAY_SIZE(modes) && modes[entry->d_type])
190         return modes[entry->d_type];
191 #endif
192
193     abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);
194     if (!abspath) {
195         errno = ENOMEM;
196         return -1;
197     }
198     err = stat(abspath, &statbuf);
199     saved_errno = errno;
200     talloc_free (abspath);
201     if (err < 0) {
202         errno = saved_errno;
203         return -1;
204     }
205     return statbuf.st_mode & S_IFMT;
206 }
207
208 /* Test if the directory looks like a Maildir directory.
209  *
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".
212  *
213  * Return 1 if the directory looks like a Maildir and 0 otherwise.
214  */
215 static int
216 _entries_resemble_maildir (const char *path, struct dirent **entries, int count)
217 {
218     int i, found = 0;
219
220     for (i = 0; i < count; i++) {
221         if (dirent_type (path, entries[i]) != S_IFDIR)
222             continue;
223
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)
227         {
228             found++;
229             if (found == 3)
230                 return 1;
231         }
232     }
233
234     return 0;
235 }
236
237 static notmuch_bool_t
238 _special_directory (const char *entry)
239 {
240     return strcmp (entry, ".") == 0 || strcmp (entry, "..") == 0;
241 }
242
243 /* Test if the file/directory is to be ignored.
244  */
245 static notmuch_bool_t
246 _entry_in_ignore_list (const char *entry, add_files_state_t *state)
247 {
248     size_t i;
249
250     for (i = 0; i < state->new_ignore_length; i++)
251         if (strcmp (entry, state->new_ignore[i]) == 0)
252             return TRUE;
253
254     return FALSE;
255 }
256
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)
261 {
262     notmuch_message_t *message = NULL;
263     const char **tag;
264     notmuch_status_t status;
265
266     status = notmuch_database_begin_atomic (notmuch);
267     if (status)
268         goto DONE;
269
270     status = notmuch_database_index_file (notmuch, filename, NULL, &message);
271     switch (status) {
272     /* Success. */
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);
278
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);
283             }
284         }
285
286         notmuch_message_thaw (message);
287         break;
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);
292         break;
293     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
294         fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
295         break;
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);
301         break;
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);
307         goto DONE;
308     default:
309         INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
310         goto DONE;
311     }
312
313     status = notmuch_database_end_atomic (notmuch);
314
315   DONE:
316     if (message)
317         notmuch_message_destroy (message);
318
319     return status;
320 }
321
322 /* Examine 'path' recursively as follows:
323  *
324  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
325  *   o Ask the database for its timestamp of 'path' (db_mtime)
326  *
327  *   o Ask the filesystem for files and directories within 'path'
328  *     (via scandir and stored in fs_entries)
329  *
330  *   o Pass 1: For each directory in fs_entries, recursively call into
331  *     this same function.
332  *
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
336  *     2).
337  *
338  *   o Ask the database for files and directories within 'path'
339  *     (db_files and db_subdirs)
340  *
341  *   o Pass 2: Walk fs_entries simultaneously with db_files and
342  *     db_subdirs. Look for one of three interesting cases:
343  *
344  *         1. Regular file in fs_entries and not in db_files
345  *            This is a new file to add_message into the database.
346  *
347  *         2. Filename in db_files not in fs_entries.
348  *            This is a file that has been removed from the mail store.
349  *
350  *         3. Directory in db_subdirs not in fs_entries
351  *            This is a directory that has been removed from the mail store.
352  *
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).
359  *
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.
362  */
363 static notmuch_status_t
364 add_files (notmuch_database_t *notmuch,
365            const char *path,
366            add_files_state_t *state)
367 {
368     struct dirent *entry = NULL;
369     char *next = 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;
377     time_t stat_time;
378     struct stat st;
379     notmuch_bool_t is_maildir;
380
381     if (stat (path, &st)) {
382         fprintf (stderr, "Error reading directory %s: %s\n",
383                  path, strerror (errno));
384         return NOTMUCH_STATUS_FILE_ERROR;
385     }
386     stat_time = time (NULL);
387
388     if (! S_ISDIR (st.st_mode)) {
389         fprintf (stderr, "Error: %s is not a directory.\n", path);
390         return NOTMUCH_STATUS_FILE_ERROR;
391     }
392
393     fs_mtime = st.st_mtime;
394
395     status = notmuch_database_get_directory (notmuch, path, &directory);
396     if (status) {
397         ret = status;
398         goto DONE;
399     }
400     db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
401
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
407      * directories.
408      *
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.
418      */
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))
426             goto DONE;
427         notmuch_filenames_destroy (db_subdirs);
428         db_subdirs = NULL;
429     }
430
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,
435                               directory ?
436                               dirent_sort_strcmp_name : dirent_sort_inode);
437
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;
446         goto DONE;
447     }
448
449     /* Pass 1: Recurse into all sub-directories. */
450     is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
451
452     for (i = 0; i < num_fs_entries && ! interrupted; i++) {
453         entry = fs_entries[i];
454
455         /* Ignore any files/directories the user has configured to
456          * ignore.  We do this before dirent_type both for performance
457          * and because we don't care if dirent_type fails on entries
458          * that are explicitly ignored.
459          */
460         if (_entry_in_ignore_list (entry->d_name, state)) {
461             if (state->debug)
462                 printf ("(D) add_files, pass 1: explicitly ignoring %s/%s\n",
463                         path, entry->d_name);
464             continue;
465         }
466
467         /* We only want to descend into directories (and symlinks to
468          * directories). */
469         entry_type = dirent_type (path, entry);
470         if (entry_type == -1) {
471             /* Be pessimistic, e.g. so we don't lose lots of mail just
472              * because a user broke a symlink. */
473             fprintf (stderr, "Error reading file %s/%s: %s\n",
474                      path, entry->d_name, strerror (errno));
475             return NOTMUCH_STATUS_FILE_ERROR;
476         } else if (entry_type != S_IFDIR) {
477             continue;
478         }
479
480         /* Ignore special directories to avoid infinite recursion.
481          * Also ignore the .notmuch directory and any "tmp" directory
482          * that appears within a maildir.
483          */
484         if (_special_directory (entry->d_name) ||
485             (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
486             strcmp (entry->d_name, ".notmuch") == 0)
487             continue;
488
489         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
490         status = add_files (notmuch, next, state);
491         if (status) {
492             ret = status;
493             goto DONE;
494         }
495         talloc_free (next);
496         next = NULL;
497     }
498
499     /* If the directory's modification time in the filesystem is the
500      * same as what we recorded in the database the last time we
501      * scanned it, then we can skip the second pass entirely.
502      *
503      * We test for strict equality here to avoid a bug that can happen
504      * if the system clock jumps backward, (preventing new mail from
505      * being discovered until the clock catches up and the directory
506      * is modified again).
507      */
508     if (directory && fs_mtime == db_mtime)
509         goto DONE;
510
511     /* If the database has never seen this directory before, we can
512      * simply leave db_files and db_subdirs NULL. */
513     if (directory) {
514         db_files = notmuch_directory_get_child_files (directory);
515         db_subdirs = notmuch_directory_get_child_directories (directory);
516     }
517
518     /* Pass 2: Scan for new files, removed files, and removed directories. */
519     for (i = 0; i < num_fs_entries && ! interrupted; i++) {
520         entry = fs_entries[i];
521
522         /* Ignore files & directories user has configured to be ignored */
523         if (_entry_in_ignore_list (entry->d_name, state)) {
524             if (state->debug)
525                 printf ("(D) add_files, pass 2: explicitly ignoring %s/%s\n",
526                         path, entry->d_name);
527             continue;
528         }
529
530         /* Check if we've walked past any names in db_files or
531          * db_subdirs. If so, these have been deleted. */
532         while (notmuch_filenames_valid (db_files) &&
533                strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
534         {
535             char *absolute = talloc_asprintf (state->removed_files,
536                                               "%s/%s", path,
537                                               notmuch_filenames_get (db_files));
538
539             if (state->debug)
540                 printf ("(D) add_files, pass 2: queuing passed file %s for deletion from database\n",
541                         absolute);
542
543             _filename_list_add (state->removed_files, absolute);
544
545             notmuch_filenames_move_to_next (db_files);
546         }
547
548         while (notmuch_filenames_valid (db_subdirs) &&
549                strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
550         {
551             const char *filename = notmuch_filenames_get (db_subdirs);
552
553             if (strcmp (filename, entry->d_name) < 0)
554             {
555                 char *absolute = talloc_asprintf (state->removed_directories,
556                                                   "%s/%s", path, filename);
557                 if (state->debug)
558                     printf ("(D) add_files, pass 2: queuing passed directory %s for deletion from database\n",
559                         absolute);
560
561                 _filename_list_add (state->removed_directories, absolute);
562             }
563
564             notmuch_filenames_move_to_next (db_subdirs);
565         }
566
567         /* Only add regular files (and symlinks to regular files). */
568         entry_type = dirent_type (path, entry);
569         if (entry_type == -1) {
570             fprintf (stderr, "Error reading file %s/%s: %s\n",
571                      path, entry->d_name, strerror (errno));
572             return NOTMUCH_STATUS_FILE_ERROR;
573         } else if (entry_type != S_IFREG) {
574             continue;
575         }
576
577         /* Don't add a file that we've added before. */
578         if (notmuch_filenames_valid (db_files) &&
579             strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
580         {
581             notmuch_filenames_move_to_next (db_files);
582             continue;
583         }
584
585         /* We're now looking at a regular file that doesn't yet exist
586          * in the database, so add it. */
587         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
588
589         state->processed_files++;
590
591         if (state->verbosity >= VERBOSITY_VERBOSE) {
592             if (state->output_is_a_tty)
593                 printf("\r\033[K");
594
595             printf ("%i/%i: %s", state->processed_files, state->total_files,
596                     next);
597
598             putchar((state->output_is_a_tty) ? '\r' : '\n');
599             fflush (stdout);
600         }
601
602         status = add_file (notmuch, next, state);
603         if (status) {
604             ret = status;
605             goto DONE;
606         }
607
608         if (do_print_progress) {
609             do_print_progress = 0;
610             generic_print_progress ("Processed", "files", state->tv_start,
611                                     state->processed_files, state->total_files);
612         }
613
614         talloc_free (next);
615         next = NULL;
616     }
617
618     if (interrupted)
619         goto DONE;
620
621     /* Now that we've walked the whole filesystem list, anything left
622      * over in the database lists has been deleted. */
623     while (notmuch_filenames_valid (db_files))
624     {
625         char *absolute = talloc_asprintf (state->removed_files,
626                                           "%s/%s", path,
627                                           notmuch_filenames_get (db_files));
628         if (state->debug)
629             printf ("(D) add_files, pass 3: queuing leftover file %s for deletion from database\n",
630                     absolute);
631
632         _filename_list_add (state->removed_files, absolute);
633
634         notmuch_filenames_move_to_next (db_files);
635     }
636
637     while (notmuch_filenames_valid (db_subdirs))
638     {
639         char *absolute = talloc_asprintf (state->removed_directories,
640                                           "%s/%s", path,
641                                           notmuch_filenames_get (db_subdirs));
642
643         if (state->debug)
644             printf ("(D) add_files, pass 3: queuing leftover directory %s for deletion from database\n",
645                     absolute);
646
647         _filename_list_add (state->removed_directories, absolute);
648
649         notmuch_filenames_move_to_next (db_subdirs);
650     }
651
652     /* If the directory's mtime is the same as the wall-clock time
653      * when we stat'ed the directory, we skip updating the mtime in
654      * the database because a message could be delivered later in this
655      * same second.  This may lead to unnecessary re-scans, but it
656      * avoids overlooking messages. */
657     if (fs_mtime != stat_time)
658         _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
659
660   DONE:
661     if (next)
662         talloc_free (next);
663     if (fs_entries) {
664         for (i = 0; i < num_fs_entries; i++)
665             free (fs_entries[i]);
666
667         free (fs_entries);
668     }
669     if (db_subdirs)
670         notmuch_filenames_destroy (db_subdirs);
671     if (db_files)
672         notmuch_filenames_destroy (db_files);
673     if (directory)
674         notmuch_directory_destroy (directory);
675
676     return ret;
677 }
678
679 static void
680 setup_progress_printing_timer (void)
681 {
682     struct sigaction action;
683     struct itimerval timerval;
684
685     /* Set up our handler for SIGALRM */
686     memset (&action, 0, sizeof (struct sigaction));
687     action.sa_handler = handle_sigalrm;
688     sigemptyset (&action.sa_mask);
689     action.sa_flags = SA_RESTART;
690     sigaction (SIGALRM, &action, NULL);
691
692     /* Then start a timer to send SIGALRM once per second. */
693     timerval.it_interval.tv_sec = 1;
694     timerval.it_interval.tv_usec = 0;
695     timerval.it_value.tv_sec = 1;
696     timerval.it_value.tv_usec = 0;
697     setitimer (ITIMER_REAL, &timerval, NULL);
698 }
699
700 static void
701 stop_progress_printing_timer (void)
702 {
703     struct sigaction action;
704     struct itimerval timerval;
705
706     /* Now stop the timer. */
707     timerval.it_interval.tv_sec = 0;
708     timerval.it_interval.tv_usec = 0;
709     timerval.it_value.tv_sec = 0;
710     timerval.it_value.tv_usec = 0;
711     setitimer (ITIMER_REAL, &timerval, NULL);
712
713     /* And disable the signal handler. */
714     action.sa_handler = SIG_IGN;
715     sigaction (SIGALRM, &action, NULL);
716 }
717
718
719 /* XXX: This should be merged with the add_files function since it
720  * shares a lot of logic with it. */
721 /* Recursively count all regular files in path and all sub-directories
722  * of path.  The result is added to *count (which should be
723  * initialized to zero by the top-level caller before calling
724  * count_files). */
725 static void
726 count_files (const char *path, int *count, add_files_state_t *state)
727 {
728     struct dirent *entry = NULL;
729     char *next;
730     struct dirent **fs_entries = NULL;
731     int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
732     int entry_type, i;
733
734     if (num_fs_entries == -1) {
735         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
736                  path, strerror (errno));
737         goto DONE;
738     }
739
740     for (i = 0; i < num_fs_entries && ! interrupted; i++) {
741         entry = fs_entries[i];
742
743         /* Ignore special directories to avoid infinite recursion.
744          * Also ignore the .notmuch directory.
745          */
746         if (_special_directory (entry->d_name) ||
747             strcmp (entry->d_name, ".notmuch") == 0)
748             continue;
749
750         /* Ignore any files/directories the user has configured to be
751          * ignored
752          */
753         if (_entry_in_ignore_list (entry->d_name, state)) {
754             if (state->debug)
755                 printf ("(D) count_files: explicitly ignoring %s/%s\n",
756                         path, entry->d_name);
757             continue;
758         }
759
760         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
761             next = NULL;
762             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
763                      path, entry->d_name);
764             continue;
765         }
766
767         entry_type = dirent_type (path, entry);
768         if (entry_type == S_IFREG) {
769             *count = *count + 1;
770             if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
771                 printf ("Found %d files so far.\r", *count);
772                 fflush (stdout);
773             }
774         } else if (entry_type == S_IFDIR) {
775             count_files (next, count, state);
776         }
777
778         free (next);
779     }
780
781   DONE:
782     if (fs_entries) {
783         for (i = 0; i < num_fs_entries; i++)
784             free (fs_entries[i]);
785
786         free (fs_entries);
787     }
788 }
789
790 static void
791 upgrade_print_progress (void *closure,
792                         double progress)
793 {
794     add_files_state_t *state = closure;
795
796     printf ("Upgrading database: %.2f%% complete", progress * 100.0);
797
798     if (progress > 0) {
799         struct timeval tv_now;
800         double elapsed, time_remaining;
801
802         gettimeofday (&tv_now, NULL);
803
804         elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
805         time_remaining = (elapsed / progress) * (1.0 - progress);
806         printf (" (");
807         notmuch_time_print_formatted_seconds (time_remaining);
808         printf (" remaining)");
809     }
810
811     printf (".      \r");
812
813     fflush (stdout);
814 }
815
816 /* Remove one message filename from the database. */
817 static notmuch_status_t
818 remove_filename (notmuch_database_t *notmuch,
819                  const char *path,
820                  add_files_state_t *add_files_state)
821 {
822     notmuch_status_t status;
823     notmuch_message_t *message;
824     status = notmuch_database_begin_atomic (notmuch);
825     if (status)
826         return status;
827     status = notmuch_database_find_message_by_filename (notmuch, path, &message);
828     if (status || message == NULL)
829         goto DONE;
830
831     status = notmuch_database_remove_message (notmuch, path);
832     if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
833         add_files_state->renamed_messages++;
834         if (add_files_state->synchronize_flags == TRUE)
835             notmuch_message_maildir_flags_to_tags (message);
836         status = NOTMUCH_STATUS_SUCCESS;
837     } else if (status == NOTMUCH_STATUS_SUCCESS) {
838         add_files_state->removed_messages++;
839     }
840     notmuch_message_destroy (message);
841
842   DONE:
843     notmuch_database_end_atomic (notmuch);
844     return status;
845 }
846
847 /* Recursively remove all filenames from the database referring to
848  * 'path' (or to any of its children). */
849 static notmuch_status_t
850 _remove_directory (void *ctx,
851                    notmuch_database_t *notmuch,
852                    const char *path,
853                    add_files_state_t *add_files_state)
854 {
855     notmuch_status_t status;
856     notmuch_directory_t *directory;
857     notmuch_filenames_t *files, *subdirs;
858     char *absolute;
859
860     status = notmuch_database_get_directory (notmuch, path, &directory);
861     if (status || !directory)
862         return status;
863
864     for (files = notmuch_directory_get_child_files (directory);
865          notmuch_filenames_valid (files);
866          notmuch_filenames_move_to_next (files))
867     {
868         absolute = talloc_asprintf (ctx, "%s/%s", path,
869                                     notmuch_filenames_get (files));
870         status = remove_filename (notmuch, absolute, add_files_state);
871         talloc_free (absolute);
872         if (status)
873             goto DONE;
874     }
875
876     for (subdirs = notmuch_directory_get_child_directories (directory);
877          notmuch_filenames_valid (subdirs);
878          notmuch_filenames_move_to_next (subdirs))
879     {
880         absolute = talloc_asprintf (ctx, "%s/%s", path,
881                                     notmuch_filenames_get (subdirs));
882         status = _remove_directory (ctx, notmuch, absolute, add_files_state);
883         talloc_free (absolute);
884         if (status)
885             goto DONE;
886     }
887
888     status = notmuch_directory_delete (directory);
889
890   DONE:
891     if (status)
892         notmuch_directory_destroy (directory);
893     return status;
894 }
895
896 static void
897 print_results (const add_files_state_t *state)
898 {
899     double elapsed;
900     struct timeval tv_now;
901
902     gettimeofday (&tv_now, NULL);
903     elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
904
905     if (state->processed_files) {
906         printf ("Processed %d %s in ", state->processed_files,
907                 state->processed_files == 1 ? "file" : "total files");
908         notmuch_time_print_formatted_seconds (elapsed);
909         if (elapsed > 1)
910             printf (" (%d files/sec.)",
911                     (int) (state->processed_files / elapsed));
912         printf (".%s\n", (state->output_is_a_tty) ? "\033[K" : "");
913     }
914
915     if (state->added_messages)
916         printf ("Added %d new %s to the database.", state->added_messages,
917                 state->added_messages == 1 ? "message" : "messages");
918     else
919         printf ("No new mail.");
920
921     if (state->removed_messages)
922         printf (" Removed %d %s.", state->removed_messages,
923                 state->removed_messages == 1 ? "message" : "messages");
924
925     if (state->renamed_messages)
926         printf (" Detected %d file %s.", state->renamed_messages,
927                 state->renamed_messages == 1 ? "rename" : "renames");
928
929     printf ("\n");
930 }
931
932 int
933 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
934 {
935     notmuch_database_t *notmuch;
936     add_files_state_t add_files_state = {
937         .verbosity = VERBOSITY_NORMAL,
938         .debug = FALSE,
939         .output_is_a_tty = isatty (fileno (stdout)),
940     };
941     struct timeval tv_start;
942     int ret = 0;
943     struct stat st;
944     const char *db_path;
945     char *dot_notmuch_path;
946     struct sigaction action;
947     _filename_node_t *f;
948     int opt_index;
949     unsigned int i;
950     notmuch_bool_t timer_is_active = FALSE;
951     notmuch_bool_t no_hooks = FALSE;
952     notmuch_bool_t quiet = FALSE, verbose = FALSE;
953     notmuch_status_t status;
954
955     notmuch_opt_desc_t options[] = {
956         { NOTMUCH_OPT_BOOLEAN,  &quiet, "quiet", 'q', 0 },
957         { NOTMUCH_OPT_BOOLEAN,  &verbose, "verbose", 'v', 0 },
958         { NOTMUCH_OPT_BOOLEAN,  &add_files_state.debug, "debug", 'd', 0 },
959         { NOTMUCH_OPT_BOOLEAN,  &no_hooks, "no-hooks", 'n', 0 },
960         { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
961         { 0, 0, 0, 0, 0 }
962     };
963
964     opt_index = parse_arguments (argc, argv, options, 1);
965     if (opt_index < 0)
966         return EXIT_FAILURE;
967
968     notmuch_process_shared_options (argv[0]);
969
970     /* quiet trumps verbose */
971     if (quiet)
972         add_files_state.verbosity = VERBOSITY_QUIET;
973     else if (verbose)
974         add_files_state.verbosity = VERBOSITY_VERBOSE;
975
976     add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
977     add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
978     add_files_state.synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
979     db_path = notmuch_config_get_database_path (config);
980
981     for (i = 0; i < add_files_state.new_tags_length; i++) {
982         const char *error_msg;
983
984         error_msg = illegal_tag (add_files_state.new_tags[i], FALSE);
985         if (error_msg) {
986             fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
987                      add_files_state.new_tags[i], error_msg);
988             return EXIT_FAILURE;
989         }
990     }
991
992     if (!no_hooks) {
993         ret = notmuch_run_hook (db_path, "pre-new");
994         if (ret)
995             return EXIT_FAILURE;
996     }
997
998     dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
999
1000     if (stat (dot_notmuch_path, &st)) {
1001         int count;
1002
1003         count = 0;
1004         count_files (db_path, &count, &add_files_state);
1005         if (interrupted)
1006             return EXIT_FAILURE;
1007
1008         if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1009             printf ("Found %d total files (that's not much mail).\n", count);
1010         if (notmuch_database_create (db_path, &notmuch))
1011             return EXIT_FAILURE;
1012         add_files_state.total_files = count;
1013     } else {
1014         char *status_string = NULL;
1015         if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1016                                            &notmuch, &status_string)) {
1017             if (status_string) {
1018                 fputs (status_string, stderr);
1019                 free (status_string);
1020             }
1021             return EXIT_FAILURE;
1022         }
1023
1024         notmuch_exit_if_unmatched_db_uuid (notmuch);
1025
1026         if (notmuch_database_needs_upgrade (notmuch)) {
1027             time_t now = time (NULL);
1028             struct tm *gm_time = gmtime (&now);
1029
1030             /* since dump files are written atomically, the amount of
1031              * harm from overwriting one within a second seems
1032              * relatively small. */
1033
1034             const char *backup_name =
1035                 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1036                                  dot_notmuch_path,
1037                                  gm_time->tm_year + 1900,
1038                                  gm_time->tm_mon + 1,
1039                                  gm_time->tm_mday,
1040                                  gm_time->tm_hour,
1041                                  gm_time->tm_min,
1042                                  gm_time->tm_sec);
1043
1044             if (add_files_state.verbosity >= VERBOSITY_NORMAL) {
1045                 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1046                 printf ("This process is safe to interrupt.\n");
1047                 printf ("Backing up tags to %s...\n", backup_name);
1048             }
1049
1050             if (notmuch_database_dump (notmuch, backup_name, "",
1051                                        DUMP_FORMAT_BATCH_TAG, DUMP_INCLUDE_DEFAULT, TRUE)) {
1052                 fprintf (stderr, "Backup failed. Aborting upgrade.");
1053                 return EXIT_FAILURE;
1054             }
1055
1056             gettimeofday (&add_files_state.tv_start, NULL);
1057             status = notmuch_database_upgrade (
1058                 notmuch,
1059                 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1060                 &add_files_state);
1061             if (status) {
1062                 printf ("Upgrade failed: %s\n",
1063                         notmuch_status_to_string (status));
1064                 notmuch_database_destroy (notmuch);
1065                 return EXIT_FAILURE;
1066             }
1067             if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1068                 printf ("Your notmuch database has now been upgraded.\n");
1069         }
1070
1071         add_files_state.total_files = 0;
1072     }
1073
1074     if (notmuch == NULL)
1075         return EXIT_FAILURE;
1076
1077     /* Set up our handler for SIGINT. We do this after having
1078      * potentially done a database upgrade we this interrupt handler
1079      * won't support. */
1080     memset (&action, 0, sizeof (struct sigaction));
1081     action.sa_handler = handle_sigint;
1082     sigemptyset (&action.sa_mask);
1083     action.sa_flags = SA_RESTART;
1084     sigaction (SIGINT, &action, NULL);
1085
1086     talloc_free (dot_notmuch_path);
1087     dot_notmuch_path = NULL;
1088
1089     gettimeofday (&add_files_state.tv_start, NULL);
1090
1091     add_files_state.removed_files = _filename_list_create (config);
1092     add_files_state.removed_directories = _filename_list_create (config);
1093     add_files_state.directory_mtimes = _filename_list_create (config);
1094
1095     if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1096         add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1097         setup_progress_printing_timer ();
1098         timer_is_active = TRUE;
1099     }
1100
1101     ret = add_files (notmuch, db_path, &add_files_state);
1102     if (ret)
1103         goto DONE;
1104
1105     gettimeofday (&tv_start, NULL);
1106     for (f = add_files_state.removed_files->head; f && !interrupted; f = f->next) {
1107         ret = remove_filename (notmuch, f->filename, &add_files_state);
1108         if (ret)
1109             goto DONE;
1110         if (do_print_progress) {
1111             do_print_progress = 0;
1112             generic_print_progress ("Cleaned up", "messages",
1113                 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1114                 add_files_state.removed_files->count);
1115         }
1116     }
1117
1118     gettimeofday (&tv_start, NULL);
1119     for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
1120         ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
1121         if (ret)
1122             goto DONE;
1123         if (do_print_progress) {
1124             do_print_progress = 0;
1125             generic_print_progress ("Cleaned up", "directories",
1126                 tv_start, i,
1127                 add_files_state.removed_directories->count);
1128         }
1129     }
1130
1131     for (f = add_files_state.directory_mtimes->head; f && !interrupted; f = f->next) {
1132         notmuch_directory_t *directory;
1133         status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1134         if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1135             notmuch_directory_set_mtime (directory, f->mtime);
1136             notmuch_directory_destroy (directory);
1137         }
1138     }
1139
1140   DONE:
1141     talloc_free (add_files_state.removed_files);
1142     talloc_free (add_files_state.removed_directories);
1143     talloc_free (add_files_state.directory_mtimes);
1144
1145     if (timer_is_active)
1146         stop_progress_printing_timer ();
1147
1148     if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1149         print_results (&add_files_state);
1150
1151     if (ret)
1152         fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1153                  notmuch_status_to_string (ret));
1154
1155     notmuch_database_destroy (notmuch);
1156
1157     if (!no_hooks && !ret && !interrupted)
1158         ret = notmuch_run_hook (db_path, "post-new");
1159
1160     if (ret || interrupted)
1161         return EXIT_FAILURE;
1162
1163     if (add_files_state.vanished_files)
1164         return NOTMUCH_EXIT_TEMPFAIL;
1165
1166     return EXIT_SUCCESS;
1167 }