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