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;
116 /* If we're told to, we bail out on encountering a read-only
117 * directory, (with this being a clear clue from the user to
118 * Notmuch that new mail won't be arriving there and we need not
120 if (state->ignore_read_only_directories &&
121 (st->st_mode & S_IWUSR) == 0)
123 state->saw_read_only_directory = TRUE;
127 path_mtime = st->st_mtime;
129 path_dbtime = notmuch_database_get_timestamp (notmuch, path);
130 num_entries = scandir (path, &namelist, 0, ino_cmp);
132 if (num_entries == -1) {
133 fprintf (stderr, "Error opening directory %s: %s\n",
134 path, strerror (errno));
135 ret = NOTMUCH_STATUS_FILE_ERROR;
141 while (!interrupted) {
142 if (i == num_entries)
145 entry= namelist[i++];
147 /* If this directory hasn't been modified since the last
148 * add_files, then we only need to look further for
149 * sub-directories. */
150 if (path_mtime <= path_dbtime && entry->d_type != DT_DIR)
153 /* Ignore special directories to avoid infinite recursion.
154 * Also ignore the .notmuch directory.
156 /* XXX: Eventually we'll want more sophistication to let the
157 * user specify files to be ignored. */
158 if (strcmp (entry->d_name, ".") == 0 ||
159 strcmp (entry->d_name, "..") == 0 ||
160 strcmp (entry->d_name, ".notmuch") ==0)
165 next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
167 if (stat (next, st)) {
168 fprintf (stderr, "Error reading %s: %s\n",
169 next, strerror (errno));
170 ret = NOTMUCH_STATUS_FILE_ERROR;
174 if (S_ISREG (st->st_mode)) {
175 /* If the file hasn't been modified since the last
176 * add_files, then we need not look at it. */
177 if (path_dbtime == 0 || st->st_mtime > path_dbtime) {
178 state->processed_files++;
180 status = notmuch_database_add_message (notmuch, next, &message);
183 case NOTMUCH_STATUS_SUCCESS:
184 state->added_messages++;
185 tag_inbox_and_unread (message);
187 /* Non-fatal issues (go on to next file) */
188 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
189 /* Stay silent on this one. */
191 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
192 fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
195 /* Fatal issues. Don't process anymore. */
196 case NOTMUCH_STATUS_READONLY_DATABASE:
197 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
198 case NOTMUCH_STATUS_OUT_OF_MEMORY:
199 fprintf (stderr, "Error: %s. Halting processing.\n",
200 notmuch_status_to_string (status));
204 case NOTMUCH_STATUS_FILE_ERROR:
205 case NOTMUCH_STATUS_NULL_POINTER:
206 case NOTMUCH_STATUS_TAG_TOO_LONG:
207 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
208 case NOTMUCH_STATUS_LAST_STATUS:
209 INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
214 notmuch_message_destroy (message);
218 if (do_add_files_print_progress) {
219 do_add_files_print_progress = 0;
220 add_files_print_progress (state);
223 } else if (S_ISDIR (st->st_mode)) {
224 status = add_files_recursive (notmuch, next, st, state);
225 if (status && ret == NOTMUCH_STATUS_SUCCESS)
233 status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
234 if (status && ret == NOTMUCH_STATUS_SUCCESS)
250 /* This is the top-level entry point for add_files. It does a couple
251 * of error checks, sets up the progress-printing timer and then calls
252 * into the recursive function. */
254 add_files (notmuch_database_t *notmuch,
256 add_files_state_t *state)
259 notmuch_status_t status;
260 struct sigaction action;
261 struct itimerval timerval;
263 if (stat (path, &st)) {
264 fprintf (stderr, "Error reading directory %s: %s\n",
265 path, strerror (errno));
266 return NOTMUCH_STATUS_FILE_ERROR;
269 if (! S_ISDIR (st.st_mode)) {
270 fprintf (stderr, "Error: %s is not a directory.\n", path);
271 return NOTMUCH_STATUS_FILE_ERROR;
274 /* Setup our handler for SIGALRM */
275 memset (&action, 0, sizeof (struct sigaction));
276 action.sa_handler = handle_sigalrm;
277 sigemptyset (&action.sa_mask);
278 action.sa_flags = SA_RESTART;
279 sigaction (SIGALRM, &action, NULL);
281 /* Then start a timer to send SIGALRM once per second. */
282 timerval.it_interval.tv_sec = 1;
283 timerval.it_interval.tv_usec = 0;
284 timerval.it_value.tv_sec = 1;
285 timerval.it_value.tv_usec = 0;
286 setitimer (ITIMER_REAL, &timerval, NULL);
288 status = add_files_recursive (notmuch, path, &st, state);
290 /* Now stop the timer. */
291 timerval.it_interval.tv_sec = 0;
292 timerval.it_interval.tv_usec = 0;
293 timerval.it_value.tv_sec = 0;
294 timerval.it_value.tv_usec = 0;
295 setitimer (ITIMER_REAL, &timerval, NULL);
297 /* And disable the signal handler. */
298 action.sa_handler = SIG_IGN;
299 sigaction (SIGALRM, &action, NULL);
304 /* XXX: This should be merged with the add_files function since it
305 * shares a lot of logic with it. */
306 /* Recursively count all regular files in path and all sub-directories
307 * of path. The result is added to *count (which should be
308 * initialized to zero by the top-level caller before calling
311 count_files (const char *path, int *count)
313 struct dirent *entry = NULL;
316 struct dirent **namelist = NULL;
317 int n_entries = scandir (path, &namelist, 0, ino_cmp);
320 if (n_entries == -1) {
321 fprintf (stderr, "Warning: failed to open directory %s: %s\n",
322 path, strerror (errno));
326 while (!interrupted) {
330 entry= namelist[i++];
332 /* Ignore special directories to avoid infinite recursion.
333 * Also ignore the .notmuch directory.
335 /* XXX: Eventually we'll want more sophistication to let the
336 * user specify files to be ignored. */
337 if (strcmp (entry->d_name, ".") == 0 ||
338 strcmp (entry->d_name, "..") == 0 ||
339 strcmp (entry->d_name, ".notmuch") == 0)
344 if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
346 fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
347 path, entry->d_name);
353 if (S_ISREG (st.st_mode)) {
355 if (*count % 1000 == 0) {
356 printf ("Found %d files so far.\r", *count);
359 } else if (S_ISDIR (st.st_mode)) {
360 count_files (next, count);
374 notmuch_new_command (void *ctx,
375 unused (int argc), unused (char *argv[]))
377 notmuch_config_t *config;
378 notmuch_database_t *notmuch;
379 add_files_state_t add_files_state;
381 struct timeval tv_now;
385 char *dot_notmuch_path;
386 struct sigaction action;
388 /* Setup our handler for SIGINT */
389 memset (&action, 0, sizeof (struct sigaction));
390 action.sa_handler = handle_sigint;
391 sigemptyset (&action.sa_mask);
392 action.sa_flags = SA_RESTART;
393 sigaction (SIGINT, &action, NULL);
395 config = notmuch_config_open (ctx, NULL, NULL);
399 db_path = notmuch_config_get_database_path (config);
401 dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
403 if (stat (dot_notmuch_path, &st)) {
407 count_files (db_path, &count);
411 printf ("Found %d total files. \n", count);
412 notmuch = notmuch_database_create (db_path);
413 add_files_state.ignore_read_only_directories = FALSE;
414 add_files_state.total_files = count;
416 notmuch = notmuch_database_open (db_path,
417 NOTMUCH_DATABASE_MODE_READ_WRITE);
418 add_files_state.ignore_read_only_directories = TRUE;
419 add_files_state.total_files = 0;
425 talloc_free (dot_notmuch_path);
426 dot_notmuch_path = NULL;
428 add_files_state.saw_read_only_directory = FALSE;
429 add_files_state.processed_files = 0;
430 add_files_state.added_messages = 0;
431 gettimeofday (&add_files_state.tv_start, NULL);
433 ret = add_files (notmuch, db_path, &add_files_state);
435 gettimeofday (&tv_now, NULL);
436 elapsed = notmuch_time_elapsed (add_files_state.tv_start,
438 if (add_files_state.processed_files) {
439 printf ("Processed %d %s in ", add_files_state.processed_files,
440 add_files_state.processed_files == 1 ?
441 "file" : "total files");
442 notmuch_time_print_formatted_seconds (elapsed);
444 printf (" (%d files/sec.). \n",
445 (int) (add_files_state.processed_files / elapsed));
450 if (add_files_state.added_messages) {
451 printf ("Added %d new %s to the database (not much, really).\n",
452 add_files_state.added_messages,
453 add_files_state.added_messages == 1 ?
454 "message" : "messages");
456 printf ("No new mail---and that's not much.\n");
459 if (elapsed > 1 && ! add_files_state.saw_read_only_directory) {
460 printf ("\nTip: If you have any sub-directories that are archives (that is,\n"
461 "they will never receive new mail), marking these directories as\n"
462 "read-only (chmod u-w /path/to/dir) will make \"notmuch new\"\n"
463 "much more efficient (it won't even look in those directories).\n");
467 printf ("\nNote: At least one error was encountered: %s\n",
468 notmuch_status_to_string (ret));
471 notmuch_database_close (notmuch);
473 return ret || interrupted;