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