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