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