c8c5e26106ad9d1086eb92ee0998d30a312dca99
[notmuch] / lib / database.cc
1 /* database.cc - The database interfaces of the notmuch mail library
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 "database-private.h"
22 #include "parse-time-vrp.h"
23 #include "string-util.h"
24
25 #include <iostream>
26
27 #include <sys/time.h>
28 #include <sys/stat.h>
29 #include <signal.h>
30 #include <ftw.h>
31
32 #include <glib.h> /* g_free, GPtrArray, GHashTable */
33 #include <glib-object.h> /* g_type_init */
34
35 #include <gmime/gmime.h> /* g_mime_init */
36
37 using namespace std;
38
39 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
40
41 typedef struct {
42     const char *name;
43     const char *prefix;
44 } prefix_t;
45
46 #define NOTMUCH_DATABASE_VERSION 3
47
48 #define STRINGIFY(s) _SUB_STRINGIFY(s)
49 #define _SUB_STRINGIFY(s) #s
50
51 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
52  *
53  * We currently have three different types of documents (mail, ghost,
54  * and directory) and also some metadata.
55  *
56  * Mail document
57  * -------------
58  * A mail document is associated with a particular email message. It
59  * is stored in one or more files on disk (though only one has its
60  * content indexed) and is uniquely identified  by its "id" field
61  * (which is generally the message ID). It is indexed with the
62  * following prefixed terms which the database uses to construct
63  * threads, etc.:
64  *
65  *    Single terms of given prefix:
66  *
67  *      type:   mail
68  *
69  *      id:     Unique ID of mail. This is from the Message-ID header
70  *              if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
71  *              If it's present and too long, then we use
72  *              "notmuch-sha1-<sha1_sum_of_message_id>".
73  *              If this header is not present, we use
74  *              "notmuch-sha1-<sha1_sum_of_entire_file>".
75  *
76  *      thread: The ID of the thread to which the mail belongs
77  *
78  *      replyto: The ID from the In-Reply-To header of the mail (if any).
79  *
80  *    Multiple terms of given prefix:
81  *
82  *      reference: All message IDs from In-Reply-To and References
83  *                 headers in the message.
84  *
85  *      tag:       Any tags associated with this message by the user.
86  *
87  *      file-direntry:  A colon-separated pair of values
88  *                      (INTEGER:STRING), where INTEGER is the
89  *                      document ID of a directory document, and
90  *                      STRING is the name of a file within that
91  *                      directory for this mail message.
92  *
93  *    A mail document also has four values:
94  *
95  *      TIMESTAMP:      The time_t value corresponding to the message's
96  *                      Date header.
97  *
98  *      MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
99  *
100  *      FROM:           The value of the "From" header
101  *
102  *      SUBJECT:        The value of the "Subject" header
103  *
104  *      LAST_MOD:       The revision number as of the last tag or
105  *                      filename change.
106  *
107  * In addition, terms from the content of the message are added with
108  * "from", "to", "attachment", and "subject" prefixes for use by the
109  * user in searching. Similarly, terms from the path of the mail
110  * message are added with "folder" and "path" prefixes. But the
111  * database doesn't really care itself about any of these.
112  *
113  * The data portion of a mail document is empty.
114  *
115  * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
116  * -----------------------------------------------
117  * A ghost mail document is like a mail document, but where we don't
118  * have the message content.  These are used to track thread reference
119  * information for messages we haven't received.
120  *
121  * A ghost mail document has type: ghost; id and thread fields that
122  * are identical to the mail document fields; and a MESSAGE_ID value.
123  *
124  * Directory document
125  * ------------------
126  * A directory document is used by a client of the notmuch library to
127  * maintain data necessary to allow for efficient polling of mail
128  * directories.
129  *
130  * All directory documents contain one term:
131  *
132  *      directory:      The directory path (relative to the database path)
133  *                      Or the SHA1 sum of the directory path (if the
134  *                      path itself is too long to fit in a Xapian
135  *                      term).
136  *
137  * And all directory documents for directories other than top-level
138  * directories also contain the following term:
139  *
140  *      directory-direntry: A colon-separated pair of values
141  *                          (INTEGER:STRING), where INTEGER is the
142  *                          document ID of the parent directory
143  *                          document, and STRING is the name of this
144  *                          directory within that parent.
145  *
146  * All directory documents have a single value:
147  *
148  *      TIMESTAMP:      The mtime of the directory (at last scan)
149  *
150  * The data portion of a directory document contains the path of the
151  * directory (relative to the database path).
152  *
153  * Database metadata
154  * -----------------
155  * Xapian allows us to store arbitrary name-value pairs as
156  * "metadata". We currently use the following metadata names with the
157  * given meanings:
158  *
159  *      version         The database schema version, (which is distinct
160  *                      from both the notmuch package version (see
161  *                      notmuch --version) and the libnotmuch library
162  *                      version. The version is stored as an base-10
163  *                      ASCII integer. The initial database version
164  *                      was 1, (though a schema existed before that
165  *                      were no "version" database value existed at
166  *                      all). Successive versions are allocated as
167  *                      changes are made to the database (such as by
168  *                      indexing new fields).
169  *
170  *      features        The set of features supported by this
171  *                      database. This consists of a set of
172  *                      '\n'-separated lines, where each is a feature
173  *                      name, a '\t', and compatibility flags.  If the
174  *                      compatibility flags contain 'w', then the
175  *                      opener must support this feature to safely
176  *                      write this database.  If the compatibility
177  *                      flags contain 'r', then the opener must
178  *                      support this feature to read this database.
179  *                      Introduced in database version 3.
180  *
181  *      last_thread_id  The last thread ID generated. This is stored
182  *                      as a 16-byte hexadecimal ASCII representation
183  *                      of a 64-bit unsigned integer. The first ID
184  *                      generated is 1 and the value will be
185  *                      incremented for each thread ID.
186  *
187  * Obsolete metadata
188  * -----------------
189  *
190  * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
191  * Instead, the database has the following additional database
192  * metadata:
193  *
194  *      thread_id_*     A pre-allocated thread ID for a particular
195  *                      message. This is actually an arbitrarily large
196  *                      family of metadata name. Any particular name is
197  *                      formed by concatenating "thread_id_" with a message
198  *                      ID (or the SHA1 sum of a message ID if it is very
199  *                      long---see description of 'id' in the mail
200  *                      document). The value stored is a thread ID.
201  *
202  *                      These thread ID metadata values are stored
203  *                      whenever a message references a parent message
204  *                      that does not yet exist in the database. A
205  *                      thread ID will be allocated and stored, and if
206  *                      the message is later added, the stored thread
207  *                      ID will be used (and the metadata value will
208  *                      be cleared).
209  *
210  *                      Even before a message is added, it's
211  *                      pre-allocated thread ID is useful so that all
212  *                      descendant messages that reference this common
213  *                      parent can be recognized as belonging to the
214  *                      same thread.
215  */
216
217 /* With these prefix values we follow the conventions published here:
218  *
219  * http://xapian.org/docs/omega/termprefixes.html
220  *
221  * as much as makes sense. Note that I took some liberty in matching
222  * the reserved prefix values to notmuch concepts, (for example, 'G'
223  * is documented as "newsGroup (or similar entity - e.g. a web forum
224  * name)", for which I think the thread is the closest analogue in
225  * notmuch. This in spite of the fact that we will eventually be
226  * storing mailing-list messages where 'G' for "mailing list name"
227  * might be even a closer analogue. I'm treating the single-character
228  * prefixes preferentially for core notmuch concepts (which will be
229  * nearly universal to all mail messages).
230  */
231
232 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
233     { "type",                   "T" },
234     { "reference",              "XREFERENCE" },
235     { "replyto",                "XREPLYTO" },
236     { "directory",              "XDIRECTORY" },
237     { "file-direntry",          "XFDIRENTRY" },
238     { "directory-direntry",     "XDDIRENTRY" },
239 };
240
241 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
242     { "thread",                 "G" },
243     { "tag",                    "K" },
244     { "is",                     "K" },
245     { "id",                     "Q" },
246     { "path",                   "P" },
247     /*
248      * Without the ":", since this is a multi-letter prefix, Xapian
249      * will add a colon itself if the first letter of the path is
250      * upper-case ASCII. Including the ":" forces there to always be a
251      * colon, which keeps our own logic simpler.
252      */
253     { "folder",                 "XFOLDER:" },
254 };
255
256 static prefix_t PROBABILISTIC_PREFIX[]= {
257     { "from",                   "XFROM" },
258     { "to",                     "XTO" },
259     { "attachment",             "XATTACHMENT" },
260     { "mimetype",               "XMIMETYPE"},
261     { "subject",                "XSUBJECT"},
262 };
263
264 const char *
265 _find_prefix (const char *name)
266 {
267     unsigned int i;
268
269     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
270         if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
271             return BOOLEAN_PREFIX_INTERNAL[i].prefix;
272     }
273
274     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
275         if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
276             return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
277     }
278
279     for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
280         if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
281             return PROBABILISTIC_PREFIX[i].prefix;
282     }
283
284     INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
285
286     return "";
287 }
288
289 static const struct {
290     /* NOTMUCH_FEATURE_* value. */
291     _notmuch_features value;
292     /* Feature name as it appears in the database.  This name should
293      * be appropriate for displaying to the user if an older version
294      * of notmuch doesn't support this feature. */
295     const char *name;
296     /* Compatibility flags when this feature is declared. */
297     const char *flags;
298 } feature_names[] = {
299     { NOTMUCH_FEATURE_FILE_TERMS,
300       "multiple paths per message", "rw" },
301     { NOTMUCH_FEATURE_DIRECTORY_DOCS,
302       "relative directory paths", "rw" },
303     /* Header values are not required for reading a database because a
304      * reader can just refer to the message file. */
305     { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
306       "from/subject/message-ID in database", "w" },
307     { NOTMUCH_FEATURE_BOOL_FOLDER,
308       "exact folder:/path: search", "rw" },
309     { NOTMUCH_FEATURE_GHOSTS,
310       "mail documents for missing messages", "w"},
311     /* Knowledge of the index mime-types are not required for reading
312      * a database because a reader will just be unable to query
313      * them. */
314     { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
315       "indexed MIME types", "w"},
316     { NOTMUCH_FEATURE_LAST_MOD,
317       "modification tracking", "w"},
318 };
319
320 const char *
321 notmuch_status_to_string (notmuch_status_t status)
322 {
323     switch (status) {
324     case NOTMUCH_STATUS_SUCCESS:
325         return "No error occurred";
326     case NOTMUCH_STATUS_OUT_OF_MEMORY:
327         return "Out of memory";
328     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
329         return "Attempt to write to a read-only database";
330     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
331         return "A Xapian exception occurred";
332     case NOTMUCH_STATUS_FILE_ERROR:
333         return "Something went wrong trying to read or write a file";
334     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
335         return "File is not an email";
336     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
337         return "Message ID is identical to a message in database";
338     case NOTMUCH_STATUS_NULL_POINTER:
339         return "Erroneous NULL pointer";
340     case NOTMUCH_STATUS_TAG_TOO_LONG:
341         return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
342     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
343         return "Unbalanced number of calls to notmuch_message_freeze/thaw";
344     case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
345         return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
346     case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
347         return "Unsupported operation";
348     case NOTMUCH_STATUS_UPGRADE_REQUIRED:
349         return "Operation requires a database upgrade";
350     case NOTMUCH_STATUS_PATH_ERROR:
351         return "Path supplied is illegal for this function";
352     default:
353     case NOTMUCH_STATUS_LAST_STATUS:
354         return "Unknown error status value";
355     }
356 }
357
358 void
359 _notmuch_database_log (notmuch_database_t *notmuch,
360                       const char *format,
361                       ...)
362 {
363     va_list va_args;
364
365     va_start (va_args, format);
366
367     if (notmuch->status_string)
368         talloc_free (notmuch->status_string);
369
370     notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
371
372     va_end (va_args);
373 }
374
375 static void
376 find_doc_ids_for_term (notmuch_database_t *notmuch,
377                        const char *term,
378                        Xapian::PostingIterator *begin,
379                        Xapian::PostingIterator *end)
380 {
381     *begin = notmuch->xapian_db->postlist_begin (term);
382
383     *end = notmuch->xapian_db->postlist_end (term);
384 }
385
386 static void
387 find_doc_ids (notmuch_database_t *notmuch,
388               const char *prefix_name,
389               const char *value,
390               Xapian::PostingIterator *begin,
391               Xapian::PostingIterator *end)
392 {
393     char *term;
394
395     term = talloc_asprintf (notmuch, "%s%s",
396                             _find_prefix (prefix_name), value);
397
398     find_doc_ids_for_term (notmuch, term, begin, end);
399
400     talloc_free (term);
401 }
402
403 notmuch_private_status_t
404 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
405                                       const char *prefix_name,
406                                       const char *value,
407                                       unsigned int *doc_id)
408 {
409     Xapian::PostingIterator i, end;
410
411     find_doc_ids (notmuch, prefix_name, value, &i, &end);
412
413     if (i == end) {
414         *doc_id = 0;
415         return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
416     }
417
418     *doc_id = *i;
419
420 #if DEBUG_DATABASE_SANITY
421     i++;
422
423     if (i != end)
424         INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
425                         prefix_name, value);
426 #endif
427
428     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
429 }
430
431 static Xapian::Document
432 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
433 {
434     return notmuch->xapian_db->get_document (doc_id);
435 }
436
437 /* Generate a compressed version of 'message_id' of the form:
438  *
439  *      notmuch-sha1-<sha1_sum_of_message_id>
440  */
441 char *
442 _notmuch_message_id_compressed (void *ctx, const char *message_id)
443 {
444     char *sha1, *compressed;
445
446     sha1 = _notmuch_sha1_of_string (message_id);
447
448     compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
449     free (sha1);
450
451     return compressed;
452 }
453
454 notmuch_status_t
455 notmuch_database_find_message (notmuch_database_t *notmuch,
456                                const char *message_id,
457                                notmuch_message_t **message_ret)
458 {
459     notmuch_private_status_t status;
460     unsigned int doc_id;
461
462     if (message_ret == NULL)
463         return NOTMUCH_STATUS_NULL_POINTER;
464
465     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
466         message_id = _notmuch_message_id_compressed (notmuch, message_id);
467
468     try {
469         status = _notmuch_database_find_unique_doc_id (notmuch, "id",
470                                                        message_id, &doc_id);
471
472         if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
473             *message_ret = NULL;
474         else {
475             *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
476                                                     NULL);
477             if (*message_ret == NULL)
478                 return NOTMUCH_STATUS_OUT_OF_MEMORY;
479         }
480
481         return NOTMUCH_STATUS_SUCCESS;
482     } catch (const Xapian::Error &error) {
483         _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
484                  error.get_msg().c_str());
485         notmuch->exception_reported = TRUE;
486         *message_ret = NULL;
487         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
488     }
489 }
490
491 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
492  * a (potentially nested) parenthesized sequence with '\' used to
493  * escape any character (including parentheses).
494  *
495  * If the sequence to be skipped continues to the end of the string,
496  * then 'str' will be left pointing at the final terminating '\0'
497  * character.
498  */
499 static void
500 skip_space_and_comments (const char **str)
501 {
502     const char *s;
503
504     s = *str;
505     while (*s && (isspace (*s) || *s == '(')) {
506         while (*s && isspace (*s))
507             s++;
508         if (*s == '(') {
509             int nesting = 1;
510             s++;
511             while (*s && nesting) {
512                 if (*s == '(') {
513                     nesting++;
514                 } else if (*s == ')') {
515                     nesting--;
516                 } else if (*s == '\\') {
517                     if (*(s+1))
518                         s++;
519                 }
520                 s++;
521             }
522         }
523     }
524
525     *str = s;
526 }
527
528 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
529  * comments, and the '<' and '>' delimiters.
530  *
531  * If not NULL, then *next will be made to point to the first character
532  * not parsed, (possibly pointing to the final '\0' terminator.
533  *
534  * Returns a newly talloc'ed string belonging to 'ctx'.
535  *
536  * Returns NULL if there is any error parsing the message-id. */
537 static char *
538 _parse_message_id (void *ctx, const char *message_id, const char **next)
539 {
540     const char *s, *end;
541     char *result;
542
543     if (message_id == NULL || *message_id == '\0')
544         return NULL;
545
546     s = message_id;
547
548     skip_space_and_comments (&s);
549
550     /* Skip any unstructured text as well. */
551     while (*s && *s != '<')
552         s++;
553
554     if (*s == '<') {
555         s++;
556     } else {
557         if (next)
558             *next = s;
559         return NULL;
560     }
561
562     skip_space_and_comments (&s);
563
564     end = s;
565     while (*end && *end != '>')
566         end++;
567     if (next) {
568         if (*end)
569             *next = end + 1;
570         else
571             *next = end;
572     }
573
574     if (end > s && *end == '>')
575         end--;
576     if (end <= s)
577         return NULL;
578
579     result = talloc_strndup (ctx, s, end - s + 1);
580
581     /* Finally, collapse any whitespace that is within the message-id
582      * itself. */
583     {
584         char *r;
585         int len;
586
587         for (r = result, len = strlen (r); *r; r++, len--)
588             if (*r == ' ' || *r == '\t')
589                 memmove (r, r+1, len);
590     }
591
592     return result;
593 }
594
595 /* Parse a References header value, putting a (talloc'ed under 'ctx')
596  * copy of each referenced message-id into 'hash'.
597  *
598  * We explicitly avoid including any reference identical to
599  * 'message_id' in the result (to avoid mass confusion when a single
600  * message references itself cyclically---and yes, mail messages are
601  * not infrequent in the wild that do this---don't ask me why).
602  *
603  * Return the last reference parsed, if it is not equal to message_id.
604  */
605 static char *
606 parse_references (void *ctx,
607                   const char *message_id,
608                   GHashTable *hash,
609                   const char *refs)
610 {
611     char *ref, *last_ref = NULL;
612
613     if (refs == NULL || *refs == '\0')
614         return NULL;
615
616     while (*refs) {
617         ref = _parse_message_id (ctx, refs, &refs);
618
619         if (ref && strcmp (ref, message_id)) {
620             g_hash_table_insert (hash, ref, NULL);
621             last_ref = ref;
622         }
623     }
624
625     /* The return value of this function is used to add a parent
626      * reference to the database.  We should avoid making a message
627      * its own parent, thus the above check.
628      */
629     return last_ref;
630 }
631
632 notmuch_status_t
633 notmuch_database_create (const char *path, notmuch_database_t **database)
634 {
635     char *status_string = NULL;
636     notmuch_status_t status;
637
638     status = notmuch_database_create_verbose (path, database,
639                                               &status_string);
640
641     if (status_string) {
642         fputs (status_string, stderr);
643         free (status_string);
644     }
645
646     return status;
647 }
648
649 notmuch_status_t
650 notmuch_database_create_verbose (const char *path,
651                                  notmuch_database_t **database,
652                                  char **status_string)
653 {
654     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
655     notmuch_database_t *notmuch = NULL;
656     char *notmuch_path = NULL;
657     char *message = NULL;
658     struct stat st;
659     int err;
660
661     if (path == NULL) {
662         message = strdup ("Error: Cannot create a database for a NULL path.\n");
663         status = NOTMUCH_STATUS_NULL_POINTER;
664         goto DONE;
665     }
666
667     if (path[0] != '/') {
668         message = strdup ("Error: Database path must be absolute.\n");
669         status = NOTMUCH_STATUS_PATH_ERROR;
670         goto DONE;
671     }
672
673     err = stat (path, &st);
674     if (err) {
675         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
676                                 path, strerror (errno)));
677         status = NOTMUCH_STATUS_FILE_ERROR;
678         goto DONE;
679     }
680
681     if (! S_ISDIR (st.st_mode)) {
682         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
683                                  "Not a directory.\n",
684                                  path));
685         status = NOTMUCH_STATUS_FILE_ERROR;
686         goto DONE;
687     }
688
689     notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
690
691     err = mkdir (notmuch_path, 0755);
692
693     if (err) {
694         IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
695                                  notmuch_path, strerror (errno)));
696         status = NOTMUCH_STATUS_FILE_ERROR;
697         goto DONE;
698     }
699
700     status = notmuch_database_open_verbose (path,
701                                             NOTMUCH_DATABASE_MODE_READ_WRITE,
702                                             &notmuch, &message);
703     if (status)
704         goto DONE;
705
706     /* Upgrade doesn't add these feature to existing databases, but
707      * new databases have them. */
708     notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
709     notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
710
711     status = notmuch_database_upgrade (notmuch, NULL, NULL);
712     if (status) {
713         notmuch_database_close(notmuch);
714         notmuch = NULL;
715     }
716
717   DONE:
718     if (notmuch_path)
719         talloc_free (notmuch_path);
720
721     if (message) {
722         if (status_string)
723             *status_string = message;
724         else
725             free (message);
726     }
727     if (database)
728         *database = notmuch;
729     else
730         talloc_free (notmuch);
731     return status;
732 }
733
734 notmuch_status_t
735 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
736 {
737     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
738         _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
739         return NOTMUCH_STATUS_READ_ONLY_DATABASE;
740     }
741
742     return NOTMUCH_STATUS_SUCCESS;
743 }
744
745 /* Allocate a revision number for the next change. */
746 unsigned long
747 _notmuch_database_new_revision (notmuch_database_t *notmuch)
748 {
749     unsigned long new_revision = notmuch->revision + 1;
750
751     /* If we're in an atomic section, hold off on updating the
752      * committed revision number until we commit the atomic section.
753      */
754     if (notmuch->atomic_nesting)
755         notmuch->atomic_dirty = TRUE;
756     else
757         notmuch->revision = new_revision;
758
759     return new_revision;
760 }
761
762 /* Parse a database features string from the given database version.
763  * Returns the feature bit set.
764  *
765  * For version < 3, this ignores the features string and returns a
766  * hard-coded set of features.
767  *
768  * If there are unrecognized features that are required to open the
769  * database in mode (which should be 'r' or 'w'), return a
770  * comma-separated list of unrecognized but required features in
771  * *incompat_out suitable for presenting to the user.  *incompat_out
772  * will be allocated from ctx.
773  */
774 static _notmuch_features
775 _parse_features (const void *ctx, const char *features, unsigned int version,
776                  char mode, char **incompat_out)
777 {
778     _notmuch_features res = static_cast<_notmuch_features>(0);
779     unsigned int namelen, i;
780     size_t llen = 0;
781     const char *flags;
782
783     /* Prior to database version 3, features were implied by the
784      * version number. */
785     if (version == 0)
786         return NOTMUCH_FEATURES_V0;
787     else if (version == 1)
788         return NOTMUCH_FEATURES_V1;
789     else if (version == 2)
790         return NOTMUCH_FEATURES_V2;
791
792     /* Parse the features string */
793     while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
794         flags = strchr (features, '\t');
795         if (! flags || flags > features + llen)
796             continue;
797         namelen = flags - features;
798
799         for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
800             if (strlen (feature_names[i].name) == namelen &&
801                 strncmp (feature_names[i].name, features, namelen) == 0) {
802                 res |= feature_names[i].value;
803                 break;
804             }
805         }
806
807         if (i == ARRAY_SIZE (feature_names) && incompat_out) {
808             /* Unrecognized feature */
809             const char *have = strchr (flags, mode);
810             if (have && have < features + llen) {
811                 /* This feature is required to access this database in
812                  * 'mode', but we don't understand it. */
813                 if (! *incompat_out)
814                     *incompat_out = talloc_strdup (ctx, "");
815                 *incompat_out = talloc_asprintf_append_buffer (
816                     *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
817                     namelen, features);
818             }
819         }
820     }
821
822     return res;
823 }
824
825 static char *
826 _print_features (const void *ctx, unsigned int features)
827 {
828     unsigned int i;
829     char *res = talloc_strdup (ctx, "");
830
831     for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
832         if (features & feature_names[i].value)
833             res = talloc_asprintf_append_buffer (
834                 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
835
836     return res;
837 }
838
839 notmuch_status_t
840 notmuch_database_open (const char *path,
841                        notmuch_database_mode_t mode,
842                        notmuch_database_t **database)
843 {
844     char *status_string = NULL;
845     notmuch_status_t status;
846
847     status = notmuch_database_open_verbose (path, mode, database,
848                                            &status_string);
849
850     if (status_string) {
851         fputs (status_string, stderr);
852         free (status_string);
853     }
854
855     return status;
856 }
857
858 notmuch_status_t
859 notmuch_database_open_verbose (const char *path,
860                                notmuch_database_mode_t mode,
861                                notmuch_database_t **database,
862                                char **status_string)
863 {
864     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
865     void *local = talloc_new (NULL);
866     notmuch_database_t *notmuch = NULL;
867     char *notmuch_path, *xapian_path, *incompat_features;
868     char *message = NULL;
869     struct stat st;
870     int err;
871     unsigned int i, version;
872     static int initialized = 0;
873
874     if (path == NULL) {
875         message = strdup ("Error: Cannot open a database for a NULL path.\n");
876         status = NOTMUCH_STATUS_NULL_POINTER;
877         goto DONE;
878     }
879
880     if (path[0] != '/') {
881         message = strdup ("Error: Database path must be absolute.\n");
882         status = NOTMUCH_STATUS_PATH_ERROR;
883         goto DONE;
884     }
885
886     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
887         message = strdup ("Out of memory\n");
888         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
889         goto DONE;
890     }
891
892     err = stat (notmuch_path, &st);
893     if (err) {
894         IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
895                                  notmuch_path, strerror (errno)));
896         status = NOTMUCH_STATUS_FILE_ERROR;
897         goto DONE;
898     }
899
900     if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
901         message = strdup ("Out of memory\n");
902         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
903         goto DONE;
904     }
905
906     /* Initialize the GLib type system and threads */
907 #if !GLIB_CHECK_VERSION(2, 35, 1)
908     g_type_init ();
909 #endif
910
911     /* Initialize gmime */
912     if (! initialized) {
913         g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
914         initialized = 1;
915     }
916
917     notmuch = talloc_zero (NULL, notmuch_database_t);
918     notmuch->exception_reported = FALSE;
919     notmuch->status_string = NULL;
920     notmuch->path = talloc_strdup (notmuch, path);
921
922     if (notmuch->path[strlen (notmuch->path) - 1] == '/')
923         notmuch->path[strlen (notmuch->path) - 1] = '\0';
924
925     notmuch->mode = mode;
926     notmuch->atomic_nesting = 0;
927     try {
928         string last_thread_id;
929         string last_mod;
930
931         if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
932             notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
933                                                                Xapian::DB_CREATE_OR_OPEN);
934         } else {
935             notmuch->xapian_db = new Xapian::Database (xapian_path);
936         }
937
938         /* Check version.  As of database version 3, we represent
939          * changes in terms of features, so assume a version bump
940          * means a dramatically incompatible change. */
941         version = notmuch_database_get_version (notmuch);
942         if (version > NOTMUCH_DATABASE_VERSION) {
943             IGNORE_RESULT (asprintf (&message,
944                       "Error: Notmuch database at %s\n"
945                       "       has a newer database format version (%u) than supported by this\n"
946                       "       version of notmuch (%u).\n",
947                                      notmuch_path, version, NOTMUCH_DATABASE_VERSION));
948             notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
949             notmuch_database_destroy (notmuch);
950             notmuch = NULL;
951             status = NOTMUCH_STATUS_FILE_ERROR;
952             goto DONE;
953         }
954
955         /* Check features. */
956         incompat_features = NULL;
957         notmuch->features = _parse_features (
958             local, notmuch->xapian_db->get_metadata ("features").c_str (),
959             version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
960             &incompat_features);
961         if (incompat_features) {
962             IGNORE_RESULT (asprintf (&message,
963                 "Error: Notmuch database at %s\n"
964                 "       requires features (%s)\n"
965                 "       not supported by this version of notmuch.\n",
966                                      notmuch_path, incompat_features));
967             notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
968             notmuch_database_destroy (notmuch);
969             notmuch = NULL;
970             status = NOTMUCH_STATUS_FILE_ERROR;
971             goto DONE;
972         }
973
974         notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
975         last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
976         if (last_thread_id.empty ()) {
977             notmuch->last_thread_id = 0;
978         } else {
979             const char *str;
980             char *end;
981
982             str = last_thread_id.c_str ();
983             notmuch->last_thread_id = strtoull (str, &end, 16);
984             if (*end != '\0')
985                 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
986         }
987
988         /* Get current highest revision number. */
989         last_mod = notmuch->xapian_db->get_value_upper_bound (
990             NOTMUCH_VALUE_LAST_MOD);
991         if (last_mod.empty ())
992             notmuch->revision = 0;
993         else
994             notmuch->revision = Xapian::sortable_unserialise (last_mod);
995         notmuch->uuid = talloc_strdup (
996             notmuch, notmuch->xapian_db->get_uuid ().c_str ());
997
998         notmuch->query_parser = new Xapian::QueryParser;
999         notmuch->term_gen = new Xapian::TermGenerator;
1000         notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
1001         notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1002         notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1003         notmuch->last_mod_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
1004
1005         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
1006         notmuch->query_parser->set_database (*notmuch->xapian_db);
1007         notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
1008         notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
1009         notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
1010         notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
1011         notmuch->query_parser->add_valuerangeprocessor (notmuch->last_mod_range_processor);
1012
1013         for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
1014             prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
1015             notmuch->query_parser->add_boolean_prefix (prefix->name,
1016                                                        prefix->prefix);
1017         }
1018
1019         for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
1020             prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
1021             notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
1022         }
1023     } catch (const Xapian::Error &error) {
1024         IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
1025                                  error.get_msg().c_str()));
1026         notmuch_database_destroy (notmuch);
1027         notmuch = NULL;
1028         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1029     }
1030
1031   DONE:
1032     talloc_free (local);
1033
1034     if (message) {
1035         if (status_string)
1036             *status_string = message;
1037         else
1038             free (message);
1039     }
1040
1041     if (database)
1042         *database = notmuch;
1043     else
1044         talloc_free (notmuch);
1045     return status;
1046 }
1047
1048 notmuch_status_t
1049 notmuch_database_close (notmuch_database_t *notmuch)
1050 {
1051     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1052
1053     /* Many Xapian objects (and thus notmuch objects) hold references to
1054      * the database, so merely deleting the database may not suffice to
1055      * close it.  Thus, we explicitly close it here. */
1056     if (notmuch->xapian_db != NULL) {
1057         try {
1058             /* If there's an outstanding transaction, it's unclear if
1059              * closing the Xapian database commits everything up to
1060              * that transaction, or may discard committed (but
1061              * unflushed) transactions.  To be certain, explicitly
1062              * cancel any outstanding transaction before closing. */
1063             if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1064                 notmuch->atomic_nesting)
1065                 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1066                     ->cancel_transaction ();
1067
1068             /* Close the database.  This implicitly flushes
1069              * outstanding changes. */
1070             notmuch->xapian_db->close();
1071         } catch (const Xapian::Error &error) {
1072             status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1073             if (! notmuch->exception_reported) {
1074                 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1075                          error.get_msg().c_str());
1076             }
1077         }
1078     }
1079
1080     delete notmuch->term_gen;
1081     notmuch->term_gen = NULL;
1082     delete notmuch->query_parser;
1083     notmuch->query_parser = NULL;
1084     delete notmuch->xapian_db;
1085     notmuch->xapian_db = NULL;
1086     delete notmuch->value_range_processor;
1087     notmuch->value_range_processor = NULL;
1088     delete notmuch->date_range_processor;
1089     notmuch->date_range_processor = NULL;
1090     delete notmuch->last_mod_range_processor;
1091     notmuch->last_mod_range_processor = NULL;
1092
1093     return status;
1094 }
1095
1096 #if HAVE_XAPIAN_COMPACT
1097 static int
1098 unlink_cb (const char *path,
1099            unused (const struct stat *sb),
1100            unused (int type),
1101            unused (struct FTW *ftw))
1102 {
1103     return remove (path);
1104 }
1105
1106 static int
1107 rmtree (const char *path)
1108 {
1109     return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1110 }
1111
1112 class NotmuchCompactor : public Xapian::Compactor
1113 {
1114     notmuch_compact_status_cb_t status_cb;
1115     void *status_closure;
1116
1117 public:
1118     NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1119         status_cb (cb), status_closure (closure) { }
1120
1121     virtual void
1122     set_status (const std::string &table, const std::string &status)
1123     {
1124         char *msg;
1125
1126         if (status_cb == NULL)
1127             return;
1128
1129         if (status.length () == 0)
1130             msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
1131         else
1132             msg = talloc_asprintf (NULL, "     %s", status.c_str());
1133
1134         if (msg == NULL) {
1135             return;
1136         }
1137
1138         status_cb (msg, status_closure);
1139         talloc_free (msg);
1140     }
1141 };
1142
1143 /* Compacts the given database, optionally saving the original database
1144  * in backup_path. Additionally, a callback function can be provided to
1145  * give the user feedback on the progress of the (likely long-lived)
1146  * compaction process.
1147  *
1148  * The backup path must point to a directory on the same volume as the
1149  * original database. Passing a NULL backup_path will result in the
1150  * uncompacted database being deleted after compaction has finished.
1151  * Note that the database write lock will be held during the
1152  * compaction process to protect data integrity.
1153  */
1154 notmuch_status_t
1155 notmuch_database_compact (const char *path,
1156                           const char *backup_path,
1157                           notmuch_compact_status_cb_t status_cb,
1158                           void *closure)
1159 {
1160     void *local;
1161     char *notmuch_path, *xapian_path, *compact_xapian_path;
1162     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1163     notmuch_database_t *notmuch = NULL;
1164     struct stat statbuf;
1165     notmuch_bool_t keep_backup;
1166     char *message = NULL;
1167
1168     local = talloc_new (NULL);
1169     if (! local)
1170         return NOTMUCH_STATUS_OUT_OF_MEMORY;
1171
1172     ret = notmuch_database_open_verbose (path,
1173                                          NOTMUCH_DATABASE_MODE_READ_WRITE,
1174                                          &notmuch,
1175                                          &message);
1176     if (ret) {
1177         if (status_cb) status_cb (message, closure);
1178         goto DONE;
1179     }
1180
1181     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1182         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1183         goto DONE;
1184     }
1185
1186     if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1187         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1188         goto DONE;
1189     }
1190
1191     if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1192         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1193         goto DONE;
1194     }
1195
1196     if (backup_path == NULL) {
1197         if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1198             ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1199             goto DONE;
1200         }
1201         keep_backup = FALSE;
1202     }
1203     else {
1204         keep_backup = TRUE;
1205     }
1206
1207     if (stat (backup_path, &statbuf) != -1) {
1208         _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1209         ret = NOTMUCH_STATUS_FILE_ERROR;
1210         goto DONE;
1211     }
1212     if (errno != ENOENT) {
1213         _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1214                  strerror (errno));
1215         ret = NOTMUCH_STATUS_FILE_ERROR;
1216         goto DONE;
1217     }
1218
1219     /* Unconditionally attempt to remove old work-in-progress database (if
1220      * any). This is "protected" by database lock. If this fails due to write
1221      * errors (etc), the following code will fail and provide error message.
1222      */
1223     (void) rmtree (compact_xapian_path);
1224
1225     try {
1226         NotmuchCompactor compactor (status_cb, closure);
1227
1228         compactor.set_renumber (false);
1229         compactor.add_source (xapian_path);
1230         compactor.set_destdir (compact_xapian_path);
1231         compactor.compact ();
1232     } catch (const Xapian::Error &error) {
1233         _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg().c_str());
1234         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1235         goto DONE;
1236     }
1237
1238     if (rename (xapian_path, backup_path)) {
1239         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1240                  xapian_path, backup_path, strerror (errno));
1241         ret = NOTMUCH_STATUS_FILE_ERROR;
1242         goto DONE;
1243     }
1244
1245     if (rename (compact_xapian_path, xapian_path)) {
1246         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1247                  compact_xapian_path, xapian_path, strerror (errno));
1248         ret = NOTMUCH_STATUS_FILE_ERROR;
1249         goto DONE;
1250     }
1251
1252     if (! keep_backup) {
1253         if (rmtree (backup_path)) {
1254             _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1255                      backup_path, strerror (errno));
1256             ret = NOTMUCH_STATUS_FILE_ERROR;
1257             goto DONE;
1258         }
1259     }
1260
1261   DONE:
1262     if (notmuch) {
1263         notmuch_status_t ret2;
1264
1265         const char *str = notmuch_database_status_string (notmuch);
1266         if (status_cb && str)
1267             status_cb (str, closure);
1268
1269         ret2 = notmuch_database_destroy (notmuch);
1270
1271         /* don't clobber previous error status */
1272         if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1273             ret = ret2;
1274     }
1275
1276     talloc_free (local);
1277
1278     return ret;
1279 }
1280 #else
1281 notmuch_status_t
1282 notmuch_database_compact (unused (const char *path),
1283                           unused (const char *backup_path),
1284                           unused (notmuch_compact_status_cb_t status_cb),
1285                           unused (void *closure))
1286 {
1287     _notmuch_database_log (notmuch, "notmuch was compiled against a xapian version lacking compaction support.\n");
1288     return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1289 }
1290 #endif
1291
1292 notmuch_status_t
1293 notmuch_database_destroy (notmuch_database_t *notmuch)
1294 {
1295     notmuch_status_t status;
1296
1297     status = notmuch_database_close (notmuch);
1298     talloc_free (notmuch);
1299
1300     return status;
1301 }
1302
1303 const char *
1304 notmuch_database_get_path (notmuch_database_t *notmuch)
1305 {
1306     return notmuch->path;
1307 }
1308
1309 unsigned int
1310 notmuch_database_get_version (notmuch_database_t *notmuch)
1311 {
1312     unsigned int version;
1313     string version_string;
1314     const char *str;
1315     char *end;
1316
1317     version_string = notmuch->xapian_db->get_metadata ("version");
1318     if (version_string.empty ())
1319         return 0;
1320
1321     str = version_string.c_str ();
1322     if (str == NULL || *str == '\0')
1323         return 0;
1324
1325     version = strtoul (str, &end, 10);
1326     if (*end != '\0')
1327         INTERNAL_ERROR ("Malformed database version: %s", str);
1328
1329     return version;
1330 }
1331
1332 notmuch_bool_t
1333 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1334 {
1335     return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1336         ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1337          (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1338 }
1339
1340 static volatile sig_atomic_t do_progress_notify = 0;
1341
1342 static void
1343 handle_sigalrm (unused (int signal))
1344 {
1345     do_progress_notify = 1;
1346 }
1347
1348 /* Upgrade the current database.
1349  *
1350  * After opening a database in read-write mode, the client should
1351  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1352  * if so, upgrade with this function before making any modifications.
1353  *
1354  * The optional progress_notify callback can be used by the caller to
1355  * provide progress indication to the user. If non-NULL it will be
1356  * called periodically with 'count' as the number of messages upgraded
1357  * so far and 'total' the overall number of messages that will be
1358  * converted.
1359  */
1360 notmuch_status_t
1361 notmuch_database_upgrade (notmuch_database_t *notmuch,
1362                           void (*progress_notify) (void *closure,
1363                                                    double progress),
1364                           void *closure)
1365 {
1366     void *local = talloc_new (NULL);
1367     Xapian::TermIterator t, t_end;
1368     Xapian::WritableDatabase *db;
1369     struct sigaction action;
1370     struct itimerval timerval;
1371     notmuch_bool_t timer_is_active = FALSE;
1372     enum _notmuch_features target_features, new_features;
1373     notmuch_status_t status;
1374     notmuch_private_status_t private_status;
1375     notmuch_query_t *query = NULL;
1376     unsigned int count = 0, total = 0;
1377
1378     status = _notmuch_database_ensure_writable (notmuch);
1379     if (status)
1380         return status;
1381
1382     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1383
1384     target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1385     new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1386
1387     if (! notmuch_database_needs_upgrade (notmuch))
1388         return NOTMUCH_STATUS_SUCCESS;
1389
1390     if (progress_notify) {
1391         /* Set up our handler for SIGALRM */
1392         memset (&action, 0, sizeof (struct sigaction));
1393         action.sa_handler = handle_sigalrm;
1394         sigemptyset (&action.sa_mask);
1395         action.sa_flags = SA_RESTART;
1396         sigaction (SIGALRM, &action, NULL);
1397
1398         /* Then start a timer to send SIGALRM once per second. */
1399         timerval.it_interval.tv_sec = 1;
1400         timerval.it_interval.tv_usec = 0;
1401         timerval.it_value.tv_sec = 1;
1402         timerval.it_value.tv_usec = 0;
1403         setitimer (ITIMER_REAL, &timerval, NULL);
1404
1405         timer_is_active = TRUE;
1406     }
1407
1408     /* Figure out how much total work we need to do. */
1409     if (new_features &
1410         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1411          NOTMUCH_FEATURE_LAST_MOD)) {
1412         query = notmuch_query_create (notmuch, "");
1413         unsigned msg_count;
1414
1415         status = notmuch_query_count_messages_st (query, &msg_count);
1416         if (status)
1417             goto DONE;
1418
1419         total += msg_count;
1420         notmuch_query_destroy (query);
1421         query = NULL;
1422     }
1423     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1424         t_end = db->allterms_end ("XTIMESTAMP");
1425         for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1426             ++total;
1427     }
1428     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1429         /* The ghost message upgrade converts all thread_id_*
1430          * metadata values into ghost message documents. */
1431         t_end = db->metadata_keys_end ("thread_id_");
1432         for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1433             ++total;
1434     }
1435
1436     /* Perform the upgrade in a transaction. */
1437     db->begin_transaction (true);
1438
1439     /* Set the target features so we write out changes in the desired
1440      * format. */
1441     notmuch->features = target_features;
1442
1443     /* Perform per-message upgrades. */
1444     if (new_features &
1445         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1446          NOTMUCH_FEATURE_LAST_MOD)) {
1447         notmuch_messages_t *messages;
1448         notmuch_message_t *message;
1449         char *filename;
1450
1451         query = notmuch_query_create (notmuch, "");
1452
1453         status = notmuch_query_search_messages_st (query, &messages);
1454         if (status)
1455             goto DONE;
1456         for (;
1457              notmuch_messages_valid (messages);
1458              notmuch_messages_move_to_next (messages))
1459         {
1460             if (do_progress_notify) {
1461                 progress_notify (closure, (double) count / total);
1462                 do_progress_notify = 0;
1463             }
1464
1465             message = notmuch_messages_get (messages);
1466
1467             /* Before version 1, each message document had its
1468              * filename in the data field. Copy that into the new
1469              * format by calling notmuch_message_add_filename.
1470              */
1471             if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1472                 filename = _notmuch_message_talloc_copy_data (message);
1473                 if (filename && *filename != '\0') {
1474                     _notmuch_message_add_filename (message, filename);
1475                     _notmuch_message_clear_data (message);
1476                 }
1477                 talloc_free (filename);
1478             }
1479
1480             /* Prior to version 2, the "folder:" prefix was
1481              * probabilistic and stemmed. Change it to the current
1482              * boolean prefix. Add "path:" prefixes while at it.
1483              */
1484             if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1485                 _notmuch_message_upgrade_folder (message);
1486
1487             /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
1488              * track modification revisions.  Give all messages the
1489              * next available revision; since we just started tracking
1490              * revisions for this database, that will be 1.
1491              */
1492             if (new_features & NOTMUCH_FEATURE_LAST_MOD)
1493                 _notmuch_message_upgrade_last_mod (message);
1494
1495             _notmuch_message_sync (message);
1496
1497             notmuch_message_destroy (message);
1498
1499             count++;
1500         }
1501
1502         notmuch_query_destroy (query);
1503         query = NULL;
1504     }
1505
1506     /* Perform per-directory upgrades. */
1507
1508     /* Before version 1 we stored directory timestamps in
1509      * XTIMESTAMP documents instead of the current XDIRECTORY
1510      * documents. So copy those as well. */
1511     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1512         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1513
1514         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1515              t != t_end;
1516              t++)
1517         {
1518             Xapian::PostingIterator p, p_end;
1519             std::string term = *t;
1520
1521             p_end = notmuch->xapian_db->postlist_end (term);
1522
1523             for (p = notmuch->xapian_db->postlist_begin (term);
1524                  p != p_end;
1525                  p++)
1526             {
1527                 Xapian::Document document;
1528                 time_t mtime;
1529                 notmuch_directory_t *directory;
1530
1531                 if (do_progress_notify) {
1532                     progress_notify (closure, (double) count / total);
1533                     do_progress_notify = 0;
1534                 }
1535
1536                 document = find_document_for_doc_id (notmuch, *p);
1537                 mtime = Xapian::sortable_unserialise (
1538                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1539
1540                 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1541                                                        NOTMUCH_FIND_CREATE, &status);
1542                 notmuch_directory_set_mtime (directory, mtime);
1543                 notmuch_directory_destroy (directory);
1544
1545                 db->delete_document (*p);
1546             }
1547
1548             ++count;
1549         }
1550     }
1551
1552     /* Perform metadata upgrades. */
1553
1554     /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1555      * messages were stored as database metadata. Change these to
1556      * ghost messages.
1557      */
1558     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1559         notmuch_message_t *message;
1560         std::string message_id, thread_id;
1561
1562         t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1563         for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1564              t != t_end; ++t) {
1565             if (do_progress_notify) {
1566                 progress_notify (closure, (double) count / total);
1567                 do_progress_notify = 0;
1568             }
1569
1570             message_id = (*t).substr (
1571                 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1572             thread_id = db->get_metadata (*t);
1573
1574             /* Create ghost message */
1575             message = _notmuch_message_create_for_message_id (
1576                 notmuch, message_id.c_str (), &private_status);
1577             if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1578                 /* Document already exists; ignore the stored thread ID */
1579             } else if (private_status ==
1580                        NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1581                 private_status = _notmuch_message_initialize_ghost (
1582                     message, thread_id.c_str ());
1583                 if (! private_status)
1584                     _notmuch_message_sync (message);
1585             }
1586
1587             if (private_status) {
1588                 _notmuch_database_log (notmuch,
1589                          "Upgrade failed while creating ghost messages.\n");
1590                 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1591                 goto DONE;
1592             }
1593
1594             /* Clear saved metadata thread ID */
1595             db->set_metadata (*t, "");
1596
1597             ++count;
1598         }
1599     }
1600
1601     status = NOTMUCH_STATUS_SUCCESS;
1602     db->set_metadata ("features", _print_features (local, notmuch->features));
1603     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1604
1605  DONE:
1606     if (status == NOTMUCH_STATUS_SUCCESS)
1607         db->commit_transaction ();
1608     else
1609         db->cancel_transaction ();
1610
1611     if (timer_is_active) {
1612         /* Now stop the timer. */
1613         timerval.it_interval.tv_sec = 0;
1614         timerval.it_interval.tv_usec = 0;
1615         timerval.it_value.tv_sec = 0;
1616         timerval.it_value.tv_usec = 0;
1617         setitimer (ITIMER_REAL, &timerval, NULL);
1618
1619         /* And disable the signal handler. */
1620         action.sa_handler = SIG_IGN;
1621         sigaction (SIGALRM, &action, NULL);
1622     }
1623
1624     if (query)
1625         notmuch_query_destroy (query);
1626
1627     talloc_free (local);
1628     return status;
1629 }
1630
1631 notmuch_status_t
1632 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1633 {
1634     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1635         notmuch->atomic_nesting > 0)
1636         goto DONE;
1637
1638         if (notmuch_database_needs_upgrade(notmuch))
1639                 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1640
1641     try {
1642         (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1643     } catch (const Xapian::Error &error) {
1644         _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1645                  error.get_msg().c_str());
1646         notmuch->exception_reported = TRUE;
1647         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1648     }
1649
1650 DONE:
1651     notmuch->atomic_nesting++;
1652     return NOTMUCH_STATUS_SUCCESS;
1653 }
1654
1655 notmuch_status_t
1656 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1657 {
1658     Xapian::WritableDatabase *db;
1659
1660     if (notmuch->atomic_nesting == 0)
1661         return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1662
1663     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1664         notmuch->atomic_nesting > 1)
1665         goto DONE;
1666
1667     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1668     try {
1669         db->commit_transaction ();
1670
1671         /* This is a hack for testing.  Xapian never flushes on a
1672          * non-flushed commit, even if the flush threshold is 1.
1673          * However, we rely on flushing to test atomicity. */
1674         const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1675         if (thresh && atoi (thresh) == 1)
1676             db->flush ();
1677     } catch (const Xapian::Error &error) {
1678         _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1679                  error.get_msg().c_str());
1680         notmuch->exception_reported = TRUE;
1681         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1682     }
1683
1684     if (notmuch->atomic_dirty) {
1685         ++notmuch->revision;
1686         notmuch->atomic_dirty = FALSE;
1687     }
1688
1689 DONE:
1690     notmuch->atomic_nesting--;
1691     return NOTMUCH_STATUS_SUCCESS;
1692 }
1693
1694 unsigned long
1695 notmuch_database_get_revision (notmuch_database_t *notmuch,
1696                                 const char **uuid)
1697 {
1698     if (uuid)
1699         *uuid = notmuch->uuid;
1700     return notmuch->revision;
1701 }
1702
1703 /* We allow the user to use arbitrarily long paths for directories. But
1704  * we have a term-length limit. So if we exceed that, we'll use the
1705  * SHA-1 of the path for the database term.
1706  *
1707  * Note: This function may return the original value of 'path'. If it
1708  * does not, then the caller is responsible to free() the returned
1709  * value.
1710  */
1711 const char *
1712 _notmuch_database_get_directory_db_path (const char *path)
1713 {
1714     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1715
1716     if (term_len > NOTMUCH_TERM_MAX)
1717         return _notmuch_sha1_of_string (path);
1718     else
1719         return path;
1720 }
1721
1722 /* Given a path, split it into two parts: the directory part is all
1723  * components except for the last, and the basename is that last
1724  * component. Getting the return-value for either part is optional
1725  * (the caller can pass NULL).
1726  *
1727  * The original 'path' can represent either a regular file or a
1728  * directory---the splitting will be carried out in the same way in
1729  * either case. Trailing slashes on 'path' will be ignored, and any
1730  * cases of multiple '/' characters appearing in series will be
1731  * treated as a single '/'.
1732  *
1733  * Allocation (if any) will have 'ctx' as the talloc owner. But
1734  * pointers will be returned within the original path string whenever
1735  * possible.
1736  *
1737  * Note: If 'path' is non-empty and contains no non-trailing slash,
1738  * (that is, consists of a filename with no parent directory), then
1739  * the directory returned will be an empty string. However, if 'path'
1740  * is an empty string, then both directory and basename will be
1741  * returned as NULL.
1742  */
1743 notmuch_status_t
1744 _notmuch_database_split_path (void *ctx,
1745                               const char *path,
1746                               const char **directory,
1747                               const char **basename)
1748 {
1749     const char *slash;
1750
1751     if (path == NULL || *path == '\0') {
1752         if (directory)
1753             *directory = NULL;
1754         if (basename)
1755             *basename = NULL;
1756         return NOTMUCH_STATUS_SUCCESS;
1757     }
1758
1759     /* Find the last slash (not counting a trailing slash), if any. */
1760
1761     slash = path + strlen (path) - 1;
1762
1763     /* First, skip trailing slashes. */
1764     while (slash != path && *slash == '/')
1765         --slash;
1766
1767     /* Then, find a slash. */
1768     while (slash != path && *slash != '/') {
1769         if (basename)
1770             *basename = slash;
1771
1772         --slash;
1773     }
1774
1775     /* Finally, skip multiple slashes. */
1776     while (slash != path && *(slash - 1) == '/')
1777         --slash;
1778
1779     if (slash == path) {
1780         if (directory)
1781             *directory = talloc_strdup (ctx, "");
1782         if (basename)
1783             *basename = path;
1784     } else {
1785         if (directory)
1786             *directory = talloc_strndup (ctx, path, slash - path);
1787     }
1788
1789     return NOTMUCH_STATUS_SUCCESS;
1790 }
1791
1792 /* Find the document ID of the specified directory.
1793  *
1794  * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1795  * created if one does not exist for 'path'.  Otherwise, if the
1796  * directory document does not exist, this sets *directory_id to
1797  * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1798  */
1799 notmuch_status_t
1800 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1801                                      const char *path,
1802                                      notmuch_find_flags_t flags,
1803                                      unsigned int *directory_id)
1804 {
1805     notmuch_directory_t *directory;
1806     notmuch_status_t status;
1807
1808     if (path == NULL) {
1809         *directory_id = 0;
1810         return NOTMUCH_STATUS_SUCCESS;
1811     }
1812
1813     directory = _notmuch_directory_create (notmuch, path, flags, &status);
1814     if (status || !directory) {
1815         *directory_id = -1;
1816         return status;
1817     }
1818
1819     *directory_id = _notmuch_directory_get_document_id (directory);
1820
1821     notmuch_directory_destroy (directory);
1822
1823     return NOTMUCH_STATUS_SUCCESS;
1824 }
1825
1826 const char *
1827 _notmuch_database_get_directory_path (void *ctx,
1828                                       notmuch_database_t *notmuch,
1829                                       unsigned int doc_id)
1830 {
1831     Xapian::Document document;
1832
1833     document = find_document_for_doc_id (notmuch, doc_id);
1834
1835     return talloc_strdup (ctx, document.get_data ().c_str ());
1836 }
1837
1838 /* Given a legal 'filename' for the database, (either relative to
1839  * database path or absolute with initial components identical to
1840  * database path), return a new string (with 'ctx' as the talloc
1841  * owner) suitable for use as a direntry term value.
1842  *
1843  * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1844  * will be created in the database as needed.  Otherwise, if the
1845  * necessary directory documents do not exist, this sets
1846  * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1847  */
1848 notmuch_status_t
1849 _notmuch_database_filename_to_direntry (void *ctx,
1850                                         notmuch_database_t *notmuch,
1851                                         const char *filename,
1852                                         notmuch_find_flags_t flags,
1853                                         char **direntry)
1854 {
1855     const char *relative, *directory, *basename;
1856     Xapian::docid directory_id;
1857     notmuch_status_t status;
1858
1859     relative = _notmuch_database_relative_path (notmuch, filename);
1860
1861     status = _notmuch_database_split_path (ctx, relative,
1862                                            &directory, &basename);
1863     if (status)
1864         return status;
1865
1866     status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1867                                                   &directory_id);
1868     if (status || directory_id == (unsigned int)-1) {
1869         *direntry = NULL;
1870         return status;
1871     }
1872
1873     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1874
1875     return NOTMUCH_STATUS_SUCCESS;
1876 }
1877
1878 /* Given a legal 'path' for the database, return the relative path.
1879  *
1880  * The return value will be a pointer to the original path contents,
1881  * and will be either the original string (if 'path' was relative) or
1882  * a portion of the string (if path was absolute and begins with the
1883  * database path).
1884  */
1885 const char *
1886 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1887                                  const char *path)
1888 {
1889     const char *db_path, *relative;
1890     unsigned int db_path_len;
1891
1892     db_path = notmuch_database_get_path (notmuch);
1893     db_path_len = strlen (db_path);
1894
1895     relative = path;
1896
1897     if (*relative == '/') {
1898         while (*relative == '/' && *(relative+1) == '/')
1899             relative++;
1900
1901         if (strncmp (relative, db_path, db_path_len) == 0)
1902         {
1903             relative += db_path_len;
1904             while (*relative == '/')
1905                 relative++;
1906         }
1907     }
1908
1909     return relative;
1910 }
1911
1912 notmuch_status_t
1913 notmuch_database_get_directory (notmuch_database_t *notmuch,
1914                                 const char *path,
1915                                 notmuch_directory_t **directory)
1916 {
1917     notmuch_status_t status;
1918
1919     if (directory == NULL)
1920         return NOTMUCH_STATUS_NULL_POINTER;
1921     *directory = NULL;
1922
1923     try {
1924         *directory = _notmuch_directory_create (notmuch, path,
1925                                                 NOTMUCH_FIND_LOOKUP, &status);
1926     } catch (const Xapian::Error &error) {
1927         _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1928                  error.get_msg().c_str());
1929         notmuch->exception_reported = TRUE;
1930         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1931     }
1932     return status;
1933 }
1934
1935 /* Allocate a document ID that satisfies the following criteria:
1936  *
1937  * 1. The ID does not exist for any document in the Xapian database
1938  *
1939  * 2. The ID was not previously returned from this function
1940  *
1941  * 3. The ID is the smallest integer satisfying (1) and (2)
1942  *
1943  * This function will trigger an internal error if these constraints
1944  * cannot all be satisfied, (that is, the pool of available document
1945  * IDs has been exhausted).
1946  */
1947 unsigned int
1948 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1949 {
1950     assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1951
1952     notmuch->last_doc_id++;
1953
1954     if (notmuch->last_doc_id == 0)
1955         INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1956
1957     return notmuch->last_doc_id;
1958 }
1959
1960 static const char *
1961 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1962 {
1963     /* 16 bytes (+ terminator) for hexadecimal representation of
1964      * a 64-bit integer. */
1965     static char thread_id[17];
1966     Xapian::WritableDatabase *db;
1967
1968     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1969
1970     notmuch->last_thread_id++;
1971
1972     sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1973
1974     db->set_metadata ("last_thread_id", thread_id);
1975
1976     return thread_id;
1977 }
1978
1979 static char *
1980 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1981 {
1982     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1983         message_id = _notmuch_message_id_compressed (ctx, message_id);
1984
1985     return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1986                             message_id);
1987 }
1988
1989 static notmuch_status_t
1990 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
1991                                       void *ctx,
1992                                       const char *message_id,
1993                                       const char **thread_id_ret);
1994
1995 /* Find the thread ID to which the message with 'message_id' belongs.
1996  *
1997  * Note: 'thread_id_ret' must not be NULL!
1998  * On success '*thread_id_ret' is set to a newly talloced string belonging to
1999  * 'ctx'.
2000  *
2001  * Note: If there is no message in the database with the given
2002  * 'message_id' then a new thread_id will be allocated for this
2003  * message ID and stored in the database metadata so that the
2004  * thread ID can be looked up if the message is added to the database
2005  * later.
2006  */
2007 static notmuch_status_t
2008 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
2009                                   void *ctx,
2010                                   const char *message_id,
2011                                   const char **thread_id_ret)
2012 {
2013     notmuch_private_status_t status;
2014     notmuch_message_t *message;
2015
2016     if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS))
2017         return _resolve_message_id_to_thread_id_old (notmuch, ctx, message_id,
2018                                                      thread_id_ret);
2019
2020     /* Look for this message (regular or ghost) */
2021     message = _notmuch_message_create_for_message_id (
2022         notmuch, message_id, &status);
2023     if (status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
2024         /* Message exists */
2025         *thread_id_ret = talloc_steal (
2026             ctx, notmuch_message_get_thread_id (message));
2027     } else if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
2028         /* Message did not exist.  Give it a fresh thread ID and
2029          * populate this message as a ghost message. */
2030         *thread_id_ret = talloc_strdup (
2031             ctx, _notmuch_database_generate_thread_id (notmuch));
2032         if (! *thread_id_ret) {
2033             status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
2034         } else {
2035             status = _notmuch_message_initialize_ghost (message, *thread_id_ret);
2036             if (status == 0)
2037                 /* Commit the new ghost message */
2038                 _notmuch_message_sync (message);
2039         }
2040     } else {
2041         /* Create failed. Fall through. */
2042     }
2043
2044     notmuch_message_destroy (message);
2045
2046     return COERCE_STATUS (status, "Error creating ghost message");
2047 }
2048
2049 /* Pre-ghost messages _resolve_message_id_to_thread_id */
2050 static notmuch_status_t
2051 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
2052                                       void *ctx,
2053                                       const char *message_id,
2054                                       const char **thread_id_ret)
2055 {
2056     notmuch_status_t status;
2057     notmuch_message_t *message;
2058     string thread_id_string;
2059     char *metadata_key;
2060     Xapian::WritableDatabase *db;
2061
2062     status = notmuch_database_find_message (notmuch, message_id, &message);
2063
2064     if (status)
2065         return status;
2066
2067     if (message) {
2068         *thread_id_ret = talloc_steal (ctx,
2069                                        notmuch_message_get_thread_id (message));
2070
2071         notmuch_message_destroy (message);
2072
2073         return NOTMUCH_STATUS_SUCCESS;
2074     }
2075
2076     /* Message has not been seen yet.
2077      *
2078      * We may have seen a reference to it already, in which case, we
2079      * can return the thread ID stored in the metadata. Otherwise, we
2080      * generate a new thread ID and store it there.
2081      */
2082     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2083     metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2084     thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
2085
2086     if (thread_id_string.empty()) {
2087         *thread_id_ret = talloc_strdup (ctx,
2088                                         _notmuch_database_generate_thread_id (notmuch));
2089         db->set_metadata (metadata_key, *thread_id_ret);
2090     } else {
2091         *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
2092     }
2093
2094     talloc_free (metadata_key);
2095
2096     return NOTMUCH_STATUS_SUCCESS;
2097 }
2098
2099 static notmuch_status_t
2100 _merge_threads (notmuch_database_t *notmuch,
2101                 const char *winner_thread_id,
2102                 const char *loser_thread_id)
2103 {
2104     Xapian::PostingIterator loser, loser_end;
2105     notmuch_message_t *message = NULL;
2106     notmuch_private_status_t private_status;
2107     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2108
2109     find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
2110
2111     for ( ; loser != loser_end; loser++) {
2112         message = _notmuch_message_create (notmuch, notmuch,
2113                                            *loser, &private_status);
2114         if (message == NULL) {
2115             ret = COERCE_STATUS (private_status,
2116                                  "Cannot find document for doc_id from query");
2117             goto DONE;
2118         }
2119
2120         _notmuch_message_remove_term (message, "thread", loser_thread_id);
2121         _notmuch_message_add_term (message, "thread", winner_thread_id);
2122         _notmuch_message_sync (message);
2123
2124         notmuch_message_destroy (message);
2125         message = NULL;
2126     }
2127
2128   DONE:
2129     if (message)
2130         notmuch_message_destroy (message);
2131
2132     return ret;
2133 }
2134
2135 static void
2136 _my_talloc_free_for_g_hash (void *ptr)
2137 {
2138     talloc_free (ptr);
2139 }
2140
2141 static notmuch_status_t
2142 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
2143                                            notmuch_message_t *message,
2144                                            notmuch_message_file_t *message_file,
2145                                            const char **thread_id)
2146 {
2147     GHashTable *parents = NULL;
2148     const char *refs, *in_reply_to, *in_reply_to_message_id;
2149     const char *last_ref_message_id, *this_message_id;
2150     GList *l, *keys = NULL;
2151     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2152
2153     parents = g_hash_table_new_full (g_str_hash, g_str_equal,
2154                                      _my_talloc_free_for_g_hash, NULL);
2155     this_message_id = notmuch_message_get_message_id (message);
2156
2157     refs = _notmuch_message_file_get_header (message_file, "references");
2158     last_ref_message_id = parse_references (message,
2159                                             this_message_id,
2160                                             parents, refs);
2161
2162     in_reply_to = _notmuch_message_file_get_header (message_file, "in-reply-to");
2163     in_reply_to_message_id = parse_references (message,
2164                                                this_message_id,
2165                                                parents, in_reply_to);
2166
2167     /* For the parent of this message, use the last message ID of the
2168      * References header, if available.  If not, fall back to the
2169      * first message ID in the In-Reply-To header. */
2170     if (last_ref_message_id) {
2171         _notmuch_message_add_term (message, "replyto",
2172                                    last_ref_message_id);
2173     } else if (in_reply_to_message_id) {
2174         _notmuch_message_add_term (message, "replyto",
2175                              in_reply_to_message_id);
2176     }
2177
2178     keys = g_hash_table_get_keys (parents);
2179     for (l = keys; l; l = l->next) {
2180         char *parent_message_id;
2181         const char *parent_thread_id = NULL;
2182
2183         parent_message_id = (char *) l->data;
2184
2185         _notmuch_message_add_term (message, "reference",
2186                                    parent_message_id);
2187
2188         ret = _resolve_message_id_to_thread_id (notmuch,
2189                                                 message,
2190                                                 parent_message_id,
2191                                                 &parent_thread_id);
2192         if (ret)
2193             goto DONE;
2194
2195         if (*thread_id == NULL) {
2196             *thread_id = talloc_strdup (message, parent_thread_id);
2197             _notmuch_message_add_term (message, "thread", *thread_id);
2198         } else if (strcmp (*thread_id, parent_thread_id)) {
2199             ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
2200             if (ret)
2201                 goto DONE;
2202         }
2203     }
2204
2205   DONE:
2206     if (keys)
2207         g_list_free (keys);
2208     if (parents)
2209         g_hash_table_unref (parents);
2210
2211     return ret;
2212 }
2213
2214 static notmuch_status_t
2215 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
2216                                             notmuch_message_t *message,
2217                                             const char **thread_id)
2218 {
2219     const char *message_id = notmuch_message_get_message_id (message);
2220     Xapian::PostingIterator child, children_end;
2221     notmuch_message_t *child_message = NULL;
2222     const char *child_thread_id;
2223     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2224     notmuch_private_status_t private_status;
2225
2226     find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
2227
2228     for ( ; child != children_end; child++) {
2229
2230         child_message = _notmuch_message_create (message, notmuch,
2231                                                  *child, &private_status);
2232         if (child_message == NULL) {
2233             ret = COERCE_STATUS (private_status,
2234                                  "Cannot find document for doc_id from query");
2235             goto DONE;
2236         }
2237
2238         child_thread_id = notmuch_message_get_thread_id (child_message);
2239         if (*thread_id == NULL) {
2240             *thread_id = talloc_strdup (message, child_thread_id);
2241             _notmuch_message_add_term (message, "thread", *thread_id);
2242         } else if (strcmp (*thread_id, child_thread_id)) {
2243             _notmuch_message_remove_term (child_message, "reference",
2244                                           message_id);
2245             _notmuch_message_sync (child_message);
2246             ret = _merge_threads (notmuch, *thread_id, child_thread_id);
2247             if (ret)
2248                 goto DONE;
2249         }
2250
2251         notmuch_message_destroy (child_message);
2252         child_message = NULL;
2253     }
2254
2255   DONE:
2256     if (child_message)
2257         notmuch_message_destroy (child_message);
2258
2259     return ret;
2260 }
2261
2262 /* Fetch and clear the stored thread_id for message, or NULL if none. */
2263 static char *
2264 _consume_metadata_thread_id (void *ctx, notmuch_database_t *notmuch,
2265                              notmuch_message_t *message)
2266 {
2267     const char *message_id;
2268     string stored_id;
2269     char *metadata_key;
2270
2271     message_id = notmuch_message_get_message_id (message);
2272     metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2273
2274     /* Check if we have already seen related messages to this one.
2275      * If we have then use the thread_id that we stored at that time.
2276      */
2277     stored_id = notmuch->xapian_db->get_metadata (metadata_key);
2278     if (stored_id.empty ()) {
2279         return NULL;
2280     } else {
2281         Xapian::WritableDatabase *db;
2282
2283         db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2284
2285         /* Clear the metadata for this message ID. We don't need it
2286          * anymore. */
2287         db->set_metadata (metadata_key, "");
2288
2289         return talloc_strdup (ctx, stored_id.c_str ());
2290     }
2291 }
2292
2293 /* Given a blank or ghost 'message' and its corresponding
2294  * 'message_file' link it to existing threads in the database.
2295  *
2296  * First, if is_ghost, this retrieves the thread ID already stored in
2297  * the message (which will be the case if a message was previously
2298  * added that referenced this one).  If the message is blank
2299  * (!is_ghost), it doesn't have a thread ID yet (we'll generate one
2300  * later in this function).  If the database does not support ghost
2301  * messages, this checks for a thread ID stored in database metadata
2302  * for this message ID.
2303  *
2304  * Second, we look at 'message_file' and its link-relevant headers
2305  * (References and In-Reply-To) for message IDs.
2306  *
2307  * Finally, we look in the database for existing message that
2308  * reference 'message'.
2309  *
2310  * In all cases, we assign to the current message the first thread ID
2311  * found. We will also merge any existing, distinct threads where this
2312  * message belongs to both, (which is not uncommon when messages are
2313  * processed out of order).
2314  *
2315  * Finally, if no thread ID has been found through referenced messages, we
2316  * call _notmuch_message_generate_thread_id to generate a new thread
2317  * ID. This should only happen for new, top-level messages, (no
2318  * References or In-Reply-To header in this message, and no previously
2319  * added message refers to this message).
2320  */
2321 static notmuch_status_t
2322 _notmuch_database_link_message (notmuch_database_t *notmuch,
2323                                 notmuch_message_t *message,
2324                                 notmuch_message_file_t *message_file,
2325                                 notmuch_bool_t is_ghost)
2326 {
2327     void *local = talloc_new (NULL);
2328     notmuch_status_t status;
2329     const char *thread_id = NULL;
2330
2331     /* Check if the message already had a thread ID */
2332     if (notmuch->features & NOTMUCH_FEATURE_GHOSTS) {
2333         if (is_ghost)
2334             thread_id = notmuch_message_get_thread_id (message);
2335     } else {
2336         thread_id = _consume_metadata_thread_id (local, notmuch, message);
2337         if (thread_id)
2338             _notmuch_message_add_term (message, "thread", thread_id);
2339     }
2340
2341     status = _notmuch_database_link_message_to_parents (notmuch, message,
2342                                                         message_file,
2343                                                         &thread_id);
2344     if (status)
2345         goto DONE;
2346
2347     if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS)) {
2348         /* In general, it shouldn't be necessary to link children,
2349          * since the earlier indexing of those children will have
2350          * stored a thread ID for the missing parent.  However, prior
2351          * to ghost messages, these stored thread IDs were NOT
2352          * rewritten during thread merging (and there was no
2353          * performant way to do so), so if indexed children were
2354          * pulled into a different thread ID by a merge, it was
2355          * necessary to pull them *back* into the stored thread ID of
2356          * the parent.  With ghost messages, we just rewrite the
2357          * stored thread IDs during merging, so this workaround isn't
2358          * necessary. */
2359         status = _notmuch_database_link_message_to_children (notmuch, message,
2360                                                              &thread_id);
2361         if (status)
2362             goto DONE;
2363     }
2364
2365     /* If not part of any existing thread, generate a new thread ID. */
2366     if (thread_id == NULL) {
2367         thread_id = _notmuch_database_generate_thread_id (notmuch);
2368
2369         _notmuch_message_add_term (message, "thread", thread_id);
2370     }
2371
2372  DONE:
2373     talloc_free (local);
2374
2375     return status;
2376 }
2377
2378 notmuch_status_t
2379 notmuch_database_add_message (notmuch_database_t *notmuch,
2380                               const char *filename,
2381                               notmuch_message_t **message_ret)
2382 {
2383     notmuch_message_file_t *message_file;
2384     notmuch_message_t *message = NULL;
2385     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
2386     notmuch_private_status_t private_status;
2387     notmuch_bool_t is_ghost = false;
2388
2389     const char *date, *header;
2390     const char *from, *to, *subject;
2391     char *message_id = NULL;
2392
2393     if (message_ret)
2394         *message_ret = NULL;
2395
2396     ret = _notmuch_database_ensure_writable (notmuch);
2397     if (ret)
2398         return ret;
2399
2400     message_file = _notmuch_message_file_open (notmuch, filename);
2401     if (message_file == NULL)
2402         return NOTMUCH_STATUS_FILE_ERROR;
2403
2404     /* Adding a message may change many documents.  Do this all
2405      * atomically. */
2406     ret = notmuch_database_begin_atomic (notmuch);
2407     if (ret)
2408         goto DONE;
2409
2410     /* Parse message up front to get better error status. */
2411     ret = _notmuch_message_file_parse (message_file);
2412     if (ret)
2413         goto DONE;
2414
2415     try {
2416         /* Before we do any real work, (especially before doing a
2417          * potential SHA-1 computation on the entire file's contents),
2418          * let's make sure that what we're looking at looks like an
2419          * actual email message.
2420          */
2421         from = _notmuch_message_file_get_header (message_file, "from");
2422         subject = _notmuch_message_file_get_header (message_file, "subject");
2423         to = _notmuch_message_file_get_header (message_file, "to");
2424
2425         if ((from == NULL || *from == '\0') &&
2426             (subject == NULL || *subject == '\0') &&
2427             (to == NULL || *to == '\0'))
2428         {
2429             ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
2430             goto DONE;
2431         }
2432
2433         /* Now that we're sure it's mail, the first order of business
2434          * is to find a message ID (or else create one ourselves). */
2435
2436         header = _notmuch_message_file_get_header (message_file, "message-id");
2437         if (header && *header != '\0') {
2438             message_id = _parse_message_id (message_file, header, NULL);
2439
2440             /* So the header value isn't RFC-compliant, but it's
2441              * better than no message-id at all. */
2442             if (message_id == NULL)
2443                 message_id = talloc_strdup (message_file, header);
2444         }
2445
2446         if (message_id == NULL ) {
2447             /* No message-id at all, let's generate one by taking a
2448              * hash over the file's contents. */
2449             char *sha1 = _notmuch_sha1_of_file (filename);
2450
2451             /* If that failed too, something is really wrong. Give up. */
2452             if (sha1 == NULL) {
2453                 ret = NOTMUCH_STATUS_FILE_ERROR;
2454                 goto DONE;
2455             }
2456
2457             message_id = talloc_asprintf (message_file,
2458                                           "notmuch-sha1-%s", sha1);
2459             free (sha1);
2460         }
2461
2462         /* Now that we have a message ID, we get a message object,
2463          * (which may or may not reference an existing document in the
2464          * database). */
2465
2466         message = _notmuch_message_create_for_message_id (notmuch,
2467                                                           message_id,
2468                                                           &private_status);
2469
2470         talloc_free (message_id);
2471
2472         if (message == NULL) {
2473             ret = COERCE_STATUS (private_status,
2474                                  "Unexpected status value from _notmuch_message_create_for_message_id");
2475             goto DONE;
2476         }
2477
2478         _notmuch_message_add_filename (message, filename);
2479
2480         /* Is this a newly created message object or a ghost
2481          * message?  We have to be slightly careful: if this is a
2482          * blank message, it's not safe to call
2483          * notmuch_message_get_flag yet. */
2484         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND ||
2485             (is_ghost = notmuch_message_get_flag (
2486                 message, NOTMUCH_MESSAGE_FLAG_GHOST))) {
2487             _notmuch_message_add_term (message, "type", "mail");
2488             if (is_ghost)
2489                 /* Convert ghost message to a regular message */
2490                 _notmuch_message_remove_term (message, "type", "ghost");
2491
2492             ret = _notmuch_database_link_message (notmuch, message,
2493                                                   message_file, is_ghost);
2494             if (ret)
2495                 goto DONE;
2496
2497             date = _notmuch_message_file_get_header (message_file, "date");
2498             _notmuch_message_set_header_values (message, date, from, subject);
2499
2500             ret = _notmuch_message_index_file (message, message_file);
2501             if (ret)
2502                 goto DONE;
2503         } else {
2504             ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2505         }
2506
2507         _notmuch_message_sync (message);
2508     } catch (const Xapian::Error &error) {
2509         _notmuch_database_log (notmuch, "A Xapian exception occurred adding message: %s.\n",
2510                  error.get_msg().c_str());
2511         notmuch->exception_reported = TRUE;
2512         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2513         goto DONE;
2514     }
2515
2516   DONE:
2517     if (message) {
2518         if ((ret == NOTMUCH_STATUS_SUCCESS ||
2519              ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2520             *message_ret = message;
2521         else
2522             notmuch_message_destroy (message);
2523     }
2524
2525     if (message_file)
2526         _notmuch_message_file_close (message_file);
2527
2528     ret2 = notmuch_database_end_atomic (notmuch);
2529     if ((ret == NOTMUCH_STATUS_SUCCESS ||
2530          ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2531         ret2 != NOTMUCH_STATUS_SUCCESS)
2532         ret = ret2;
2533
2534     return ret;
2535 }
2536
2537 notmuch_status_t
2538 notmuch_database_remove_message (notmuch_database_t *notmuch,
2539                                  const char *filename)
2540 {
2541     notmuch_status_t status;
2542     notmuch_message_t *message;
2543
2544     status = notmuch_database_find_message_by_filename (notmuch, filename,
2545                                                         &message);
2546
2547     if (status == NOTMUCH_STATUS_SUCCESS && message) {
2548             status = _notmuch_message_remove_filename (message, filename);
2549             if (status == NOTMUCH_STATUS_SUCCESS)
2550                 _notmuch_message_delete (message);
2551             else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2552                 _notmuch_message_sync (message);
2553
2554             notmuch_message_destroy (message);
2555     }
2556
2557     return status;
2558 }
2559
2560 notmuch_status_t
2561 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2562                                            const char *filename,
2563                                            notmuch_message_t **message_ret)
2564 {
2565     void *local;
2566     const char *prefix = _find_prefix ("file-direntry");
2567     char *direntry, *term;
2568     Xapian::PostingIterator i, end;
2569     notmuch_status_t status;
2570
2571     if (message_ret == NULL)
2572         return NOTMUCH_STATUS_NULL_POINTER;
2573
2574     if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2575         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2576
2577     /* return NULL on any failure */
2578     *message_ret = NULL;
2579
2580     local = talloc_new (notmuch);
2581
2582     try {
2583         status = _notmuch_database_filename_to_direntry (
2584             local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2585         if (status || !direntry)
2586             goto DONE;
2587
2588         term = talloc_asprintf (local, "%s%s", prefix, direntry);
2589
2590         find_doc_ids_for_term (notmuch, term, &i, &end);
2591
2592         if (i != end) {
2593             notmuch_private_status_t private_status;
2594
2595             *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2596                                                     &private_status);
2597             if (*message_ret == NULL)
2598                 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2599         }
2600     } catch (const Xapian::Error &error) {
2601         _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2602                  error.get_msg().c_str());
2603         notmuch->exception_reported = TRUE;
2604         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2605     }
2606
2607   DONE:
2608     talloc_free (local);
2609
2610     if (status && *message_ret) {
2611         notmuch_message_destroy (*message_ret);
2612         *message_ret = NULL;
2613     }
2614     return status;
2615 }
2616
2617 notmuch_string_list_t *
2618 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2619                                          Xapian::TermIterator &end,
2620                                          const char *prefix)
2621 {
2622     int prefix_len = strlen (prefix);
2623     notmuch_string_list_t *list;
2624
2625     list = _notmuch_string_list_create (ctx);
2626     if (unlikely (list == NULL))
2627         return NULL;
2628
2629     for (i.skip_to (prefix); i != end; i++) {
2630         /* Terminate loop at first term without desired prefix. */
2631         if (strncmp ((*i).c_str (), prefix, prefix_len))
2632             break;
2633
2634         _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2635     }
2636
2637     return list;
2638 }
2639
2640 notmuch_tags_t *
2641 notmuch_database_get_all_tags (notmuch_database_t *db)
2642 {
2643     Xapian::TermIterator i, end;
2644     notmuch_string_list_t *tags;
2645
2646     try {
2647         i = db->xapian_db->allterms_begin();
2648         end = db->xapian_db->allterms_end();
2649         tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2650                                                         _find_prefix ("tag"));
2651         _notmuch_string_list_sort (tags);
2652         return _notmuch_tags_create (db, tags);
2653     } catch (const Xapian::Error &error) {
2654         _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2655                  error.get_msg().c_str());
2656         db->exception_reported = TRUE;
2657         return NULL;
2658     }
2659 }
2660
2661 const char *
2662 notmuch_database_status_string (const notmuch_database_t *notmuch)
2663 {
2664     return notmuch->status_string;
2665 }