Prevent segmentation fault in notmuch_database_close
[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     void *local = talloc_new (NULL);
586     notmuch_database_t *notmuch = NULL;
587     char *notmuch_path, *xapian_path;
588     struct stat st;
589     int err;
590     unsigned int i, version;
591     static int initialized = 0;
592
593     if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
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 (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
606         fprintf (stderr, "Out of memory\n");
607         goto DONE;
608     }
609
610     /* Initialize the GLib type system and threads */
611     g_type_init ();
612
613     /* Initialize gmime */
614     if (! initialized) {
615         g_mime_init (0);
616         initialized = 1;
617     }
618
619     notmuch = talloc_zero (NULL, notmuch_database_t);
620     notmuch->exception_reported = FALSE;
621     notmuch->path = talloc_strdup (notmuch, path);
622
623     if (notmuch->path[strlen (notmuch->path) - 1] == '/')
624         notmuch->path[strlen (notmuch->path) - 1] = '\0';
625
626     notmuch->needs_upgrade = FALSE;
627     notmuch->mode = mode;
628     notmuch->atomic_nesting = 0;
629     try {
630         string last_thread_id;
631
632         if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
633             notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
634                                                                Xapian::DB_CREATE_OR_OPEN);
635             version = notmuch_database_get_version (notmuch);
636
637             if (version > NOTMUCH_DATABASE_VERSION) {
638                 fprintf (stderr,
639                          "Error: Notmuch database at %s\n"
640                          "       has a newer database format version (%u) than supported by this\n"
641                          "       version of notmuch (%u). Refusing to open this database in\n"
642                          "       read-write mode.\n",
643                          notmuch_path, version, NOTMUCH_DATABASE_VERSION);
644                 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
645                 notmuch_database_close (notmuch);
646                 notmuch = NULL;
647                 goto DONE;
648             }
649
650             if (version < NOTMUCH_DATABASE_VERSION)
651                 notmuch->needs_upgrade = TRUE;
652         } else {
653             notmuch->xapian_db = new Xapian::Database (xapian_path);
654             version = notmuch_database_get_version (notmuch);
655             if (version > NOTMUCH_DATABASE_VERSION)
656             {
657                 fprintf (stderr,
658                          "Warning: Notmuch database at %s\n"
659                          "         has a newer database format version (%u) than supported by this\n"
660                          "         version of notmuch (%u). Some operations may behave incorrectly,\n"
661                          "         (but the database will not be harmed since it is being opened\n"
662                          "         in read-only mode).\n",
663                          notmuch_path, version, NOTMUCH_DATABASE_VERSION);
664             }
665         }
666
667         notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
668         last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
669         if (last_thread_id.empty ()) {
670             notmuch->last_thread_id = 0;
671         } else {
672             const char *str;
673             char *end;
674
675             str = last_thread_id.c_str ();
676             notmuch->last_thread_id = strtoull (str, &end, 16);
677             if (*end != '\0')
678                 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
679         }
680
681         notmuch->query_parser = new Xapian::QueryParser;
682         notmuch->term_gen = new Xapian::TermGenerator;
683         notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
684         notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
685
686         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
687         notmuch->query_parser->set_database (*notmuch->xapian_db);
688         notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
689         notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
690         notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
691
692         for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
693             prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
694             notmuch->query_parser->add_boolean_prefix (prefix->name,
695                                                        prefix->prefix);
696         }
697
698         for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
699             prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
700             notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
701         }
702     } catch (const Xapian::Error &error) {
703         fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
704                  error.get_msg().c_str());
705         notmuch_database_close (notmuch);
706         notmuch = NULL;
707     }
708
709   DONE:
710     talloc_free (local);
711
712     return notmuch;
713 }
714
715 void
716 notmuch_database_close (notmuch_database_t *notmuch)
717 {
718     try {
719         if (notmuch->xapian_db != NULL &&
720             notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
721             (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
722     } catch (const Xapian::Error &error) {
723         if (! notmuch->exception_reported) {
724             fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
725                      error.get_msg().c_str());
726         }
727     }
728
729     delete notmuch->term_gen;
730     delete notmuch->query_parser;
731     delete notmuch->xapian_db;
732     delete notmuch->value_range_processor;
733     talloc_free (notmuch);
734 }
735
736 const char *
737 notmuch_database_get_path (notmuch_database_t *notmuch)
738 {
739     return notmuch->path;
740 }
741
742 unsigned int
743 notmuch_database_get_version (notmuch_database_t *notmuch)
744 {
745     unsigned int version;
746     string version_string;
747     const char *str;
748     char *end;
749
750     version_string = notmuch->xapian_db->get_metadata ("version");
751     if (version_string.empty ())
752         return 0;
753
754     str = version_string.c_str ();
755     if (str == NULL || *str == '\0')
756         return 0;
757
758     version = strtoul (str, &end, 10);
759     if (*end != '\0')
760         INTERNAL_ERROR ("Malformed database version: %s", str);
761
762     return version;
763 }
764
765 notmuch_bool_t
766 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
767 {
768     return notmuch->needs_upgrade;
769 }
770
771 static volatile sig_atomic_t do_progress_notify = 0;
772
773 static void
774 handle_sigalrm (unused (int signal))
775 {
776     do_progress_notify = 1;
777 }
778
779 /* Upgrade the current database.
780  *
781  * After opening a database in read-write mode, the client should
782  * check if an upgrade is needed (notmuch_database_needs_upgrade) and
783  * if so, upgrade with this function before making any modifications.
784  *
785  * The optional progress_notify callback can be used by the caller to
786  * provide progress indication to the user. If non-NULL it will be
787  * called periodically with 'count' as the number of messages upgraded
788  * so far and 'total' the overall number of messages that will be
789  * converted.
790  */
791 notmuch_status_t
792 notmuch_database_upgrade (notmuch_database_t *notmuch,
793                           void (*progress_notify) (void *closure,
794                                                    double progress),
795                           void *closure)
796 {
797     Xapian::WritableDatabase *db;
798     struct sigaction action;
799     struct itimerval timerval;
800     notmuch_bool_t timer_is_active = FALSE;
801     unsigned int version;
802     notmuch_status_t status;
803     unsigned int count = 0, total = 0;
804
805     status = _notmuch_database_ensure_writable (notmuch);
806     if (status)
807         return status;
808
809     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
810
811     version = notmuch_database_get_version (notmuch);
812
813     if (version >= NOTMUCH_DATABASE_VERSION)
814         return NOTMUCH_STATUS_SUCCESS;
815
816     if (progress_notify) {
817         /* Setup our handler for SIGALRM */
818         memset (&action, 0, sizeof (struct sigaction));
819         action.sa_handler = handle_sigalrm;
820         sigemptyset (&action.sa_mask);
821         action.sa_flags = SA_RESTART;
822         sigaction (SIGALRM, &action, NULL);
823
824         /* Then start a timer to send SIGALRM once per second. */
825         timerval.it_interval.tv_sec = 1;
826         timerval.it_interval.tv_usec = 0;
827         timerval.it_value.tv_sec = 1;
828         timerval.it_value.tv_usec = 0;
829         setitimer (ITIMER_REAL, &timerval, NULL);
830
831         timer_is_active = TRUE;
832     }
833
834     /* Before version 1, each message document had its filename in the
835      * data field. Copy that into the new format by calling
836      * notmuch_message_add_filename.
837      */
838     if (version < 1) {
839         notmuch_query_t *query = notmuch_query_create (notmuch, "");
840         notmuch_messages_t *messages;
841         notmuch_message_t *message;
842         char *filename;
843         Xapian::TermIterator t, t_end;
844
845         total = notmuch_query_count_messages (query);
846
847         for (messages = notmuch_query_search_messages (query);
848              notmuch_messages_valid (messages);
849              notmuch_messages_move_to_next (messages))
850         {
851             if (do_progress_notify) {
852                 progress_notify (closure, (double) count / total);
853                 do_progress_notify = 0;
854             }
855
856             message = notmuch_messages_get (messages);
857
858             filename = _notmuch_message_talloc_copy_data (message);
859             if (filename && *filename != '\0') {
860                 _notmuch_message_add_filename (message, filename);
861                 _notmuch_message_sync (message);
862             }
863             talloc_free (filename);
864
865             notmuch_message_destroy (message);
866
867             count++;
868         }
869
870         notmuch_query_destroy (query);
871
872         /* Also, before version 1 we stored directory timestamps in
873          * XTIMESTAMP documents instead of the current XDIRECTORY
874          * documents. So copy those as well. */
875
876         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
877
878         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
879              t != t_end;
880              t++)
881         {
882             Xapian::PostingIterator p, p_end;
883             std::string term = *t;
884
885             p_end = notmuch->xapian_db->postlist_end (term);
886
887             for (p = notmuch->xapian_db->postlist_begin (term);
888                  p != p_end;
889                  p++)
890             {
891                 Xapian::Document document;
892                 time_t mtime;
893                 notmuch_directory_t *directory;
894
895                 if (do_progress_notify) {
896                     progress_notify (closure, (double) count / total);
897                     do_progress_notify = 0;
898                 }
899
900                 document = find_document_for_doc_id (notmuch, *p);
901                 mtime = Xapian::sortable_unserialise (
902                     document.get_value (NOTMUCH_VALUE_TIMESTAMP));
903
904                 directory = notmuch_database_get_directory (notmuch,
905                                                             term.c_str() + 10);
906                 notmuch_directory_set_mtime (directory, mtime);
907                 notmuch_directory_destroy (directory);
908             }
909         }
910     }
911
912     db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
913     db->flush ();
914
915     /* Now that the upgrade is complete we can remove the old data
916      * and documents that are no longer needed. */
917     if (version < 1) {
918         notmuch_query_t *query = notmuch_query_create (notmuch, "");
919         notmuch_messages_t *messages;
920         notmuch_message_t *message;
921         char *filename;
922
923         for (messages = notmuch_query_search_messages (query);
924              notmuch_messages_valid (messages);
925              notmuch_messages_move_to_next (messages))
926         {
927             if (do_progress_notify) {
928                 progress_notify (closure, (double) count / total);
929                 do_progress_notify = 0;
930             }
931
932             message = notmuch_messages_get (messages);
933
934             filename = _notmuch_message_talloc_copy_data (message);
935             if (filename && *filename != '\0') {
936                 _notmuch_message_clear_data (message);
937                 _notmuch_message_sync (message);
938             }
939             talloc_free (filename);
940
941             notmuch_message_destroy (message);
942         }
943
944         notmuch_query_destroy (query);
945     }
946
947     if (version < 1) {
948         Xapian::TermIterator t, t_end;
949
950         t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
951
952         for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
953              t != t_end;
954              t++)
955         {
956             Xapian::PostingIterator p, p_end;
957             std::string term = *t;
958
959             p_end = notmuch->xapian_db->postlist_end (term);
960
961             for (p = notmuch->xapian_db->postlist_begin (term);
962                  p != p_end;
963                  p++)
964             {
965                 if (do_progress_notify) {
966                     progress_notify (closure, (double) count / total);
967                     do_progress_notify = 0;
968                 }
969
970                 db->delete_document (*p);
971             }
972         }
973     }
974
975     if (timer_is_active) {
976         /* Now stop the timer. */
977         timerval.it_interval.tv_sec = 0;
978         timerval.it_interval.tv_usec = 0;
979         timerval.it_value.tv_sec = 0;
980         timerval.it_value.tv_usec = 0;
981         setitimer (ITIMER_REAL, &timerval, NULL);
982
983         /* And disable the signal handler. */
984         action.sa_handler = SIG_IGN;
985         sigaction (SIGALRM, &action, NULL);
986     }
987
988     return NOTMUCH_STATUS_SUCCESS;
989 }
990
991 notmuch_status_t
992 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
993 {
994     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
995         notmuch->atomic_nesting > 0)
996         goto DONE;
997
998     try {
999         (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1000     } catch (const Xapian::Error &error) {
1001         fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
1002                  error.get_msg().c_str());
1003         notmuch->exception_reported = TRUE;
1004         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1005     }
1006
1007 DONE:
1008     notmuch->atomic_nesting++;
1009     return NOTMUCH_STATUS_SUCCESS;
1010 }
1011
1012 notmuch_status_t
1013 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1014 {
1015     Xapian::WritableDatabase *db;
1016
1017     if (notmuch->atomic_nesting == 0)
1018         return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1019
1020     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1021         notmuch->atomic_nesting > 1)
1022         goto DONE;
1023
1024     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1025     try {
1026         db->commit_transaction ();
1027
1028         /* This is a hack for testing.  Xapian never flushes on a
1029          * non-flushed commit, even if the flush threshold is 1.
1030          * However, we rely on flushing to test atomicity. */
1031         const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1032         if (thresh && atoi (thresh) == 1)
1033             db->flush ();
1034     } catch (const Xapian::Error &error) {
1035         fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1036                  error.get_msg().c_str());
1037         notmuch->exception_reported = TRUE;
1038         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1039     }
1040
1041 DONE:
1042     notmuch->atomic_nesting--;
1043     return NOTMUCH_STATUS_SUCCESS;
1044 }
1045
1046 /* We allow the user to use arbitrarily long paths for directories. But
1047  * we have a term-length limit. So if we exceed that, we'll use the
1048  * SHA-1 of the path for the database term.
1049  *
1050  * Note: This function may return the original value of 'path'. If it
1051  * does not, then the caller is responsible to free() the returned
1052  * value.
1053  */
1054 const char *
1055 _notmuch_database_get_directory_db_path (const char *path)
1056 {
1057     int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1058
1059     if (term_len > NOTMUCH_TERM_MAX)
1060         return notmuch_sha1_of_string (path);
1061     else
1062         return path;
1063 }
1064
1065 /* Given a path, split it into two parts: the directory part is all
1066  * components except for the last, and the basename is that last
1067  * component. Getting the return-value for either part is optional
1068  * (the caller can pass NULL).
1069  *
1070  * The original 'path' can represent either a regular file or a
1071  * directory---the splitting will be carried out in the same way in
1072  * either case. Trailing slashes on 'path' will be ignored, and any
1073  * cases of multiple '/' characters appearing in series will be
1074  * treated as a single '/'.
1075  *
1076  * Allocation (if any) will have 'ctx' as the talloc owner. But
1077  * pointers will be returned within the original path string whenever
1078  * possible.
1079  *
1080  * Note: If 'path' is non-empty and contains no non-trailing slash,
1081  * (that is, consists of a filename with no parent directory), then
1082  * the directory returned will be an empty string. However, if 'path'
1083  * is an empty string, then both directory and basename will be
1084  * returned as NULL.
1085  */
1086 notmuch_status_t
1087 _notmuch_database_split_path (void *ctx,
1088                               const char *path,
1089                               const char **directory,
1090                               const char **basename)
1091 {
1092     const char *slash;
1093
1094     if (path == NULL || *path == '\0') {
1095         if (directory)
1096             *directory = NULL;
1097         if (basename)
1098             *basename = NULL;
1099         return NOTMUCH_STATUS_SUCCESS;
1100     }
1101
1102     /* Find the last slash (not counting a trailing slash), if any. */
1103
1104     slash = path + strlen (path) - 1;
1105
1106     /* First, skip trailing slashes. */
1107     while (slash != path) {
1108         if (*slash != '/')
1109             break;
1110
1111         --slash;
1112     }
1113
1114     /* Then, find a slash. */
1115     while (slash != path) {
1116         if (*slash == '/')
1117             break;
1118
1119         if (basename)
1120             *basename = slash;
1121
1122         --slash;
1123     }
1124
1125     /* Finally, skip multiple slashes. */
1126     while (slash != path) {
1127         if (*slash != '/')
1128             break;
1129
1130         --slash;
1131     }
1132
1133     if (slash == path) {
1134         if (directory)
1135             *directory = talloc_strdup (ctx, "");
1136         if (basename)
1137             *basename = path;
1138     } else {
1139         if (directory)
1140             *directory = talloc_strndup (ctx, path, slash - path + 1);
1141     }
1142
1143     return NOTMUCH_STATUS_SUCCESS;
1144 }
1145
1146 notmuch_status_t
1147 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1148                                      const char *path,
1149                                      unsigned int *directory_id)
1150 {
1151     notmuch_directory_t *directory;
1152     notmuch_status_t status;
1153
1154     if (path == NULL) {
1155         *directory_id = 0;
1156         return NOTMUCH_STATUS_SUCCESS;
1157     }
1158
1159     directory = _notmuch_directory_create (notmuch, path, &status);
1160     if (status) {
1161         *directory_id = -1;
1162         return status;
1163     }
1164
1165     *directory_id = _notmuch_directory_get_document_id (directory);
1166
1167     notmuch_directory_destroy (directory);
1168
1169     return NOTMUCH_STATUS_SUCCESS;
1170 }
1171
1172 const char *
1173 _notmuch_database_get_directory_path (void *ctx,
1174                                       notmuch_database_t *notmuch,
1175                                       unsigned int doc_id)
1176 {
1177     Xapian::Document document;
1178
1179     document = find_document_for_doc_id (notmuch, doc_id);
1180
1181     return talloc_strdup (ctx, document.get_data ().c_str ());
1182 }
1183
1184 /* Given a legal 'filename' for the database, (either relative to
1185  * database path or absolute with initial components identical to
1186  * database path), return a new string (with 'ctx' as the talloc
1187  * owner) suitable for use as a direntry term value.
1188  *
1189  * The necessary directory documents will be created in the database
1190  * as needed.
1191  */
1192 notmuch_status_t
1193 _notmuch_database_filename_to_direntry (void *ctx,
1194                                         notmuch_database_t *notmuch,
1195                                         const char *filename,
1196                                         char **direntry)
1197 {
1198     const char *relative, *directory, *basename;
1199     Xapian::docid directory_id;
1200     notmuch_status_t status;
1201
1202     relative = _notmuch_database_relative_path (notmuch, filename);
1203
1204     status = _notmuch_database_split_path (ctx, relative,
1205                                            &directory, &basename);
1206     if (status)
1207         return status;
1208
1209     status = _notmuch_database_find_directory_id (notmuch, directory,
1210                                                   &directory_id);
1211     if (status)
1212         return status;
1213
1214     *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1215
1216     return NOTMUCH_STATUS_SUCCESS;
1217 }
1218
1219 /* Given a legal 'path' for the database, return the relative path.
1220  *
1221  * The return value will be a pointer to the original path contents,
1222  * and will be either the original string (if 'path' was relative) or
1223  * a portion of the string (if path was absolute and begins with the
1224  * database path).
1225  */
1226 const char *
1227 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1228                                  const char *path)
1229 {
1230     const char *db_path, *relative;
1231     unsigned int db_path_len;
1232
1233     db_path = notmuch_database_get_path (notmuch);
1234     db_path_len = strlen (db_path);
1235
1236     relative = path;
1237
1238     if (*relative == '/') {
1239         while (*relative == '/' && *(relative+1) == '/')
1240             relative++;
1241
1242         if (strncmp (relative, db_path, db_path_len) == 0)
1243         {
1244             relative += db_path_len;
1245             while (*relative == '/')
1246                 relative++;
1247         }
1248     }
1249
1250     return relative;
1251 }
1252
1253 notmuch_directory_t *
1254 notmuch_database_get_directory (notmuch_database_t *notmuch,
1255                                 const char *path)
1256 {
1257     notmuch_status_t status;
1258
1259     try {
1260         return _notmuch_directory_create (notmuch, path, &status);
1261     } catch (const Xapian::Error &error) {
1262         fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1263                  error.get_msg().c_str());
1264         notmuch->exception_reported = TRUE;
1265         return NULL;
1266     }
1267 }
1268
1269 /* Allocate a document ID that satisfies the following criteria:
1270  *
1271  * 1. The ID does not exist for any document in the Xapian database
1272  *
1273  * 2. The ID was not previously returned from this function
1274  *
1275  * 3. The ID is the smallest integer satisfying (1) and (2)
1276  *
1277  * This function will trigger an internal error if these constraints
1278  * cannot all be satisfied, (that is, the pool of available document
1279  * IDs has been exhausted).
1280  */
1281 unsigned int
1282 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1283 {
1284     assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1285
1286     notmuch->last_doc_id++;
1287
1288     if (notmuch->last_doc_id == 0)
1289         INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");        
1290
1291     return notmuch->last_doc_id;
1292 }
1293
1294 static const char *
1295 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1296 {
1297     /* 16 bytes (+ terminator) for hexadecimal representation of
1298      * a 64-bit integer. */
1299     static char thread_id[17];
1300     Xapian::WritableDatabase *db;
1301
1302     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1303
1304     notmuch->last_thread_id++;
1305
1306     sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1307
1308     db->set_metadata ("last_thread_id", thread_id);
1309
1310     return thread_id;
1311 }
1312
1313 static char *
1314 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1315 {
1316     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1317         message_id = _message_id_compressed (ctx, message_id);
1318
1319     return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1320                             message_id);
1321 }
1322
1323 /* Find the thread ID to which the message with 'message_id' belongs.
1324  *
1325  * Note: 'thread_id_ret' must not be NULL!
1326  * On success '*thread_id_ret' is set to a newly talloced string belonging to
1327  * 'ctx'.
1328  *
1329  * Note: If there is no message in the database with the given
1330  * 'message_id' then a new thread_id will be allocated for this
1331  * message and stored in the database metadata, (where this same
1332  * thread ID can be looked up if the message is added to the database
1333  * later).
1334  */
1335 static notmuch_status_t
1336 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1337                                   void *ctx,
1338                                   const char *message_id,
1339                                   const char **thread_id_ret)
1340 {
1341     notmuch_status_t status;
1342     notmuch_message_t *message;
1343     string thread_id_string;
1344     char *metadata_key;
1345     Xapian::WritableDatabase *db;
1346
1347     status = notmuch_database_find_message (notmuch, message_id, &message);
1348
1349     if (status)
1350         return status;
1351
1352     if (message) {
1353         *thread_id_ret = talloc_steal (ctx,
1354                                        notmuch_message_get_thread_id (message));
1355
1356         notmuch_message_destroy (message);
1357
1358         return NOTMUCH_STATUS_SUCCESS;
1359     }
1360
1361     /* Message has not been seen yet.
1362      *
1363      * We may have seen a reference to it already, in which case, we
1364      * can return the thread ID stored in the metadata. Otherwise, we
1365      * generate a new thread ID and store it there.
1366      */
1367     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1368     metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1369     thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1370
1371     if (thread_id_string.empty()) {
1372         *thread_id_ret = talloc_strdup (ctx,
1373                                         _notmuch_database_generate_thread_id (notmuch));
1374         db->set_metadata (metadata_key, *thread_id_ret);
1375     } else {
1376         *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1377     }
1378
1379     talloc_free (metadata_key);
1380
1381     return NOTMUCH_STATUS_SUCCESS;
1382 }
1383
1384 static notmuch_status_t
1385 _merge_threads (notmuch_database_t *notmuch,
1386                 const char *winner_thread_id,
1387                 const char *loser_thread_id)
1388 {
1389     Xapian::PostingIterator loser, loser_end;
1390     notmuch_message_t *message = NULL;
1391     notmuch_private_status_t private_status;
1392     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1393
1394     find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1395
1396     for ( ; loser != loser_end; loser++) {
1397         message = _notmuch_message_create (notmuch, notmuch,
1398                                            *loser, &private_status);
1399         if (message == NULL) {
1400             ret = COERCE_STATUS (private_status,
1401                                  "Cannot find document for doc_id from query");
1402             goto DONE;
1403         }
1404
1405         _notmuch_message_remove_term (message, "thread", loser_thread_id);
1406         _notmuch_message_add_term (message, "thread", winner_thread_id);
1407         _notmuch_message_sync (message);
1408
1409         notmuch_message_destroy (message);
1410         message = NULL;
1411     }
1412
1413   DONE:
1414     if (message)
1415         notmuch_message_destroy (message);
1416
1417     return ret;
1418 }
1419
1420 static void
1421 _my_talloc_free_for_g_hash (void *ptr)
1422 {
1423     talloc_free (ptr);
1424 }
1425
1426 static notmuch_status_t
1427 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1428                                            notmuch_message_t *message,
1429                                            notmuch_message_file_t *message_file,
1430                                            const char **thread_id)
1431 {
1432     GHashTable *parents = NULL;
1433     const char *refs, *in_reply_to, *in_reply_to_message_id;
1434     GList *l, *keys = NULL;
1435     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1436
1437     parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1438                                      _my_talloc_free_for_g_hash, NULL);
1439
1440     refs = notmuch_message_file_get_header (message_file, "references");
1441     parse_references (message, notmuch_message_get_message_id (message),
1442                       parents, refs);
1443
1444     in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1445     parse_references (message, notmuch_message_get_message_id (message),
1446                       parents, in_reply_to);
1447
1448     /* Carefully avoid adding any self-referential in-reply-to term. */
1449     in_reply_to_message_id = _parse_message_id (message, in_reply_to, NULL);
1450     if (in_reply_to_message_id &&
1451         strcmp (in_reply_to_message_id,
1452                 notmuch_message_get_message_id (message)))
1453     {
1454         _notmuch_message_add_term (message, "replyto",
1455                              _parse_message_id (message, in_reply_to, NULL));
1456     }
1457
1458     keys = g_hash_table_get_keys (parents);
1459     for (l = keys; l; l = l->next) {
1460         char *parent_message_id;
1461         const char *parent_thread_id = NULL;
1462
1463         parent_message_id = (char *) l->data;
1464
1465         _notmuch_message_add_term (message, "reference",
1466                                    parent_message_id);
1467
1468         ret = _resolve_message_id_to_thread_id (notmuch,
1469                                                 message,
1470                                                 parent_message_id,
1471                                                 &parent_thread_id);
1472         if (ret)
1473             goto DONE;
1474
1475         if (*thread_id == NULL) {
1476             *thread_id = talloc_strdup (message, parent_thread_id);
1477             _notmuch_message_add_term (message, "thread", *thread_id);
1478         } else if (strcmp (*thread_id, parent_thread_id)) {
1479             ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1480             if (ret)
1481                 goto DONE;
1482         }
1483     }
1484
1485   DONE:
1486     if (keys)
1487         g_list_free (keys);
1488     if (parents)
1489         g_hash_table_unref (parents);
1490
1491     return ret;
1492 }
1493
1494 static notmuch_status_t
1495 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1496                                             notmuch_message_t *message,
1497                                             const char **thread_id)
1498 {
1499     const char *message_id = notmuch_message_get_message_id (message);
1500     Xapian::PostingIterator child, children_end;
1501     notmuch_message_t *child_message = NULL;
1502     const char *child_thread_id;
1503     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1504     notmuch_private_status_t private_status;
1505
1506     find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1507
1508     for ( ; child != children_end; child++) {
1509
1510         child_message = _notmuch_message_create (message, notmuch,
1511                                                  *child, &private_status);
1512         if (child_message == NULL) {
1513             ret = COERCE_STATUS (private_status,
1514                                  "Cannot find document for doc_id from query");
1515             goto DONE;
1516         }
1517
1518         child_thread_id = notmuch_message_get_thread_id (child_message);
1519         if (*thread_id == NULL) {
1520             *thread_id = talloc_strdup (message, child_thread_id);
1521             _notmuch_message_add_term (message, "thread", *thread_id);
1522         } else if (strcmp (*thread_id, child_thread_id)) {
1523             _notmuch_message_remove_term (child_message, "reference",
1524                                           message_id);
1525             _notmuch_message_sync (child_message);
1526             ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1527             if (ret)
1528                 goto DONE;
1529         }
1530
1531         notmuch_message_destroy (child_message);
1532         child_message = NULL;
1533     }
1534
1535   DONE:
1536     if (child_message)
1537         notmuch_message_destroy (child_message);
1538
1539     return ret;
1540 }
1541
1542 /* Given a (mostly empty) 'message' and its corresponding
1543  * 'message_file' link it to existing threads in the database.
1544  *
1545  * The first check is in the metadata of the database to see if we
1546  * have pre-allocated a thread_id in advance for this message, (which
1547  * would have happened if a message was previously added that
1548  * referenced this one).
1549  *
1550  * Second, we look at 'message_file' and its link-relevant headers
1551  * (References and In-Reply-To) for message IDs.
1552  *
1553  * Finally, we look in the database for existing message that
1554  * reference 'message'.
1555  *
1556  * In all cases, we assign to the current message the first thread_id
1557  * found (through either parent or child). We will also merge any
1558  * existing, distinct threads where this message belongs to both,
1559  * (which is not uncommon when messages are processed out of order).
1560  *
1561  * Finally, if no thread ID has been found through parent or child, we
1562  * call _notmuch_message_generate_thread_id to generate a new thread
1563  * ID. This should only happen for new, top-level messages, (no
1564  * References or In-Reply-To header in this message, and no previously
1565  * added message refers to this message).
1566  */
1567 static notmuch_status_t
1568 _notmuch_database_link_message (notmuch_database_t *notmuch,
1569                                 notmuch_message_t *message,
1570                                 notmuch_message_file_t *message_file)
1571 {
1572     notmuch_status_t status;
1573     const char *message_id, *thread_id = NULL;
1574     char *metadata_key;
1575     string stored_id;
1576
1577     message_id = notmuch_message_get_message_id (message);
1578     metadata_key = _get_metadata_thread_id_key (message, message_id);
1579
1580     /* Check if we have already seen related messages to this one.
1581      * If we have then use the thread_id that we stored at that time.
1582      */
1583     stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1584     if (! stored_id.empty()) {
1585         Xapian::WritableDatabase *db;
1586
1587         db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1588
1589         /* Clear the metadata for this message ID. We don't need it
1590          * anymore. */
1591         db->set_metadata (metadata_key, "");
1592         thread_id = stored_id.c_str();
1593
1594         _notmuch_message_add_term (message, "thread", thread_id);
1595     }
1596     talloc_free (metadata_key);
1597
1598     status = _notmuch_database_link_message_to_parents (notmuch, message,
1599                                                         message_file,
1600                                                         &thread_id);
1601     if (status)
1602         return status;
1603
1604     status = _notmuch_database_link_message_to_children (notmuch, message,
1605                                                          &thread_id);
1606     if (status)
1607         return status;
1608
1609     /* If not part of any existing thread, generate a new thread ID. */
1610     if (thread_id == NULL) {
1611         thread_id = _notmuch_database_generate_thread_id (notmuch);
1612
1613         _notmuch_message_add_term (message, "thread", thread_id);
1614     }
1615
1616     return NOTMUCH_STATUS_SUCCESS;
1617 }
1618
1619 notmuch_status_t
1620 notmuch_database_add_message (notmuch_database_t *notmuch,
1621                               const char *filename,
1622                               notmuch_message_t **message_ret)
1623 {
1624     notmuch_message_file_t *message_file;
1625     notmuch_message_t *message = NULL;
1626     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1627     notmuch_private_status_t private_status;
1628
1629     const char *date, *header;
1630     const char *from, *to, *subject;
1631     char *message_id = NULL;
1632
1633     if (message_ret)
1634         *message_ret = NULL;
1635
1636     ret = _notmuch_database_ensure_writable (notmuch);
1637     if (ret)
1638         return ret;
1639
1640     message_file = notmuch_message_file_open (filename);
1641     if (message_file == NULL)
1642         return NOTMUCH_STATUS_FILE_ERROR;
1643
1644     /* Adding a message may change many documents.  Do this all
1645      * atomically. */
1646     ret = notmuch_database_begin_atomic (notmuch);
1647     if (ret)
1648         goto DONE;
1649
1650     notmuch_message_file_restrict_headers (message_file,
1651                                            "date",
1652                                            "from",
1653                                            "in-reply-to",
1654                                            "message-id",
1655                                            "references",
1656                                            "subject",
1657                                            "to",
1658                                            (char *) NULL);
1659
1660     try {
1661         /* Before we do any real work, (especially before doing a
1662          * potential SHA-1 computation on the entire file's contents),
1663          * let's make sure that what we're looking at looks like an
1664          * actual email message.
1665          */
1666         from = notmuch_message_file_get_header (message_file, "from");
1667         subject = notmuch_message_file_get_header (message_file, "subject");
1668         to = notmuch_message_file_get_header (message_file, "to");
1669
1670         if ((from == NULL || *from == '\0') &&
1671             (subject == NULL || *subject == '\0') &&
1672             (to == NULL || *to == '\0'))
1673         {
1674             ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1675             goto DONE;
1676         }
1677
1678         /* Now that we're sure it's mail, the first order of business
1679          * is to find a message ID (or else create one ourselves). */
1680
1681         header = notmuch_message_file_get_header (message_file, "message-id");
1682         if (header && *header != '\0') {
1683             message_id = _parse_message_id (message_file, header, NULL);
1684
1685             /* So the header value isn't RFC-compliant, but it's
1686              * better than no message-id at all. */
1687             if (message_id == NULL)
1688                 message_id = talloc_strdup (message_file, header);
1689
1690             /* If a message ID is too long, substitute its sha1 instead. */
1691             if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1692                 char *compressed = _message_id_compressed (message_file,
1693                                                            message_id);
1694                 talloc_free (message_id);
1695                 message_id = compressed;
1696             }
1697         }
1698
1699         if (message_id == NULL ) {
1700             /* No message-id at all, let's generate one by taking a
1701              * hash over the file's contents. */
1702             char *sha1 = notmuch_sha1_of_file (filename);
1703
1704             /* If that failed too, something is really wrong. Give up. */
1705             if (sha1 == NULL) {
1706                 ret = NOTMUCH_STATUS_FILE_ERROR;
1707                 goto DONE;
1708             }
1709
1710             message_id = talloc_asprintf (message_file,
1711                                           "notmuch-sha1-%s", sha1);
1712             free (sha1);
1713         }
1714
1715         /* Now that we have a message ID, we get a message object,
1716          * (which may or may not reference an existing document in the
1717          * database). */
1718
1719         message = _notmuch_message_create_for_message_id (notmuch,
1720                                                           message_id,
1721                                                           &private_status);
1722
1723         talloc_free (message_id);
1724
1725         if (message == NULL) {
1726             ret = COERCE_STATUS (private_status,
1727                                  "Unexpected status value from _notmuch_message_create_for_message_id");
1728             goto DONE;
1729         }
1730
1731         _notmuch_message_add_filename (message, filename);
1732
1733         /* Is this a newly created message object? */
1734         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1735             _notmuch_message_add_term (message, "type", "mail");
1736
1737             ret = _notmuch_database_link_message (notmuch, message,
1738                                                   message_file);
1739             if (ret)
1740                 goto DONE;
1741
1742             date = notmuch_message_file_get_header (message_file, "date");
1743             _notmuch_message_set_header_values (message, date, from, subject);
1744
1745             _notmuch_message_index_file (message, filename);
1746         } else {
1747             ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1748         }
1749
1750         _notmuch_message_sync (message);
1751     } catch (const Xapian::Error &error) {
1752         fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
1753                  error.get_msg().c_str());
1754         notmuch->exception_reported = TRUE;
1755         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1756         goto DONE;
1757     }
1758
1759   DONE:
1760     if (message) {
1761         if ((ret == NOTMUCH_STATUS_SUCCESS ||
1762              ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
1763             *message_ret = message;
1764         else
1765             notmuch_message_destroy (message);
1766     }
1767
1768     if (message_file)
1769         notmuch_message_file_close (message_file);
1770
1771     ret2 = notmuch_database_end_atomic (notmuch);
1772     if ((ret == NOTMUCH_STATUS_SUCCESS ||
1773          ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
1774         ret2 != NOTMUCH_STATUS_SUCCESS)
1775         ret = ret2;
1776
1777     return ret;
1778 }
1779
1780 notmuch_status_t
1781 notmuch_database_remove_message (notmuch_database_t *notmuch,
1782                                  const char *filename)
1783 {
1784     notmuch_status_t status;
1785     notmuch_message_t *message;
1786
1787     status = notmuch_database_find_message_by_filename (notmuch, filename,
1788                                                         &message);
1789
1790     if (status == NOTMUCH_STATUS_SUCCESS && message) {
1791             status = _notmuch_message_remove_filename (message, filename);
1792             if (status == NOTMUCH_STATUS_SUCCESS)
1793                 _notmuch_message_delete (message);
1794             else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1795                 _notmuch_message_sync (message);
1796
1797             notmuch_message_destroy (message);
1798     }
1799
1800     return status;
1801 }
1802
1803 notmuch_status_t
1804 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1805                                            const char *filename,
1806                                            notmuch_message_t **message_ret)
1807 {
1808     void *local;
1809     const char *prefix = _find_prefix ("file-direntry");
1810     char *direntry, *term;
1811     Xapian::PostingIterator i, end;
1812     notmuch_status_t status;
1813
1814     if (message_ret == NULL)
1815         return NOTMUCH_STATUS_NULL_POINTER;
1816
1817     local = talloc_new (notmuch);
1818
1819     try {
1820         status = _notmuch_database_filename_to_direntry (local, notmuch,
1821                                                          filename, &direntry);
1822         if (status)
1823             goto DONE;
1824
1825         term = talloc_asprintf (local, "%s%s", prefix, direntry);
1826
1827         find_doc_ids_for_term (notmuch, term, &i, &end);
1828
1829         if (i != end) {
1830             notmuch_private_status_t private_status;
1831
1832             *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1833                                                     &private_status);
1834             if (*message_ret == NULL)
1835                 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1836         }
1837     } catch (const Xapian::Error &error) {
1838         fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
1839                  error.get_msg().c_str());
1840         notmuch->exception_reported = TRUE;
1841         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1842     }
1843
1844   DONE:
1845     talloc_free (local);
1846
1847     if (status && *message_ret) {
1848         notmuch_message_destroy (*message_ret);
1849         *message_ret = NULL;
1850     }
1851     return status;
1852 }
1853
1854 notmuch_string_list_t *
1855 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1856                                          Xapian::TermIterator &end,
1857                                          const char *prefix)
1858 {
1859     int prefix_len = strlen (prefix);
1860     notmuch_string_list_t *list;
1861
1862     list = _notmuch_string_list_create (ctx);
1863     if (unlikely (list == NULL))
1864         return NULL;
1865
1866     for (i.skip_to (prefix); i != end; i++) {
1867         /* Terminate loop at first term without desired prefix. */
1868         if (strncmp ((*i).c_str (), prefix, prefix_len))
1869             break;
1870
1871         _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1872     }
1873
1874     return list;
1875 }
1876
1877 notmuch_tags_t *
1878 notmuch_database_get_all_tags (notmuch_database_t *db)
1879 {
1880     Xapian::TermIterator i, end;
1881     notmuch_string_list_t *tags;
1882
1883     try {
1884         i = db->xapian_db->allterms_begin();
1885         end = db->xapian_db->allterms_end();
1886         tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1887                                                         _find_prefix ("tag"));
1888         _notmuch_string_list_sort (tags);
1889         return _notmuch_tags_create (db, tags);
1890     } catch (const Xapian::Error &error) {
1891         fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
1892                  error.get_msg().c_str());
1893         db->exception_reported = TRUE;
1894         return NULL;
1895     }
1896 }