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