1 /* notmuch - Not much of an email program, (just index and search)
3 * Copyright © 2009 Carl Worth
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.
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.
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/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-client.h"
23 static volatile sig_atomic_t do_add_files_print_progress = 0;
26 handle_sigalrm (unused (int signal))
28 do_add_files_print_progress = 1;
31 static volatile sig_atomic_t interrupted;
34 handle_sigint (unused (int sig))
36 static char msg[] = "Stopping... \n";
37 write(2, msg, sizeof(msg)-1);
42 tag_inbox_and_unread (notmuch_message_t *message)
44 notmuch_message_add_tag (message, "inbox");
45 notmuch_message_add_tag (message, "unread");
49 add_files_print_progress (add_files_state_t *state)
51 struct timeval tv_now;
52 double elapsed_overall, rate_overall;
54 gettimeofday (&tv_now, NULL);
56 elapsed_overall = notmuch_time_elapsed (state->tv_start, tv_now);
57 rate_overall = (state->processed_files) / elapsed_overall;
59 printf ("Processed %d", state->processed_files);
61 if (state->total_files) {
62 double time_remaining;
64 time_remaining = ((state->total_files - state->processed_files) /
66 printf (" of %d files (", state->total_files);
67 notmuch_time_print_formatted_seconds (time_remaining);
68 printf (" remaining). \r");
70 printf (" files (%d files/sec.) \r", (int) rate_overall);
76 static int ino_cmp(const struct dirent **a, const struct dirent **b)
78 return ((*a)->d_ino < (*b)->d_ino)? -1: 1;
81 /* Examine 'path' recursively as follows:
83 * o Ask the filesystem for the mtime of 'path' (path_mtime)
85 * o Ask the database for its timestamp of 'path' (path_dbtime)
87 * o If 'path_mtime' > 'path_dbtime'
89 * o For each regular file in 'path' with mtime newer than the
90 * 'path_dbtime' call add_message to add the file to the
93 * o For each sub-directory of path, recursively call into this
96 * o Tell the database to update its time of 'path' to 'path_mtime'
98 * The 'struct stat *st' must point to a structure that has already
99 * been initialized for 'path' by calling stat().
101 static notmuch_status_t
102 add_files_recursive (notmuch_database_t *notmuch,
105 add_files_state_t *state)
108 struct dirent *entry = NULL;
110 time_t path_mtime, path_dbtime;
111 notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
112 notmuch_message_t *message = NULL;
113 struct dirent **namelist = NULL;
115 /* If we're told to, we bail out on encountering a read-only
116 * directory, (with this being a clear clue from the user to
117 * Notmuch that new mail won't be arriving there and we need not
119 if (state->ignore_read_only_directories &&
120 (st->st_mode & S_IWUSR) == 0)
122 state->saw_read_only_directory = TRUE;
126 path_mtime = st->st_mtime;
128 path_dbtime = notmuch_database_get_timestamp (notmuch, path);
129 int n_entries= scandir(path, &namelist, 0, ino_cmp);
131 if (n_entries == -1) {
132 fprintf (stderr, "Error opening directory %s: %s\n",
133 path, strerror (errno));
134 ret = NOTMUCH_STATUS_FILE_ERROR;
140 while (!interrupted) {
144 entry= namelist[i++];
146 /* If this directory hasn't been modified since the last
147 * add_files, then we only need to look further for
148 * sub-directories. */
149 if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
152 /* Ignore special directories to avoid infinite recursion.
153 * Also ignore the .notmuch directory.
155 /* XXX: Eventually we'll want more sophistication to let the
156 * user specify files to be ignored. */
157 if (strcmp (entry->d_name, ".") == 0 ||
158 strcmp (entry->d_name, "..") == 0 ||
159 strcmp (entry->d_name, ".notmuch") ==0)
164 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
166 if (stat (next, st)) {
167 fprintf (stderr, "Error reading %s: %s\n",
168 next, strerror (errno));
169 ret = NOTMUCH_STATUS_FILE_ERROR;
173 if (S_ISREG (st->st_mode)) {
174 /* If the file hasn't been modified since the last
175 * add_files, then we need not look at it. */
176 if (path_dbtime == 0 || st->st_mtime > path_dbtime) {
177 state->processed_files++;
179 status = notmuch_database_add_message (notmuch, next, &message);
182 case NOTMUCH_STATUS_SUCCESS:
183 state->added_messages++;
184 tag_inbox_and_unread (message);
186 /* Non-fatal issues (go on to next file) */
187 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
188 /* Stay silent on this one. */
190 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
191 fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
194 /* Fatal issues. Don't process anymore. */
195 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
196 case NOTMUCH_STATUS_OUT_OF_MEMORY:
197 fprintf (stderr, "Error: %s. Halting processing.\n",
198 notmuch_status_to_string (status));
202 case NOTMUCH_STATUS_FILE_ERROR:
203 case NOTMUCH_STATUS_NULL_POINTER:
204 case NOTMUCH_STATUS_TAG_TOO_LONG:
205 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
206 case NOTMUCH_STATUS_LAST_STATUS:
207 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
212 notmuch_message_destroy (message);
216 if (do_add_files_print_progress) {
217 do_add_files_print_progress = 0;
218 add_files_print_progress (state);
221 } else if (S_ISDIR (st->st_mode)) {
222 status = add_files_recursive (notmuch, next, st, state);
223 if (status && ret == NOTMUCH_STATUS_SUCCESS)
231 status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
232 if (status && ret == NOTMUCH_STATUS_SUCCESS)
248 /* This is the top-level entry point for add_files. It does a couple
249 * of error checks, sets up the progress-printing timer and then calls
250 * into the recursive function. */
252 add_files (notmuch_database_t *notmuch,
254 add_files_state_t *state)
257 notmuch_status_t status;
258 struct sigaction action;
259 struct itimerval timerval;
261 if (stat (path, &st)) {
262 fprintf (stderr, "Error reading directory %s: %s\n",
263 path, strerror (errno));
264 return NOTMUCH_STATUS_FILE_ERROR;
267 if (! S_ISDIR (st.st_mode)) {
268 fprintf (stderr, "Error: %s is not a directory.\n", path);
269 return NOTMUCH_STATUS_FILE_ERROR;
272 /* Setup our handler for SIGALRM */
273 memset (&action, 0, sizeof (struct sigaction));
274 action.sa_handler = handle_sigalrm;
275 sigemptyset (&action.sa_mask);
276 action.sa_flags = SA_RESTART;
277 sigaction (SIGALRM, &action, NULL);
279 /* Then start a timer to send SIGALRM once per second. */
280 timerval.it_interval.tv_sec = 1;
281 timerval.it_interval.tv_usec = 0;
282 timerval.it_value.tv_sec = 1;
283 timerval.it_value.tv_usec = 0;
284 setitimer (ITIMER_REAL, &timerval, NULL);
286 status = add_files_recursive (notmuch, path, &st, state);
288 /* Now stop the timer. */
289 timerval.it_interval.tv_sec = 0;
290 timerval.it_interval.tv_usec = 0;
291 timerval.it_value.tv_sec = 0;
292 timerval.it_value.tv_usec = 0;
293 setitimer (ITIMER_REAL, &timerval, NULL);
295 /* And disable the signal handler. */
296 action.sa_handler = SIG_IGN;
297 sigaction (SIGALRM, &action, NULL);
302 /* XXX: This should be merged with the add_files function since it
303 * shares a lot of logic with it. */
304 /* Recursively count all regular files in path and all sub-directories
305 * of path. The result is added to *count (which should be
306 * initialized to zero by the top-level caller before calling
309 count_files (const char *path, int *count)
312 struct dirent *e, *entry = NULL;
318 dir = opendir (path);
321 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
322 path, strerror (errno));
326 entry_length = offsetof (struct dirent, d_name) +
327 pathconf (path, _PC_NAME_MAX) + 1;
328 entry = malloc (entry_length);
330 while (!interrupted) {
331 err = readdir_r (dir, entry, &e);
333 fprintf (stderr, "Error reading directory: %s\n",
342 /* Ignore special directories to avoid infinite recursion.
343 * Also ignore the .notmuch directory.
345 /* XXX: Eventually we'll want more sophistication to let the
346 * user specify files to be ignored. */
347 if (strcmp (entry->d_name, ".") == 0 ||
348 strcmp (entry->d_name, "..") == 0 ||
349 strcmp (entry->d_name, ".notmuch") == 0)
354 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
356 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
357 path, entry->d_name);
363 if (S_ISREG (st.st_mode)) {
365 if (*count % 1000 == 0) {
366 printf ("Found %d files so far.\r", *count);
369 } else if (S_ISDIR (st.st_mode)) {
370 count_files (next, count);
384 notmuch_new_command (void *ctx,
385 unused (int argc), unused (char *argv[]))
387 notmuch_config_t *config;
388 notmuch_database_t *notmuch;
389 add_files_state_t add_files_state;
391 struct timeval tv_now;
395 char *dot_notmuch_path;
396 struct sigaction action;
398 /* Setup our handler for SIGINT */
399 memset (&action, 0, sizeof (struct sigaction));
400 action.sa_handler = handle_sigint;
401 sigemptyset (&action.sa_mask);
402 action.sa_flags = SA_RESTART;
403 sigaction (SIGINT, &action, NULL);
405 config = notmuch_config_open (ctx, NULL, NULL);
409 db_path = notmuch_config_get_database_path (config);
411 dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
413 if (stat (dot_notmuch_path, &st)) {
417 count_files (db_path, &count);
421 notmuch = notmuch_database_create (db_path);
422 add_files_state.ignore_read_only_directories = FALSE;
423 add_files_state.total_files = count;
425 notmuch = notmuch_database_open (db_path);
426 add_files_state.ignore_read_only_directories = TRUE;
427 add_files_state.total_files = 0;
433 talloc_free (dot_notmuch_path);
434 dot_notmuch_path = NULL;
436 add_files_state.saw_read_only_directory = FALSE;
437 add_files_state.total_files = 0;
438 add_files_state.processed_files = 0;
439 add_files_state.added_messages = 0;
440 gettimeofday (&add_files_state.tv_start, NULL);
442 ret = add_files (notmuch, db_path, &add_files_state);
444 gettimeofday (&tv_now, NULL);
445 elapsed = notmuch_time_elapsed (add_files_state.tv_start,
447 if (add_files_state.processed_files) {
448 printf ("Processed %d %s in ", add_files_state.processed_files,
449 add_files_state.processed_files == 1 ?
450 "file" : "total files");
451 notmuch_time_print_formatted_seconds (elapsed);
453 printf (" (%d files/sec.). \n",
454 (int) (add_files_state.processed_files / elapsed));
459 if (add_files_state.added_messages) {
460 printf ("Added %d new %s to the database (not much, really).\n",
461 add_files_state.added_messages,
462 add_files_state.added_messages == 1 ?
463 "message" : "messages");
465 printf ("No new mail---and that's not much.\n");
468 if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
469 printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
470 "they will never receive new mail), marking these directories as\n"
471 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
472 "much more efficient (it won't even look in those directories).\n");
476 printf ("\nNote: At least one error was encountered: %s\n",
477 notmuch_status_to_string (ret));
480 notmuch_database_close (notmuch);
482 return ret || interrupted;