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 "thread-fp.h"
25 #include "regexp-fields.h"
26 #include "string-util.h"
27
28 #include <iostream>
29
30 #include <sys/time.h>
31 #include <sys/stat.h>
32 #include <signal.h>
33 #include <ftw.h>
34
35 #include <glib.h>               /* g_free, GPtrArray, GHashTable */
36 #include <glib-object.h>        /* g_type_init */
37
38 #include <gmime/gmime.h>        /* g_mime_init */
39
40 using namespace std;
41
42 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
43
44 typedef struct {
45     const char *name;
46     const char *prefix;
47     notmuch_field_flag_t flags;
48 } prefix_t;
49
50 #define NOTMUCH_DATABASE_VERSION 3
51
52 #define STRINGIFY(s) _SUB_STRINGIFY (s)
53 #define _SUB_STRINGIFY(s) #s
54
55 #if HAVE_XAPIAN_DB_RETRY_LOCK
56 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
57 #else
58 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
59 #endif
60
61 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
62  *
63  * We currently have three different types of documents (mail, ghost,
64  * and directory) and also some metadata.
65  *
66  * There are two kinds of prefixes used in notmuch. There are the
67  * human friendly 'prefix names' like "thread:", which are also used
68  * in the query parser, and the actual prefix terms in the database
69  * (e.g. "G"). The correspondence is maintained in the file scope data
70  * structure 'prefix_table'.
71  *
72  * Mail document
73  * -------------
74  * A mail document is associated with a particular email message. It
75  * is stored in one or more files on disk and is uniquely identified
76  * by its "id" field (which is generally the message ID). It is
77  * indexed with the following prefixed terms which the database uses
78  * to construct threads, etc.:
79  *
80  *    Single terms of given prefix:
81  *
82  *      type:   mail
83  *
84  *      id:     Unique ID of mail. This is from the Message-ID header
85  *              if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
86  *              If it's present and too long, then we use
87  *              "notmuch-sha1-<sha1_sum_of_message_id>".
88  *              If this header is not present, we use
89  *              "notmuch-sha1-<sha1_sum_of_entire_file>".
90  *
91  *      thread: The ID of the thread to which the mail belongs
92  *
93  *      replyto: The ID from the In-Reply-To header of the mail (if any).
94  *
95  *    Multiple terms of given prefix:
96  *
97  *      reference: All message IDs from In-Reply-To and References
98  *                 headers in the message.
99  *
100  *      tag:       Any tags associated with this message by the user.
101  *
102  *      file-direntry:  A colon-separated pair of values
103  *                      (INTEGER:STRING), where INTEGER is the
104  *                      document ID of a directory document, and
105  *                      STRING is the name of a file within that
106  *                      directory for this mail message.
107  *
108  *      property:       Has a property with key=value
109  *                 FIXME: if no = is present, should match on any value
110  *
111  *    A mail document also has four values:
112  *
113  *      TIMESTAMP:      The time_t value corresponding to the message's
114  *                      Date header.
115  *
116  *      MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
117  *
118  *      FROM:           The value of the "From" header
119  *
120  *      SUBJECT:        The value of the "Subject" header
121  *
122  *      LAST_MOD:       The revision number as of the last tag or
123  *                      filename change.
124  *
125  * The prefixed terms described above are also searchable without an
126  * explicit field name, but as of notmuch 0.29 this is due to
127  * query-parser setup, not extra terms in the database.  In addition,
128  * terms from the content of the message are added without a prefix
129  * for use by the user in searching. Note that the prefix name "body"
130  * is used to refer to the empty prefix string in the database.
131  *
132  * The path of the containing folder is added with the "folder" prefix
133  * (see _notmuch_message_add_folder_terms).  Sub-paths of the the path
134  * of the mail message are added with the "path" prefix.
135  *
136  * The data portion of a mail document is empty.
137  *
138  * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
139  * -----------------------------------------------
140  * A ghost mail document is like a mail document, but where we don't
141  * have the message content.  These are used to track thread reference
142  * information for messages we haven't received.
143  *
144  * A ghost mail document has type: ghost; id and thread fields that
145  * are identical to the mail document fields; and a MESSAGE_ID value.
146  *
147  * Directory document
148  * ------------------
149  * A directory document is used by a client of the notmuch library to
150  * maintain data necessary to allow for efficient polling of mail
151  * directories.
152  *
153  * All directory documents contain one term:
154  *
155  *      directory:      The directory path (relative to the database path)
156  *                      Or the SHA1 sum of the directory path (if the
157  *                      path itself is too long to fit in a Xapian
158  *                      term).
159  *
160  * And all directory documents for directories other than top-level
161  * directories also contain the following term:
162  *
163  *      directory-direntry: A colon-separated pair of values
164  *                          (INTEGER:STRING), where INTEGER is the
165  *                          document ID of the parent directory
166  *                          document, and STRING is the name of this
167  *                          directory within that parent.
168  *
169  * All directory documents have a single value:
170  *
171  *      TIMESTAMP:      The mtime of the directory (at last scan)
172  *
173  * The data portion of a directory document contains the path of the
174  * directory (relative to the database path).
175  *
176  * Database metadata
177  * -----------------
178  * Xapian allows us to store arbitrary name-value pairs as
179  * "metadata". We currently use the following metadata names with the
180  * given meanings:
181  *
182  *      version         The database schema version, (which is distinct
183  *                      from both the notmuch package version (see
184  *                      notmuch --version) and the libnotmuch library
185  *                      version. The version is stored as an base-10
186  *                      ASCII integer. The initial database version
187  *                      was 1, (though a schema existed before that
188  *                      were no "version" database value existed at
189  *                      all). Successive versions are allocated as
190  *                      changes are made to the database (such as by
191  *                      indexing new fields).
192  *
193  *      features        The set of features supported by this
194  *                      database. This consists of a set of
195  *                      '\n'-separated lines, where each is a feature
196  *                      name, a '\t', and compatibility flags.  If the
197  *                      compatibility flags contain 'w', then the
198  *                      opener must support this feature to safely
199  *                      write this database.  If the compatibility
200  *                      flags contain 'r', then the opener must
201  *                      support this feature to read this database.
202  *                      Introduced in database version 3.
203  *
204  *      last_thread_id  The last thread ID generated. This is stored
205  *                      as a 16-byte hexadecimal ASCII representation
206  *                      of a 64-bit unsigned integer. The first ID
207  *                      generated is 1 and the value will be
208  *                      incremented for each thread ID.
209  *
210  *      C*              metadata keys starting with C indicate
211  *                      configuration data. It can be managed with the
212  *                      n_database_*config* API.  There is a convention
213  *                      of hierarchical keys separated by '.' (e.g.
214  *                      query.notmuch stores the value for the named
215  *                      query 'notmuch'), but it is not enforced by the
216  *                      API.
217  *
218  * Obsolete metadata
219  * -----------------
220  *
221  * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
222  * Instead, the database has the following additional database
223  * metadata:
224  *
225  *      thread_id_*     A pre-allocated thread ID for a particular
226  *                      message. This is actually an arbitrarily large
227  *                      family of metadata name. Any particular name is
228  *                      formed by concatenating "thread_id_" with a message
229  *                      ID (or the SHA1 sum of a message ID if it is very
230  *                      long---see description of 'id' in the mail
231  *                      document). The value stored is a thread ID.
232  *
233  *                      These thread ID metadata values are stored
234  *                      whenever a message references a parent message
235  *                      that does not yet exist in the database. A
236  *                      thread ID will be allocated and stored, and if
237  *                      the message is later added, the stored thread
238  *                      ID will be used (and the metadata value will
239  *                      be cleared).
240  *
241  *                      Even before a message is added, it's
242  *                      pre-allocated thread ID is useful so that all
243  *                      descendant messages that reference this common
244  *                      parent can be recognized as belonging to the
245  *                      same thread.
246  */
247
248 /* With these prefix values we follow the conventions published here:
249  *
250  * https://xapian.org/docs/omega/termprefixes.html
251  *
252  * as much as makes sense. Note that I took some liberty in matching
253  * the reserved prefix values to notmuch concepts, (for example, 'G'
254  * is documented as "newsGroup (or similar entity - e.g. a web forum
255  * name)", for which I think the thread is the closest analogue in
256  * notmuch. This in spite of the fact that we will eventually be
257  * storing mailing-list messages where 'G' for "mailing list name"
258  * might be even a closer analogue. I'm treating the single-character
259  * prefixes preferentially for core notmuch concepts (which will be
260  * nearly universal to all mail messages).
261  */
262
263 static const
264 prefix_t prefix_table[] = {
265     /* name                     term prefix     flags */
266     { "type",                   "T",            NOTMUCH_FIELD_NO_FLAGS },
267     { "reference",              "XREFERENCE",   NOTMUCH_FIELD_NO_FLAGS },
268     { "replyto",                "XREPLYTO",     NOTMUCH_FIELD_NO_FLAGS },
269     { "directory",              "XDIRECTORY",   NOTMUCH_FIELD_NO_FLAGS },
270     { "file-direntry",          "XFDIRENTRY",   NOTMUCH_FIELD_NO_FLAGS },
271     { "directory-direntry",     "XDDIRENTRY",   NOTMUCH_FIELD_NO_FLAGS },
272     { "body",                   "",             NOTMUCH_FIELD_EXTERNAL |
273       NOTMUCH_FIELD_PROBABILISTIC },
274     { "thread",                 "G",            NOTMUCH_FIELD_EXTERNAL |
275       NOTMUCH_FIELD_PROCESSOR },
276     { "tag",                    "K",            NOTMUCH_FIELD_EXTERNAL |
277       NOTMUCH_FIELD_PROCESSOR },
278     { "is",                     "K",            NOTMUCH_FIELD_EXTERNAL |
279       NOTMUCH_FIELD_PROCESSOR },
280     { "id",                     "Q",            NOTMUCH_FIELD_EXTERNAL },
281     { "mid",                    "Q",            NOTMUCH_FIELD_EXTERNAL |
282       NOTMUCH_FIELD_PROCESSOR },
283     { "path",                   "P",            NOTMUCH_FIELD_EXTERNAL |
284       NOTMUCH_FIELD_PROCESSOR },
285     { "property",               "XPROPERTY",    NOTMUCH_FIELD_EXTERNAL },
286     /*
287      * Unconditionally add ':' to reduce potential ambiguity with
288      * overlapping prefixes and/or terms that start with capital
289      * letters. See Xapian document termprefixes.html for related
290      * discussion.
291      */
292     { "folder",                 "XFOLDER:",     NOTMUCH_FIELD_EXTERNAL |
293       NOTMUCH_FIELD_PROCESSOR },
294 #if HAVE_XAPIAN_FIELD_PROCESSOR
295     { "date",                   NULL,           NOTMUCH_FIELD_EXTERNAL |
296       NOTMUCH_FIELD_PROCESSOR },
297     { "query",                  NULL,           NOTMUCH_FIELD_EXTERNAL |
298       NOTMUCH_FIELD_PROCESSOR },
299 #endif
300     { "from",                   "XFROM",        NOTMUCH_FIELD_EXTERNAL |
301       NOTMUCH_FIELD_PROBABILISTIC |
302       NOTMUCH_FIELD_PROCESSOR },
303     { "to",                     "XTO",          NOTMUCH_FIELD_EXTERNAL |
304       NOTMUCH_FIELD_PROBABILISTIC },
305     { "attachment",             "XATTACHMENT",  NOTMUCH_FIELD_EXTERNAL |
306       NOTMUCH_FIELD_PROBABILISTIC },
307     { "mimetype",               "XMIMETYPE",    NOTMUCH_FIELD_EXTERNAL |
308       NOTMUCH_FIELD_PROBABILISTIC },
309     { "subject",                "XSUBJECT",     NOTMUCH_FIELD_EXTERNAL |
310       NOTMUCH_FIELD_PROBABILISTIC |
311       NOTMUCH_FIELD_PROCESSOR },
312 };
313
314 static void
315 _setup_query_field_default (const prefix_t *prefix, notmuch_database_t *notmuch)
316 {
317     if (prefix->prefix)
318         notmuch->query_parser->add_prefix ("", prefix->prefix);
319     if (prefix->flags & NOTMUCH_FIELD_PROBABILISTIC)
320         notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
321     else
322         notmuch->query_parser->add_boolean_prefix (prefix->name, prefix->prefix);
323 }
324
325 notmuch_string_map_iterator_t *
326 _notmuch_database_user_headers (notmuch_database_t *notmuch)
327 {
328     return _notmuch_string_map_iterator_create (notmuch->user_header, "", false);
329 }
330
331 const char *
332 _user_prefix (void *ctx, const char *name)
333 {
334     return talloc_asprintf (ctx, "XU%s:", name);
335 }
336
337 static notmuch_status_t
338 _setup_user_query_fields (notmuch_database_t *notmuch)
339 {
340     notmuch_config_list_t *list;
341     notmuch_status_t status;
342
343     notmuch->user_prefix = _notmuch_string_map_create (notmuch);
344     if (notmuch->user_prefix == NULL)
345         return NOTMUCH_STATUS_OUT_OF_MEMORY;
346
347     notmuch->user_header = _notmuch_string_map_create (notmuch);
348     if (notmuch->user_header == NULL)
349         return NOTMUCH_STATUS_OUT_OF_MEMORY;
350
351     status = notmuch_database_get_config_list (notmuch, CONFIG_HEADER_PREFIX, &list);
352     if (status)
353         return status;
354
355     for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
356
357         prefix_t query_field;
358
359         const char *key = notmuch_config_list_key (list)
360                           + sizeof (CONFIG_HEADER_PREFIX) - 1;
361
362         _notmuch_string_map_append (notmuch->user_prefix,
363                                     key,
364                                     _user_prefix (notmuch, key));
365
366         _notmuch_string_map_append (notmuch->user_header,
367                                     key,
368                                     notmuch_config_list_value (list));
369
370         query_field.name = talloc_strdup (notmuch, key);
371         query_field.prefix = _user_prefix (notmuch, key);
372         query_field.flags = NOTMUCH_FIELD_PROBABILISTIC
373                             | NOTMUCH_FIELD_EXTERNAL;
374
375         _setup_query_field_default (&query_field, notmuch);
376     }
377
378     notmuch_config_list_destroy (list);
379
380     return NOTMUCH_STATUS_SUCCESS;
381 }
382
383 #if HAVE_XAPIAN_FIELD_PROCESSOR
384 static void
385 _setup_query_field (const prefix_t *prefix, notmuch_database_t *notmuch)
386 {
387     if (prefix->flags & NOTMUCH_FIELD_PROCESSOR) {
388         Xapian::FieldProcessor *fp;
389
390         if (STRNCMP_LITERAL (prefix->name, "date") == 0)
391             fp = (new DateFieldProcessor ())->release ();
392         else if (STRNCMP_LITERAL (prefix->name, "query") == 0)
393             fp = (new QueryFieldProcessor (*notmuch->query_parser, notmuch))->release ();
394         else if (STRNCMP_LITERAL (prefix->name, "thread") == 0)
395             fp = (new ThreadFieldProcessor (*notmuch->query_parser, notmuch))->release ();
396         else
397             fp = (new RegexpFieldProcessor (prefix->name, prefix->flags,
398                                             *notmuch->query_parser, notmuch))->release ();
399
400         /* we treat all field-processor fields as boolean in order to get the raw input */
401         if (prefix->prefix)
402             notmuch->query_parser->add_prefix ("", prefix->prefix);
403         notmuch->query_parser->add_boolean_prefix (prefix->name, fp);
404     } else {
405         _setup_query_field_default (prefix, notmuch);
406     }
407 }
408 #else
409 static inline void
410 _setup_query_field (const prefix_t *prefix, notmuch_database_t *notmuch)
411 {
412     _setup_query_field_default (prefix, notmuch);
413 }
414 #endif
415
416 const char *
417 _find_prefix (const char *name)
418 {
419     unsigned int i;
420
421     for (i = 0; i < ARRAY_SIZE (prefix_table); i++) {
422         if (strcmp (name, prefix_table[i].name) == 0)
423             return prefix_table[i].prefix;
424     }
425
426     INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
427
428     return "";
429 }
430
431 /* Like find prefix, but include the possibility of user defined
432  * prefixes specific to this database */
433
434 const char *
435 _notmuch_database_prefix (notmuch_database_t *notmuch, const char *name)
436 {
437     unsigned int i;
438
439     /*XXX TODO: reduce code duplication */
440     for (i = 0; i < ARRAY_SIZE (prefix_table); i++) {
441         if (strcmp (name, prefix_table[i].name) == 0)
442             return prefix_table[i].prefix;
443     }
444
445     if (notmuch->user_prefix)
446         return _notmuch_string_map_get (notmuch->user_prefix, name);
447
448     return NULL;
449 }
450
451 static const struct {
452     /* NOTMUCH_FEATURE_* value. */
453     _notmuch_features value;
454     /* Feature name as it appears in the database.  This name should
455      * be appropriate for displaying to the user if an older version
456      * of notmuch doesn't support this feature. */
457     const char *name;
458     /* Compatibility flags when this feature is declared. */
459     const char *flags;
460 } feature_names[] = {
461     { NOTMUCH_FEATURE_FILE_TERMS,
462       "multiple paths per message", "rw" },
463     { NOTMUCH_FEATURE_DIRECTORY_DOCS,
464       "relative directory paths", "rw" },
465     /* Header values are not required for reading a database because a
466      * reader can just refer to the message file. */
467     { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
468       "from/subject/message-ID in database", "w" },
469     { NOTMUCH_FEATURE_BOOL_FOLDER,
470       "exact folder:/path: search", "rw" },
471     { NOTMUCH_FEATURE_GHOSTS,
472       "mail documents for missing messages", "w" },
473     /* Knowledge of the index mime-types are not required for reading
474      * a database because a reader will just be unable to query
475      * them. */
476     { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
477       "indexed MIME types", "w" },
478     { NOTMUCH_FEATURE_LAST_MOD,
479       "modification tracking", "w" },
480     /* Existing databases will work fine for all queries not involving
481      * 'body:' */
482     { NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY,
483       "index body and headers separately", "w" },
484 };
485
486 const char *
487 notmuch_status_to_string (notmuch_status_t status)
488 {
489     switch (status) {
490     case NOTMUCH_STATUS_SUCCESS:
491         return "No error occurred";
492     case NOTMUCH_STATUS_OUT_OF_MEMORY:
493         return "Out of memory";
494     case NOTMUCH_STATUS_READ_ONLY_DATABASE:
495         return "Attempt to write to a read-only database";
496     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
497         return "A Xapian exception occurred";
498     case NOTMUCH_STATUS_FILE_ERROR:
499         return "Something went wrong trying to read or write a file";
500     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
501         return "File is not an email";
502     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
503         return "Message ID is identical to a message in database";
504     case NOTMUCH_STATUS_NULL_POINTER:
505         return "Erroneous NULL pointer";
506     case NOTMUCH_STATUS_TAG_TOO_LONG:
507         return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
508     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
509         return "Unbalanced number of calls to notmuch_message_freeze/thaw";
510     case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
511         return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
512     case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
513         return "Unsupported operation";
514     case NOTMUCH_STATUS_UPGRADE_REQUIRED:
515         return "Operation requires a database upgrade";
516     case NOTMUCH_STATUS_PATH_ERROR:
517         return "Path supplied is illegal for this function";
518     case NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL:
519         return "Crypto protocol missing, malformed, or unintelligible";
520     case NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION:
521         return "Crypto engine initialization failure";
522     case NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL:
523         return "Unknown crypto protocol";
524     default:
525     case NOTMUCH_STATUS_LAST_STATUS:
526         return "Unknown error status value";
527     }
528 }
529
530 void
531 _notmuch_database_log (notmuch_database_t *notmuch,
532                        const char *format,
533                        ...)
534 {
535     va_list va_args;
536
537     va_start (va_args, format);
538
539     if (notmuch->status_string)
540         talloc_free (notmuch->status_string);
541
542     notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
543     va_end (va_args);
544 }
545
546 void
547 _notmuch_database_log_append (notmuch_database_t *notmuch,
548                               const char *format,
549                               ...)
550 {
551     va_list va_args;
552
553     va_start (va_args, format);
554
555     if (notmuch->status_string)
556         notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
557     else
558         notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
559
560     va_end (va_args);
561 }
562
563 static void
564 find_doc_ids_for_term (notmuch_database_t *notmuch,
565                        const char *term,
566                        Xapian::PostingIterator *begin,
567                        Xapian::PostingIterator *end)
568 {
569     *begin = notmuch->xapian_db->postlist_begin (term);
570
571     *end = notmuch->xapian_db->postlist_end (term);
572 }
573
574 void
575 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
576                                 const char *prefix_name,
577                                 const char *value,
578                                 Xapian::PostingIterator *begin,
579                                 Xapian::PostingIterator *end)
580 {
581     char *term;
582
583     term = talloc_asprintf (notmuch, "%s%s",
584                             _find_prefix (prefix_name), value);
585
586     find_doc_ids_for_term (notmuch, term, begin, end);
587
588     talloc_free (term);
589 }
590
591 notmuch_private_status_t
592 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
593                                       const char *prefix_name,
594                                       const char *value,
595                                       unsigned int *doc_id)
596 {
597     Xapian::PostingIterator i, end;
598
599     _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
600
601     if (i == end) {
602         *doc_id = 0;
603         return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
604     }
605
606     *doc_id = *i;
607
608 #if DEBUG_DATABASE_SANITY
609     i++;
610
611     if (i != end)
612         INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
613                         prefix_name, value);
614 #endif
615
616     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
617 }
618
619 static Xapian::Document
620 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
621 {
622     return notmuch->xapian_db->get_document (doc_id);
623 }
624
625 /* Generate a compressed version of 'message_id' of the form:
626  *
627  *      notmuch-sha1-<sha1_sum_of_message_id>
628  */
629 char *
630 _notmuch_message_id_compressed (void *ctx, const char *message_id)
631 {
632     char *sha1, *compressed;
633
634     sha1 = _notmuch_sha1_of_string (message_id);
635
636     compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
637     free (sha1);
638
639     return compressed;
640 }
641
642 notmuch_status_t
643 notmuch_database_find_message (notmuch_database_t *notmuch,
644                                const char *message_id,
645                                notmuch_message_t **message_ret)
646 {
647     notmuch_private_status_t status;
648     unsigned int doc_id;
649
650     if (message_ret == NULL)
651         return NOTMUCH_STATUS_NULL_POINTER;
652
653     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
654         message_id = _notmuch_message_id_compressed (notmuch, message_id);
655
656     try {
657         status = _notmuch_database_find_unique_doc_id (notmuch, "id",
658                                                        message_id, &doc_id);
659
660         if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
661             *message_ret = NULL;
662         else {
663             *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
664                                                     NULL);
665             if (*message_ret == NULL)
666                 return NOTMUCH_STATUS_OUT_OF_MEMORY;
667         }
668
669         return NOTMUCH_STATUS_SUCCESS;
670     } catch (const Xapian::Error &error) {
671         _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
672                                error.get_msg ().c_str ());
673         notmuch->exception_reported = true;
674         *message_ret = NULL;
675         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
676     }
677 }
678
679 notmuch_status_t
680 notmuch_database_create (const char *path, notmuch_database_t **database)
681 {
682     char *status_string = NULL;
683     notmuch_status_t status;
684
685     status = notmuch_database_create_verbose (path, database,
686                                               &status_string);
687
688     if (status_string) {
689         fputs (status_string, stderr);
690         free (status_string);
691     }
692
693     return status;
694 }
695
696 notmuch_status_t
697 notmuch_database_create_verbose (const char *path,
698                                  notmuch_database_t **database,
699                                  char **status_string)
700 {
701     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
702     notmuch_database_t *notmuch = NULL;
703     char *notmuch_path = NULL;
704     char *message = NULL;
705     struct stat st;
706     int err;
707
708     if (path == NULL) {
709         message = strdup ("Error: Cannot create a database for a NULL path.\n");
710         status = NOTMUCH_STATUS_NULL_POINTER;
711         goto DONE;
712     }
713
714     if (path[0] != '/') {
715         message = strdup ("Error: Database path must be absolute.\n");
716         status = NOTMUCH_STATUS_PATH_ERROR;
717         goto DONE;
718     }
719
720     err = stat (path, &st);
721     if (err) {
722         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
723                                  path, strerror (errno)));
724         status = NOTMUCH_STATUS_FILE_ERROR;
725         goto DONE;
726     }
727
728     if (! S_ISDIR (st.st_mode)) {
729         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
730                                  "Not a directory.\n",
731                                  path));
732         status = NOTMUCH_STATUS_FILE_ERROR;
733         goto DONE;
734     }
735
736     notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
737
738     err = mkdir (notmuch_path, 0755);
739
740     if (err) {
741         IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
742                                  notmuch_path, strerror (errno)));
743         status = NOTMUCH_STATUS_FILE_ERROR;
744         goto DONE;
745     }
746
747     status = notmuch_database_open_verbose (path,
748                                             NOTMUCH_DATABASE_MODE_READ_WRITE,
749                                             &notmuch, &message);
750     if (status)
751         goto DONE;
752
753     /* Upgrade doesn't add these feature to existing databases, but
754      * new databases have them. */
755     notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
756     notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
757     notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
758
759     status = notmuch_database_upgrade (notmuch, NULL, NULL);
760     if (status) {
761         notmuch_database_close (notmuch);
762         notmuch = NULL;
763     }
764
765   DONE:
766     if (notmuch_path)
767         talloc_free (notmuch_path);
768
769     if (message) {
770         if (status_string)
771             *status_string = message;
772         else
773             free (message);
774     }
775     if (database)
776         *database = notmuch;
777     else
778         talloc_free (notmuch);
779     return status;
780 }
781
782 notmuch_status_t
783 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
784 {
785     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
786         _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
787         return NOTMUCH_STATUS_READ_ONLY_DATABASE;
788     }
789
790     return NOTMUCH_STATUS_SUCCESS;
791 }
792
793 /* Allocate a revision number for the next change. */
794 unsigned long
795 _notmuch_database_new_revision (notmuch_database_t *notmuch)
796 {
797     unsigned long new_revision = notmuch->revision + 1;
798
799     /* If we're in an atomic section, hold off on updating the
800      * committed revision number until we commit the atomic section.
801      */
802     if (notmuch->atomic_nesting)
803         notmuch->atomic_dirty = true;
804     else
805         notmuch->revision = new_revision;
806
807     return new_revision;
808 }
809
810 /* Parse a database features string from the given database version.
811  * Returns the feature bit set.
812  *
813  * For version < 3, this ignores the features string and returns a
814  * hard-coded set of features.
815  *
816  * If there are unrecognized features that are required to open the
817  * database in mode (which should be 'r' or 'w'), return a
818  * comma-separated list of unrecognized but required features in
819  * *incompat_out suitable for presenting to the user.  *incompat_out
820  * will be allocated from ctx.
821  */
822 static _notmuch_features
823 _parse_features (const void *ctx, const char *features, unsigned int version,
824                  char mode, char **incompat_out)
825 {
826     _notmuch_features res = static_cast<_notmuch_features>(0);
827     unsigned int namelen, i;
828     size_t llen = 0;
829     const char *flags;
830
831     /* Prior to database version 3, features were implied by the
832      * version number. */
833     if (version == 0)
834         return NOTMUCH_FEATURES_V0;
835     else if (version == 1)
836         return NOTMUCH_FEATURES_V1;
837     else if (version == 2)
838         return NOTMUCH_FEATURES_V2;
839
840     /* Parse the features string */
841     while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
842         flags = strchr (features, '\t');
843         if (! flags || flags > features + llen)
844             continue;
845         namelen = flags - features;
846
847         for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
848             if (strlen (feature_names[i].name) == namelen &&
849                 strncmp (feature_names[i].name, features, namelen) == 0) {
850                 res |= feature_names[i].value;
851                 break;
852             }
853         }
854
855         if (i == ARRAY_SIZE (feature_names) && incompat_out) {
856             /* Unrecognized feature */
857             const char *have = strchr (flags, mode);
858             if (have && have < features + llen) {
859                 /* This feature is required to access this database in
860                  * 'mode', but we don't understand it. */
861                 if (! *incompat_out)
862                     *incompat_out = talloc_strdup (ctx, "");
863                 *incompat_out = talloc_asprintf_append_buffer (
864                     *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
865                     namelen, features);
866             }
867         }
868     }
869
870     return res;
871 }
872
873 static char *
874 _print_features (const void *ctx, unsigned int features)
875 {
876     unsigned int i;
877     char *res = talloc_strdup (ctx, "");
878
879     for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
880         if (features & feature_names[i].value)
881             res = talloc_asprintf_append_buffer (
882                 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
883
884     return res;
885 }
886
887 notmuch_status_t
888 notmuch_database_open (const char *path,
889                        notmuch_database_mode_t mode,
890                        notmuch_database_t **database)
891 {
892     char *status_string = NULL;
893     notmuch_status_t status;
894
895     status = notmuch_database_open_verbose (path, mode, database,
896                                             &status_string);
897
898     if (status_string) {
899         fputs (status_string, stderr);
900         free (status_string);
901     }
902
903     return status;
904 }
905
906 notmuch_status_t
907 notmuch_database_open_verbose (const char *path,
908                                notmuch_database_mode_t mode,
909                                notmuch_database_t **database,
910                                char **status_string)
911 {
912     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
913     void *local = talloc_new (NULL);
914     notmuch_database_t *notmuch = NULL;
915     char *notmuch_path, *xapian_path, *incompat_features;
916     char *message = NULL;
917     struct stat st;
918     int err;
919     unsigned int i, version;
920     static int initialized = 0;
921
922     if (path == NULL) {
923         message = strdup ("Error: Cannot open a database for a NULL path.\n");
924         status = NOTMUCH_STATUS_NULL_POINTER;
925         goto DONE;
926     }
927
928     if (path[0] != '/') {
929         message = strdup ("Error: Database path must be absolute.\n");
930         status = NOTMUCH_STATUS_PATH_ERROR;
931         goto DONE;
932     }
933
934     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
935         message = strdup ("Out of memory\n");
936         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
937         goto DONE;
938     }
939
940     err = stat (notmuch_path, &st);
941     if (err) {
942         IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
943                                  notmuch_path, strerror (errno)));
944         status = NOTMUCH_STATUS_FILE_ERROR;
945         goto DONE;
946     }
947
948     if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
949         message = strdup ("Out of memory\n");
950         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
951         goto DONE;
952     }
953
954     /* Initialize the GLib type system and threads */
955 #if ! GLIB_CHECK_VERSION (2, 35, 1)
956     g_type_init ();
957 #endif
958
959     /* Initialize gmime */
960     if (! initialized) {
961         g_mime_init ();
962         initialized = 1;
963     }
964
965     notmuch = talloc_zero (NULL, notmuch_database_t);
966     notmuch->exception_reported = false;
967     notmuch->status_string = NULL;
968     notmuch->path = talloc_strdup (notmuch, path);
969
970     strip_trailing (notmuch->path, '/');
971
972     notmuch->mode = mode;
973     notmuch->atomic_nesting = 0;
974     notmuch->view = 1;
975     try {
976         string last_thread_id;
977         string last_mod;
978
979         if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
980             notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
981                                                                DB_ACTION);
982         } else {
983             notmuch->xapian_db = new Xapian::Database (xapian_path);
984         }
985
986         /* Check version.  As of database version 3, we represent
987          * changes in terms of features, so assume a version bump
988          * means a dramatically incompatible change. */
989         version = notmuch_database_get_version (notmuch);
990         if (version > NOTMUCH_DATABASE_VERSION) {
991             IGNORE_RESULT (asprintf (&message,
992                                      "Error: Notmuch database at %s\n"
993                                      "       has a newer database format version (%u) than supported by this\n"
994                                      "       version of notmuch (%u).\n",
995                                      notmuch_path, version, NOTMUCH_DATABASE_VERSION));
996             notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
997             notmuch_database_destroy (notmuch);
998             notmuch = NULL;
999             status = NOTMUCH_STATUS_FILE_ERROR;
1000             goto DONE;
1001         }
1002
1003         /* Check features. */
1004         incompat_features = NULL;
1005         notmuch->features = _parse_features (
1006             local, notmuch->xapian_db->get_metadata ("features").c_str (),
1007             version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
1008             &incompat_features);
1009         if (incompat_features) {
1010             IGNORE_RESULT (asprintf (&message,
1011                                      "Error: Notmuch database at %s\n"
1012                                      "       requires features (%s)\n"
1013                                      "       not supported by this version of notmuch.\n",
1014                                      notmuch_path, incompat_features));
1015             notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1016             notmuch_database_destroy (notmuch);
1017             notmuch = NULL;
1018             status = NOTMUCH_STATUS_FILE_ERROR;
1019             goto DONE;
1020         }
1021
1022         notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
1023         last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
1024         if (last_thread_id.empty ()) {
1025             notmuch->last_thread_id = 0;
1026         } else {
1027             const char *str;
1028             char *end;
1029
1030             str = last_thread_id.c_str ();
1031             notmuch->last_thread_id = strtoull (str, &end, 16);
1032             if (*end != '\0')
1033                 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
1034         }
1035
1036         /* Get current highest revision number. */
1037         last_mod = notmuch->xapian_db->get_value_upper_bound (
1038             NOTMUCH_VALUE_LAST_MOD);
1039         if (last_mod.empty ())
1040             notmuch->revision = 0;
1041         else
1042             notmuch->revision = Xapian::sortable_unserialise (last_mod);
1043         notmuch->uuid = talloc_strdup (
1044             notmuch, notmuch->xapian_db->get_uuid ().c_str ());
1045
1046         notmuch->query_parser = new Xapian::QueryParser;
1047         notmuch->term_gen = new Xapian::TermGenerator;
1048         notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
1049         notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1050         notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1051         notmuch->last_mod_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
1052
1053         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
1054         notmuch->query_parser->set_database (*notmuch->xapian_db);
1055         notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
1056         notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
1057         notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
1058         notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
1059         notmuch->query_parser->add_valuerangeprocessor (notmuch->last_mod_range_processor);
1060
1061         for (i = 0; i < ARRAY_SIZE (prefix_table); i++) {
1062             const prefix_t *prefix = &prefix_table[i];
1063             if (prefix->flags & NOTMUCH_FIELD_EXTERNAL) {
1064                 _setup_query_field (prefix, notmuch);
1065             }
1066         }
1067         status = _setup_user_query_fields (notmuch);
1068     } catch (const Xapian::Error &error) {
1069         IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
1070                                  error.get_msg ().c_str ()));
1071         notmuch_database_destroy (notmuch);
1072         notmuch = NULL;
1073         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1074     }
1075
1076   DONE:
1077     talloc_free (local);
1078
1079     if (message) {
1080         if (status_string)
1081             *status_string = message;
1082         else
1083             free (message);
1084     }
1085
1086     if (database)
1087         *database = notmuch;
1088     else
1089         talloc_free (notmuch);
1090     return status;
1091 }
1092
1093 notmuch_status_t
1094 notmuch_database_close (notmuch_database_t *notmuch)
1095 {
1096     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1097
1098     /* Many Xapian objects (and thus notmuch objects) hold references to
1099      * the database, so merely deleting the database may not suffice to
1100      * close it.  Thus, we explicitly close it here. */
1101     if (notmuch->xapian_db != NULL) {
1102         try {
1103             /* If there's an outstanding transaction, it's unclear if
1104              * closing the Xapian database commits everything up to
1105              * that transaction, or may discard committed (but
1106              * unflushed) transactions.  To be certain, explicitly
1107              * cancel any outstanding transaction before closing. */
1108             if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1109                 notmuch->atomic_nesting)
1110                 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1111                 ->cancel_transaction ();
1112
1113             /* Close the database.  This implicitly flushes
1114              * outstanding changes. */
1115             notmuch->xapian_db->close ();
1116         } catch (const Xapian::Error &error) {
1117             status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1118             if (! notmuch->exception_reported) {
1119                 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1120                                        error.get_msg ().c_str ());
1121             }
1122         }
1123     }
1124
1125     delete notmuch->term_gen;
1126     notmuch->term_gen = NULL;
1127     delete notmuch->query_parser;
1128     notmuch->query_parser = NULL;
1129     delete notmuch->xapian_db;
1130     notmuch->xapian_db = NULL;
1131     delete notmuch->value_range_processor;
1132     notmuch->value_range_processor = NULL;
1133     delete notmuch->date_range_processor;
1134     notmuch->date_range_processor = NULL;
1135     delete notmuch->last_mod_range_processor;
1136     notmuch->last_mod_range_processor = NULL;
1137
1138     return status;
1139 }
1140
1141 notmuch_status_t
1142 _notmuch_database_reopen (notmuch_database_t *notmuch)
1143 {
1144     if (notmuch->mode != NOTMUCH_DATABASE_MODE_READ_ONLY)
1145         return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1146
1147     try {
1148         notmuch->xapian_db->reopen ();
1149     } catch (const Xapian::Error &error) {
1150         if (! notmuch->exception_reported) {
1151             _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
1152                                    error.get_msg ().c_str ());
1153             notmuch->exception_reported = true;
1154         }
1155         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1156     }
1157
1158     notmuch->view++;
1159
1160     return NOTMUCH_STATUS_SUCCESS;
1161 }
1162
1163 static int
1164 unlink_cb (const char *path,
1165            unused (const struct stat *sb),
1166            unused (int type),
1167            unused (struct FTW *ftw))
1168 {
1169     return remove (path);
1170 }
1171
1172 static int
1173 rmtree (const char *path)
1174 {
1175     return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1176 }
1177
1178 class NotmuchCompactor : public Xapian::Compactor
1179 {
1180     notmuch_compact_status_cb_t status_cb;
1181     void *status_closure;
1182
1183 public:
1184     NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1185         status_cb (cb), status_closure (closure)
1186     {
1187     }
1188
1189     virtual void
1190     set_status (const std::string &table, const std::string &status)
1191     {
1192         char *msg;
1193
1194         if (status_cb == NULL)
1195             return;
1196
1197         if (status.length () == 0)
1198             msg = talloc_asprintf (NULL, "compacting table %s", table.c_str ());
1199         else
1200             msg = talloc_asprintf (NULL, "     %s", status.c_str ());
1201
1202         if (msg == NULL) {
1203             return;
1204         }
1205
1206         status_cb (msg, status_closure);
1207         talloc_free (msg);
1208     }
1209 };
1210
1211 /* Compacts the given database, optionally saving the original database
1212  * in backup_path. Additionally, a callback function can be provided to
1213  * give the user feedback on the progress of the (likely long-lived)
1214  * compaction process.
1215  *
1216  * The backup path must point to a directory on the same volume as the
1217  * original database. Passing a NULL backup_path will result in the
1218  * uncompacted database being deleted after compaction has finished.
1219  * Note that the database write lock will be held during the
1220  * compaction process to protect data integrity.
1221  */
1222 notmuch_status_t
1223 notmuch_database_compact (const char *path,
1224                           const char *backup_path,
1225                           notmuch_compact_status_cb_t status_cb,
1226                           void *closure)
1227 {
1228     void *local;
1229     char *notmuch_path, *xapian_path, *compact_xapian_path;
1230     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1231     notmuch_database_t *notmuch = NULL;
1232     struct stat statbuf;
1233     bool keep_backup;
1234     char *message = NULL;
1235
1236     local = talloc_new (NULL);
1237     if (! local)
1238         return NOTMUCH_STATUS_OUT_OF_MEMORY;
1239
1240     ret = notmuch_database_open_verbose (path,
1241                                          NOTMUCH_DATABASE_MODE_READ_WRITE,
1242                                          &notmuch,
1243                                          &message);
1244     if (ret) {
1245         if (status_cb) status_cb (message, closure);
1246         goto DONE;
1247     }
1248
1249     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1250         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1251         goto DONE;
1252     }
1253
1254     if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1255         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1256         goto DONE;
1257     }
1258
1259     if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1260         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1261         goto DONE;
1262     }
1263
1264     if (backup_path == NULL) {
1265         if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1266             ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1267             goto DONE;
1268         }
1269         keep_backup = false;
1270     } else {
1271         keep_backup = true;
1272     }
1273
1274     if (stat (backup_path, &statbuf) != -1) {
1275         _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1276         ret = NOTMUCH_STATUS_FILE_ERROR;
1277         goto DONE;
1278     }
1279     if (errno != ENOENT) {
1280         _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1281                                strerror (errno));
1282         ret = NOTMUCH_STATUS_FILE_ERROR;
1283         goto DONE;
1284     }
1285
1286     /* Unconditionally attempt to remove old work-in-progress database (if
1287      * any). This is "protected" by database lock. If this fails due to write
1288      * errors (etc), the following code will fail and provide error message.
1289      */
1290     (void) rmtree (compact_xapian_path);
1291
1292     try {
1293         NotmuchCompactor compactor (status_cb, closure);
1294
1295         compactor.set_renumber (false);
1296         compactor.add_source (xapian_path);
1297         compactor.set_destdir (compact_xapian_path);
1298         compactor.compact ();
1299     } catch (const Xapian::Error &error) {
1300         _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg ().c_str ());
1301         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1302         goto DONE;
1303     }
1304
1305     if (rename (xapian_path, backup_path)) {
1306         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1307                                xapian_path, backup_path, strerror (errno));
1308         ret = NOTMUCH_STATUS_FILE_ERROR;
1309         goto DONE;
1310     }
1311
1312     if (rename (compact_xapian_path, xapian_path)) {
1313         _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1314                                compact_xapian_path, xapian_path, strerror (errno));
1315         ret = NOTMUCH_STATUS_FILE_ERROR;
1316         goto DONE;
1317     }
1318
1319     if (! keep_backup) {
1320         if (rmtree (backup_path)) {
1321             _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1322                                    backup_path, strerror (errno));
1323             ret = NOTMUCH_STATUS_FILE_ERROR;
1324             goto DONE;
1325         }
1326     }
1327
1328   DONE:
1329     if (notmuch) {
1330         notmuch_status_t ret2;
1331
1332         const char *str = notmuch_database_status_string (notmuch);
1333         if (status_cb && str)
1334             status_cb (str, closure);
1335
1336         ret2 = notmuch_database_destroy (notmuch);
1337
1338         /* don't clobber previous error status */
1339         if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1340             ret = ret2;
1341     }
1342
1343     talloc_free (local);
1344
1345     return ret;
1346 }
1347
1348 notmuch_status_t
1349 notmuch_database_destroy (notmuch_database_t *notmuch)
1350 {
1351     notmuch_status_t status;
1352
1353     status = notmuch_database_close (notmuch);
1354     talloc_free (notmuch);
1355
1356     return status;
1357 }
1358
1359 const char *
1360 notmuch_database_get_path (notmuch_database_t *notmuch)
1361 {
1362     return notmuch->path;
1363 }
1364
1365 unsigned int
1366 notmuch_database_get_version (notmuch_database_t *notmuch)
1367 {
1368     unsigned int version;
1369     string version_string;
1370     const char *str;
1371     char *end;
1372
1373     version_string = notmuch->xapian_db->get_metadata ("version");
1374     if (version_string.empty ())
1375         return 0;
1376
1377     str = version_string.c_str ();
1378     if (str == NULL || *str == '\0')
1379         return 0;
1380
1381     version = strtoul (str, &end, 10);
1382     if (*end != '\0')
1383         INTERNAL_ERROR ("Malformed database version: %s", str);
1384
1385     return version;
1386 }
1387
1388 notmuch_bool_t
1389 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1390 {
1391     return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1392            ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1393             (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1394 }
1395
1396 static volatile sig_atomic_t do_progress_notify = 0;
1397
1398 static void
1399 handle_sigalrm (unused (int signal))
1400 {
1401     do_progress_notify = 1;
1402 }
1403
1404 /* Upgrade the current database.
1405  *
1406  * After opening a database in read-write mode, the client should
1407  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1408  * if so, upgrade with this function before making any modifications.
1409  *
1410  * The optional progress_notify callback can be used by the caller to
1411  * provide progress indication to the user. If non-NULL it will be
1412  * called periodically with 'count' as the number of messages upgraded
1413  * so far and 'total' the overall number of messages that will be
1414  * converted.
1415  */
1416 notmuch_status_t
1417 notmuch_database_upgrade (notmuch_database_t *notmuch,
1418                           void (*progress_notify)(void *closure,
1419                                                   double progress),
1420                           void *closure)
1421 {
1422     void *local = talloc_new (NULL);
1423     Xapian::TermIterator t, t_end;
1424     Xapian::WritableDatabase *db;
1425     struct sigaction action;
1426     struct itimerval timerval;
1427     bool timer_is_active = false;
1428     enum _notmuch_features target_features, new_features;
1429     notmuch_status_t status;
1430     notmuch_private_status_t private_status;
1431     notmuch_query_t *query = NULL;
1432     unsigned int count = 0, total = 0;
1433
1434     status = _notmuch_database_ensure_writable (notmuch);
1435     if (status)
1436         return status;
1437
1438     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1439
1440     target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1441     new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1442
1443     if (! notmuch_database_needs_upgrade (notmuch))
1444         return NOTMUCH_STATUS_SUCCESS;
1445
1446     if (progress_notify) {
1447         /* Set up our handler for SIGALRM */
1448         memset (&action, 0, sizeof (struct sigaction));
1449         action.sa_handler = handle_sigalrm;
1450         sigemptyset (&action.sa_mask);
1451         action.sa_flags = SA_RESTART;
1452         sigaction (SIGALRM, &action, NULL);
1453
1454         /* Then start a timer to send SIGALRM once per second. */
1455         timerval.it_interval.tv_sec = 1;
1456         timerval.it_interval.tv_usec = 0;
1457         timerval.it_value.tv_sec = 1;
1458         timerval.it_value.tv_usec = 0;
1459         setitimer (ITIMER_REAL, &timerval, NULL);
1460
1461         timer_is_active = true;
1462     }
1463
1464     /* Figure out how much total work we need to do. */
1465     if (new_features &
1466         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1467          NOTMUCH_FEATURE_LAST_MOD)) {
1468         query = notmuch_query_create (notmuch, "");
1469         unsigned msg_count;
1470
1471         status = notmuch_query_count_messages (query, &msg_count);
1472         if (status)
1473             goto DONE;
1474
1475         total += msg_count;
1476         notmuch_query_destroy (query);
1477         query = NULL;
1478     }
1479     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1480         t_end = db->allterms_end ("XTIMESTAMP");
1481         for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1482             ++total;
1483     }
1484     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1485         /* The ghost message upgrade converts all thread_id_*
1486          * metadata values into ghost message documents. */
1487         t_end = db->metadata_keys_end ("thread_id_");
1488         for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1489             ++total;
1490     }
1491
1492     /* Perform the upgrade in a transaction. */
1493     db->begin_transaction (true);
1494
1495     /* Set the target features so we write out changes in the desired
1496      * format. */
1497     notmuch->features = target_features;
1498
1499     /* Perform per-message upgrades. */
1500     if (new_features &
1501         (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1502          NOTMUCH_FEATURE_LAST_MOD)) {
1503         notmuch_messages_t *messages;
1504         notmuch_message_t *message;
1505         char *filename;
1506
1507         query = notmuch_query_create (notmuch, "");
1508
1509         status = notmuch_query_search_messages (query, &messages);
1510         if (status)
1511             goto DONE;
1512         for (;
1513              notmuch_messages_valid (messages);
1514              notmuch_messages_move_to_next (messages)) {
1515             if (do_progress_notify) {
1516                 progress_notify (closure, (double) count / total);
1517                 do_progress_notify = 0;
1518             }
1519
1520             message = notmuch_messages_get (messages);
1521
1522             /* Before version 1, each message document had its
1523              * filename in the data field. Copy that into the new
1524              * format by calling notmuch_message_add_filename.
1525              */
1526             if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1527                 filename = _notmuch_message_talloc_copy_data (message);
1528                 if (filename && *filename != '\0') {
1529                     _notmuch_message_add_filename (message, filename);
1530                     _notmuch_message_clear_data (message);
1531                 }
1532                 talloc_free (filename);
1533             }
1534
1535             /* Prior to version 2, the "folder:" prefix was
1536              * probabilistic and stemmed. Change it to the current
1537              * boolean prefix. Add "path:" prefixes while at it.
1538              */
1539             if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1540                 _notmuch_message_upgrade_folder (message);
1541
1542             /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
1543              * track modification revisions.  Give all messages the
1544              * next available revision; since we just started tracking
1545              * revisions for this database, that will be 1.
1546              */
1547             if (new_features & NOTMUCH_FEATURE_LAST_MOD)
1548                 _notmuch_message_upgrade_last_mod (message);
1549
1550             _notmuch_message_sync (message);
1551
1552             notmuch_message_destroy (message);
1553
1554             count++;
1555         }
1556
1557         notmuch_query_destroy (query);
1558         query = NULL;
1559     }
1560
1561     /* Perform per-directory upgrades. */
1562
1563     /* Before version 1 we stored directory timestamps in
1564      * XTIMESTAMP documents instead of the current XDIRECTORY
1565      * documents. So copy those as well. */
1566     if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1567         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1568
1569         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1570              t != t_end;
1571              t++) {
1572             Xapian::PostingIterator p, p_end;
1573             std::string term = *t;
1574
1575             p_end = notmuch->xapian_db->postlist_end (term);
1576
1577             for (p = notmuch->xapian_db->postlist_begin (term);
1578                  p != p_end;
1579                  p++) {
1580                 Xapian::Document document;
1581                 time_t mtime;
1582                 notmuch_directory_t *directory;
1583
1584                 if (do_progress_notify) {
1585                     progress_notify (closure, (double) count / total);
1586                     do_progress_notify = 0;
1587                 }
1588
1589                 document = find_document_for_doc_id (notmuch, *p);
1590                 mtime = Xapian::sortable_unserialise (
1591                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1592
1593                 directory = _notmuch_directory_create (notmuch, term.c_str () + 10,
1594                                                        NOTMUCH_FIND_CREATE, &status);
1595                 notmuch_directory_set_mtime (directory, mtime);
1596                 notmuch_directory_destroy (directory);
1597
1598                 db->delete_document (*p);
1599             }
1600
1601             ++count;
1602         }
1603     }
1604
1605     /* Perform metadata upgrades. */
1606
1607     /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1608      * messages were stored as database metadata. Change these to
1609      * ghost messages.
1610      */
1611     if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1612         notmuch_message_t *message;
1613         std::string message_id, thread_id;
1614
1615         t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1616         for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1617              t != t_end; ++t) {
1618             if (do_progress_notify) {
1619                 progress_notify (closure, (double) count / total);
1620                 do_progress_notify = 0;
1621             }
1622
1623             message_id = (*t).substr (
1624                 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1625             thread_id = db->get_metadata (*t);
1626
1627             /* Create ghost message */
1628             message = _notmuch_message_create_for_message_id (
1629                 notmuch, message_id.c_str (), &private_status);
1630             if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1631                 /* Document already exists; ignore the stored thread ID */
1632             } else if (private_status ==
1633                        NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1634                 private_status = _notmuch_message_initialize_ghost (
1635                     message, thread_id.c_str ());
1636                 if (! private_status)
1637                     _notmuch_message_sync (message);
1638             }
1639
1640             if (private_status) {
1641                 _notmuch_database_log (notmuch,
1642                                        "Upgrade failed while creating ghost messages.\n");
1643                 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1644                 goto DONE;
1645             }
1646
1647             /* Clear saved metadata thread ID */
1648             db->set_metadata (*t, "");
1649
1650             ++count;
1651         }
1652     }
1653
1654     status = NOTMUCH_STATUS_SUCCESS;
1655     db->set_metadata ("features", _print_features (local, notmuch->features));
1656     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1657
1658   DONE:
1659     if (status == NOTMUCH_STATUS_SUCCESS)
1660         db->commit_transaction ();
1661     else
1662         db->cancel_transaction ();
1663
1664     if (timer_is_active) {
1665         /* Now stop the timer. */
1666         timerval.it_interval.tv_sec = 0;
1667         timerval.it_interval.tv_usec = 0;
1668         timerval.it_value.tv_sec = 0;
1669         timerval.it_value.tv_usec = 0;
1670         setitimer (ITIMER_REAL, &timerval, NULL);
1671
1672         /* And disable the signal handler. */
1673         action.sa_handler = SIG_IGN;
1674         sigaction (SIGALRM, &action, NULL);
1675     }
1676
1677     if (query)
1678         notmuch_query_destroy (query);
1679
1680     talloc_free (local);
1681     return status;
1682 }
1683
1684 notmuch_status_t
1685 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1686 {
1687     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1688         notmuch->atomic_nesting > 0)
1689         goto DONE;
1690
1691     if (notmuch_database_needs_upgrade (notmuch))
1692         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1693
1694     try {
1695         (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1696     } catch (const Xapian::Error &error) {
1697         _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1698                                error.get_msg ().c_str ());
1699         notmuch->exception_reported = true;
1700         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1701     }
1702
1703   DONE:
1704     notmuch->atomic_nesting++;
1705     return NOTMUCH_STATUS_SUCCESS;
1706 }
1707
1708 notmuch_status_t
1709 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1710 {
1711     Xapian::WritableDatabase *db;
1712
1713     if (notmuch->atomic_nesting == 0)
1714         return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1715
1716     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1717         notmuch->atomic_nesting > 1)
1718         goto DONE;
1719
1720     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1721     try {
1722         db->commit_transaction ();
1723
1724         /* This is a hack for testing.  Xapian never flushes on a
1725          * non-flushed commit, even if the flush threshold is 1.
1726          * However, we rely on flushing to test atomicity. */
1727         const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1728         if (thresh && atoi (thresh) == 1)
1729             db->commit ();
1730     } catch (const Xapian::Error &error) {
1731         _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1732                                error.get_msg ().c_str ());
1733         notmuch->exception_reported = true;
1734         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1735     }
1736
1737     if (notmuch->atomic_dirty) {
1738         ++notmuch->revision;
1739         notmuch->atomic_dirty = false;
1740     }
1741
1742   DONE:
1743     notmuch->atomic_nesting--;
1744     return NOTMUCH_STATUS_SUCCESS;
1745 }
1746
1747 unsigned long
1748 notmuch_database_get_revision (notmuch_database_t *notmuch,
1749                                const char **uuid)
1750 {
1751     if (uuid)
1752         *uuid = notmuch->uuid;
1753     return notmuch->revision;
1754 }
1755
1756 /* We allow the user to use arbitrarily long paths for directories. But
1757  * we have a term-length limit. So if we exceed that, we'll use the
1758  * SHA-1 of the path for the database term.
1759  *
1760  * Note: This function may return the original value of 'path'. If it
1761  * does not, then the caller is responsible to free() the returned
1762  * value.
1763  */
1764 const char *
1765 _notmuch_database_get_directory_db_path (const char *path)
1766 {
1767     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1768
1769     if (term_len > NOTMUCH_TERM_MAX)
1770         return _notmuch_sha1_of_string (path);
1771     else
1772         return path;
1773 }
1774
1775 /* Given a path, split it into two parts: the directory part is all
1776  * components except for the last, and the basename is that last
1777  * component. Getting the return-value for either part is optional
1778  * (the caller can pass NULL).
1779  *
1780  * The original 'path' can represent either a regular file or a
1781  * directory---the splitting will be carried out in the same way in
1782  * either case. Trailing slashes on 'path' will be ignored, and any
1783  * cases of multiple '/' characters appearing in series will be
1784  * treated as a single '/'.
1785  *
1786  * Allocation (if any) will have 'ctx' as the talloc owner. But
1787  * pointers will be returned within the original path string whenever
1788  * possible.
1789  *
1790  * Note: If 'path' is non-empty and contains no non-trailing slash,
1791  * (that is, consists of a filename with no parent directory), then
1792  * the directory returned will be an empty string. However, if 'path'
1793  * is an empty string, then both directory and basename will be
1794  * returned as NULL.
1795  */
1796 notmuch_status_t
1797 _notmuch_database_split_path (void *ctx,
1798                               const char *path,
1799                               const char **directory,
1800                               const char **basename)
1801 {
1802     const char *slash;
1803
1804     if (path == NULL || *path == '\0') {
1805         if (directory)
1806             *directory = NULL;
1807         if (basename)
1808             *basename = NULL;
1809         return NOTMUCH_STATUS_SUCCESS;
1810     }
1811
1812     /* Find the last slash (not counting a trailing slash), if any. */
1813
1814     slash = path + strlen (path) - 1;
1815
1816     /* First, skip trailing slashes. */
1817     while (slash != path && *slash == '/')
1818         --slash;
1819
1820     /* Then, find a slash. */
1821     while (slash != path && *slash != '/') {
1822         if (basename)
1823             *basename = slash;
1824
1825         --slash;
1826     }
1827
1828     /* Finally, skip multiple slashes. */
1829     while (slash != path && *(slash - 1) == '/')
1830         --slash;
1831
1832     if (slash == path) {
1833         if (directory)
1834             *directory = talloc_strdup (ctx, "");
1835         if (basename)
1836             *basename = path;
1837     } else {
1838         if (directory)
1839             *directory = talloc_strndup (ctx, path, slash - path);
1840     }
1841
1842     return NOTMUCH_STATUS_SUCCESS;
1843 }
1844
1845 /* Find the document ID of the specified directory.
1846  *
1847  * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1848  * created if one does not exist for 'path'.  Otherwise, if the
1849  * directory document does not exist, this sets *directory_id to
1850  * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1851  */
1852 notmuch_status_t
1853 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1854                                      const char *path,
1855                                      notmuch_find_flags_t flags,
1856                                      unsigned int *directory_id)
1857 {
1858     notmuch_directory_t *directory;
1859     notmuch_status_t status;
1860
1861     if (path == NULL) {
1862         *directory_id = 0;
1863         return NOTMUCH_STATUS_SUCCESS;
1864     }
1865
1866     directory = _notmuch_directory_create (notmuch, path, flags, &status);
1867     if (status || ! directory) {
1868         *directory_id = -1;
1869         return status;
1870     }
1871
1872     *directory_id = _notmuch_directory_get_document_id (directory);
1873
1874     notmuch_directory_destroy (directory);
1875
1876     return NOTMUCH_STATUS_SUCCESS;
1877 }
1878
1879 const char *
1880 _notmuch_database_get_directory_path (void *ctx,
1881                                       notmuch_database_t *notmuch,
1882                                       unsigned int doc_id)
1883 {
1884     Xapian::Document document;
1885
1886     document = find_document_for_doc_id (notmuch, doc_id);
1887
1888     return talloc_strdup (ctx, document.get_data ().c_str ());
1889 }
1890
1891 /* Given a legal 'filename' for the database, (either relative to
1892  * database path or absolute with initial components identical to
1893  * database path), return a new string (with 'ctx' as the talloc
1894  * owner) suitable for use as a direntry term value.
1895  *
1896  * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1897  * will be created in the database as needed.  Otherwise, if the
1898  * necessary directory documents do not exist, this sets
1899  * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1900  */
1901 notmuch_status_t
1902 _notmuch_database_filename_to_direntry (void *ctx,
1903                                         notmuch_database_t *notmuch,
1904                                         const char *filename,
1905                                         notmuch_find_flags_t flags,
1906                                         char **direntry)
1907 {
1908     const char *relative, *directory, *basename;
1909     Xapian::docid directory_id;
1910     notmuch_status_t status;
1911
1912     relative = _notmuch_database_relative_path (notmuch, filename);
1913
1914     status = _notmuch_database_split_path (ctx, relative,
1915                                            &directory, &basename);
1916     if (status)
1917         return status;
1918
1919     status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1920                                                   &directory_id);
1921     if (status || directory_id == (unsigned int) -1) {
1922         *direntry = NULL;
1923         return status;
1924     }
1925
1926     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1927
1928     return NOTMUCH_STATUS_SUCCESS;
1929 }
1930
1931 /* Given a legal 'path' for the database, return the relative path.
1932  *
1933  * The return value will be a pointer to the original path contents,
1934  * and will be either the original string (if 'path' was relative) or
1935  * a portion of the string (if path was absolute and begins with the
1936  * database path).
1937  */
1938 const char *
1939 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1940                                  const char *path)
1941 {
1942     const char *db_path, *relative;
1943     unsigned int db_path_len;
1944
1945     db_path = notmuch_database_get_path (notmuch);
1946     db_path_len = strlen (db_path);
1947
1948     relative = path;
1949
1950     if (*relative == '/') {
1951         while (*relative == '/' && *(relative + 1) == '/')
1952             relative++;
1953
1954         if (strncmp (relative, db_path, db_path_len) == 0) {
1955             relative += db_path_len;
1956             while (*relative == '/')
1957                 relative++;
1958         }
1959     }
1960
1961     return relative;
1962 }
1963
1964 notmuch_status_t
1965 notmuch_database_get_directory (notmuch_database_t *notmuch,
1966                                 const char *path,
1967                                 notmuch_directory_t **directory)
1968 {
1969     notmuch_status_t status;
1970
1971     if (directory == NULL)
1972         return NOTMUCH_STATUS_NULL_POINTER;
1973     *directory = NULL;
1974
1975     try {
1976         *directory = _notmuch_directory_create (notmuch, path,
1977                                                 NOTMUCH_FIND_LOOKUP, &status);
1978     } catch (const Xapian::Error &error) {
1979         _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1980                                error.get_msg ().c_str ());
1981         notmuch->exception_reported = true;
1982         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1983     }
1984     return status;
1985 }
1986
1987 /* Allocate a document ID that satisfies the following criteria:
1988  *
1989  * 1. The ID does not exist for any document in the Xapian database
1990  *
1991  * 2. The ID was not previously returned from this function
1992  *
1993  * 3. The ID is the smallest integer satisfying (1) and (2)
1994  *
1995  * This function will trigger an internal error if these constraints
1996  * cannot all be satisfied, (that is, the pool of available document
1997  * IDs has been exhausted).
1998  */
1999 unsigned int
2000 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
2001 {
2002     assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
2003
2004     notmuch->last_doc_id++;
2005
2006     if (notmuch->last_doc_id == 0)
2007         INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
2008
2009     return notmuch->last_doc_id;
2010 }
2011
2012 notmuch_status_t
2013 notmuch_database_remove_message (notmuch_database_t *notmuch,
2014                                  const char *filename)
2015 {
2016     notmuch_status_t status;
2017     notmuch_message_t *message;
2018
2019     status = notmuch_database_find_message_by_filename (notmuch, filename,
2020                                                         &message);
2021
2022     if (status == NOTMUCH_STATUS_SUCCESS && message) {
2023         status = _notmuch_message_remove_filename (message, filename);
2024         if (status == NOTMUCH_STATUS_SUCCESS)
2025             _notmuch_message_delete (message);
2026         else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2027             _notmuch_message_sync (message);
2028
2029         notmuch_message_destroy (message);
2030     }
2031
2032     return status;
2033 }
2034
2035 notmuch_status_t
2036 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2037                                            const char *filename,
2038                                            notmuch_message_t **message_ret)
2039 {
2040     void *local;
2041     const char *prefix = _find_prefix ("file-direntry");
2042     char *direntry, *term;
2043     Xapian::PostingIterator i, end;
2044     notmuch_status_t status;
2045
2046     if (message_ret == NULL)
2047         return NOTMUCH_STATUS_NULL_POINTER;
2048
2049     if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2050         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2051
2052     /* return NULL on any failure */
2053     *message_ret = NULL;
2054
2055     local = talloc_new (notmuch);
2056
2057     try {
2058         status = _notmuch_database_filename_to_direntry (
2059             local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2060         if (status || ! direntry)
2061             goto DONE;
2062
2063         term = talloc_asprintf (local, "%s%s", prefix, direntry);
2064
2065         find_doc_ids_for_term (notmuch, term, &i, &end);
2066
2067         if (i != end) {
2068             notmuch_private_status_t private_status;
2069
2070             *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2071                                                     &private_status);
2072             if (*message_ret == NULL)
2073                 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2074         }
2075     } catch (const Xapian::Error &error) {
2076         _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2077                                error.get_msg ().c_str ());
2078         notmuch->exception_reported = true;
2079         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2080     }
2081
2082   DONE:
2083     talloc_free (local);
2084
2085     if (status && *message_ret) {
2086         notmuch_message_destroy (*message_ret);
2087         *message_ret = NULL;
2088     }
2089     return status;
2090 }
2091
2092 notmuch_string_list_t *
2093 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2094                                          Xapian::TermIterator &end,
2095                                          const char *prefix)
2096 {
2097     int prefix_len = strlen (prefix);
2098     notmuch_string_list_t *list;
2099
2100     list = _notmuch_string_list_create (ctx);
2101     if (unlikely (list == NULL))
2102         return NULL;
2103
2104     for (i.skip_to (prefix); i != end; i++) {
2105         /* Terminate loop at first term without desired prefix. */
2106         if (strncmp ((*i).c_str (), prefix, prefix_len))
2107             break;
2108
2109         _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2110     }
2111
2112     return list;
2113 }
2114
2115 notmuch_tags_t *
2116 notmuch_database_get_all_tags (notmuch_database_t *db)
2117 {
2118     Xapian::TermIterator i, end;
2119     notmuch_string_list_t *tags;
2120
2121     try {
2122         i = db->xapian_db->allterms_begin ();
2123         end = db->xapian_db->allterms_end ();
2124         tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2125                                                         _find_prefix ("tag"));
2126         _notmuch_string_list_sort (tags);
2127         return _notmuch_tags_create (db, tags);
2128     } catch (const Xapian::Error &error) {
2129         _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2130                                error.get_msg ().c_str ());
2131         db->exception_reported = true;
2132         return NULL;
2133     }
2134 }
2135
2136 const char *
2137 notmuch_database_status_string (const notmuch_database_t *notmuch)
2138 {
2139     return notmuch->status_string;
2140 }