]> git.notmuchmail.org Git - notmuch/blob - notmuch-new.c
notmuch new: Fix regression preventing recursion through symlinks.
[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
23 #include <unistd.h>
24
25 typedef struct _filename_node {
26     char *filename;
27     struct _filename_node *next;
28 } _filename_node_t;
29
30 typedef struct _filename_list {
31     _filename_node_t *head;
32     _filename_node_t **tail;
33 } _filename_list_t;
34
35 typedef struct {
36     int output_is_a_tty;
37     int verbose;
38
39     int total_files;
40     int processed_files;
41     int added_messages;
42     struct timeval tv_start;
43
44     _filename_list_t *removed_files;
45     _filename_list_t *removed_directories;
46 } add_files_state_t;
47
48 static volatile sig_atomic_t do_add_files_print_progress = 0;
49
50 static void
51 handle_sigalrm (unused (int signal))
52 {
53     do_add_files_print_progress = 1;
54 }
55
56 static volatile sig_atomic_t interrupted;
57
58 static void
59 handle_sigint (unused (int sig))
60 {
61     ssize_t ignored;
62     static char msg[] = "Stopping...         \n";
63
64     ignored = write(2, msg, sizeof(msg)-1);
65     interrupted = 1;
66 }
67
68 static _filename_list_t *
69 _filename_list_create (const void *ctx)
70 {
71     _filename_list_t *list;
72
73     list = talloc (ctx, _filename_list_t);
74     if (list == NULL)
75         return NULL;
76
77     list->head = NULL;
78     list->tail = &list->head;
79
80     return list;
81 }
82
83 static void
84 _filename_list_add (_filename_list_t *list,
85                     const char *filename)
86 {
87     _filename_node_t *node = talloc (list, _filename_node_t);
88
89     node->filename = talloc_strdup (list, filename);
90     node->next = NULL;
91
92     *(list->tail) = node;
93     list->tail = &node->next;
94 }
95
96 static void
97 tag_inbox_and_unread (notmuch_message_t *message)
98 {
99     notmuch_message_add_tag (message, "inbox");
100     notmuch_message_add_tag (message, "unread");
101 }
102
103 static void
104 add_files_print_progress (add_files_state_t *state)
105 {
106     struct timeval tv_now;
107     double elapsed_overall, rate_overall;
108
109     gettimeofday (&tv_now, NULL);
110
111     elapsed_overall = notmuch_time_elapsed (state->tv_start, tv_now);
112     rate_overall = (state->processed_files) / elapsed_overall;
113
114     printf ("Processed %d", state->processed_files);
115
116     if (state->total_files) {
117         double time_remaining;
118
119         time_remaining = ((state->total_files - state->processed_files) /
120                           rate_overall);
121         printf (" of %d files (", state->total_files);
122         notmuch_time_print_formatted_seconds (time_remaining);
123         printf (" remaining).      \r");
124     } else {
125         printf (" files (%d files/sec.)    \r", (int) rate_overall);
126     }
127
128     fflush (stdout);
129 }
130
131 static int
132 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
133 {
134     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
135 }
136
137 static int
138 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
139 {
140     return strcmp ((*a)->d_name, (*b)->d_name);
141 }
142
143 /* Test if the directory looks like a Maildir directory.
144  *
145  * Search through the array of directory entries to see if we can find all
146  * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
147  *
148  * Return 1 if the directory looks like a Maildir and 0 otherwise.
149  */
150 static int
151 _entries_resemble_maildir (struct dirent **entries, int count)
152 {
153     int i, found = 0;
154
155     for (i = 0; i < count; i++) {
156         if (entries[i]->d_type != DT_DIR)
157             continue;
158
159         if (strcmp(entries[i]->d_name, "new") == 0 ||
160             strcmp(entries[i]->d_name, "cur") == 0 ||
161             strcmp(entries[i]->d_name, "tmp") == 0)
162         {
163             found++;
164             if (found == 3)
165                 return 1;
166         }
167     }
168
169     return 0;
170 }
171
172 /* Examine 'path' recursively as follows:
173  *
174  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
175  *   o Ask the database for its timestamp of 'path' (db_mtime)
176  *
177  *   o Ask the filesystem for files and directories within 'path'
178  *     (via scandir and stored in fs_entries)
179  *   o Ask the database for files and directories within 'path'
180  *     (db_files and db_subdirs)
181  *
182  *   o Pass 1: For each directory in fs_entries, recursively call into
183  *     this same function.
184  *
185  *   o Pass 2: If 'fs_mtime' > 'db_mtime', then walk fs_entries
186  *     simultaneously with db_files and db_subdirs. Look for one of
187  *     three interesting cases:
188  *
189  *         1. Regular file in fs_entries and not in db_files
190  *            This is a new file to add_message into the database.
191  *
192  *         2. Filename in db_files not in fs_entries.
193  *            This is a file that has been removed from the mail store.
194  *
195  *         3. Directory in db_subdirs not in fs_entries
196  *            This is a directory that has been removed from the mail store.
197  *
198  *     Note that the addition of a directory is not interesting here,
199  *     since that will have been taken care of in pass 1. Also, we
200  *     don't immediately act on file/directory removal since we must
201  *     ensure that in the case of a rename that the new filename is
202  *     added before the old filename is removed, (so that no
203  *     information is lost from the database).
204  *
205  *   o Tell the database to update its time of 'path' to 'fs_mtime'
206  */
207 static notmuch_status_t
208 add_files_recursive (notmuch_database_t *notmuch,
209                      const char *path,
210                      add_files_state_t *state)
211 {
212     DIR *dir = NULL;
213     struct dirent *entry = NULL;
214     char *next = NULL;
215     time_t fs_mtime, db_mtime;
216     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
217     notmuch_message_t *message = NULL;
218     struct dirent **fs_entries = NULL;
219     int i, num_fs_entries;
220     notmuch_directory_t *directory;
221     notmuch_filenames_t *db_files = NULL;
222     notmuch_filenames_t *db_subdirs = NULL;
223     struct stat st;
224     notmuch_bool_t is_maildir;
225
226     if (stat (path, &st)) {
227         fprintf (stderr, "Error reading directory %s: %s\n",
228                  path, strerror (errno));
229         return NOTMUCH_STATUS_FILE_ERROR;
230     }
231
232     /* This is not an error since we may have recursed based on a
233      * symlink to a regular file, not a directory, and we don't know
234      * that until this stat. */
235     if (! S_ISDIR (st.st_mode))
236         return NOTMUCH_STATUS_SUCCESS;
237
238     fs_mtime = st.st_mtime;
239
240     directory = notmuch_database_get_directory (notmuch, path);
241     db_mtime = notmuch_directory_get_mtime (directory);
242
243     /* If the database knows about this directory, then we sort based
244      * on strcmp to match the database sorting. Otherwise, we can do
245      * inode-based sorting for faster filesystem operation. */
246     num_fs_entries = scandir (path, &fs_entries, 0,
247                               db_mtime ?
248                               dirent_sort_strcmp_name : dirent_sort_inode);
249
250     if (num_fs_entries == -1) {
251         fprintf (stderr, "Error opening directory %s: %s\n",
252                  path, strerror (errno));
253         ret = NOTMUCH_STATUS_FILE_ERROR;
254         goto DONE;
255     }
256
257     /* Pass 1: Recurse into all sub-directories. */
258     is_maildir = _entries_resemble_maildir (fs_entries, num_fs_entries);
259
260     for (i = 0; i < num_fs_entries; i++) {
261         if (interrupted)
262             break;
263
264         entry = fs_entries[i];
265
266         if (entry->d_type != DT_DIR && entry->d_type != DT_LNK)
267             continue;
268
269         /* Ignore special directories to avoid infinite recursion.
270          * Also ignore the .notmuch directory and any "tmp" directory
271          * that appears within a maildir.
272          */
273         /* XXX: Eventually we'll want more sophistication to let the
274          * user specify files to be ignored. */
275         if (strcmp (entry->d_name, ".") == 0 ||
276             strcmp (entry->d_name, "..") == 0 ||
277             (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
278             strcmp (entry->d_name, ".notmuch") ==0)
279         {
280             continue;
281         }
282
283         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
284         status = add_files_recursive (notmuch, next, state);
285         if (status && ret == NOTMUCH_STATUS_SUCCESS)
286             ret = status;
287         talloc_free (next);
288         next = NULL;
289     }
290
291     /* If this directory hasn't been modified since the last
292      * "notmuch new", then we can skip the second pass entirely. */
293     if (fs_mtime <= db_mtime)
294         goto DONE;
295
296     /* Pass 2: Scan for new files, removed files, and removed directories. */
297     db_files = notmuch_directory_get_child_files (directory);
298     db_subdirs = notmuch_directory_get_child_directories (directory);
299
300     for (i = 0; i < num_fs_entries; i++)
301     {
302         if (interrupted)
303             break;
304
305         entry = fs_entries[i];
306
307         /* Check if we've walked past any names in db_files or
308          * db_subdirs. If so, these have been deleted. */
309         while (notmuch_filenames_has_more (db_files) &&
310                strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
311         {
312             char *absolute = talloc_asprintf (state->removed_files,
313                                               "%s/%s", path,
314                                               notmuch_filenames_get (db_files));
315
316             _filename_list_add (state->removed_files, absolute);
317
318             notmuch_filenames_advance (db_files);
319         }
320
321         while (notmuch_filenames_has_more (db_subdirs) &&
322                strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
323         {
324             const char *filename = notmuch_filenames_get (db_subdirs);
325
326             if (strcmp (filename, entry->d_name) < 0)
327             {
328                 char *absolute = talloc_asprintf (state->removed_directories,
329                                                   "%s/%s", path, filename);
330
331                 _filename_list_add (state->removed_directories, absolute);
332             }
333
334             notmuch_filenames_advance (db_subdirs);
335         }
336
337         if (entry->d_type != DT_REG)
338             continue;
339
340         /* Don't add a file that we've added before. */
341         if (notmuch_filenames_has_more (db_files) &&
342             strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
343         {
344             notmuch_filenames_advance (db_files);
345             continue;
346         }
347
348         /* We're now looking at a regular file that doesn't yet exist
349          * in the database, so add it. */
350         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
351
352         state->processed_files++;
353
354         if (state->verbose) {
355             if (state->output_is_a_tty)
356                 printf("\r\033[K");
357
358             printf ("%i/%i: %s",
359                     state->processed_files,
360                     state->total_files,
361                     next);
362
363             putchar((state->output_is_a_tty) ? '\r' : '\n');
364             fflush (stdout);
365         }
366
367         status = notmuch_database_add_message (notmuch, next, &message);
368         switch (status) {
369         /* success */
370         case NOTMUCH_STATUS_SUCCESS:
371             state->added_messages++;
372             tag_inbox_and_unread (message);
373             break;
374         /* Non-fatal issues (go on to next file) */
375         case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
376             /* Stay silent on this one. */
377             break;
378         case NOTMUCH_STATUS_FILE_NOT_EMAIL:
379             fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
380                      next);
381             break;
382         /* Fatal issues. Don't process anymore. */
383         case NOTMUCH_STATUS_READONLY_DATABASE:
384         case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
385         case NOTMUCH_STATUS_OUT_OF_MEMORY:
386             fprintf (stderr, "Error: %s. Halting processing.\n",
387                      notmuch_status_to_string (status));
388             ret = status;
389             goto DONE;
390         default:
391         case NOTMUCH_STATUS_FILE_ERROR:
392         case NOTMUCH_STATUS_NULL_POINTER:
393         case NOTMUCH_STATUS_TAG_TOO_LONG:
394         case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
395         case NOTMUCH_STATUS_LAST_STATUS:
396             INTERNAL_ERROR ("add_message returned unexpected value: %d",  status);
397             goto DONE;
398         }
399
400         if (message) {
401             notmuch_message_destroy (message);
402             message = NULL;
403         }
404
405         if (do_add_files_print_progress) {
406             do_add_files_print_progress = 0;
407             add_files_print_progress (state);
408         }
409
410         talloc_free (next);
411         next = NULL;
412     }
413
414     if (! interrupted) {
415         status = notmuch_directory_set_mtime (directory, fs_mtime);
416         if (status && ret == NOTMUCH_STATUS_SUCCESS)
417             ret = status;
418     }
419
420   DONE:
421     if (next)
422         talloc_free (next);
423     if (entry)
424         free (entry);
425     if (dir)
426         closedir (dir);
427     if (fs_entries)
428         free (fs_entries);
429     if (db_subdirs)
430         notmuch_filenames_destroy (db_subdirs);
431     if (db_files)
432         notmuch_filenames_destroy (db_files);
433     if (directory)
434         notmuch_directory_destroy (directory);
435
436     return ret;
437 }
438
439 /* This is the top-level entry point for add_files. It does a couple
440  * of error checks, sets up the progress-printing timer and then calls
441  * into the recursive function. */
442 static notmuch_status_t
443 add_files (notmuch_database_t *notmuch,
444            const char *path,
445            add_files_state_t *state)
446 {
447     notmuch_status_t status;
448     struct sigaction action;
449     struct itimerval timerval;
450     notmuch_bool_t timer_is_active = FALSE;
451     struct stat st;
452
453     if (state->output_is_a_tty && ! debugger_is_active () && ! state->verbose) {
454         /* Setup our handler for SIGALRM */
455         memset (&action, 0, sizeof (struct sigaction));
456         action.sa_handler = handle_sigalrm;
457         sigemptyset (&action.sa_mask);
458         action.sa_flags = SA_RESTART;
459         sigaction (SIGALRM, &action, NULL);
460
461         /* Then start a timer to send SIGALRM once per second. */
462         timerval.it_interval.tv_sec = 1;
463         timerval.it_interval.tv_usec = 0;
464         timerval.it_value.tv_sec = 1;
465         timerval.it_value.tv_usec = 0;
466         setitimer (ITIMER_REAL, &timerval, NULL);
467
468         timer_is_active = TRUE;
469     }
470
471     if (stat (path, &st)) {
472         fprintf (stderr, "Error reading directory %s: %s\n",
473                  path, strerror (errno));
474         return NOTMUCH_STATUS_FILE_ERROR;
475     }
476
477     if (! S_ISDIR (st.st_mode)) {
478         fprintf (stderr, "Error: %s is not a directory.\n", path);
479         return NOTMUCH_STATUS_FILE_ERROR;
480     }
481
482     status = add_files_recursive (notmuch, path, state);
483
484     if (timer_is_active) {
485         /* Now stop the timer. */
486         timerval.it_interval.tv_sec = 0;
487         timerval.it_interval.tv_usec = 0;
488         timerval.it_value.tv_sec = 0;
489         timerval.it_value.tv_usec = 0;
490         setitimer (ITIMER_REAL, &timerval, NULL);
491
492         /* And disable the signal handler. */
493         action.sa_handler = SIG_IGN;
494         sigaction (SIGALRM, &action, NULL);
495     }
496
497     return status;
498 }
499
500 /* XXX: This should be merged with the add_files function since it
501  * shares a lot of logic with it. */
502 /* Recursively count all regular files in path and all sub-directories
503  * of path.  The result is added to *count (which should be
504  * initialized to zero by the top-level caller before calling
505  * count_files). */
506 static void
507 count_files (const char *path, int *count)
508 {
509     struct dirent *entry = NULL;
510     char *next;
511     struct stat st;
512     struct dirent **fs_entries = NULL;
513     int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
514     int i = 0;
515
516     if (num_fs_entries == -1) {
517         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
518                  path, strerror (errno));
519         goto DONE;
520     }
521
522     while (!interrupted) {
523         if (i == num_fs_entries)
524             break;
525
526         entry = fs_entries[i++];
527
528         /* Ignore special directories to avoid infinite recursion.
529          * Also ignore the .notmuch directory.
530          */
531         /* XXX: Eventually we'll want more sophistication to let the
532          * user specify files to be ignored. */
533         if (strcmp (entry->d_name, ".") == 0 ||
534             strcmp (entry->d_name, "..") == 0 ||
535             strcmp (entry->d_name, ".notmuch") == 0)
536         {
537             continue;
538         }
539
540         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
541             next = NULL;
542             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
543                      path, entry->d_name);
544             continue;
545         }
546
547         stat (next, &st);
548
549         if (S_ISREG (st.st_mode)) {
550             *count = *count + 1;
551             if (*count % 1000 == 0) {
552                 printf ("Found %d files so far.\r", *count);
553                 fflush (stdout);
554             }
555         } else if (S_ISDIR (st.st_mode)) {
556             count_files (next, count);
557         }
558
559         free (next);
560     }
561
562   DONE:
563     if (entry)
564         free (entry);
565     if (fs_entries)
566         free (fs_entries);
567 }
568
569 int
570 notmuch_new_command (void *ctx, int argc, char *argv[])
571 {
572     notmuch_config_t *config;
573     notmuch_database_t *notmuch;
574     add_files_state_t add_files_state;
575     double elapsed;
576     struct timeval tv_now;
577     int ret = 0;
578     struct stat st;
579     const char *db_path;
580     char *dot_notmuch_path;
581     struct sigaction action;
582     _filename_node_t *f;
583     int renamed_files, removed_files;
584     notmuch_status_t status;
585     int i;
586
587     add_files_state.verbose = 0;
588     add_files_state.output_is_a_tty = isatty (fileno (stdout));
589
590     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
591         if (STRNCMP_LITERAL (argv[i], "--verbose") == 0) {
592             add_files_state.verbose = 1;
593         } else {
594             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
595             return 1;
596         }
597     }
598
599     /* Setup our handler for SIGINT */
600     memset (&action, 0, sizeof (struct sigaction));
601     action.sa_handler = handle_sigint;
602     sigemptyset (&action.sa_mask);
603     action.sa_flags = SA_RESTART;
604     sigaction (SIGINT, &action, NULL);
605
606     config = notmuch_config_open (ctx, NULL, NULL);
607     if (config == NULL)
608         return 1;
609
610     db_path = notmuch_config_get_database_path (config);
611
612     dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
613
614     if (stat (dot_notmuch_path, &st)) {
615         int count;
616
617         count = 0;
618         count_files (db_path, &count);
619         if (interrupted)
620             return 1;
621
622         printf ("Found %d total files (that's not much mail).\n", count);
623         notmuch = notmuch_database_create (db_path);
624         add_files_state.total_files = count;
625     } else {
626         notmuch = notmuch_database_open (db_path,
627                                          NOTMUCH_DATABASE_MODE_READ_WRITE);
628         add_files_state.total_files = 0;
629     }
630
631     if (notmuch == NULL)
632         return 1;
633
634     talloc_free (dot_notmuch_path);
635     dot_notmuch_path = NULL;
636
637     add_files_state.processed_files = 0;
638     add_files_state.added_messages = 0;
639     gettimeofday (&add_files_state.tv_start, NULL);
640
641     add_files_state.removed_files = _filename_list_create (ctx);
642     add_files_state.removed_directories = _filename_list_create (ctx);
643
644     ret = add_files (notmuch, db_path, &add_files_state);
645
646     removed_files = 0;
647     renamed_files = 0;
648     for (f = add_files_state.removed_files->head; f; f = f->next) {
649         status = notmuch_database_remove_message (notmuch, f->filename);
650         if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
651             renamed_files++;
652         else
653             removed_files++;
654     }
655
656     for (f = add_files_state.removed_directories->head; f; f = f->next) {
657         notmuch_directory_t *directory;
658         notmuch_filenames_t *files;
659
660         directory = notmuch_database_get_directory (notmuch, f->filename);
661
662         for (files = notmuch_directory_get_child_files (directory);
663              notmuch_filenames_has_more (files);
664              notmuch_filenames_advance (files))
665         {
666             char *absolute;
667
668             absolute = talloc_asprintf (ctx, "%s/%s", f->filename,
669                                         notmuch_filenames_get (files));
670             status = notmuch_database_remove_message (notmuch, absolute);
671             if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
672                 renamed_files++;
673             else
674                 removed_files++;
675             talloc_free (absolute);
676         }
677
678         notmuch_directory_destroy (directory);
679     }
680
681     talloc_free (add_files_state.removed_files);
682     talloc_free (add_files_state.removed_directories);
683
684     gettimeofday (&tv_now, NULL);
685     elapsed = notmuch_time_elapsed (add_files_state.tv_start,
686                                     tv_now);
687
688     if (add_files_state.processed_files) {
689         printf ("Processed %d %s in ", add_files_state.processed_files,
690                 add_files_state.processed_files == 1 ?
691                 "file" : "total files");
692         notmuch_time_print_formatted_seconds (elapsed);
693         if (elapsed > 1) {
694             printf (" (%d files/sec.).                 \n",
695                     (int) (add_files_state.processed_files / elapsed));
696         } else {
697             printf (".                    \n");
698         }
699     }
700
701     if (add_files_state.added_messages) {
702         printf ("Added %d new %s to the database.",
703                 add_files_state.added_messages,
704                 add_files_state.added_messages == 1 ?
705                 "message" : "messages");
706     } else {
707         printf ("No new mail.");
708     }
709
710     if (removed_files) {
711         printf (" Removed %d %s.",
712                 removed_files,
713                 removed_files == 1 ? "message" : "messages");
714     }
715
716     if (renamed_files) {
717         printf (" Detected %d file %s.",
718                 renamed_files,
719                 renamed_files == 1 ? "rename" : "renames");
720     }
721
722     printf ("\n");
723
724     if (ret) {
725         printf ("\nNote: At least one error was encountered: %s\n",
726                 notmuch_status_to_string (ret));
727     }
728
729     notmuch_database_close (notmuch);
730
731     return ret || interrupted;
732 }