7a8702e263c46985bb21818d3f8dd039e39799d6
[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;
867     char *notmuch_path, *xapian_path, *compact_xapian_path;
868     char *old_xapian_path = NULL;
869     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
870     notmuch_database_t *notmuch = NULL;
871     struct stat statbuf;
872
873     local = talloc_new (NULL);
874     if (! local)
875         return NOTMUCH_STATUS_OUT_OF_MEMORY;
876
877     ret = notmuch_database_open(path, NOTMUCH_DATABASE_MODE_READ_WRITE, &notmuch);
878     if (ret) {
879         goto DONE;
880     }
881
882     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
883         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
884         goto DONE;
885     }
886
887     if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
888         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
889         goto DONE;
890     }
891
892     if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
893         ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
894         goto DONE;
895     }
896
897     if (backup_path != NULL) {
898         if (! (old_xapian_path = talloc_asprintf (local, "%s/xapian.old", backup_path))) {
899             ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
900             goto DONE;
901         }
902
903         if (stat(old_xapian_path, &statbuf) != -1) {
904             fprintf (stderr, "Backup path already exists: %s\n", old_xapian_path);
905             ret = NOTMUCH_STATUS_FILE_ERROR;
906             goto DONE;
907         }
908         if (errno != ENOENT) {
909             fprintf (stderr, "Unknown error while stat()ing backup path: %s\n",
910                      strerror(errno));
911             goto DONE;
912         }
913     }
914
915     try {
916         NotmuchCompactor compactor(status_cb);
917
918         compactor.set_renumber(false);
919         compactor.add_source(xapian_path);
920         compactor.set_destdir(compact_xapian_path);
921         compactor.compact();
922     } catch (Xapian::InvalidArgumentError e) {
923         fprintf (stderr, "Error while compacting: %s\n", e.get_msg().c_str());
924         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
925         goto DONE;
926     }
927
928     if (old_xapian_path != NULL) {
929         if (rename(xapian_path, old_xapian_path)) {
930             fprintf (stderr, "Error moving old database out of the way\n");
931             ret = NOTMUCH_STATUS_FILE_ERROR;
932             goto DONE;
933         }
934     } else {
935         rmtree(xapian_path);
936     }
937
938     if (rename(compact_xapian_path, xapian_path)) {
939         fprintf (stderr, "Error moving compacted database\n");
940         ret = NOTMUCH_STATUS_FILE_ERROR;
941         goto DONE;
942     }
943
944     notmuch_database_close(notmuch);
945
946 DONE:
947     talloc_free(local);
948     return ret;
949 }
950 #else
951 notmuch_status_t
952 notmuch_database_compact (unused (const char* path),
953                           unused (const char* backup_path),
954                           unused (notmuch_compact_status_cb_t status_cb))
955 {
956     fprintf (stderr, "notmuch was compiled against a xapian version lacking compaction support.\n");
957     return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
958 }
959 #endif
960
961 void
962 notmuch_database_destroy (notmuch_database_t *notmuch)
963 {
964     notmuch_database_close (notmuch);
965     talloc_free (notmuch);
966 }
967
968 const char *
969 notmuch_database_get_path (notmuch_database_t *notmuch)
970 {
971     return notmuch->path;
972 }
973
974 unsigned int
975 notmuch_database_get_version (notmuch_database_t *notmuch)
976 {
977     unsigned int version;
978     string version_string;
979     const char *str;
980     char *end;
981
982     version_string = notmuch->xapian_db->get_metadata ("version");
983     if (version_string.empty ())
984         return 0;
985
986     str = version_string.c_str ();
987     if (str == NULL || *str == '\0')
988         return 0;
989
990     version = strtoul (str, &end, 10);
991     if (*end != '\0')
992         INTERNAL_ERROR ("Malformed database version: %s", str);
993
994     return version;
995 }
996
997 notmuch_bool_t
998 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
999 {
1000     return notmuch->needs_upgrade;
1001 }
1002
1003 static volatile sig_atomic_t do_progress_notify = 0;
1004
1005 static void
1006 handle_sigalrm (unused (int signal))
1007 {
1008     do_progress_notify = 1;
1009 }
1010
1011 /* Upgrade the current database.
1012  *
1013  * After opening a database in read-write mode, the client should
1014  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1015  * if so, upgrade with this function before making any modifications.
1016  *
1017  * The optional progress_notify callback can be used by the caller to
1018  * provide progress indication to the user. If non-NULL it will be
1019  * called periodically with 'count' as the number of messages upgraded
1020  * so far and 'total' the overall number of messages that will be
1021  * converted.
1022  */
1023 notmuch_status_t
1024 notmuch_database_upgrade (notmuch_database_t *notmuch,
1025                           void (*progress_notify) (void *closure,
1026                                                    double progress),
1027                           void *closure)
1028 {
1029     Xapian::WritableDatabase *db;
1030     struct sigaction action;
1031     struct itimerval timerval;
1032     notmuch_bool_t timer_is_active = FALSE;
1033     unsigned int version;
1034     notmuch_status_t status;
1035     unsigned int count = 0, total = 0;
1036
1037     status = _notmuch_database_ensure_writable (notmuch);
1038     if (status)
1039         return status;
1040
1041     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1042
1043     version = notmuch_database_get_version (notmuch);
1044
1045     if (version >= NOTMUCH_DATABASE_VERSION)
1046         return NOTMUCH_STATUS_SUCCESS;
1047
1048     if (progress_notify) {
1049         /* Setup our handler for SIGALRM */
1050         memset (&action, 0, sizeof (struct sigaction));
1051         action.sa_handler = handle_sigalrm;
1052         sigemptyset (&action.sa_mask);
1053         action.sa_flags = SA_RESTART;
1054         sigaction (SIGALRM, &action, NULL);
1055
1056         /* Then start a timer to send SIGALRM once per second. */
1057         timerval.it_interval.tv_sec = 1;
1058         timerval.it_interval.tv_usec = 0;
1059         timerval.it_value.tv_sec = 1;
1060         timerval.it_value.tv_usec = 0;
1061         setitimer (ITIMER_REAL, &timerval, NULL);
1062
1063         timer_is_active = TRUE;
1064     }
1065
1066     /* Before version 1, each message document had its filename in the
1067      * data field. Copy that into the new format by calling
1068      * notmuch_message_add_filename.
1069      */
1070     if (version < 1) {
1071         notmuch_query_t *query = notmuch_query_create (notmuch, "");
1072         notmuch_messages_t *messages;
1073         notmuch_message_t *message;
1074         char *filename;
1075         Xapian::TermIterator t, t_end;
1076
1077         total = notmuch_query_count_messages (query);
1078
1079         for (messages = notmuch_query_search_messages (query);
1080              notmuch_messages_valid (messages);
1081              notmuch_messages_move_to_next (messages))
1082         {
1083             if (do_progress_notify) {
1084                 progress_notify (closure, (double) count / total);
1085                 do_progress_notify = 0;
1086             }
1087
1088             message = notmuch_messages_get (messages);
1089
1090             filename = _notmuch_message_talloc_copy_data (message);
1091             if (filename && *filename != '\0') {
1092                 _notmuch_message_add_filename (message, filename);
1093                 _notmuch_message_sync (message);
1094             }
1095             talloc_free (filename);
1096
1097             notmuch_message_destroy (message);
1098
1099             count++;
1100         }
1101
1102         notmuch_query_destroy (query);
1103
1104         /* Also, before version 1 we stored directory timestamps in
1105          * XTIMESTAMP documents instead of the current XDIRECTORY
1106          * documents. So copy those as well. */
1107
1108         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1109
1110         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1111              t != t_end;
1112              t++)
1113         {
1114             Xapian::PostingIterator p, p_end;
1115             std::string term = *t;
1116
1117             p_end = notmuch->xapian_db->postlist_end (term);
1118
1119             for (p = notmuch->xapian_db->postlist_begin (term);
1120                  p != p_end;
1121                  p++)
1122             {
1123                 Xapian::Document document;
1124                 time_t mtime;
1125                 notmuch_directory_t *directory;
1126
1127                 if (do_progress_notify) {
1128                     progress_notify (closure, (double) count / total);
1129                     do_progress_notify = 0;
1130                 }
1131
1132                 document = find_document_for_doc_id (notmuch, *p);
1133                 mtime = Xapian::sortable_unserialise (
1134                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1135
1136                 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1137                                                        NOTMUCH_FIND_CREATE, &status);
1138                 notmuch_directory_set_mtime (directory, mtime);
1139                 notmuch_directory_destroy (directory);
1140             }
1141         }
1142     }
1143
1144     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1145     db->flush ();
1146
1147     /* Now that the upgrade is complete we can remove the old data
1148      * and documents that are no longer needed. */
1149     if (version < 1) {
1150         notmuch_query_t *query = notmuch_query_create (notmuch, "");
1151         notmuch_messages_t *messages;
1152         notmuch_message_t *message;
1153         char *filename;
1154
1155         for (messages = notmuch_query_search_messages (query);
1156              notmuch_messages_valid (messages);
1157              notmuch_messages_move_to_next (messages))
1158         {
1159             if (do_progress_notify) {
1160                 progress_notify (closure, (double) count / total);
1161                 do_progress_notify = 0;
1162             }
1163
1164             message = notmuch_messages_get (messages);
1165
1166             filename = _notmuch_message_talloc_copy_data (message);
1167             if (filename && *filename != '\0') {
1168                 _notmuch_message_clear_data (message);
1169                 _notmuch_message_sync (message);
1170             }
1171             talloc_free (filename);
1172
1173             notmuch_message_destroy (message);
1174         }
1175
1176         notmuch_query_destroy (query);
1177     }
1178
1179     if (version < 1) {
1180         Xapian::TermIterator t, t_end;
1181
1182         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1183
1184         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1185              t != t_end;
1186              t++)
1187         {
1188             Xapian::PostingIterator p, p_end;
1189             std::string term = *t;
1190
1191             p_end = notmuch->xapian_db->postlist_end (term);
1192
1193             for (p = notmuch->xapian_db->postlist_begin (term);
1194                  p != p_end;
1195                  p++)
1196             {
1197                 if (do_progress_notify) {
1198                     progress_notify (closure, (double) count / total);
1199                     do_progress_notify = 0;
1200                 }
1201
1202                 db->delete_document (*p);
1203             }
1204         }
1205     }
1206
1207     if (timer_is_active) {
1208         /* Now stop the timer. */
1209         timerval.it_interval.tv_sec = 0;
1210         timerval.it_interval.tv_usec = 0;
1211         timerval.it_value.tv_sec = 0;
1212         timerval.it_value.tv_usec = 0;
1213         setitimer (ITIMER_REAL, &timerval, NULL);
1214
1215         /* And disable the signal handler. */
1216         action.sa_handler = SIG_IGN;
1217         sigaction (SIGALRM, &action, NULL);
1218     }
1219
1220     return NOTMUCH_STATUS_SUCCESS;
1221 }
1222
1223 notmuch_status_t
1224 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1225 {
1226     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1227         notmuch->atomic_nesting > 0)
1228         goto DONE;
1229
1230     try {
1231         (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1232     } catch (const Xapian::Error &error) {
1233         fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
1234                  error.get_msg().c_str());
1235         notmuch->exception_reported = TRUE;
1236         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1237     }
1238
1239 DONE:
1240     notmuch->atomic_nesting++;
1241     return NOTMUCH_STATUS_SUCCESS;
1242 }
1243
1244 notmuch_status_t
1245 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1246 {
1247     Xapian::WritableDatabase *db;
1248
1249     if (notmuch->atomic_nesting == 0)
1250         return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1251
1252     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1253         notmuch->atomic_nesting > 1)
1254         goto DONE;
1255
1256     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1257     try {
1258         db->commit_transaction ();
1259
1260         /* This is a hack for testing.  Xapian never flushes on a
1261          * non-flushed commit, even if the flush threshold is 1.
1262          * However, we rely on flushing to test atomicity. */
1263         const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1264         if (thresh && atoi (thresh) == 1)
1265             db->flush ();
1266     } catch (const Xapian::Error &error) {
1267         fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1268                  error.get_msg().c_str());
1269         notmuch->exception_reported = TRUE;
1270         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1271     }
1272
1273 DONE:
1274     notmuch->atomic_nesting--;
1275     return NOTMUCH_STATUS_SUCCESS;
1276 }
1277
1278 /* We allow the user to use arbitrarily long paths for directories. But
1279  * we have a term-length limit. So if we exceed that, we'll use the
1280  * SHA-1 of the path for the database term.
1281  *
1282  * Note: This function may return the original value of 'path'. If it
1283  * does not, then the caller is responsible to free() the returned
1284  * value.
1285  */
1286 const char *
1287 _notmuch_database_get_directory_db_path (const char *path)
1288 {
1289     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1290
1291     if (term_len > NOTMUCH_TERM_MAX)
1292         return notmuch_sha1_of_string (path);
1293     else
1294         return path;
1295 }
1296
1297 /* Given a path, split it into two parts: the directory part is all
1298  * components except for the last, and the basename is that last
1299  * component. Getting the return-value for either part is optional
1300  * (the caller can pass NULL).
1301  *
1302  * The original 'path' can represent either a regular file or a
1303  * directory---the splitting will be carried out in the same way in
1304  * either case. Trailing slashes on 'path' will be ignored, and any
1305  * cases of multiple '/' characters appearing in series will be
1306  * treated as a single '/'.
1307  *
1308  * Allocation (if any) will have 'ctx' as the talloc owner. But
1309  * pointers will be returned within the original path string whenever
1310  * possible.
1311  *
1312  * Note: If 'path' is non-empty and contains no non-trailing slash,
1313  * (that is, consists of a filename with no parent directory), then
1314  * the directory returned will be an empty string. However, if 'path'
1315  * is an empty string, then both directory and basename will be
1316  * returned as NULL.
1317  */
1318 notmuch_status_t
1319 _notmuch_database_split_path (void *ctx,
1320                               const char *path,
1321                               const char **directory,
1322                               const char **basename)
1323 {
1324     const char *slash;
1325
1326     if (path == NULL || *path == '\0') {
1327         if (directory)
1328             *directory = NULL;
1329         if (basename)
1330             *basename = NULL;
1331         return NOTMUCH_STATUS_SUCCESS;
1332     }
1333
1334     /* Find the last slash (not counting a trailing slash), if any. */
1335
1336     slash = path + strlen (path) - 1;
1337
1338     /* First, skip trailing slashes. */
1339     while (slash != path) {
1340         if (*slash != '/')
1341             break;
1342
1343         --slash;
1344     }
1345
1346     /* Then, find a slash. */
1347     while (slash != path) {
1348         if (*slash == '/')
1349             break;
1350
1351         if (basename)
1352             *basename = slash;
1353
1354         --slash;
1355     }
1356
1357     /* Finally, skip multiple slashes. */
1358     while (slash != path) {
1359         if (*slash != '/')
1360             break;
1361
1362         --slash;
1363     }
1364
1365     if (slash == path) {
1366         if (directory)
1367             *directory = talloc_strdup (ctx, "");
1368         if (basename)
1369             *basename = path;
1370     } else {
1371         if (directory)
1372             *directory = talloc_strndup (ctx, path, slash - path + 1);
1373     }
1374
1375     return NOTMUCH_STATUS_SUCCESS;
1376 }
1377
1378 /* Find the document ID of the specified directory.
1379  *
1380  * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1381  * created if one does not exist for 'path'.  Otherwise, if the
1382  * directory document does not exist, this sets *directory_id to
1383  * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1384  */
1385 notmuch_status_t
1386 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1387                                      const char *path,
1388                                      notmuch_find_flags_t flags,
1389                                      unsigned int *directory_id)
1390 {
1391     notmuch_directory_t *directory;
1392     notmuch_status_t status;
1393
1394     if (path == NULL) {
1395         *directory_id = 0;
1396         return NOTMUCH_STATUS_SUCCESS;
1397     }
1398
1399     directory = _notmuch_directory_create (notmuch, path, flags, &status);
1400     if (status || !directory) {
1401         *directory_id = -1;
1402         return status;
1403     }
1404
1405     *directory_id = _notmuch_directory_get_document_id (directory);
1406
1407     notmuch_directory_destroy (directory);
1408
1409     return NOTMUCH_STATUS_SUCCESS;
1410 }
1411
1412 const char *
1413 _notmuch_database_get_directory_path (void *ctx,
1414                                       notmuch_database_t *notmuch,
1415                                       unsigned int doc_id)
1416 {
1417     Xapian::Document document;
1418
1419     document = find_document_for_doc_id (notmuch, doc_id);
1420
1421     return talloc_strdup (ctx, document.get_data ().c_str ());
1422 }
1423
1424 /* Given a legal 'filename' for the database, (either relative to
1425  * database path or absolute with initial components identical to
1426  * database path), return a new string (with 'ctx' as the talloc
1427  * owner) suitable for use as a direntry term value.
1428  *
1429  * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1430  * will be created in the database as needed.  Otherwise, if the
1431  * necessary directory documents do not exist, this sets
1432  * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1433  */
1434 notmuch_status_t
1435 _notmuch_database_filename_to_direntry (void *ctx,
1436                                         notmuch_database_t *notmuch,
1437                                         const char *filename,
1438                                         notmuch_find_flags_t flags,
1439                                         char **direntry)
1440 {
1441     const char *relative, *directory, *basename;
1442     Xapian::docid directory_id;
1443     notmuch_status_t status;
1444
1445     relative = _notmuch_database_relative_path (notmuch, filename);
1446
1447     status = _notmuch_database_split_path (ctx, relative,
1448                                            &directory, &basename);
1449     if (status)
1450         return status;
1451
1452     status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1453                                                   &directory_id);
1454     if (status || directory_id == (unsigned int)-1) {
1455         *direntry = NULL;
1456         return status;
1457     }
1458
1459     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1460
1461     return NOTMUCH_STATUS_SUCCESS;
1462 }
1463
1464 /* Given a legal 'path' for the database, return the relative path.
1465  *
1466  * The return value will be a pointer to the original path contents,
1467  * and will be either the original string (if 'path' was relative) or
1468  * a portion of the string (if path was absolute and begins with the
1469  * database path).
1470  */
1471 const char *
1472 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1473                                  const char *path)
1474 {
1475     const char *db_path, *relative;
1476     unsigned int db_path_len;
1477
1478     db_path = notmuch_database_get_path (notmuch);
1479     db_path_len = strlen (db_path);
1480
1481     relative = path;
1482
1483     if (*relative == '/') {
1484         while (*relative == '/' && *(relative+1) == '/')
1485             relative++;
1486
1487         if (strncmp (relative, db_path, db_path_len) == 0)
1488         {
1489             relative += db_path_len;
1490             while (*relative == '/')
1491                 relative++;
1492         }
1493     }
1494
1495     return relative;
1496 }
1497
1498 notmuch_status_t
1499 notmuch_database_get_directory (notmuch_database_t *notmuch,
1500                                 const char *path,
1501                                 notmuch_directory_t **directory)
1502 {
1503     notmuch_status_t status;
1504
1505     if (directory == NULL)
1506         return NOTMUCH_STATUS_NULL_POINTER;
1507     *directory = NULL;
1508
1509     try {
1510         *directory = _notmuch_directory_create (notmuch, path,
1511                                                 NOTMUCH_FIND_LOOKUP, &status);
1512     } catch (const Xapian::Error &error) {
1513         fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1514                  error.get_msg().c_str());
1515         notmuch->exception_reported = TRUE;
1516         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1517     }
1518     return status;
1519 }
1520
1521 /* Allocate a document ID that satisfies the following criteria:
1522  *
1523  * 1. The ID does not exist for any document in the Xapian database
1524  *
1525  * 2. The ID was not previously returned from this function
1526  *
1527  * 3. The ID is the smallest integer satisfying (1) and (2)
1528  *
1529  * This function will trigger an internal error if these constraints
1530  * cannot all be satisfied, (that is, the pool of available document
1531  * IDs has been exhausted).
1532  */
1533 unsigned int
1534 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1535 {
1536     assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1537
1538     notmuch->last_doc_id++;
1539
1540     if (notmuch->last_doc_id == 0)
1541         INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");        
1542
1543     return notmuch->last_doc_id;
1544 }
1545
1546 static const char *
1547 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1548 {
1549     /* 16 bytes (+ terminator) for hexadecimal representation of
1550      * a 64-bit integer. */
1551     static char thread_id[17];
1552     Xapian::WritableDatabase *db;
1553
1554     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1555
1556     notmuch->last_thread_id++;
1557
1558     sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1559
1560     db->set_metadata ("last_thread_id", thread_id);
1561
1562     return thread_id;
1563 }
1564
1565 static char *
1566 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1567 {
1568     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1569         message_id = _message_id_compressed (ctx, message_id);
1570
1571     return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1572                             message_id);
1573 }
1574
1575 /* Find the thread ID to which the message with 'message_id' belongs.
1576  *
1577  * Note: 'thread_id_ret' must not be NULL!
1578  * On success '*thread_id_ret' is set to a newly talloced string belonging to
1579  * 'ctx'.
1580  *
1581  * Note: If there is no message in the database with the given
1582  * 'message_id' then a new thread_id will be allocated for this
1583  * message and stored in the database metadata, (where this same
1584  * thread ID can be looked up if the message is added to the database
1585  * later).
1586  */
1587 static notmuch_status_t
1588 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1589                                   void *ctx,
1590                                   const char *message_id,
1591                                   const char **thread_id_ret)
1592 {
1593     notmuch_status_t status;
1594     notmuch_message_t *message;
1595     string thread_id_string;
1596     char *metadata_key;
1597     Xapian::WritableDatabase *db;
1598
1599     status = notmuch_database_find_message (notmuch, message_id, &message);
1600
1601     if (status)
1602         return status;
1603
1604     if (message) {
1605         *thread_id_ret = talloc_steal (ctx,
1606                                        notmuch_message_get_thread_id (message));
1607
1608         notmuch_message_destroy (message);
1609
1610         return NOTMUCH_STATUS_SUCCESS;
1611     }
1612
1613     /* Message has not been seen yet.
1614      *
1615      * We may have seen a reference to it already, in which case, we
1616      * can return the thread ID stored in the metadata. Otherwise, we
1617      * generate a new thread ID and store it there.
1618      */
1619     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1620     metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1621     thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1622
1623     if (thread_id_string.empty()) {
1624         *thread_id_ret = talloc_strdup (ctx,
1625                                         _notmuch_database_generate_thread_id (notmuch));
1626         db->set_metadata (metadata_key, *thread_id_ret);
1627     } else {
1628         *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1629     }
1630
1631     talloc_free (metadata_key);
1632
1633     return NOTMUCH_STATUS_SUCCESS;
1634 }
1635
1636 static notmuch_status_t
1637 _merge_threads (notmuch_database_t *notmuch,
1638                 const char *winner_thread_id,
1639                 const char *loser_thread_id)
1640 {
1641     Xapian::PostingIterator loser, loser_end;
1642     notmuch_message_t *message = NULL;
1643     notmuch_private_status_t private_status;
1644     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1645
1646     find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1647
1648     for ( ; loser != loser_end; loser++) {
1649         message = _notmuch_message_create (notmuch, notmuch,
1650                                            *loser, &private_status);
1651         if (message == NULL) {
1652             ret = COERCE_STATUS (private_status,
1653                                  "Cannot find document for doc_id from query");
1654             goto DONE;
1655         }
1656
1657         _notmuch_message_remove_term (message, "thread", loser_thread_id);
1658         _notmuch_message_add_term (message, "thread", winner_thread_id);
1659         _notmuch_message_sync (message);
1660
1661         notmuch_message_destroy (message);
1662         message = NULL;
1663     }
1664
1665   DONE:
1666     if (message)
1667         notmuch_message_destroy (message);
1668
1669     return ret;
1670 }
1671
1672 static void
1673 _my_talloc_free_for_g_hash (void *ptr)
1674 {
1675     talloc_free (ptr);
1676 }
1677
1678 static notmuch_status_t
1679 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1680                                            notmuch_message_t *message,
1681                                            notmuch_message_file_t *message_file,
1682                                            const char **thread_id)
1683 {
1684     GHashTable *parents = NULL;
1685     const char *refs, *in_reply_to, *in_reply_to_message_id;
1686     const char *last_ref_message_id, *this_message_id;
1687     GList *l, *keys = NULL;
1688     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1689
1690     parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1691                                      _my_talloc_free_for_g_hash, NULL);
1692     this_message_id = notmuch_message_get_message_id (message);
1693
1694     refs = notmuch_message_file_get_header (message_file, "references");
1695     last_ref_message_id = parse_references (message,
1696                                             this_message_id,
1697                                             parents, refs);
1698
1699     in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1700     in_reply_to_message_id = parse_references (message,
1701                                                this_message_id,
1702                                                parents, in_reply_to);
1703
1704     /* For the parent of this message, use the last message ID of the
1705      * References header, if available.  If not, fall back to the
1706      * first message ID in the In-Reply-To header. */
1707     if (last_ref_message_id) {
1708         _notmuch_message_add_term (message, "replyto",
1709                                    last_ref_message_id);
1710     } else if (in_reply_to_message_id) {
1711         _notmuch_message_add_term (message, "replyto",
1712                              in_reply_to_message_id);
1713     }
1714
1715     keys = g_hash_table_get_keys (parents);
1716     for (l = keys; l; l = l->next) {
1717         char *parent_message_id;
1718         const char *parent_thread_id = NULL;
1719
1720         parent_message_id = (char *) l->data;
1721
1722         _notmuch_message_add_term (message, "reference",
1723                                    parent_message_id);
1724
1725         ret = _resolve_message_id_to_thread_id (notmuch,
1726                                                 message,
1727                                                 parent_message_id,
1728                                                 &parent_thread_id);
1729         if (ret)
1730             goto DONE;
1731
1732         if (*thread_id == NULL) {
1733             *thread_id = talloc_strdup (message, parent_thread_id);
1734             _notmuch_message_add_term (message, "thread", *thread_id);
1735         } else if (strcmp (*thread_id, parent_thread_id)) {
1736             ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1737             if (ret)
1738                 goto DONE;
1739         }
1740     }
1741
1742   DONE:
1743     if (keys)
1744         g_list_free (keys);
1745     if (parents)
1746         g_hash_table_unref (parents);
1747
1748     return ret;
1749 }
1750
1751 static notmuch_status_t
1752 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1753                                             notmuch_message_t *message,
1754                                             const char **thread_id)
1755 {
1756     const char *message_id = notmuch_message_get_message_id (message);
1757     Xapian::PostingIterator child, children_end;
1758     notmuch_message_t *child_message = NULL;
1759     const char *child_thread_id;
1760     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1761     notmuch_private_status_t private_status;
1762
1763     find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1764
1765     for ( ; child != children_end; child++) {
1766
1767         child_message = _notmuch_message_create (message, notmuch,
1768                                                  *child, &private_status);
1769         if (child_message == NULL) {
1770             ret = COERCE_STATUS (private_status,
1771                                  "Cannot find document for doc_id from query");
1772             goto DONE;
1773         }
1774
1775         child_thread_id = notmuch_message_get_thread_id (child_message);
1776         if (*thread_id == NULL) {
1777             *thread_id = talloc_strdup (message, child_thread_id);
1778             _notmuch_message_add_term (message, "thread", *thread_id);
1779         } else if (strcmp (*thread_id, child_thread_id)) {
1780             _notmuch_message_remove_term (child_message, "reference",
1781                                           message_id);
1782             _notmuch_message_sync (child_message);
1783             ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1784             if (ret)
1785                 goto DONE;
1786         }
1787
1788         notmuch_message_destroy (child_message);
1789         child_message = NULL;
1790     }
1791
1792   DONE:
1793     if (child_message)
1794         notmuch_message_destroy (child_message);
1795
1796     return ret;
1797 }
1798
1799 /* Given a (mostly empty) 'message' and its corresponding
1800  * 'message_file' link it to existing threads in the database.
1801  *
1802  * The first check is in the metadata of the database to see if we
1803  * have pre-allocated a thread_id in advance for this message, (which
1804  * would have happened if a message was previously added that
1805  * referenced this one).
1806  *
1807  * Second, we look at 'message_file' and its link-relevant headers
1808  * (References and In-Reply-To) for message IDs.
1809  *
1810  * Finally, we look in the database for existing message that
1811  * reference 'message'.
1812  *
1813  * In all cases, we assign to the current message the first thread_id
1814  * found (through either parent or child). We will also merge any
1815  * existing, distinct threads where this message belongs to both,
1816  * (which is not uncommon when messages are processed out of order).
1817  *
1818  * Finally, if no thread ID has been found through parent or child, we
1819  * call _notmuch_message_generate_thread_id to generate a new thread
1820  * ID. This should only happen for new, top-level messages, (no
1821  * References or In-Reply-To header in this message, and no previously
1822  * added message refers to this message).
1823  */
1824 static notmuch_status_t
1825 _notmuch_database_link_message (notmuch_database_t *notmuch,
1826                                 notmuch_message_t *message,
1827                                 notmuch_message_file_t *message_file)
1828 {
1829     notmuch_status_t status;
1830     const char *message_id, *thread_id = NULL;
1831     char *metadata_key;
1832     string stored_id;
1833
1834     message_id = notmuch_message_get_message_id (message);
1835     metadata_key = _get_metadata_thread_id_key (message, message_id);
1836
1837     /* Check if we have already seen related messages to this one.
1838      * If we have then use the thread_id that we stored at that time.
1839      */
1840     stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1841     if (! stored_id.empty()) {
1842         Xapian::WritableDatabase *db;
1843
1844         db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1845
1846         /* Clear the metadata for this message ID. We don't need it
1847          * anymore. */
1848         db->set_metadata (metadata_key, "");
1849         thread_id = stored_id.c_str();
1850
1851         _notmuch_message_add_term (message, "thread", thread_id);
1852     }
1853     talloc_free (metadata_key);
1854
1855     status = _notmuch_database_link_message_to_parents (notmuch, message,
1856                                                         message_file,
1857                                                         &thread_id);
1858     if (status)
1859         return status;
1860
1861     status = _notmuch_database_link_message_to_children (notmuch, message,
1862                                                          &thread_id);
1863     if (status)
1864         return status;
1865
1866     /* If not part of any existing thread, generate a new thread ID. */
1867     if (thread_id == NULL) {
1868         thread_id = _notmuch_database_generate_thread_id (notmuch);
1869
1870         _notmuch_message_add_term (message, "thread", thread_id);
1871     }
1872
1873     return NOTMUCH_STATUS_SUCCESS;
1874 }
1875
1876 notmuch_status_t
1877 notmuch_database_add_message (notmuch_database_t *notmuch,
1878                               const char *filename,
1879                               notmuch_message_t **message_ret)
1880 {
1881     notmuch_message_file_t *message_file;
1882     notmuch_message_t *message = NULL;
1883     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1884     notmuch_private_status_t private_status;
1885
1886     const char *date, *header;
1887     const char *from, *to, *subject;
1888     char *message_id = NULL;
1889
1890     if (message_ret)
1891         *message_ret = NULL;
1892
1893     ret = _notmuch_database_ensure_writable (notmuch);
1894     if (ret)
1895         return ret;
1896
1897     message_file = notmuch_message_file_open (filename);
1898     if (message_file == NULL)
1899         return NOTMUCH_STATUS_FILE_ERROR;
1900
1901     /* Adding a message may change many documents.  Do this all
1902      * atomically. */
1903     ret = notmuch_database_begin_atomic (notmuch);
1904     if (ret)
1905         goto DONE;
1906
1907     notmuch_message_file_restrict_headers (message_file,
1908                                            "date",
1909                                            "from",
1910                                            "in-reply-to",
1911                                            "message-id",
1912                                            "references",
1913                                            "subject",
1914                                            "to",
1915                                            (char *) NULL);
1916
1917     try {
1918         /* Before we do any real work, (especially before doing a
1919          * potential SHA-1 computation on the entire file's contents),
1920          * let's make sure that what we're looking at looks like an
1921          * actual email message.
1922          */
1923         from = notmuch_message_file_get_header (message_file, "from");
1924         subject = notmuch_message_file_get_header (message_file, "subject");
1925         to = notmuch_message_file_get_header (message_file, "to");
1926
1927         if ((from == NULL || *from == '\0') &&
1928             (subject == NULL || *subject == '\0') &&
1929             (to == NULL || *to == '\0'))
1930         {
1931             ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1932             goto DONE;
1933         }
1934
1935         /* Now that we're sure it's mail, the first order of business
1936          * is to find a message ID (or else create one ourselves). */
1937
1938         header = notmuch_message_file_get_header (message_file, "message-id");
1939         if (header && *header != '\0') {
1940             message_id = _parse_message_id (message_file, header, NULL);
1941
1942             /* So the header value isn't RFC-compliant, but it's
1943              * better than no message-id at all. */
1944             if (message_id == NULL)
1945                 message_id = talloc_strdup (message_file, header);
1946
1947             /* If a message ID is too long, substitute its sha1 instead. */
1948             if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1949                 char *compressed = _message_id_compressed (message_file,
1950                                                            message_id);
1951                 talloc_free (message_id);
1952                 message_id = compressed;
1953             }
1954         }
1955
1956         if (message_id == NULL ) {
1957             /* No message-id at all, let's generate one by taking a
1958              * hash over the file's contents. */
1959             char *sha1 = notmuch_sha1_of_file (filename);
1960
1961             /* If that failed too, something is really wrong. Give up. */
1962             if (sha1 == NULL) {
1963                 ret = NOTMUCH_STATUS_FILE_ERROR;
1964                 goto DONE;
1965             }
1966
1967             message_id = talloc_asprintf (message_file,
1968                                           "notmuch-sha1-%s", sha1);
1969             free (sha1);
1970         }
1971
1972         /* Now that we have a message ID, we get a message object,
1973          * (which may or may not reference an existing document in the
1974          * database). */
1975
1976         message = _notmuch_message_create_for_message_id (notmuch,
1977                                                           message_id,
1978                                                           &private_status);
1979
1980         talloc_free (message_id);
1981
1982         if (message == NULL) {
1983             ret = COERCE_STATUS (private_status,
1984                                  "Unexpected status value from _notmuch_message_create_for_message_id");
1985             goto DONE;
1986         }
1987
1988         _notmuch_message_add_filename (message, filename);
1989
1990         /* Is this a newly created message object? */
1991         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1992             _notmuch_message_add_term (message, "type", "mail");
1993
1994             ret = _notmuch_database_link_message (notmuch, message,
1995                                                   message_file);
1996             if (ret)
1997                 goto DONE;
1998
1999             date = notmuch_message_file_get_header (message_file, "date");
2000             _notmuch_message_set_header_values (message, date, from, subject);
2001
2002             ret = _notmuch_message_index_file (message, filename);
2003             if (ret)
2004                 goto DONE;
2005         } else {
2006             ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2007         }
2008
2009         _notmuch_message_sync (message);
2010     } catch (const Xapian::Error &error) {
2011         fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
2012                  error.get_msg().c_str());
2013         notmuch->exception_reported = TRUE;
2014         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2015         goto DONE;
2016     }
2017
2018   DONE:
2019     if (message) {
2020         if ((ret == NOTMUCH_STATUS_SUCCESS ||
2021              ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2022             *message_ret = message;
2023         else
2024             notmuch_message_destroy (message);
2025     }
2026
2027     if (message_file)
2028         notmuch_message_file_close (message_file);
2029
2030     ret2 = notmuch_database_end_atomic (notmuch);
2031     if ((ret == NOTMUCH_STATUS_SUCCESS ||
2032          ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2033         ret2 != NOTMUCH_STATUS_SUCCESS)
2034         ret = ret2;
2035
2036     return ret;
2037 }
2038
2039 notmuch_status_t
2040 notmuch_database_remove_message (notmuch_database_t *notmuch,
2041                                  const char *filename)
2042 {
2043     notmuch_status_t status;
2044     notmuch_message_t *message;
2045
2046     status = notmuch_database_find_message_by_filename (notmuch, filename,
2047                                                         &message);
2048
2049     if (status == NOTMUCH_STATUS_SUCCESS && message) {
2050             status = _notmuch_message_remove_filename (message, filename);
2051             if (status == NOTMUCH_STATUS_SUCCESS)
2052                 _notmuch_message_delete (message);
2053             else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2054                 _notmuch_message_sync (message);
2055
2056             notmuch_message_destroy (message);
2057     }
2058
2059     return status;
2060 }
2061
2062 notmuch_status_t
2063 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2064                                            const char *filename,
2065                                            notmuch_message_t **message_ret)
2066 {
2067     void *local;
2068     const char *prefix = _find_prefix ("file-direntry");
2069     char *direntry, *term;
2070     Xapian::PostingIterator i, end;
2071     notmuch_status_t status;
2072
2073     if (message_ret == NULL)
2074         return NOTMUCH_STATUS_NULL_POINTER;
2075
2076     /* return NULL on any failure */
2077     *message_ret = NULL;
2078
2079     local = talloc_new (notmuch);
2080
2081     try {
2082         status = _notmuch_database_filename_to_direntry (
2083             local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2084         if (status || !direntry)
2085             goto DONE;
2086
2087         term = talloc_asprintf (local, "%s%s", prefix, direntry);
2088
2089         find_doc_ids_for_term (notmuch, term, &i, &end);
2090
2091         if (i != end) {
2092             notmuch_private_status_t private_status;
2093
2094             *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2095                                                     &private_status);
2096             if (*message_ret == NULL)
2097                 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2098         }
2099     } catch (const Xapian::Error &error) {
2100         fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
2101                  error.get_msg().c_str());
2102         notmuch->exception_reported = TRUE;
2103         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2104     }
2105
2106   DONE:
2107     talloc_free (local);
2108
2109     if (status && *message_ret) {
2110         notmuch_message_destroy (*message_ret);
2111         *message_ret = NULL;
2112     }
2113     return status;
2114 }
2115
2116 notmuch_string_list_t *
2117 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2118                                          Xapian::TermIterator &end,
2119                                          const char *prefix)
2120 {
2121     int prefix_len = strlen (prefix);
2122     notmuch_string_list_t *list;
2123
2124     list = _notmuch_string_list_create (ctx);
2125     if (unlikely (list == NULL))
2126         return NULL;
2127
2128     for (i.skip_to (prefix); i != end; i++) {
2129         /* Terminate loop at first term without desired prefix. */
2130         if (strncmp ((*i).c_str (), prefix, prefix_len))
2131             break;
2132
2133         _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2134     }
2135
2136     return list;
2137 }
2138
2139 notmuch_tags_t *
2140 notmuch_database_get_all_tags (notmuch_database_t *db)
2141 {
2142     Xapian::TermIterator i, end;
2143     notmuch_string_list_t *tags;
2144
2145     try {
2146         i = db->xapian_db->allterms_begin();
2147         end = db->xapian_db->allterms_end();
2148         tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2149                                                         _find_prefix ("tag"));
2150         _notmuch_string_list_sort (tags);
2151         return _notmuch_tags_create (db, tags);
2152     } catch (const Xapian::Error &error) {
2153         fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
2154                  error.get_msg().c_str());
2155         db->exception_reported = TRUE;
2156         return NULL;
2157     }
2158 }