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