git.notmuchmail.org Git - notmuch/blob - 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 static volatile sig_atomic_t do_add_files_print_progress = 0;
  24
  25 static void
  26 handle_sigalrm (unused (int signal))
  27 {
  28     do_add_files_print_progress = 1;
  29 }
  30
  31 static volatile sig_atomic_t interrupted;
  32
  33 static void
  34 handle_sigint (unused (int sig))
  35 {
  36     static char msg[] = "Stopping...         \n";
  37     write(2, msg, sizeof(msg)-1);
  38     interrupted = 1;
  39 }
  40
  41 static void
  42 tag_inbox_and_unread (notmuch_message_t *message)
  43 {
  44     notmuch_message_add_tag (message, "inbox");
  45     notmuch_message_add_tag (message, "unread");
  46 }
  47
  48 static void
  49 add_files_print_progress (add_files_state_t *state)
  50 {
  51     struct timeval tv_now;
  52     double elapsed_overall, rate_overall;
  53
  54     gettimeofday (&tv_now, NULL);
  55
  56     elapsed_overall = notmuch_time_elapsed (state->tv_start, tv_now);
  57     rate_overall = (state->processed_files) / elapsed_overall;
  58
  59     printf ("Processed %d", state->processed_files);
  60
  61     if (state->total_files) {
  62         double time_remaining;
  63
  64         time_remaining = ((state->total_files - state->processed_files) /
  65                           rate_overall);
  66         printf (" of %d files (", state->total_files);
  67         notmuch_time_print_formatted_seconds (time_remaining);
  68         printf (" remaining).      \r");
  69     } else {
  70         printf (" files (%d files/sec.)    \r", (int) rate_overall);
  71     }
  72
  73     fflush (stdout);
  74 }
  75
  76 static int ino_cmp(const struct dirent **a, const struct dirent **b)
  77 {
  78     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
  79 }
  80
  81 /* Examine 'path' recursively as follows:
  82  *
  83  *   o Ask the filesystem for the mtime of 'path' (path_mtime)
  84  *
  85  *   o Ask the database for its timestamp of 'path' (path_dbtime)
  86  *
  87  *   o If 'path_mtime' > 'path_dbtime'
  88  *
  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
  91  *         database.
  92  *
  93  *       o For each sub-directory of path, recursively call into this
  94  *         same function.
  95  *
  96  *   o Tell the database to update its time of 'path' to 'path_mtime'
  97  *
  98  * The 'struct stat *st' must point to a structure that has already
  99  * been initialized for 'path' by calling stat().
 100  */
 101 static notmuch_status_t
 102 add_files_recursive (notmuch_database_t *notmuch,
 103                      const char *path,
 104                      struct stat *st,
 105                      add_files_state_t *state)
 106 {
 107     DIR *dir = NULL;
 108     struct dirent *entry = NULL;
 109     char *next = 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;
 114     int num_entries;
 115
 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
 119      * look. */
 120     if (state->ignore_read_only_directories &&
 121         (st->st_mode & S_IWUSR) == 0)
 122     {
 123         state->saw_read_only_directory = TRUE;
 124         goto DONE;
 125     }
 126
 127     path_mtime = st->st_mtime;
 128
 129     path_dbtime = notmuch_database_get_timestamp (notmuch, path);
 130     num_entries = scandir (path, &namelist, 0, ino_cmp);
 131
 132     if (num_entries == -1) {
 133         fprintf (stderr, "Error opening directory %s: %s\n",
 134                  path, strerror (errno));
 135         ret = NOTMUCH_STATUS_FILE_ERROR;
 136         goto DONE;
 137     }
 138
 139     int i=0;
 140
 141     while (!interrupted) {
 142         if (i == num_entries)
 143             break;
 144
 145         entry= namelist[i++];
 146
 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)
 151             continue;
 152
 153         /* Ignore special directories to avoid infinite recursion.
 154          * Also ignore the .notmuch directory.
 155          */
 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)
 161         {
 162             continue;
 163         }
 164
 165         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
 166
 167         if (stat (next, st)) {
 168             fprintf (stderr, "Error reading %s: %s\n",
 169                      next, strerror (errno));
 170             ret = NOTMUCH_STATUS_FILE_ERROR;
 171             continue;
 172         }
 173
 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++;
 179
 180                 status = notmuch_database_add_message (notmuch, next, &message);
 181                 switch (status) {
 182                     /* success */
 183                     case NOTMUCH_STATUS_SUCCESS:
 184                         state->added_messages++;
 185                         tag_inbox_and_unread (message);
 186                         break;
 187                     /* Non-fatal issues (go on to next file) */
 188                     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
 189                         /* Stay silent on this one. */
 190                         break;
 191                     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
 192                         fprintf (stderr, "Note: Ignoring non-mail file: %s\n",
 193                                  next);
 194                         break;
 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));
 201                         ret = status;
 202                         goto DONE;
 203                     default:
 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);
 210                         goto DONE;
 211                 }
 212
 213                 if (message) {
 214                     notmuch_message_destroy (message);
 215                     message = NULL;
 216                 }
 217
 218                 if (do_add_files_print_progress) {
 219                     do_add_files_print_progress = 0;
 220                     add_files_print_progress (state);
 221                 }
 222             }
 223         } else if (S_ISDIR (st->st_mode)) {
 224             status = add_files_recursive (notmuch, next, st, state);
 225             if (status && ret == NOTMUCH_STATUS_SUCCESS)
 226                 ret = status;
 227         }
 228
 229         talloc_free (next);
 230         next = NULL;
 231     }
 232
 233     status = notmuch_database_set_timestamp (notmuch, path, path_mtime);
 234     if (status && ret == NOTMUCH_STATUS_SUCCESS)
 235         ret = status;
 236
 237   DONE:
 238     if (next)
 239         talloc_free (next);
 240     if (entry)
 241         free (entry);
 242     if (dir)
 243         closedir (dir);
 244     if (namelist)
 245         free (namelist);
 246
 247     return ret;
 248 }
 249
 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. */
 253 notmuch_status_t
 254 add_files (notmuch_database_t *notmuch,
 255            const char *path,
 256            add_files_state_t *state)
 257 {
 258     struct stat st;
 259     notmuch_status_t status;
 260     struct sigaction action;
 261     struct itimerval timerval;
 262
 263     if (stat (path, &st)) {
 264         fprintf (stderr, "Error reading directory %s: %s\n",
 265                  path, strerror (errno));
 266         return NOTMUCH_STATUS_FILE_ERROR;
 267     }
 268
 269     if (! S_ISDIR (st.st_mode)) {
 270         fprintf (stderr, "Error: %s is not a directory.\n", path);
 271         return NOTMUCH_STATUS_FILE_ERROR;
 272     }
 273
 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);
 280
 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);
 287
 288     status = add_files_recursive (notmuch, path, &st, state);
 289
 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);
 296
 297     /* And disable the signal handler. */
 298     action.sa_handler = SIG_IGN;
 299     sigaction (SIGALRM, &action, NULL);
 300
 301     return status;
 302 }
 303
 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
 309  * count_files). */
 310 static void
 311 count_files (const char *path, int *count)
 312 {
 313     struct dirent *entry = NULL;
 314     char *next;
 315     struct stat st;
 316     struct dirent **namelist = NULL;
 317     int n_entries = scandir (path, &namelist, 0, ino_cmp);
 318     int i = 0;
 319
 320     if (n_entries == -1) {
 321         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
 322                  path, strerror (errno));
 323         goto DONE;
 324     }
 325
 326     while (!interrupted) {
 327         if (i == n_entries)
 328             break;
 329
 330         entry= namelist[i++];
 331
 332         /* Ignore special directories to avoid infinite recursion.
 333          * Also ignore the .notmuch directory.
 334          */
 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)
 340         {
 341             continue;
 342         }
 343
 344         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
 345             next = NULL;
 346             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
 347                      path, entry->d_name);
 348             continue;
 349         }
 350
 351         stat (next, &st);
 352
 353         if (S_ISREG (st.st_mode)) {
 354             *count = *count + 1;
 355             if (*count % 1000 == 0) {
 356                 printf ("Found %d files so far.\r", *count);
 357                 fflush (stdout);
 358             }
 359         } else if (S_ISDIR (st.st_mode)) {
 360             count_files (next, count);
 361         }
 362
 363         free (next);
 364     }
 365
 366   DONE:
 367     if (entry)
 368         free (entry);
 369     if (namelist)
 370         free (namelist);
 371 }
 372
 373 int
 374 notmuch_new_command (void *ctx,
 375                      unused (int argc), unused (char *argv[]))
 376 {
 377     notmuch_config_t *config;
 378     notmuch_database_t *notmuch;
 379     add_files_state_t add_files_state;
 380     double elapsed;
 381     struct timeval tv_now;
 382     int ret = 0;
 383     struct stat st;
 384     const char *db_path;
 385     char *dot_notmuch_path;
 386     struct sigaction action;
 387
 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);
 394
 395     config = notmuch_config_open (ctx, NULL, NULL);
 396     if (config == NULL)
 397         return 1;
 398
 399     db_path = notmuch_config_get_database_path (config);
 400
 401     dot_notmuch_path = talloc_asprintf (ctx, "%s/%s", db_path, ".notmuch");
 402
 403     if (stat (dot_notmuch_path, &st)) {
 404         int count;
 405
 406         count = 0;
 407         count_files (db_path, &count);
 408         if (interrupted)
 409             return 1;
 410
 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;
 415     } else {
 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;
 420     }
 421
 422     if (notmuch == NULL)
 423         return 1;
 424
 425     talloc_free (dot_notmuch_path);
 426     dot_notmuch_path = NULL;
 427
 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);
 432
 433     ret = add_files (notmuch, db_path, &add_files_state);
 434
 435     gettimeofday (&tv_now, NULL);
 436     elapsed = notmuch_time_elapsed (add_files_state.tv_start,
 437                                     tv_now);
 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);
 443         if (elapsed > 1) {
 444             printf (" (%d files/sec.).                 \n",
 445                     (int) (add_files_state.processed_files / elapsed));
 446         } else {
 447             printf (".                    \n");
 448         }
 449     }
 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");
 455     } else {
 456         printf ("No new mail---and that's not much.\n");
 457     }
 458
 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");
 464     }
 465
 466     if (ret) {
 467         printf ("\nNote: At least one error was encountered: %s\n",
 468                 notmuch_status_to_string (ret));
 469     }
 470
 471     notmuch_database_close (notmuch);
 472
 473     return ret || interrupted;
 474 }