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