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