notmuch search: Add (relative) date to search output
[notmuch] / 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 <xapian.h>
26
27 #include <glib.h> /* g_free, GPtrArray, GHashTable */
28
29 using namespace std;
30
31 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
32
33 typedef struct {
34     const char *name;
35     const char *prefix;
36 } prefix_t;
37
38 /* Here's the current schema for our database:
39  *
40  * We currently have two different types of documents: mail and timestamps.
41  *
42  * Mail document
43  * -------------
44  * A mail document is associated with a particular email message file
45  * on disk. It is indexed with the following prefixed terms:
46  *
47  *    Single terms of given prefix:
48  *
49  *      type:   mail
50  *
51  *      id:     Unique ID of mail, (from Message-ID header or generated
52  *              as "notmuch-sha1-<sha1_sum_of_entire_file>.
53  *
54  *      thread: The ID of the thread to which the mail belongs
55  *
56  *    Multiple terms of given prefix:
57  *
58  *      ref:    All unresolved message IDs from In-Reply-To and
59  *              References headers in the message. (Once a referenced
60  *              message is added to the database and the thread IDs
61  *              are linked the corresponding "ref" term is dropped
62  *              from the message document.)
63  *
64  *      tag:    Any tags associated with this message by the user.
65  *
66  *    A mail document also has two values:
67  *
68  *      TIMESTAMP:      The time_t value corresponding to the message's
69  *                      Date header.
70  *
71  *      MESSAGE_ID:     The unique ID of the mail mess (see "id" above)
72  *
73  * Timestamp document
74  * ------------------
75  * A timestamp document is used by a client of the notmuch library to
76  * maintain data necessary to allow for efficient polling of mail
77  * directories. The notmuch library does no interpretation of
78  * timestamps, but merely allows the user to store and retrieve
79  * timestamps as name/value pairs.
80  *
81  * The timestamp document is indexed with a single prefixed term:
82  *
83  *      timestamp:      The user's key value (likely a directory name)
84  *
85  * and has a single value:
86  *
87  *      TIMESTAMP:      The time_t value from the user.
88  */
89
90 /* With these prefix values we follow the conventions published here:
91  *
92  * http://xapian.org/docs/omega/termprefixes.html
93  *
94  * as much as makes sense. Note that I took some liberty in matching
95  * the reserved prefix values to notmuch concepts, (for example, 'G'
96  * is documented as "newsGroup (or similar entity - e.g. a web forum
97  * name)", for which I think the thread is the closest analogue in
98  * notmuch. This in spite of the fact that we will eventually be
99  * storing mailing-list messages where 'G' for "mailing list name"
100  * might be even a closer analogue. I'm treating the single-character
101  * prefixes preferentially for core notmuch concepts (which will be
102  * nearly universal to all mail messages).
103  */
104
105 prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
106     { "type", "T" },
107     { "ref", "XREFERENCE" },
108     { "timestamp", "XTIMESTAMP" },
109     { "contact", "XCONTACT" }
110 };
111
112 prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
113     { "thread", "G" },
114     { "tag", "K" },
115     { "id", "Q" }
116 };
117
118 prefix_t PROBABILISTIC_PREFIX[]= {
119     { "from", "XFROM" },
120     { "to", "XTO" },
121     { "attachment", "XATTACHMENT" },
122     { "subject", "XSUBJECT"}
123 };
124
125 int
126 _internal_error (const char *format, ...)
127 {
128     va_list va_args;
129
130     va_start (va_args, format);
131
132     fprintf (stderr, "Internal error: ");
133     vfprintf (stderr, format, va_args);
134
135     exit (1);
136
137     return 1;
138 }
139
140 const char *
141 _find_prefix (const char *name)
142 {
143     unsigned int i;
144
145     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++)
146         if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
147             return BOOLEAN_PREFIX_INTERNAL[i].prefix;
148
149     for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++)
150         if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
151             return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
152
153     for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++)
154         if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
155             return PROBABILISTIC_PREFIX[i].prefix;
156
157     INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
158
159     return "";
160 }
161
162 const char *
163 notmuch_status_to_string (notmuch_status_t status)
164 {
165     switch (status) {
166     case NOTMUCH_STATUS_SUCCESS:
167         return "No error occurred";
168     case NOTMUCH_STATUS_OUT_OF_MEMORY:
169         return "Out of memory";
170     case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
171         return "A Xapian exception occurred";
172     case NOTMUCH_STATUS_FILE_ERROR:
173         return "Something went wrong trying to read or write a file";
174     case NOTMUCH_STATUS_FILE_NOT_EMAIL:
175         return "File is not an email";
176     case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
177         return "Message ID is identical to a message in database";
178     case NOTMUCH_STATUS_NULL_POINTER:
179         return "Erroneous NULL pointer";
180     case NOTMUCH_STATUS_TAG_TOO_LONG:
181         return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
182     case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
183         return "Unblanced number of calls to notmuch_message_freeze/thaw";
184     default:
185     case NOTMUCH_STATUS_LAST_STATUS:
186         return "Unknown error status value";
187     }
188 }
189
190 static void
191 find_doc_ids (notmuch_database_t *notmuch,
192               const char *prefix_name,
193               const char *value,
194               Xapian::PostingIterator *begin,
195               Xapian::PostingIterator *end)
196 {
197     Xapian::PostingIterator i;
198     char *term;
199
200     term = talloc_asprintf (notmuch, "%s%s",
201                             _find_prefix (prefix_name), value);
202
203     *begin = notmuch->xapian_db->postlist_begin (term);
204
205     *end = notmuch->xapian_db->postlist_end (term);
206
207     talloc_free (term);
208 }
209
210 static notmuch_private_status_t
211 find_unique_doc_id (notmuch_database_t *notmuch,
212                     const char *prefix_name,
213                     const char *value,
214                     unsigned int *doc_id)
215 {
216     Xapian::PostingIterator i, end;
217
218     find_doc_ids (notmuch, prefix_name, value, &i, &end);
219
220     if (i == end) {
221         *doc_id = 0;
222         return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
223     } else {
224         *doc_id = *i;
225         return NOTMUCH_PRIVATE_STATUS_SUCCESS;
226     }
227 }
228
229 static Xapian::Document
230 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
231 {
232     return notmuch->xapian_db->get_document (doc_id);
233 }
234
235 static notmuch_private_status_t
236 find_unique_document (notmuch_database_t *notmuch,
237                       const char *prefix_name,
238                       const char *value,
239                       Xapian::Document *document,
240                       unsigned int *doc_id)
241 {
242     notmuch_private_status_t status;
243
244     status = find_unique_doc_id (notmuch, prefix_name, value, doc_id);
245
246     if (status) {
247         *document = Xapian::Document ();
248         return status;
249     }
250
251     *document = find_document_for_doc_id (notmuch, *doc_id);
252     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
253 }
254
255 notmuch_message_t *
256 notmuch_database_find_message (notmuch_database_t *notmuch,
257                                const char *message_id)
258 {
259     notmuch_private_status_t status;
260     unsigned int doc_id;
261
262     status = find_unique_doc_id (notmuch, "id", message_id, &doc_id);
263
264     if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
265         return NULL;
266
267     return _notmuch_message_create (notmuch, notmuch, doc_id, NULL);
268 }
269
270 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
271  * a (potentially nested) parenthesized sequence with '\' used to
272  * escape any character (including parentheses).
273  *
274  * If the sequence to be skipped continues to the end of the string,
275  * then 'str' will be left pointing at the final terminating '\0'
276  * character.
277  */
278 static void
279 skip_space_and_comments (const char **str)
280 {
281     const char *s;
282
283     s = *str;
284     while (*s && (isspace (*s) || *s == '(')) {
285         while (*s && isspace (*s))
286             s++;
287         if (*s == '(') {
288             int nesting = 1;
289             s++;
290             while (*s && nesting) {
291                 if (*s == '(')
292                     nesting++;
293                 else if (*s == ')')
294                     nesting--;
295                 else if (*s == '\\')
296                     if (*(s+1))
297                         s++;
298                 s++;
299             }
300         }
301     }
302
303     *str = s;
304 }
305
306 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
307  * comments, and the '<' and '>' delimeters.
308  *
309  * If not NULL, then *next will be made to point to the first character
310  * not parsed, (possibly pointing to the final '\0' terminator.
311  *
312  * Returns a newly talloc'ed string belonging to 'ctx'.
313  *
314  * Returns NULL if there is any error parsing the message-id. */
315 static char *
316 parse_message_id (void *ctx, const char *message_id, const char **next)
317 {
318     const char *s, *end;
319     char *result;
320
321     if (message_id == NULL)
322         return NULL;
323
324     s = message_id;
325
326     skip_space_and_comments (&s);
327
328     /* Skip any unstructured text as well. */
329     while (*s && *s != '<')
330         s++;
331
332     if (*s == '<') {
333         s++;
334     } else {
335         if (next)
336             *next = s;
337         return NULL;
338     }
339
340     skip_space_and_comments (&s);
341
342     end = s;
343     while (*end && *end != '>')
344         end++;
345     if (next) {
346         if (*end)
347             *next = end + 1;
348         else
349             *next = end;
350     }
351
352     if (end > s && *end == '>')
353         end--;
354     if (end <= s)
355         return NULL;
356
357     result = talloc_strndup (ctx, s, end - s + 1);
358
359     /* Finally, collapse any whitespace that is within the message-id
360      * itself. */
361     {
362         char *r;
363         int len;
364
365         for (r = result, len = strlen (r); *r; r++, len--)
366             if (*r == ' ' || *r == '\t')
367                 memmove (r, r+1, len);
368     }
369
370     return result;
371 }
372
373 /* Parse a References header value, putting a (talloc'ed under 'ctx')
374  * copy of each referenced message-id into 'hash'. */
375 static void
376 parse_references (void *ctx,
377                   GHashTable *hash,
378                   const char *refs)
379 {
380     char *ref;
381
382     if (refs == NULL)
383         return;
384
385     while (*refs) {
386         ref = parse_message_id (ctx, refs, &refs);
387
388         if (ref)
389             g_hash_table_insert (hash, ref, NULL);
390     }
391 }
392
393 char *
394 notmuch_database_default_path (void)
395 {
396     char *path;
397
398     if (getenv ("NOTMUCH_BASE"))
399         return strdup (getenv ("NOTMUCH_BASE"));
400
401     if (asprintf (&path, "%s/mail", getenv ("HOME")) == -1) {
402         fprintf (stderr, "Out of memory.\n");
403         return xstrdup("");
404     }
405
406     return path;
407 }
408
409 notmuch_database_t *
410 notmuch_database_create (const char *path)
411 {
412     notmuch_database_t *notmuch = NULL;
413     char *notmuch_path = NULL;
414     struct stat st;
415     int err;
416     char *local_path = NULL;
417
418     if (path == NULL)
419         path = local_path = notmuch_database_default_path ();
420
421     err = stat (path, &st);
422     if (err) {
423         fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
424                  path, strerror (errno));
425         goto DONE;
426     }
427
428     if (! S_ISDIR (st.st_mode)) {
429         fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
430                  path);
431         goto DONE;
432     }
433
434     notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
435
436     err = mkdir (notmuch_path, 0755);
437
438     if (err) {
439         fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
440                  notmuch_path, strerror (errno));
441         goto DONE;
442     }
443
444     notmuch = notmuch_database_open (path);
445
446   DONE:
447     if (notmuch_path)
448         talloc_free (notmuch_path);
449     if (local_path)
450         free (local_path);
451
452     return notmuch;
453 }
454
455 notmuch_database_t *
456 notmuch_database_open (const char *path)
457 {
458     notmuch_database_t *notmuch = NULL;
459     char *notmuch_path = NULL, *xapian_path = NULL;
460     struct stat st;
461     int err;
462     char *local_path = NULL;
463     unsigned int i;
464
465     if (path == NULL)
466         path = local_path = notmuch_database_default_path ();
467
468     if (asprintf (&notmuch_path, "%s/%s", path, ".notmuch") == -1) {
469         notmuch_path = NULL;
470         fprintf (stderr, "Out of memory\n");
471         goto DONE;
472     }
473
474     err = stat (notmuch_path, &st);
475     if (err) {
476         fprintf (stderr, "Error opening database at %s: %s\n",
477                  notmuch_path, strerror (errno));
478         goto DONE;
479     }
480
481     if (asprintf (&xapian_path, "%s/%s", notmuch_path, "xapian") == -1) {
482         xapian_path = NULL;
483         fprintf (stderr, "Out of memory\n");
484         goto DONE;
485     }
486
487     notmuch = talloc (NULL, notmuch_database_t);
488     notmuch->path = talloc_strdup (notmuch, path);
489
490     if (notmuch->path[strlen (notmuch->path) - 1] == '/')
491         notmuch->path[strlen (notmuch->path) - 1] = '\0';
492
493     try {
494         notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
495                                                            Xapian::DB_CREATE_OR_OPEN);
496         notmuch->query_parser = new Xapian::QueryParser;
497         notmuch->term_gen = new Xapian::TermGenerator;
498         notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
499
500         notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
501         notmuch->query_parser->set_database (*notmuch->xapian_db);
502         notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
503         notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
504
505         for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
506             prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
507             notmuch->query_parser->add_boolean_prefix (prefix->name,
508                                                        prefix->prefix);
509         }
510
511         for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
512             prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
513             notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
514         }
515     } catch (const Xapian::Error &error) {
516         fprintf (stderr, "A Xapian exception occurred: %s\n",
517                  error.get_msg().c_str());
518         notmuch = NULL;
519     }
520     
521   DONE:
522     if (local_path)
523         free (local_path);
524     if (notmuch_path)
525         free (notmuch_path);
526     if (xapian_path)
527         free (xapian_path);
528
529     return notmuch;
530 }
531
532 void
533 notmuch_database_close (notmuch_database_t *notmuch)
534 {
535     notmuch->xapian_db->flush ();
536
537     delete notmuch->term_gen;
538     delete notmuch->query_parser;
539     delete notmuch->xapian_db;
540     talloc_free (notmuch);
541 }
542
543 const char *
544 notmuch_database_get_path (notmuch_database_t *notmuch)
545 {
546     return notmuch->path;
547 }
548
549 static notmuch_private_status_t
550 find_timestamp_document (notmuch_database_t *notmuch, const char *db_key,
551                          Xapian::Document *doc, unsigned int *doc_id)
552 {
553     return find_unique_document (notmuch, "timestamp", db_key, doc, doc_id);
554 }
555
556 /* We allow the user to use arbitrarily long keys for timestamps,
557  * (they're for filesystem paths after all, which have no limit we
558  * know about). But we have a term-length limit. So if we exceed that,
559  * we'll use the SHA-1 of the user's key as the actual key for
560  * constructing a database term.
561  *
562  * Caution: This function returns a newly allocated string which the
563  * caller should free() when finished.
564  */
565 static char *
566 timestamp_db_key (const char *key)
567 {
568     int term_len = strlen (_find_prefix ("timestamp")) + strlen (key);
569
570     if (term_len > NOTMUCH_TERM_MAX)
571         return notmuch_sha1_of_string (key);
572     else
573         return strdup (key);
574 }
575
576 notmuch_status_t
577 notmuch_database_set_timestamp (notmuch_database_t *notmuch,
578                                 const char *key, time_t timestamp)
579 {
580     Xapian::Document doc;
581     unsigned int doc_id;
582     notmuch_private_status_t status;
583     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
584     char *db_key = NULL;
585
586     db_key = timestamp_db_key (key);
587
588     try {
589         status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
590
591         doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
592                        Xapian::sortable_serialise (timestamp));
593
594         if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
595             char *term = talloc_asprintf (NULL, "%s%s",
596                                           _find_prefix ("timestamp"), db_key);
597             doc.add_term (term);
598             talloc_free (term);
599
600             notmuch->xapian_db->add_document (doc);
601         } else {
602             notmuch->xapian_db->replace_document (doc_id, doc);
603         }
604
605     } catch (Xapian::Error &error) {
606         fprintf (stderr, "A Xapian exception occurred: %s.\n",
607                  error.get_msg().c_str());
608         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
609     }
610
611     if (db_key)
612         free (db_key);
613
614     return ret;
615 }
616
617 time_t
618 notmuch_database_get_timestamp (notmuch_database_t *notmuch, const char *key)
619 {
620     Xapian::Document doc;
621     unsigned int doc_id;
622     notmuch_private_status_t status;
623     char *db_key = NULL;
624     time_t ret = 0;
625
626     db_key = timestamp_db_key (key);
627
628     try {
629         status = find_timestamp_document (notmuch, db_key, &doc, &doc_id);
630
631         if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
632             goto DONE;
633
634         ret =  Xapian::sortable_unserialise (doc.get_value (NOTMUCH_VALUE_TIMESTAMP));
635     } catch (Xapian::Error &error) {
636         goto DONE;
637     }
638
639   DONE:
640     if (db_key)
641         free (db_key);
642
643     return ret;
644 }
645
646 /* Find the thread ID to which the message with 'message_id' belongs.
647  *
648  * Returns NULL if no message with message ID 'message_id' is in the
649  * database.
650  *
651  * Otherwise, returns a newly talloced string belonging to 'ctx'.
652  */
653 static const char *
654 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
655                                   void *ctx,
656                                   const char *message_id)
657 {
658     notmuch_message_t *message;
659     const char *ret = NULL;
660
661     message = notmuch_database_find_message (notmuch, message_id);
662     if (message == NULL)
663         goto DONE;
664
665     ret = talloc_steal (ctx, notmuch_message_get_thread_id (message));
666
667   DONE:
668     if (message)
669         notmuch_message_destroy (message);
670
671     return ret;
672 }
673
674 static notmuch_status_t
675 _merge_threads (notmuch_database_t *notmuch,
676                 const char *winner_thread_id,
677                 const char *loser_thread_id)
678 {
679     Xapian::PostingIterator loser, loser_end;
680     notmuch_message_t *message = NULL;
681     notmuch_private_status_t private_status;
682     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
683
684     find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
685
686     for ( ; loser != loser_end; loser++) {
687         message = _notmuch_message_create (notmuch, notmuch,
688                                            *loser, &private_status);
689         if (message == NULL) {
690             ret = COERCE_STATUS (private_status,
691                                  "Cannot find document for doc_id from query");
692             goto DONE;
693         }
694
695         _notmuch_message_remove_term (message, "thread", loser_thread_id);
696         _notmuch_message_add_term (message, "thread", winner_thread_id);
697         _notmuch_message_sync (message);
698
699         notmuch_message_destroy (message);
700         message = NULL;
701     }
702
703   DONE:
704     if (message)
705         notmuch_message_destroy (message);
706
707     return ret;
708 }
709
710 static void
711 _my_talloc_free_for_g_hash (void *ptr)
712 {
713     talloc_free (ptr);
714 }
715
716 static notmuch_status_t
717 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
718                                            notmuch_message_t *message,
719                                            notmuch_message_file_t *message_file,
720                                            const char **thread_id)
721 {
722     GHashTable *parents = NULL;
723     const char *refs, *in_reply_to;
724     GList *l, *keys = NULL;
725     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
726
727     parents = g_hash_table_new_full (g_str_hash, g_str_equal,
728                                      _my_talloc_free_for_g_hash, NULL);
729
730     refs = notmuch_message_file_get_header (message_file, "references");
731     parse_references (message, parents, refs);
732
733     in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
734     parse_references (message, parents, in_reply_to);
735
736     keys = g_hash_table_get_keys (parents);
737     for (l = keys; l; l = l->next) {
738         char *parent_message_id;
739         const char *parent_thread_id;
740
741         parent_message_id = (char *) l->data;
742         parent_thread_id = _resolve_message_id_to_thread_id (notmuch,
743                                                              message,
744                                                              parent_message_id);
745
746         if (parent_thread_id == NULL) {
747             _notmuch_message_add_term (message, "ref", parent_message_id);
748         } else {
749             if (*thread_id == NULL) {
750                 *thread_id = talloc_strdup (message, parent_thread_id);
751                 _notmuch_message_add_term (message, "thread", *thread_id);
752             } else if (strcmp (*thread_id, parent_thread_id)) {
753                 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
754                 if (ret)
755                     goto DONE;
756             }
757         }
758     }
759
760   DONE:
761     if (keys)
762         g_list_free (keys);
763     if (parents)
764         g_hash_table_unref (parents);
765
766     return ret;
767 }
768
769 static notmuch_status_t
770 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
771                                             notmuch_message_t *message,
772                                             const char **thread_id)
773 {
774     const char *message_id = notmuch_message_get_message_id (message);
775     Xapian::PostingIterator child, children_end;
776     notmuch_message_t *child_message = NULL;
777     const char *child_thread_id;
778     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
779     notmuch_private_status_t private_status;
780
781     find_doc_ids (notmuch, "ref", message_id, &child, &children_end);
782
783     for ( ; child != children_end; child++) {
784
785         child_message = _notmuch_message_create (message, notmuch,
786                                                  *child, &private_status);
787         if (child_message == NULL) {
788             ret = COERCE_STATUS (private_status,
789                                  "Cannot find document for doc_id from query");
790             goto DONE;
791         }
792
793         child_thread_id = notmuch_message_get_thread_id (child_message);
794         if (*thread_id == NULL) {
795             *thread_id = talloc_strdup (message, child_thread_id);
796             _notmuch_message_add_term (message, "thread", *thread_id);
797         } else if (strcmp (*thread_id, child_thread_id)) {
798             _notmuch_message_remove_term (child_message, "ref",
799                                           message_id);
800             _notmuch_message_sync (child_message);
801             ret = _merge_threads (notmuch, *thread_id, child_thread_id);
802             if (ret)
803                 goto DONE;
804         }
805
806         notmuch_message_destroy (child_message);
807         child_message = NULL;
808     }
809
810   DONE:
811     if (child_message)
812         notmuch_message_destroy (child_message);
813
814     return ret;
815 }
816
817 /* Given a (mostly empty) 'message' and its corresponding
818  * 'message_file' link it to existing threads in the database.
819  *
820  * We first looke at 'message_file' and its link-relevant headers
821  * (References and In-Reply-To) for message IDs. We also look in the
822  * database for existing message that reference 'message'.p
823  *
824  * The end result is to call _notmuch_message_add_thread_id with one
825  * or more thread IDs to which this message belongs, (including
826  * generating a new thread ID if necessary if the message doesn't
827  * connect to any existing threads).
828  */
829 static notmuch_status_t
830 _notmuch_database_link_message (notmuch_database_t *notmuch,
831                                 notmuch_message_t *message,
832                                 notmuch_message_file_t *message_file)
833 {
834     notmuch_status_t status;
835     const char *thread_id = NULL;
836
837     status = _notmuch_database_link_message_to_parents (notmuch, message,
838                                                         message_file,
839                                                         &thread_id);
840     if (status)
841         return status;
842
843     status = _notmuch_database_link_message_to_children (notmuch, message,
844                                                          &thread_id);
845     if (status)
846         return status;
847
848     if (thread_id == NULL)
849         _notmuch_message_ensure_thread_id (message);
850
851     return NOTMUCH_STATUS_SUCCESS;
852 }
853
854 notmuch_status_t
855 notmuch_database_add_message (notmuch_database_t *notmuch,
856                               const char *filename,
857                               notmuch_message_t **message_ret)
858 {
859     notmuch_message_file_t *message_file;
860     notmuch_message_t *message;
861     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
862     notmuch_private_status_t private_status;
863
864     const char *date, *header;
865     const char *from, *to, *subject;
866     char *message_id;
867
868     if (message_ret)
869         *message_ret = NULL;
870
871     message_file = notmuch_message_file_open (filename);
872     if (message_file == NULL) {
873         ret = NOTMUCH_STATUS_FILE_ERROR;
874         goto DONE;
875     }
876
877     notmuch_message_file_restrict_headers (message_file,
878                                            "date",
879                                            "from",
880                                            "in-reply-to",
881                                            "message-id",
882                                            "references",
883                                            "subject",
884                                            "to",
885                                            (char *) NULL);
886
887     try {
888         /* Before we do any real work, (especially before doing a
889          * potential SHA-1 computation on the entire file's contents),
890          * let's make sure that what we're looking at looks like an
891          * actual email message.
892          */
893         from = notmuch_message_file_get_header (message_file, "from");
894         subject = notmuch_message_file_get_header (message_file, "subject");
895         to = notmuch_message_file_get_header (message_file, "to");
896
897         if (from == NULL &&
898             subject == NULL &&
899             to == NULL)
900         {
901             ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
902             goto DONE;
903         }
904
905         /* Now that we're sure it's mail, the first order of business
906          * is to find a message ID (or else create one ourselves). */
907
908         header = notmuch_message_file_get_header (message_file, "message-id");
909         if (header) {
910             message_id = parse_message_id (message_file, header, NULL);
911             /* So the header value isn't RFC-compliant, but it's
912              * better than no message-id at all. */
913             if (message_id == NULL)
914                 message_id = talloc_strdup (message_file, header);
915         } else {
916             /* No message-id at all, let's generate one by taking a
917              * hash over the file's contents. */
918             char *sha1 = notmuch_sha1_of_file (filename);
919
920             /* If that failed too, something is really wrong. Give up. */
921             if (sha1 == NULL) {
922                 ret = NOTMUCH_STATUS_FILE_ERROR;
923                 goto DONE;
924             }
925
926             message_id = talloc_asprintf (message_file,
927                                           "notmuch-sha1-%s", sha1);
928             free (sha1);
929         }
930
931         /* Now that we have a message ID, we get a message object,
932          * (which may or may not reference an existing document in the
933          * database). */
934
935         /* Use NULL for owner since we want to free this locally. */
936         message = _notmuch_message_create_for_message_id (NULL,
937                                                           notmuch,
938                                                           message_id,
939                                                           &private_status);
940
941         talloc_free (message_id);
942
943         if (message == NULL)
944             goto DONE;
945
946         /* Is this a newly created message object? */
947         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
948             _notmuch_message_set_filename (message, filename);
949             _notmuch_message_add_term (message, "type", "mail");
950         } else {
951             ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
952             goto DONE;
953         }
954
955         ret = _notmuch_database_link_message (notmuch, message, message_file);
956         if (ret)
957             goto DONE;
958
959         date = notmuch_message_file_get_header (message_file, "date");
960         _notmuch_message_set_date (message, date);
961
962         _notmuch_message_index_file (message, filename);
963
964         _notmuch_message_sync (message);
965     } catch (const Xapian::Error &error) {
966         fprintf (stderr, "A Xapian exception occurred: %s.\n",
967                  error.get_msg().c_str());
968         ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
969         goto DONE;
970     }
971
972   DONE:
973     if (message) {
974         if (ret == NOTMUCH_STATUS_SUCCESS && message_ret)
975             *message_ret = message;
976         else
977             notmuch_message_destroy (message);
978     }
979
980     if (message_file)
981         notmuch_message_file_close (message_file);
982
983     return ret;
984 }