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