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