ANSI escapes in "new" only when output is a tty
[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                     if (state->output_is_a_tty)
184                         printf("\r\033[K");
185
186                     printf ("%i/%i: %s",
187                             state->processed_files,
188                             state->total_files,
189                             next);
190
191                     putchar((state->output_is_a_tty) ? '\r' : '\n');
192                     fflush (stdout);
193                 }
194
195                 status = notmuch_database_add_message (notmuch, next, &message);
196                 switch (status) {
197                     /* success */
198                     case NOTMUCH_STATUS_SUCCESS:
199                         state->added_messages++;
200                         tag_inbox_and_unread (message);
201                         break;
202                     /* Non-fatal issues (go on to next file) */
203                     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
204                         /* Stay silent on this one. */
205                         break;
206                     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
207                         fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
208                                  next);
209                         break;
210                     /* Fatal issues. Don't process anymore. */
211                     case NOTMUCH_STATUS_READONLY_DATABASE:
212                     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
213                     case NOTMUCH_STATUS_OUT_OF_MEMORY:
214                         fprintf (stderr, "Error: %s. Halting processing.\n",
215                                  notmuch_status_to_string (status));
216                         ret = status;
217                         goto DONE;
218                     default:
219                     case NOTMUCH_STATUS_FILE_ERROR:
220                     case NOTMUCH_STATUS_NULL_POINTER:
221                     case NOTMUCH_STATUS_TAG_TOO_LONG:
222                     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
223                     case NOTMUCH_STATUS_LAST_STATUS:
224                         INTERNAL_ERROR ("add_message returned unexpected value: %d",  status);
225                         goto DONE;
226                 }
227
228                 if (message) {
229                     notmuch_message_destroy (message);
230                     message = NULL;
231                 }
232
233                 if (do_add_files_print_progress) {
234                     do_add_files_print_progress = 0;
235                     add_files_print_progress (state);
236                 }
237             }
238         } else if (S_ISDIR (st->st_mode)) {
239             status = add_files_recursive (notmuch, next, st, state);
240             if (status && ret == NOTMUCH_STATUS_SUCCESS)
241                 ret = status;
242         }
243
244         talloc_free (next);
245         next = NULL;
246     }
247
248     status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
249     if (status && ret == NOTMUCH_STATUS_SUCCESS)
250         ret = status;
251
252   DONE:
253     if (next)
254         talloc_free (next);
255     if (entry)
256         free (entry);
257     if (dir)
258         closedir (dir);
259     if (namelist)
260         free (namelist);
261
262     return ret;
263 }
264
265 /* This is the top-level entry point for add_files. It does a couple
266  * of error checks, sets up the progress-printing timer and then calls
267  * into the recursive function. */
268 notmuch_status_t
269 add_files (notmuch_database_t *notmuch,
270            const char *path,
271            add_files_state_t *state)
272 {
273     struct stat st;
274     notmuch_status_t status;
275     struct sigaction action;
276     struct itimerval timerval;
277     notmuch_bool_t timer_is_active = FALSE;
278
279     if (stat (path, &st)) {
280         fprintf (stderr, "Error reading directory %s: %s\n",
281                  path, strerror (errno));
282         return NOTMUCH_STATUS_FILE_ERROR;
283     }
284
285     if (! S_ISDIR (st.st_mode)) {
286         fprintf (stderr, "Error: %s is not a directory.\n", path);
287         return NOTMUCH_STATUS_FILE_ERROR;
288     }
289
290     if (state->output_is_a_tty && ! debugger_is_active () && ! state->verbose) {
291         /* Setup our handler for SIGALRM */
292         memset (&action, 0, sizeof (struct sigaction));
293         action.sa_handler = handle_sigalrm;
294         sigemptyset (&action.sa_mask);
295         action.sa_flags = SA_RESTART;
296         sigaction (SIGALRM, &action, NULL);
297
298         /* Then start a timer to send SIGALRM once per second. */
299         timerval.it_interval.tv_sec = 1;
300         timerval.it_interval.tv_usec = 0;
301         timerval.it_value.tv_sec = 1;
302         timerval.it_value.tv_usec = 0;
303         setitimer (ITIMER_REAL, &timerval, NULL);
304
305         timer_is_active = TRUE;
306     }
307
308     status = add_files_recursive (notmuch, path, &st, state);
309
310     if (timer_is_active) {
311         /* Now stop the timer. */
312         timerval.it_interval.tv_sec = 0;
313         timerval.it_interval.tv_usec = 0;
314         timerval.it_value.tv_sec = 0;
315         timerval.it_value.tv_usec = 0;
316         setitimer (ITIMER_REAL, &timerval, NULL);
317
318         /* And disable the signal handler. */
319         action.sa_handler = SIG_IGN;
320         sigaction (SIGALRM, &action, NULL);
321     }
322
323     return status;
324 }
325
326 /* XXX: This should be merged with the add_files function since it
327  * shares a lot of logic with it. */
328 /* Recursively count all regular files in path and all sub-directories
329  * of path.  The result is added to *count (which should be
330  * initialized to zero by the top-level caller before calling
331  * count_files). */
332 static void
333 count_files (const char *path, int *count)
334 {
335     struct dirent *entry = NULL;
336     char *next;
337     struct stat st;
338     struct dirent **namelist = NULL;
339     int n_entries = scandir (path, &namelist, 0, ino_cmp);
340     int i = 0;
341
342     if (n_entries == -1) {
343         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
344                  path, strerror (errno));
345         goto DONE;
346     }
347
348     while (!interrupted) {
349         if (i == n_entries)
350             break;
351
352         entry= namelist[i++];
353
354         /* Ignore special directories to avoid infinite recursion.
355          * Also ignore the .notmuch directory.
356          */
357         /* XXX: Eventually we'll want more sophistication to let the
358          * user specify files to be ignored. */
359         if (strcmp (entry->d_name, ".") == 0 ||
360             strcmp (entry->d_name, "..") == 0 ||
361             strcmp (entry->d_name, ".notmuch") == 0)
362         {
363             continue;
364         }
365
366         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
367             next = NULL;
368             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
369                      path, entry->d_name);
370             continue;
371         }
372
373         stat (next, &st);
374
375         if (S_ISREG (st.st_mode)) {
376             *count = *count + 1;
377             if (*count % 1000 == 0) {
378                 printf ("Found %d files so far.\r", *count);
379                 fflush (stdout);
380             }
381         } else if (S_ISDIR (st.st_mode)) {
382             count_files (next, count);
383         }
384
385         free (next);
386     }
387
388   DONE:
389     if (entry)
390         free (entry);
391     if (namelist)
392         free (namelist);
393 }
394
395 int
396 notmuch_new_command (void *ctx, int argc, char *argv[])
397 {
398     notmuch_config_t *config;
399     notmuch_database_t *notmuch;
400     add_files_state_t add_files_state;
401     double elapsed;
402     struct timeval tv_now;
403     int ret = 0;
404     struct stat st;
405     const char *db_path;
406     char *dot_notmuch_path;
407     struct sigaction action;
408     int i;
409
410     add_files_state.verbose = 0;
411     add_files_state.output_is_a_tty = isatty (fileno (stdout));
412
413     for (i = 0; i < argc && argv[i][0] == '-'; i++) {
414         if (STRNCMP_LITERAL (argv[i], "--verbose") == 0) {
415             add_files_state.verbose = 1;
416         } else {
417             fprintf (stderr, "Unrecognized option: %s\n", argv[i]);
418             return 1;
419         }
420     }
421
422     /* Setup our handler for SIGINT */
423     memset (&action, 0, sizeof (struct sigaction));
424     action.sa_handler = handle_sigint;
425     sigemptyset (&action.sa_mask);
426     action.sa_flags = SA_RESTART;
427     sigaction (SIGINT, &action, NULL);
428
429     config = notmuch_config_open (ctx, NULL, NULL);
430     if (config == NULL)
431         return 1;
432
433     db_path = notmuch_config_get_database_path (config);
434
435     dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
436
437     if (stat (dot_notmuch_path, &st)) {
438         int count;
439
440         count = 0;
441         count_files (db_path, &count);
442         if (interrupted)
443             return 1;
444
445         printf ("Found %d total files.     \n", count);
446         notmuch = notmuch_database_create (db_path);
447         add_files_state.ignore_read_only_directories = FALSE;
448         add_files_state.total_files = count;
449     } else {
450         notmuch = notmuch_database_open (db_path,
451                                          NOTMUCH_DATABASE_MODE_READ_WRITE);
452         add_files_state.ignore_read_only_directories = TRUE;
453         add_files_state.total_files = 0;
454     }
455
456     if (notmuch == NULL)
457         return 1;
458
459     talloc_free (dot_notmuch_path);
460     dot_notmuch_path = NULL;
461
462     add_files_state.saw_read_only_directory = FALSE;
463     add_files_state.processed_files = 0;
464     add_files_state.added_messages = 0;
465     gettimeofday (&add_files_state.tv_start, NULL);
466
467     ret = add_files (notmuch, db_path, &add_files_state);
468
469     gettimeofday (&tv_now, NULL);
470     elapsed = notmuch_time_elapsed (add_files_state.tv_start,
471                                     tv_now);
472     if (add_files_state.processed_files) {
473         printf ("Processed %d %s in ", add_files_state.processed_files,
474                 add_files_state.processed_files == 1 ?
475                 "file" : "total files");
476         notmuch_time_print_formatted_seconds (elapsed);
477         if (elapsed > 1) {
478             printf (" (%d files/sec.).                 \n",
479                     (int) (add_files_state.processed_files / elapsed));
480         } else {
481             printf (".                    \n");
482         }
483     }
484     if (add_files_state.added_messages) {
485         printf ("Added %d new %s to the database (not much, really).\n",
486                 add_files_state.added_messages,
487                 add_files_state.added_messages == 1 ?
488                 "message" : "messages");
489     } else {
490         printf ("No new mail---and that's not much.\n");
491     }
492
493     if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
494         printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
495                 "they will never receive new mail), marking these directories as\n"
496                 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
497                 "much more efficient (it won't even look in those directories).\n");
498     }
499
500     if (ret) {
501         printf ("\nNote: At least one error was encountered: %s\n",
502                 notmuch_status_to_string (ret));
503     }
504
505     notmuch_database_close (notmuch);
506
507     return ret || interrupted;
508 }