a2b30bdc3c62fb42d3c97c6eca721af7fc73fa5d
[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 static volatile sig_atomic_t do_add_files_print_progress = 0;
26
27 static void
28 handle_sigalrm (unused (int signal))
29 {
30     do_add_files_print_progress = 1;
31 }
32
33 static volatile sig_atomic_t interrupted;
34
35 static void
36 handle_sigint (unused (int sig))
37 {
38     static char msg[] = "Stopping...         \n";
39     write(2, msg, sizeof(msg)-1);
40     interrupted = 1;
41 }
42
43 static void
44 tag_inbox_and_unread (notmuch_message_t *message)
45 {
46     notmuch_message_add_tag (message, "inbox");
47     notmuch_message_add_tag (message, "unread");
48 }
49
50 static void
51 add_files_print_progress (add_files_state_t *state)
52 {
53     struct timeval tv_now;
54     double elapsed_overall, rate_overall;
55
56     gettimeofday (&tv_now, NULL);
57
58     elapsed_overall = notmuch_time_elapsed (state->tv_start, tv_now);
59     rate_overall = (state->processed_files) / elapsed_overall;
60
61     printf ("Processed %d", state->processed_files);
62
63     if (state->total_files) {
64         double time_remaining;
65
66         time_remaining = ((state->total_files - state->processed_files) /
67                           rate_overall);
68         printf (" of %d files (", state->total_files);
69         notmuch_time_print_formatted_seconds (time_remaining);
70         printf (" remaining).      \r");
71     } else {
72         printf (" files (%d files/sec.)    \r", (int) rate_overall);
73     }
74
75     fflush (stdout);
76 }
77
78 static int ino_cmp(const struct dirent **a, const struct dirent **b)
79 {
80     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
81 }
82
83 /* Examine 'path' recursively as follows:
84  *
85  *   o Ask the filesystem for the mtime of 'path' (path_mtime)
86  *
87  *   o Ask the database for its timestamp of 'path' (path_dbtime)
88  *
89  *   o If 'path_mtime' > 'path_dbtime'
90  *
91  *       o For each regular file in 'path' with mtime newer than the
92  *         'path_dbtime' call add_message to add the file to the
93  *         database.
94  *
95  *       o For each sub-directory of path, recursively call into this
96  *         same function.
97  *
98  *   o Tell the database to update its time of 'path' to 'path_mtime'
99  *
100  * The 'struct stat *st' must point to a structure that has already
101  * been initialized for 'path' by calling stat().
102  */
103 static notmuch_status_t
104 add_files_recursive (notmuch_database_t *notmuch,
105                      const char *path,
106                      struct stat *st,
107                      add_files_state_t *state)
108 {
109     DIR *dir = NULL;
110     struct dirent *entry = NULL;
111     char *next = NULL;
112     time_t path_mtime, path_dbtime;
113     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
114     notmuch_message_t *message = NULL;
115     struct dirent **namelist = NULL;
116     int num_entries;
117
118     /* If we're told to, we bail out on encountering a read-only
119      * directory, (with this being a clear clue from the user to
120      * Notmuch that new mail won't be arriving there and we need not
121      * look. */
122     if (state->ignore_read_only_directories &&
123         (st->st_mode & S_IWUSR) == 0)
124     {
125         state->saw_read_only_directory = TRUE;
126         goto DONE;
127     }
128
129     path_mtime = st->st_mtime;
130
131     path_dbtime = notmuch_database_get_timestamp (notmuch, path);
132     num_entries = scandir (path, &namelist, 0, ino_cmp);
133
134     if (num_entries == -1) {
135         fprintf (stderr, "Error opening directory %s: %s\n",
136                  path, strerror (errno));
137         ret = NOTMUCH_STATUS_FILE_ERROR;
138         goto DONE;
139     }
140
141     int i=0;
142
143     while (!interrupted) {
144         if (i == num_entries)
145             break;
146
147         entry= namelist[i++];
148
149         /* If this directory hasn't been modified since the last
150          * add_files, then we only need to look further for
151          * sub-directories. */
152         if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
153             continue;
154
155         /* Ignore special directories to avoid infinite recursion.
156          * Also ignore the .notmuch directory.
157          */
158         /* XXX: Eventually we'll want more sophistication to let the
159          * user specify files to be ignored. */
160         if (strcmp (entry->d_name, ".") == 0 ||
161             strcmp (entry->d_name, "..") == 0 ||
162             strcmp (entry->d_name, ".notmuch") ==0)
163         {
164             continue;
165         }
166
167         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
168
169         if (stat (next, st)) {
170             fprintf (stderr, "Error reading %s: %s\n",
171                      next, strerror (errno));
172             ret = NOTMUCH_STATUS_FILE_ERROR;
173             continue;
174         }
175
176         if (S_ISREG (st->st_mode)) {
177             /* If the file hasn't been modified since the last
178              * add_files, then we need not look at it. */
179             if (path_dbtime == 0 || st->st_mtime > path_dbtime) {
180                 state->processed_files++;
181
182                 if (state->verbose) {
183                     printf ("\r\033[K%i/%i: %s\r",
184                             state->processed_files,
185                             state->total_files,
186                             next);
187                     fflush (stdout);
188                 }
189
190                 status = notmuch_database_add_message (notmuch, next, &message);
191                 switch (status) {
192                     /* success */
193                     case NOTMUCH_STATUS_SUCCESS:
194                         state->added_messages++;
195                         tag_inbox_and_unread (message);
196                         break;
197                     /* Non-fatal issues (go on to next file) */
198                     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
199                         /* Stay silent on this one. */
200                         break;
201                     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
202                         fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
203                                  next);
204                         break;
205                     /* Fatal issues. Don't process anymore. */
206                     case NOTMUCH_STATUS_READONLY_DATABASE:
207                     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
208                     case NOTMUCH_STATUS_OUT_OF_MEMORY:
209                         fprintf (stderr, "Error: %s. Halting processing.\n",
210                                  notmuch_status_to_string (status));
211                         ret = status;
212                         goto DONE;
213                     default:
214                     case NOTMUCH_STATUS_FILE_ERROR:
215                     case NOTMUCH_STATUS_NULL_POINTER:
216                     case NOTMUCH_STATUS_TAG_TOO_LONG:
217                     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
218                     case NOTMUCH_STATUS_LAST_STATUS:
219                         INTERNAL_ERROR ("add_message returned unexpected value: %d",  status);
220                         goto DONE;
221                 }
222
223                 if (message) {
224                     notmuch_message_destroy (message);
225                     message = NULL;
226                 }
227
228                 if (do_add_files_print_progress) {
229                     do_add_files_print_progress = 0;
230                     add_files_print_progress (state);
231                 }
232             }
233         } else if (S_ISDIR (st->st_mode)) {
234             status = add_files_recursive (notmuch, next, st, state);
235             if (status && ret == NOTMUCH_STATUS_SUCCESS)
236                 ret = status;
237         }
238
239         talloc_free (next);
240         next = NULL;
241     }
242
243     status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
244     if (status && ret == NOTMUCH_STATUS_SUCCESS)
245         ret = status;
246
247   DONE:
248     if (next)
249         talloc_free (next);
250     if (entry)
251         free (entry);
252     if (dir)
253         closedir (dir);
254     if (namelist)
255         free (namelist);
256
257     return ret;
258 }
259
260 /* This is the top-level entry point for add_files. It does a couple
261  * of error checks, sets up the progress-printing timer and then calls
262  * into the recursive function. */
263 notmuch_status_t
264 add_files (notmuch_database_t *notmuch,
265            const char *path,
266            add_files_state_t *state)
267 {
268     struct stat st;
269     notmuch_status_t status;
270     struct sigaction action;
271     struct itimerval timerval;
272     notmuch_bool_t timer_is_active = FALSE;
273
274     if (stat (path, &st)) {
275         fprintf (stderr, "Error reading directory %s: %s\n",
276                  path, strerror (errno));
277         return NOTMUCH_STATUS_FILE_ERROR;
278     }
279
280     if (! S_ISDIR (st.st_mode)) {
281         fprintf (stderr, "Error: %s is not a directory.\n", path);
282         return NOTMUCH_STATUS_FILE_ERROR;
283     }
284
285     if (isatty (fileno (stdout)) && ! debugger_is_active ()
286         && ! state->verbose)
287     {
288         /* Setup our handler for SIGALRM */
289         memset (&action, 0, sizeof (struct sigaction));
290         action.sa_handler = handle_sigalrm;
291         sigemptyset (&action.sa_mask);
292         action.sa_flags = SA_RESTART;
293         sigaction (SIGALRM, &action, NULL);
294
295         /* Then start a timer to send SIGALRM once per second. */
296         timerval.it_interval.tv_sec = 1;
297         timerval.it_interval.tv_usec = 0;
298         timerval.it_value.tv_sec = 1;
299         timerval.it_value.tv_usec = 0;
300         setitimer (ITIMER_REAL, &timerval, NULL);
301
302         timer_is_active = TRUE;
303     }
304
305     status = add_files_recursive (notmuch, path, &st, state);
306
307     if (timer_is_active) {
308         /* Now stop the timer. */
309         timerval.it_interval.tv_sec = 0;
310         timerval.it_interval.tv_usec = 0;
311         timerval.it_value.tv_sec = 0;
312         timerval.it_value.tv_usec = 0;
313         setitimer (ITIMER_REAL, &timerval, NULL);
314
315         /* And disable the signal handler. */
316         action.sa_handler = SIG_IGN;
317         sigaction (SIGALRM, &action, NULL);
318     }
319
320     return status;
321 }
322
323 /* XXX: This should be merged with the add_files function since it
324  * shares a lot of logic with it. */
325 /* Recursively count all regular files in path and all sub-directories
326  * of path.  The result is added to *count (which should be
327  * initialized to zero by the top-level caller before calling
328  * count_files). */
329 static void
330 count_files (const char *path, int *count)
331 {
332     struct dirent *entry = NULL;
333     char *next;
334     struct stat st;
335     struct dirent **namelist = NULL;
336     int n_entries = scandir (path, &namelist, 0, ino_cmp);
337     int i = 0;
338
339     if (n_entries == -1) {
340         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
341                  path, strerror (errno));
342         goto DONE;
343     }
344
345     while (!interrupted) {
346         if (i == n_entries)
347             break;
348
349         entry= namelist[i++];
350
351         /* Ignore special directories to avoid infinite recursion.
352          * Also ignore the .notmuch directory.
353          */
354         /* XXX: Eventually we'll want more sophistication to let the
355          * user specify files to be ignored. */
356         if (strcmp (entry->d_name, ".") == 0 ||
357             strcmp (entry->d_name, "..") == 0 ||
358             strcmp (entry->d_name, ".notmuch") == 0)
359         {
360             continue;
361         }
362
363         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
364             next = NULL;
365             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
366                      path, entry->d_name);
367             continue;
368         }
369
370         stat (next, &st);
371
372         if (S_ISREG (st.st_mode)) {
373             *count = *count + 1;
374             if (*count % 1000 == 0) {
375                 printf ("Found %d files so far.\r", *count);
376                 fflush (stdout);
377             }
378         } else if (S_ISDIR (st.st_mode)) {
379             count_files (next, count);
380         }
381
382         free (next);
383     }
384
385   DONE:
386     if (entry)
387         free (entry);
388     if (namelist)
389         free (namelist);
390 }
391
392 int
393 notmuch_new_command (void *ctx, int argc, char *argv[])
394 {
395     notmuch_config_t *config;
396     notmuch_database_t *notmuch;
397     add_files_state_t add_files_state;
398     double elapsed;
399     struct timeval tv_now;
400     int ret = 0;
401     struct stat st;
402     const char *db_path;
403     char *dot_notmuch_path;
404     struct sigaction action;
405     int i;
406
407     add_files_state.verbose = 0;
408
409     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
410         if (STRNCMP_LITERAL (argv[i], "--verbose") == 0) {
411             add_files_state.verbose = 1;
412         } else {
413             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
414             return 1;
415         }
416     }
417
418     /* Setup our handler for SIGINT */
419     memset (&action, 0, sizeof (struct sigaction));
420     action.sa_handler = handle_sigint;
421     sigemptyset (&action.sa_mask);
422     action.sa_flags = SA_RESTART;
423     sigaction (SIGINT, &action, NULL);
424
425     config = notmuch_config_open (ctx, NULL, NULL);
426     if (config == NULL)
427         return 1;
428
429     db_path = notmuch_config_get_database_path (config);
430
431     dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
432
433     if (stat (dot_notmuch_path, &st)) {
434         int count;
435
436         count = 0;
437         count_files (db_path, &count);
438         if (interrupted)
439             return 1;
440
441         printf ("Found %d total files.     \n", count);
442         notmuch = notmuch_database_create (db_path);
443         add_files_state.ignore_read_only_directories = FALSE;
444         add_files_state.total_files = count;
445     } else {
446         notmuch = notmuch_database_open (db_path,
447                                          NOTMUCH_DATABASE_MODE_READ_WRITE);
448         add_files_state.ignore_read_only_directories = TRUE;
449         add_files_state.total_files = 0;
450     }
451
452     if (notmuch == NULL)
453         return 1;
454
455     talloc_free (dot_notmuch_path);
456     dot_notmuch_path = NULL;
457
458     add_files_state.saw_read_only_directory = FALSE;
459     add_files_state.processed_files = 0;
460     add_files_state.added_messages = 0;
461     gettimeofday (&add_files_state.tv_start, NULL);
462
463     ret = add_files (notmuch, db_path, &add_files_state);
464
465     gettimeofday (&tv_now, NULL);
466     elapsed = notmuch_time_elapsed (add_files_state.tv_start,
467                                     tv_now);
468     if (add_files_state.processed_files) {
469         printf ("Processed %d %s in ", add_files_state.processed_files,
470                 add_files_state.processed_files == 1 ?
471                 "file" : "total files");
472         notmuch_time_print_formatted_seconds (elapsed);
473         if (elapsed > 1) {
474             printf (" (%d files/sec.).                 \n",
475                     (int) (add_files_state.processed_files / elapsed));
476         } else {
477             printf (".                    \n");
478         }
479     }
480     if (add_files_state.added_messages) {
481         printf ("Added %d new %s to the database (not much, really).\n",
482                 add_files_state.added_messages,
483                 add_files_state.added_messages == 1 ?
484                 "message" : "messages");
485     } else {
486         printf ("No new mail---and that's not much.\n");
487     }
488
489     if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
490         printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
491                 "they will never receive new mail), marking these directories as\n"
492                 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
493                 "much more efficient (it won't even look in those directories).\n");
494     }
495
496     if (ret) {
497         printf ("\nNote: At least one error was encountered: %s\n",
498                 notmuch_status_to_string (ret));
499     }
500
501     notmuch_database_close (notmuch);
502
503     return ret || interrupted;
504 }