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 #include "tag-util.h"
  23
  24 #include <unistd.h>
  25
  26 typedef struct _filename_node {
  27     char *filename;
  28     time_t mtime;
  29     struct _filename_node *next;
  30 } _filename_node_t;
  31
  32 typedef struct _filename_list {
  33     unsigned count;
  34     _filename_node_t *head;
  35     _filename_node_t **tail;
  36 } _filename_list_t;
  37
  38 enum verbosity {
  39     VERBOSITY_QUIET,
  40     VERBOSITY_NORMAL,
  41     VERBOSITY_VERBOSE,
  42 };
  43
  44 typedef struct {
  45     int output_is_a_tty;
  46     enum verbosity verbosity;
  47     notmuch_bool_t debug;
  48     const char **new_tags;
  49     size_t new_tags_length;
  50     const char **new_ignore;
  51     size_t new_ignore_length;
  52
  53     int total_files;
  54     int processed_files;
  55     int added_messages, removed_messages, renamed_messages;
  56     struct timeval tv_start;
  57
  58     _filename_list_t *removed_files;
  59     _filename_list_t *removed_directories;
  60     _filename_list_t *directory_mtimes;
  61
  62     notmuch_bool_t synchronize_flags;
  63 } add_files_state_t;
  64
  65 static volatile sig_atomic_t do_print_progress = 0;
  66
  67 static void
  68 handle_sigalrm (unused (int signal))
  69 {
  70     do_print_progress = 1;
  71 }
  72
  73 static volatile sig_atomic_t interrupted;
  74
  75 static void
  76 handle_sigint (unused (int sig))
  77 {
  78     static char msg[] = "Stopping...         \n";
  79
  80     /* This write is "opportunistic", so it's okay to ignore the
  81      * result.  It is not required for correctness, and if it does
  82      * fail or produce a short write, we want to get out of the signal
  83      * handler as quickly as possible, not retry it. */
  84     IGNORE_RESULT (write (2, msg, sizeof(msg)-1));
  85     interrupted = 1;
  86 }
  87
  88 static _filename_list_t *
  89 _filename_list_create (const void *ctx)
  90 {
  91     _filename_list_t *list;
  92
  93     list = talloc (ctx, _filename_list_t);
  94     if (list == NULL)
  95         return NULL;
  96
  97     list->head = NULL;
  98     list->tail = &list->head;
  99     list->count = 0;
 100
 101     return list;
 102 }
 103
 104 static _filename_node_t *
 105 _filename_list_add (_filename_list_t *list,
 106                     const char *filename)
 107 {
 108     _filename_node_t *node = talloc (list, _filename_node_t);
 109
 110     list->count++;
 111
 112     node->filename = talloc_strdup (list, filename);
 113     node->next = NULL;
 114
 115     *(list->tail) = node;
 116     list->tail = &node->next;
 117
 118     return node;
 119 }
 120
 121 static void
 122 generic_print_progress (const char *action, const char *object,
 123                         struct timeval tv_start, unsigned processed, unsigned total)
 124 {
 125     struct timeval tv_now;
 126     double elapsed_overall, rate_overall;
 127
 128     gettimeofday (&tv_now, NULL);
 129
 130     elapsed_overall = notmuch_time_elapsed (tv_start, tv_now);
 131     rate_overall = processed / elapsed_overall;
 132
 133     printf ("%s %d ", action, processed);
 134
 135     if (total) {
 136         printf ("of %d %s", total, object);
 137         if (processed > 0 && elapsed_overall > 0.5) {
 138             double time_remaining = ((total - processed) / rate_overall);
 139             printf (" (");
 140             notmuch_time_print_formatted_seconds (time_remaining);
 141             printf (" remaining)");
 142         }
 143     } else {
 144         printf ("%s", object);
 145         if (elapsed_overall > 0.5)
 146             printf (" (%d %s/sec.)", (int) rate_overall, object);
 147     }
 148     printf (".\033[K\r");
 149
 150     fflush (stdout);
 151 }
 152
 153 static int
 154 dirent_sort_inode (const struct dirent **a, const struct dirent **b)
 155 {
 156     return ((*a)->d_ino < (*b)->d_ino) ? -1 : 1;
 157 }
 158
 159 static int
 160 dirent_sort_strcmp_name (const struct dirent **a, const struct dirent **b)
 161 {
 162     return strcmp ((*a)->d_name, (*b)->d_name);
 163 }
 164
 165 /* Return the type of a directory entry relative to path as a stat(2)
 166  * mode.  Like stat, this follows symlinks.  Returns -1 and sets errno
 167  * if the file's type cannot be determined (which includes dangling
 168  * symlinks).
 169  */
 170 static int
 171 dirent_type (const char *path, const struct dirent *entry)
 172 {
 173     struct stat statbuf;
 174     char *abspath;
 175     int err, saved_errno;
 176
 177 #if HAVE_D_TYPE
 178     /* Mapping from d_type to stat mode_t.  We omit DT_LNK so that
 179      * we'll fall through to stat and get the real file type. */
 180     static const mode_t modes[] = {
 181         [DT_BLK]  = S_IFBLK,
 182         [DT_CHR]  = S_IFCHR,
 183         [DT_DIR]  = S_IFDIR,
 184         [DT_FIFO] = S_IFIFO,
 185         [DT_REG]  = S_IFREG,
 186         [DT_SOCK] = S_IFSOCK
 187     };
 188     if (entry->d_type < ARRAY_SIZE(modes) && modes[entry->d_type])
 189         return modes[entry->d_type];
 190 #endif
 191
 192     abspath = talloc_asprintf (NULL, "%s/%s", path, entry->d_name);
 193     if (!abspath) {
 194         errno = ENOMEM;
 195         return -1;
 196     }
 197     err = stat(abspath, &statbuf);
 198     saved_errno = errno;
 199     talloc_free (abspath);
 200     if (err < 0) {
 201         errno = saved_errno;
 202         return -1;
 203     }
 204     return statbuf.st_mode & S_IFMT;
 205 }
 206
 207 /* Test if the directory looks like a Maildir directory.
 208  *
 209  * Search through the array of directory entries to see if we can find all
 210  * three subdirectories typical for Maildir, that is "new", "cur", and "tmp".
 211  *
 212  * Return 1 if the directory looks like a Maildir and 0 otherwise.
 213  */
 214 static int
 215 _entries_resemble_maildir (const char *path, struct dirent **entries, int count)
 216 {
 217     int i, found = 0;
 218
 219     for (i = 0; i < count; i++) {
 220         if (dirent_type (path, entries[i]) != S_IFDIR)
 221             continue;
 222
 223         if (strcmp(entries[i]->d_name, "new") == 0 ||
 224             strcmp(entries[i]->d_name, "cur") == 0 ||
 225             strcmp(entries[i]->d_name, "tmp") == 0)
 226         {
 227             found++;
 228             if (found == 3)
 229                 return 1;
 230         }
 231     }
 232
 233     return 0;
 234 }
 235
 236 /* Test if the file/directory is to be ignored.
 237  */
 238 static notmuch_bool_t
 239 _entry_in_ignore_list (const char *entry, add_files_state_t *state)
 240 {
 241     size_t i;
 242
 243     for (i = 0; i < state->new_ignore_length; i++)
 244         if (strcmp (entry, state->new_ignore[i]) == 0)
 245             return TRUE;
 246
 247     return FALSE;
 248 }
 249
 250 /* Add a single file to the database. */
 251 static notmuch_status_t
 252 add_file (notmuch_database_t *notmuch, const char *filename,
 253           add_files_state_t *state)
 254 {
 255     notmuch_message_t *message = NULL;
 256     const char **tag;
 257     notmuch_status_t status;
 258
 259     status = notmuch_database_begin_atomic (notmuch);
 260     if (status)
 261         goto DONE;
 262
 263     status = notmuch_database_add_message (notmuch, filename, &message);
 264     switch (status) {
 265     /* Success. */
 266     case NOTMUCH_STATUS_SUCCESS:
 267         state->added_messages++;
 268         notmuch_message_freeze (message);
 269         for (tag = state->new_tags; *tag != NULL; tag++)
 270             notmuch_message_add_tag (message, *tag);
 271         if (state->synchronize_flags)
 272             notmuch_message_maildir_flags_to_tags (message);
 273         notmuch_message_thaw (message);
 274         break;
 275     /* Non-fatal issues (go on to next file). */
 276     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
 277         if (state->synchronize_flags)
 278             notmuch_message_maildir_flags_to_tags (message);
 279         break;
 280     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
 281         fprintf (stderr, "Note: Ignoring non-mail file: %s\n", filename);
 282         break;
 283     /* Fatal issues. Don't process anymore. */
 284     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
 285     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
 286     case NOTMUCH_STATUS_OUT_OF_MEMORY:
 287         fprintf (stderr, "Error: %s. Halting processing.\n",
 288                  notmuch_status_to_string (status));
 289         goto DONE;
 290     default:
 291         INTERNAL_ERROR ("add_message returned unexpected value: %d", status);
 292         goto DONE;
 293     }
 294
 295     status = notmuch_database_end_atomic (notmuch);
 296
 297   DONE:
 298     if (message)
 299         notmuch_message_destroy (message);
 300
 301     return status;
 302 }
 303
 304 /* Examine 'path' recursively as follows:
 305  *
 306  *   o Ask the filesystem for the mtime of 'path' (fs_mtime)
 307  *   o Ask the database for its timestamp of 'path' (db_mtime)
 308  *
 309  *   o Ask the filesystem for files and directories within 'path'
 310  *     (via scandir and stored in fs_entries)
 311  *
 312  *   o Pass 1: For each directory in fs_entries, recursively call into
 313  *     this same function.
 314  *
 315  *   o Compare fs_mtime to db_mtime. If they are equivalent, terminate
 316  *     the algorithm at this point, (this directory has not been
 317  *     updated in the filesystem since the last database scan of PASS
 318  *     2).
 319  *
 320  *   o Ask the database for files and directories within 'path'
 321  *     (db_files and db_subdirs)
 322  *
 323  *   o Pass 2: Walk fs_entries simultaneously with db_files and
 324  *     db_subdirs. Look for one of three interesting cases:
 325  *
 326  *         1. Regular file in fs_entries and not in db_files
 327  *            This is a new file to add_message into the database.
 328  *
 329  *         2. Filename in db_files not in fs_entries.
 330  *            This is a file that has been removed from the mail store.
 331  *
 332  *         3. Directory in db_subdirs not in fs_entries
 333  *            This is a directory that has been removed from the mail store.
 334  *
 335  *     Note that the addition of a directory is not interesting here,
 336  *     since that will have been taken care of in pass 1. Also, we
 337  *     don't immediately act on file/directory removal since we must
 338  *     ensure that in the case of a rename that the new filename is
 339  *     added before the old filename is removed, (so that no
 340  *     information is lost from the database).
 341  *
 342  *   o Tell the database to update its time of 'path' to 'fs_mtime'
 343  *     if fs_mtime isn't the current wall-clock time.
 344  */
 345 static notmuch_status_t
 346 add_files (notmuch_database_t *notmuch,
 347            const char *path,
 348            add_files_state_t *state)
 349 {
 350     DIR *dir = NULL;
 351     struct dirent *entry = NULL;
 352     char *next = NULL;
 353     time_t fs_mtime, db_mtime;
 354     notmuch_status_t status, ret = NOTMUCH_STATUS_SUCCESS;
 355     struct dirent **fs_entries = NULL;
 356     int i, num_fs_entries = 0, entry_type;
 357     notmuch_directory_t *directory;
 358     notmuch_filenames_t *db_files = NULL;
 359     notmuch_filenames_t *db_subdirs = NULL;
 360     time_t stat_time;
 361     struct stat st;
 362     notmuch_bool_t is_maildir;
 363
 364     if (stat (path, &st)) {
 365         fprintf (stderr, "Error reading directory %s: %s\n",
 366                  path, strerror (errno));
 367         return NOTMUCH_STATUS_FILE_ERROR;
 368     }
 369     stat_time = time (NULL);
 370
 371     if (! S_ISDIR (st.st_mode)) {
 372         fprintf (stderr, "Error: %s is not a directory.\n", path);
 373         return NOTMUCH_STATUS_FILE_ERROR;
 374     }
 375
 376     fs_mtime = st.st_mtime;
 377
 378     status = notmuch_database_get_directory (notmuch, path, &directory);
 379     if (status) {
 380         ret = status;
 381         goto DONE;
 382     }
 383     db_mtime = directory ? notmuch_directory_get_mtime (directory) : 0;
 384
 385     /* If the directory is unchanged from our last scan and has no
 386      * sub-directories, then return without scanning it at all.  In
 387      * some situations, skipping the scan can substantially reduce the
 388      * cost of notmuch new, especially since the huge numbers of files
 389      * in Maildirs make scans expensive, but all files live in leaf
 390      * directories.
 391      *
 392      * To check for sub-directories, we borrow a trick from find,
 393      * kpathsea, and many other UNIX tools: since a directory's link
 394      * count is the number of sub-directories (specifically, their
 395      * '..' entries) plus 2 (the link from the parent and the link for
 396      * '.').  This check is safe even on weird file systems, since
 397      * file systems that can't compute this will return 0 or 1.  This
 398      * is safe even on *really* weird file systems like HFS+ that
 399      * mistakenly return the total number of directory entries, since
 400      * that only inflates the count beyond 2.
 401      */
 402     if (directory && fs_mtime == db_mtime && st.st_nlink == 2) {
 403         /* There's one catch: pass 1 below considers symlinks to
 404          * directories to be directories, but these don't increase the
 405          * file system link count.  So, only bail early if the
 406          * database agrees that there are no sub-directories. */
 407         db_subdirs = notmuch_directory_get_child_directories (directory);
 408         if (!notmuch_filenames_valid (db_subdirs))
 409             goto DONE;
 410         notmuch_filenames_destroy (db_subdirs);
 411         db_subdirs = NULL;
 412     }
 413
 414     /* If the database knows about this directory, then we sort based
 415      * on strcmp to match the database sorting. Otherwise, we can do
 416      * inode-based sorting for faster filesystem operation. */
 417     num_fs_entries = scandir (path, &fs_entries, 0,
 418                               directory ?
 419                               dirent_sort_strcmp_name : dirent_sort_inode);
 420
 421     if (num_fs_entries == -1) {
 422         fprintf (stderr, "Error opening directory %s: %s\n",
 423                  path, strerror (errno));
 424         /* We consider this a fatal error because, if a user moved a
 425          * message from another directory that we were able to scan
 426          * into this directory, skipping this directory will cause
 427          * that message to be lost. */
 428         ret = NOTMUCH_STATUS_FILE_ERROR;
 429         goto DONE;
 430     }
 431
 432     /* Pass 1: Recurse into all sub-directories. */
 433     is_maildir = _entries_resemble_maildir (path, fs_entries, num_fs_entries);
 434
 435     for (i = 0; i < num_fs_entries; i++) {
 436         if (interrupted)
 437             break;
 438
 439         entry = fs_entries[i];
 440
 441         /* Ignore any files/directories the user has configured to
 442          * ignore.  We do this before dirent_type both for performance
 443          * and because we don't care if dirent_type fails on entries
 444          * that are explicitly ignored.
 445          */
 446         if (_entry_in_ignore_list (entry->d_name, state)) {
 447             if (state->debug)
 448                 printf ("(D) add_files_recursive, pass 1: explicitly ignoring %s/%s\n",
 449                         path, entry->d_name);
 450             continue;
 451         }
 452
 453         /* We only want to descend into directories (and symlinks to
 454          * directories). */
 455         entry_type = dirent_type (path, entry);
 456         if (entry_type == -1) {
 457             /* Be pessimistic, e.g. so we don't lose lots of mail just
 458              * because a user broke a symlink. */
 459             fprintf (stderr, "Error reading file %s/%s: %s\n",
 460                      path, entry->d_name, strerror (errno));
 461             return NOTMUCH_STATUS_FILE_ERROR;
 462         } else if (entry_type != S_IFDIR) {
 463             continue;
 464         }
 465
 466         /* Ignore special directories to avoid infinite recursion.
 467          * Also ignore the .notmuch directory and any "tmp" directory
 468          * that appears within a maildir.
 469          */
 470         if (strcmp (entry->d_name, ".") == 0 ||
 471             strcmp (entry->d_name, "..") == 0 ||
 472             (is_maildir && strcmp (entry->d_name, "tmp") == 0) ||
 473             strcmp (entry->d_name, ".notmuch") == 0)
 474             continue;
 475
 476         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
 477         status = add_files (notmuch, next, state);
 478         if (status) {
 479             ret = status;
 480             goto DONE;
 481         }
 482         talloc_free (next);
 483         next = NULL;
 484     }
 485
 486     /* If the directory's modification time in the filesystem is the
 487      * same as what we recorded in the database the last time we
 488      * scanned it, then we can skip the second pass entirely.
 489      *
 490      * We test for strict equality here to avoid a bug that can happen
 491      * if the system clock jumps backward, (preventing new mail from
 492      * being discovered until the clock catches up and the directory
 493      * is modified again).
 494      */
 495     if (directory && fs_mtime == db_mtime)
 496         goto DONE;
 497
 498     /* If the database has never seen this directory before, we can
 499      * simply leave db_files and db_subdirs NULL. */
 500     if (directory) {
 501         db_files = notmuch_directory_get_child_files (directory);
 502         db_subdirs = notmuch_directory_get_child_directories (directory);
 503     }
 504
 505     /* Pass 2: Scan for new files, removed files, and removed directories. */
 506     for (i = 0; i < num_fs_entries; i++)
 507     {
 508         if (interrupted)
 509             break;
 510
 511         entry = fs_entries[i];
 512
 513         /* Ignore files & directories user has configured to be ignored */
 514         if (_entry_in_ignore_list (entry->d_name, state)) {
 515             if (state->debug)
 516                 printf ("(D) add_files_recursive, pass 2: explicitly ignoring %s/%s\n",
 517                         path,
 518                         entry->d_name);
 519             continue;
 520         }
 521
 522         /* Check if we've walked past any names in db_files or
 523          * db_subdirs. If so, these have been deleted. */
 524         while (notmuch_filenames_valid (db_files) &&
 525                strcmp (notmuch_filenames_get (db_files), entry->d_name) < 0)
 526         {
 527             char *absolute = talloc_asprintf (state->removed_files,
 528                                               "%s/%s", path,
 529                                               notmuch_filenames_get (db_files));
 530
 531             if (state->debug)
 532                 printf ("(D) add_files_recursive, pass 2: queuing passed file %s for deletion from database\n",
 533                         absolute);
 534
 535             _filename_list_add (state->removed_files, absolute);
 536
 537             notmuch_filenames_move_to_next (db_files);
 538         }
 539
 540         while (notmuch_filenames_valid (db_subdirs) &&
 541                strcmp (notmuch_filenames_get (db_subdirs), entry->d_name) <= 0)
 542         {
 543             const char *filename = notmuch_filenames_get (db_subdirs);
 544
 545             if (strcmp (filename, entry->d_name) < 0)
 546             {
 547                 char *absolute = talloc_asprintf (state->removed_directories,
 548                                                   "%s/%s", path, filename);
 549                 if (state->debug)
 550                     printf ("(D) add_files_recursive, pass 2: queuing passed directory %s for deletion from database\n",
 551                         absolute);
 552
 553                 _filename_list_add (state->removed_directories, absolute);
 554             }
 555
 556             notmuch_filenames_move_to_next (db_subdirs);
 557         }
 558
 559         /* Only add regular files (and symlinks to regular files). */
 560         entry_type = dirent_type (path, entry);
 561         if (entry_type == -1) {
 562             fprintf (stderr, "Error reading file %s/%s: %s\n",
 563                      path, entry->d_name, strerror (errno));
 564             return NOTMUCH_STATUS_FILE_ERROR;
 565         } else if (entry_type != S_IFREG) {
 566             continue;
 567         }
 568
 569         /* Don't add a file that we've added before. */
 570         if (notmuch_filenames_valid (db_files) &&
 571             strcmp (notmuch_filenames_get (db_files), entry->d_name) == 0)
 572         {
 573             notmuch_filenames_move_to_next (db_files);
 574             continue;
 575         }
 576
 577         /* We're now looking at a regular file that doesn't yet exist
 578          * in the database, so add it. */
 579         next = talloc_asprintf (notmuch, "%s/%s", path, entry->d_name);
 580
 581         state->processed_files++;
 582
 583         if (state->verbosity >= VERBOSITY_VERBOSE) {
 584             if (state->output_is_a_tty)
 585                 printf("\r\033[K");
 586
 587             printf ("%i/%i: %s", state->processed_files, state->total_files,
 588                     next);
 589
 590             putchar((state->output_is_a_tty) ? '\r' : '\n');
 591             fflush (stdout);
 592         }
 593
 594         status = add_file (notmuch, next, state);
 595         if (status) {
 596             ret = status;
 597             goto DONE;
 598         }
 599
 600         if (do_print_progress) {
 601             do_print_progress = 0;
 602             generic_print_progress ("Processed", "files", state->tv_start,
 603                                     state->processed_files, state->total_files);
 604         }
 605
 606         talloc_free (next);
 607         next = NULL;
 608     }
 609
 610     if (interrupted)
 611         goto DONE;
 612
 613     /* Now that we've walked the whole filesystem list, anything left
 614      * over in the database lists has been deleted. */
 615     while (notmuch_filenames_valid (db_files))
 616     {
 617         char *absolute = talloc_asprintf (state->removed_files,
 618                                           "%s/%s", path,
 619                                           notmuch_filenames_get (db_files));
 620         if (state->debug)
 621             printf ("(D) add_files_recursive, pass 3: queuing leftover file %s for deletion from database\n",
 622                     absolute);
 623
 624         _filename_list_add (state->removed_files, absolute);
 625
 626         notmuch_filenames_move_to_next (db_files);
 627     }
 628
 629     while (notmuch_filenames_valid (db_subdirs))
 630     {
 631         char *absolute = talloc_asprintf (state->removed_directories,
 632                                           "%s/%s", path,
 633                                           notmuch_filenames_get (db_subdirs));
 634
 635         if (state->debug)
 636             printf ("(D) add_files_recursive, pass 3: queuing leftover directory %s for deletion from database\n",
 637                     absolute);
 638
 639         _filename_list_add (state->removed_directories, absolute);
 640
 641         notmuch_filenames_move_to_next (db_subdirs);
 642     }
 643
 644     /* If the directory's mtime is the same as the wall-clock time
 645      * when we stat'ed the directory, we skip updating the mtime in
 646      * the database because a message could be delivered later in this
 647      * same second.  This may lead to unnecessary re-scans, but it
 648      * avoids overlooking messages. */
 649     if (fs_mtime != stat_time)
 650         _filename_list_add (state->directory_mtimes, path)->mtime = fs_mtime;
 651
 652   DONE:
 653     if (next)
 654         talloc_free (next);
 655     if (dir)
 656         closedir (dir);
 657     if (fs_entries) {
 658         for (i = 0; i < num_fs_entries; i++)
 659             free (fs_entries[i]);
 660
 661         free (fs_entries);
 662     }
 663     if (db_subdirs)
 664         notmuch_filenames_destroy (db_subdirs);
 665     if (db_files)
 666         notmuch_filenames_destroy (db_files);
 667     if (directory)
 668         notmuch_directory_destroy (directory);
 669
 670     return ret;
 671 }
 672
 673 static void
 674 setup_progress_printing_timer (void)
 675 {
 676     struct sigaction action;
 677     struct itimerval timerval;
 678
 679     /* Set up our handler for SIGALRM */
 680     memset (&action, 0, sizeof (struct sigaction));
 681     action.sa_handler = handle_sigalrm;
 682     sigemptyset (&action.sa_mask);
 683     action.sa_flags = SA_RESTART;
 684     sigaction (SIGALRM, &action, NULL);
 685
 686     /* Then start a timer to send SIGALRM once per second. */
 687     timerval.it_interval.tv_sec = 1;
 688     timerval.it_interval.tv_usec = 0;
 689     timerval.it_value.tv_sec = 1;
 690     timerval.it_value.tv_usec = 0;
 691     setitimer (ITIMER_REAL, &timerval, NULL);
 692 }
 693
 694 static void
 695 stop_progress_printing_timer (void)
 696 {
 697     struct sigaction action;
 698     struct itimerval timerval;
 699
 700     /* Now stop the timer. */
 701     timerval.it_interval.tv_sec = 0;
 702     timerval.it_interval.tv_usec = 0;
 703     timerval.it_value.tv_sec = 0;
 704     timerval.it_value.tv_usec = 0;
 705     setitimer (ITIMER_REAL, &timerval, NULL);
 706
 707     /* And disable the signal handler. */
 708     action.sa_handler = SIG_IGN;
 709     sigaction (SIGALRM, &action, NULL);
 710 }
 711
 712
 713 /* XXX: This should be merged with the add_files function since it
 714  * shares a lot of logic with it. */
 715 /* Recursively count all regular files in path and all sub-directories
 716  * of path.  The result is added to *count (which should be
 717  * initialized to zero by the top-level caller before calling
 718  * count_files). */
 719 static void
 720 count_files (const char *path, int *count, add_files_state_t *state)
 721 {
 722     struct dirent *entry = NULL;
 723     char *next;
 724     struct dirent **fs_entries = NULL;
 725     int num_fs_entries = scandir (path, &fs_entries, 0, dirent_sort_inode);
 726     int entry_type, i;
 727
 728     if (num_fs_entries == -1) {
 729         fprintf (stderr, "Warning: failed to open directory %s: %s\n",
 730                  path, strerror (errno));
 731         goto DONE;
 732     }
 733
 734     for (i = 0; i < num_fs_entries && ! interrupted; i++) {
 735         entry = fs_entries[i];
 736
 737         /* Ignore special directories to avoid infinite recursion.
 738          * Also ignore the .notmuch directory and files/directories
 739          * the user has configured to be ignored.
 740          */
 741         if (strcmp (entry->d_name, ".") == 0 ||
 742             strcmp (entry->d_name, "..") == 0 ||
 743             strcmp (entry->d_name, ".notmuch") == 0 ||
 744             _entry_in_ignore_list (entry->d_name, state))
 745         {
 746             if (state->debug && _entry_in_ignore_list (entry->d_name, state))
 747                 printf ("(D) count_files: explicitly ignoring %s/%s\n",
 748                         path,
 749                         entry->d_name);
 750             continue;
 751         }
 752
 753         if (asprintf (&next, "%s/%s", path, entry->d_name) == -1) {
 754             next = NULL;
 755             fprintf (stderr, "Error descending from %s to %s: Out of memory\n",
 756                      path, entry->d_name);
 757             continue;
 758         }
 759
 760         entry_type = dirent_type (path, entry);
 761         if (entry_type == S_IFREG) {
 762             *count = *count + 1;
 763             if (*count % 1000 == 0 && state->verbosity >= VERBOSITY_NORMAL) {
 764                 printf ("Found %d files so far.\r", *count);
 765                 fflush (stdout);
 766             }
 767         } else if (entry_type == S_IFDIR) {
 768             count_files (next, count, state);
 769         }
 770
 771         free (next);
 772     }
 773
 774   DONE:
 775     if (fs_entries) {
 776         for (i = 0; i < num_fs_entries; i++)
 777             free (fs_entries[i]);
 778
 779         free (fs_entries);
 780     }
 781 }
 782
 783 static void
 784 upgrade_print_progress (void *closure,
 785                         double progress)
 786 {
 787     add_files_state_t *state = closure;
 788
 789     printf ("Upgrading database: %.2f%% complete", progress * 100.0);
 790
 791     if (progress > 0) {
 792         struct timeval tv_now;
 793         double elapsed, time_remaining;
 794
 795         gettimeofday (&tv_now, NULL);
 796
 797         elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
 798         time_remaining = (elapsed / progress) * (1.0 - progress);
 799         printf (" (");
 800         notmuch_time_print_formatted_seconds (time_remaining);
 801         printf (" remaining)");
 802     }
 803
 804     printf (".      \r");
 805
 806     fflush (stdout);
 807 }
 808
 809 /* Remove one message filename from the database. */
 810 static notmuch_status_t
 811 remove_filename (notmuch_database_t *notmuch,
 812                  const char *path,
 813                  add_files_state_t *add_files_state)
 814 {
 815     notmuch_status_t status;
 816     notmuch_message_t *message;
 817     status = notmuch_database_begin_atomic (notmuch);
 818     if (status)
 819         return status;
 820     status = notmuch_database_find_message_by_filename (notmuch, path, &message);
 821     if (status || message == NULL)
 822         goto DONE;
 823
 824     status = notmuch_database_remove_message (notmuch, path);
 825     if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
 826         add_files_state->renamed_messages++;
 827         if (add_files_state->synchronize_flags == TRUE)
 828             notmuch_message_maildir_flags_to_tags (message);
 829         status = NOTMUCH_STATUS_SUCCESS;
 830     } else if (status == NOTMUCH_STATUS_SUCCESS) {
 831         add_files_state->removed_messages++;
 832     }
 833     notmuch_message_destroy (message);
 834
 835   DONE:
 836     notmuch_database_end_atomic (notmuch);
 837     return status;
 838 }
 839
 840 /* Recursively remove all filenames from the database referring to
 841  * 'path' (or to any of its children). */
 842 static notmuch_status_t
 843 _remove_directory (void *ctx,
 844                    notmuch_database_t *notmuch,
 845                    const char *path,
 846                    add_files_state_t *add_files_state)
 847 {
 848     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
 849     notmuch_directory_t *directory;
 850     notmuch_filenames_t *files, *subdirs;
 851     char *absolute;
 852
 853     status = notmuch_database_get_directory (notmuch, path, &directory);
 854     if (status || !directory)
 855         return status;
 856
 857     for (files = notmuch_directory_get_child_files (directory);
 858          notmuch_filenames_valid (files);
 859          notmuch_filenames_move_to_next (files))
 860     {
 861         absolute = talloc_asprintf (ctx, "%s/%s", path,
 862                                     notmuch_filenames_get (files));
 863         status = remove_filename (notmuch, absolute, add_files_state);
 864         talloc_free (absolute);
 865         if (status)
 866             goto DONE;
 867     }
 868
 869     for (subdirs = notmuch_directory_get_child_directories (directory);
 870          notmuch_filenames_valid (subdirs);
 871          notmuch_filenames_move_to_next (subdirs))
 872     {
 873         absolute = talloc_asprintf (ctx, "%s/%s", path,
 874                                     notmuch_filenames_get (subdirs));
 875         status = _remove_directory (ctx, notmuch, absolute, add_files_state);
 876         talloc_free (absolute);
 877         if (status)
 878             goto DONE;
 879     }
 880
 881     /*
 882      * XXX: The library does not have a function to remove a directory
 883      * document for a path. Usually this doesn't matter except for a
 884      * slight waste of space. However, if the directory gets added to
 885      * the filesystem again, the old directory document is found with
 886      * the old mtime. Reset the directory mtime to avoid problems.
 887      */
 888     notmuch_directory_set_mtime (directory, 0);
 889
 890   DONE:
 891     notmuch_directory_destroy (directory);
 892     return status;
 893 }
 894
 895 static void
 896 print_results (const add_files_state_t *state)
 897 {
 898     double elapsed;
 899     struct timeval tv_now;
 900
 901     gettimeofday (&tv_now, NULL);
 902     elapsed = notmuch_time_elapsed (state->tv_start, tv_now);
 903
 904     if (state->processed_files) {
 905         printf ("Processed %d %s in ", state->processed_files,
 906                 state->processed_files == 1 ? "file" : "total files");
 907         notmuch_time_print_formatted_seconds (elapsed);
 908         if (elapsed > 1)
 909             printf (" (%d files/sec.).\033[K\n",
 910                     (int) (state->processed_files / elapsed));
 911         else
 912             printf (".\033[K\n");
 913     }
 914
 915     if (state->added_messages)
 916         printf ("Added %d new %s to the database.", state->added_messages,
 917                 state->added_messages == 1 ? "message" : "messages");
 918     else
 919         printf ("No new mail.");
 920
 921     if (state->removed_messages)
 922         printf (" Removed %d %s.", state->removed_messages,
 923                 state->removed_messages == 1 ? "message" : "messages");
 924
 925     if (state->renamed_messages)
 926         printf (" Detected %d file %s.", state->renamed_messages,
 927                 state->renamed_messages == 1 ? "rename" : "renames");
 928
 929     printf ("\n");
 930 }
 931
 932 int
 933 notmuch_new_command (notmuch_config_t *config, int argc, char *argv[])
 934 {
 935     notmuch_database_t *notmuch;
 936     add_files_state_t add_files_state = {
 937         .verbosity = VERBOSITY_NORMAL,
 938         .debug = FALSE,
 939         .output_is_a_tty = isatty (fileno (stdout)),
 940     };
 941     struct timeval tv_start;
 942     int ret = 0;
 943     struct stat st;
 944     const char *db_path;
 945     char *dot_notmuch_path;
 946     struct sigaction action;
 947     _filename_node_t *f;
 948     int opt_index;
 949     unsigned int i;
 950     notmuch_bool_t timer_is_active = FALSE;
 951     notmuch_bool_t no_hooks = FALSE;
 952     notmuch_bool_t quiet = FALSE, verbose = FALSE;
 953     notmuch_status_t status;
 954
 955     notmuch_opt_desc_t options[] = {
 956         { NOTMUCH_OPT_BOOLEAN,  &quiet, "quiet", 'q', 0 },
 957         { NOTMUCH_OPT_BOOLEAN,  &verbose, "verbose", 'v', 0 },
 958         { NOTMUCH_OPT_BOOLEAN,  &add_files_state.debug, "debug", 'd', 0 },
 959         { NOTMUCH_OPT_BOOLEAN,  &no_hooks, "no-hooks", 'n', 0 },
 960         { NOTMUCH_OPT_INHERIT, (void *) &notmuch_shared_options, NULL, 0, 0 },
 961         { 0, 0, 0, 0, 0 }
 962     };
 963
 964     opt_index = parse_arguments (argc, argv, options, 1);
 965     if (opt_index < 0)
 966         return EXIT_FAILURE;
 967
 968     notmuch_process_shared_options (argv[0]);
 969
 970     /* quiet trumps verbose */
 971     if (quiet)
 972         add_files_state.verbosity = VERBOSITY_QUIET;
 973     else if (verbose)
 974         add_files_state.verbosity = VERBOSITY_VERBOSE;
 975
 976     add_files_state.new_tags = notmuch_config_get_new_tags (config, &add_files_state.new_tags_length);
 977     add_files_state.new_ignore = notmuch_config_get_new_ignore (config, &add_files_state.new_ignore_length);
 978     add_files_state.synchronize_flags = notmuch_config_get_maildir_synchronize_flags (config);
 979     db_path = notmuch_config_get_database_path (config);
 980
 981     for (i = 0; i < add_files_state.new_tags_length; i++) {
 982         const char *error_msg;
 983
 984         error_msg = illegal_tag (add_files_state.new_tags[i], FALSE);
 985         if (error_msg) {
 986             fprintf (stderr, "Error: tag '%s' in new.tags: %s\n",
 987                      add_files_state.new_tags[i], error_msg);
 988             return EXIT_FAILURE;
 989         }
 990     }
 991
 992     if (!no_hooks) {
 993         ret = notmuch_run_hook (db_path, "pre-new");
 994         if (ret)
 995             return EXIT_FAILURE;
 996     }
 997
 998     dot_notmuch_path = talloc_asprintf (config, "%s/%s", db_path, ".notmuch");
 999
1000     if (stat (dot_notmuch_path, &st)) {
1001         int count;
1002
1003         count = 0;
1004         count_files (db_path, &count, &add_files_state);
1005         if (interrupted)
1006             return EXIT_FAILURE;
1007
1008         if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1009             printf ("Found %d total files (that's not much mail).\n", count);
1010         if (notmuch_database_create (db_path, &notmuch))
1011             return EXIT_FAILURE;
1012         add_files_state.total_files = count;
1013     } else {
1014         char *status_string = NULL;
1015         if (notmuch_database_open_verbose (db_path, NOTMUCH_DATABASE_MODE_READ_WRITE,
1016                                            &notmuch, &status_string)) {
1017             if (status_string) {
1018                 fputs (status_string, stderr);
1019                 free (status_string);
1020             }
1021             return EXIT_FAILURE;
1022         }
1023
1024         notmuch_exit_if_unmatched_db_uuid (notmuch);
1025
1026         if (notmuch_database_needs_upgrade (notmuch)) {
1027             time_t now = time (NULL);
1028             struct tm *gm_time = gmtime (&now);
1029
1030             /* since dump files are written atomically, the amount of
1031              * harm from overwriting one within a second seems
1032              * relatively small. */
1033
1034             const char *backup_name =
1035                 talloc_asprintf (notmuch, "%s/dump-%04d%02d%02dT%02d%02d%02d.gz",
1036                                  dot_notmuch_path,
1037                                  gm_time->tm_year + 1900,
1038                                  gm_time->tm_mon + 1,
1039                                  gm_time->tm_mday,
1040                                  gm_time->tm_hour,
1041                                  gm_time->tm_min,
1042                                  gm_time->tm_sec);
1043
1044             if (add_files_state.verbosity >= VERBOSITY_NORMAL) {
1045                 printf ("Welcome to a new version of notmuch! Your database will now be upgraded.\n");
1046                 printf ("This process is safe to interrupt.\n");
1047                 printf ("Backing up tags to %s...\n", backup_name);
1048             }
1049
1050             if (notmuch_database_dump (notmuch, backup_name, "",
1051                                        DUMP_FORMAT_BATCH_TAG, TRUE)) {
1052                 fprintf (stderr, "Backup failed. Aborting upgrade.");
1053                 return EXIT_FAILURE;
1054             }
1055
1056             gettimeofday (&add_files_state.tv_start, NULL);
1057             status = notmuch_database_upgrade (
1058                 notmuch,
1059                 add_files_state.verbosity >= VERBOSITY_NORMAL ? upgrade_print_progress : NULL,
1060                 &add_files_state);
1061             if (status) {
1062                 printf ("Upgrade failed: %s\n",
1063                         notmuch_status_to_string (status));
1064                 notmuch_database_destroy (notmuch);
1065                 return EXIT_FAILURE;
1066             }
1067             if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1068                 printf ("Your notmuch database has now been upgraded.\n");
1069         }
1070
1071         add_files_state.total_files = 0;
1072     }
1073
1074     if (notmuch == NULL)
1075         return EXIT_FAILURE;
1076
1077     /* Set up our handler for SIGINT. We do this after having
1078      * potentially done a database upgrade we this interrupt handler
1079      * won't support. */
1080     memset (&action, 0, sizeof (struct sigaction));
1081     action.sa_handler = handle_sigint;
1082     sigemptyset (&action.sa_mask);
1083     action.sa_flags = SA_RESTART;
1084     sigaction (SIGINT, &action, NULL);
1085
1086     talloc_free (dot_notmuch_path);
1087     dot_notmuch_path = NULL;
1088
1089     gettimeofday (&add_files_state.tv_start, NULL);
1090
1091     add_files_state.removed_files = _filename_list_create (config);
1092     add_files_state.removed_directories = _filename_list_create (config);
1093     add_files_state.directory_mtimes = _filename_list_create (config);
1094
1095     if (add_files_state.verbosity == VERBOSITY_NORMAL &&
1096         add_files_state.output_is_a_tty && ! debugger_is_active ()) {
1097         setup_progress_printing_timer ();
1098         timer_is_active = TRUE;
1099     }
1100
1101     ret = add_files (notmuch, db_path, &add_files_state);
1102     if (ret)
1103         goto DONE;
1104
1105     gettimeofday (&tv_start, NULL);
1106     for (f = add_files_state.removed_files->head; f && !interrupted; f = f->next) {
1107         ret = remove_filename (notmuch, f->filename, &add_files_state);
1108         if (ret)
1109             goto DONE;
1110         if (do_print_progress) {
1111             do_print_progress = 0;
1112             generic_print_progress ("Cleaned up", "messages",
1113                 tv_start, add_files_state.removed_messages + add_files_state.renamed_messages,
1114                 add_files_state.removed_files->count);
1115         }
1116     }
1117
1118     gettimeofday (&tv_start, NULL);
1119     for (f = add_files_state.removed_directories->head, i = 0; f && !interrupted; f = f->next, i++) {
1120         ret = _remove_directory (config, notmuch, f->filename, &add_files_state);
1121         if (ret)
1122             goto DONE;
1123         if (do_print_progress) {
1124             do_print_progress = 0;
1125             generic_print_progress ("Cleaned up", "directories",
1126                 tv_start, i,
1127                 add_files_state.removed_directories->count);
1128         }
1129     }
1130
1131     for (f = add_files_state.directory_mtimes->head; f && !interrupted; f = f->next) {
1132         notmuch_directory_t *directory;
1133         status = notmuch_database_get_directory (notmuch, f->filename, &directory);
1134         if (status == NOTMUCH_STATUS_SUCCESS && directory) {
1135             notmuch_directory_set_mtime (directory, f->mtime);
1136             notmuch_directory_destroy (directory);
1137         }
1138     }
1139
1140   DONE:
1141     talloc_free (add_files_state.removed_files);
1142     talloc_free (add_files_state.removed_directories);
1143     talloc_free (add_files_state.directory_mtimes);
1144
1145     if (timer_is_active)
1146         stop_progress_printing_timer ();
1147
1148     if (add_files_state.verbosity >= VERBOSITY_NORMAL)
1149         print_results (&add_files_state);
1150
1151     if (ret)
1152         fprintf (stderr, "Note: A fatal error was encountered: %s\n",
1153                  notmuch_status_to_string (ret));
1154
1155     notmuch_database_destroy (notmuch);
1156
1157     if (!no_hooks && !ret && !interrupted)
1158         ret = notmuch_run_hook (db_path, "post-new");
1159
1160     return ret || interrupted ? EXIT_FAILURE : EXIT_SUCCESS;
1161 }