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