git.notmuchmail.org Git - notmuch/blob - lib/message.cc

   1 /* message.cc - Results of message-based searches from a notmuch database
   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 https://www.gnu.org/licenses/ .
  17  *
  18  * Author: Carl Worth <cworth@cworth.org>
  19  */
  20
  21 #include "notmuch-private.h"
  22 #include "database-private.h"
  23 #include "message-private.h"
  24
  25 #include <stdint.h>
  26
  27 #include <gmime/gmime.h>
  28
  29 struct _notmuch_message {
  30     notmuch_database_t *notmuch;
  31     Xapian::docid doc_id;
  32     int frozen;
  33     char *message_id;
  34     char *thread_id;
  35     size_t thread_depth;
  36     char *in_reply_to;
  37     notmuch_string_list_t *tag_list;
  38     notmuch_string_list_t *filename_term_list;
  39     notmuch_string_list_t *filename_list;
  40     char *maildir_flags;
  41     char *author;
  42     notmuch_message_file_t *message_file;
  43     notmuch_string_list_t *property_term_list;
  44     notmuch_string_map_t *property_map;
  45     notmuch_string_list_t *reference_list;
  46     notmuch_message_list_t *replies;
  47     unsigned long flags;
  48     /* For flags that are initialized on-demand, lazy_flags indicates
  49      * if each flag has been initialized. */
  50     unsigned long lazy_flags;
  51
  52     /* Message document modified since last sync */
  53     bool modified;
  54
  55     /* last view of database the struct is synced with */
  56     unsigned long last_view;
  57
  58     Xapian::Document doc;
  59     Xapian::termcount termpos;
  60 };
  61
  62 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  63
  64 struct maildir_flag_tag {
  65     char flag;
  66     const char *tag;
  67     bool inverse;
  68 };
  69
  70 /* ASCII ordered table of Maildir flags and associated tags */
  71 static struct maildir_flag_tag flag2tag[] = {
  72     { 'D', "draft",   false },
  73     { 'F', "flagged", false },
  74     { 'P', "passed",  false },
  75     { 'R', "replied", false },
  76     { 'S', "unread",  true }
  77 };
  78
  79 /* We end up having to call the destructor explicitly because we had
  80  * to use "placement new" in order to initialize C++ objects within a
  81  * block that we allocated with talloc. So C++ is making talloc
  82  * slightly less simple to use, (we wouldn't need
  83  * talloc_set_destructor at all otherwise).
  84  */
  85 static int
  86 _notmuch_message_destructor (notmuch_message_t *message)
  87 {
  88     message->doc.~Document ();
  89
  90     return 0;
  91 }
  92
  93 #define LOG_XAPIAN_EXCEPTION(message, error) _log_xapian_exception (__location__, message, error)
  94
  95 static void
  96 _log_xapian_exception (const char *where, notmuch_message_t *message,  const Xapian::Error error) {
  97     notmuch_database_t *notmuch = notmuch_message_get_database (message);
  98     _notmuch_database_log (notmuch,
  99                            "A Xapian exception occurred %s retrieving %s : %s\n",
 100                            where,
 101                            error.get_msg ().c_str ());
 102     notmuch->exception_reported = true;
 103 }
 104
 105 static notmuch_message_t *
 106 _notmuch_message_create_for_document (const void *talloc_owner,
 107                                       notmuch_database_t *notmuch,
 108                                       unsigned int doc_id,
 109                                       Xapian::Document doc,
 110                                       notmuch_private_status_t *status)
 111 {
 112     notmuch_message_t *message;
 113
 114     if (status)
 115         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
 116
 117     message = talloc (talloc_owner, notmuch_message_t);
 118     if (unlikely (message == NULL)) {
 119         if (status)
 120             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 121         return NULL;
 122     }
 123
 124     message->notmuch = notmuch;
 125     message->doc_id = doc_id;
 126
 127     message->frozen = 0;
 128     message->flags = 0;
 129     message->lazy_flags = 0;
 130
 131     /* the message is initially not synchronized with Xapian */
 132     message->last_view = 0;
 133
 134     /* Calculated after the thread structure is computed */
 135     message->thread_depth = 0;
 136
 137     /* Each of these will be lazily created as needed. */
 138     message->message_id = NULL;
 139     message->thread_id = NULL;
 140     message->in_reply_to = NULL;
 141     message->tag_list = NULL;
 142     message->filename_term_list = NULL;
 143     message->filename_list = NULL;
 144     message->maildir_flags = NULL;
 145     message->message_file = NULL;
 146     message->author = NULL;
 147     message->property_term_list = NULL;
 148     message->property_map = NULL;
 149     message->reference_list = NULL;
 150
 151     message->replies = _notmuch_message_list_create (message);
 152     if (unlikely (message->replies == NULL)) {
 153         if (status)
 154             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 155         return NULL;
 156     }
 157
 158     /* This is C++'s creepy "placement new", which is really just an
 159      * ugly way to call a constructor for a pre-allocated object. So
 160      * it's really not an error to not be checking for OUT_OF_MEMORY
 161      * here, since this "new" isn't actually allocating memory. This
 162      * is language-design comedy of the wrong kind. */
 163
 164     new (&message->doc) Xapian::Document;
 165
 166     talloc_set_destructor (message, _notmuch_message_destructor);
 167
 168     message->doc = doc;
 169     message->termpos = 0;
 170
 171     return message;
 172 }
 173
 174 /* Create a new notmuch_message_t object for an existing document in
 175  * the database.
 176  *
 177  * Here, 'talloc owner' is an optional talloc context to which the new
 178  * message will belong. This allows for the caller to not bother
 179  * calling notmuch_message_destroy on the message, and know that all
 180  * memory will be reclaimed when 'talloc_owner' is freed. The caller
 181  * still can call notmuch_message_destroy when finished with the
 182  * message if desired.
 183  *
 184  * The 'talloc_owner' argument can also be NULL, in which case the
 185  * caller *is* responsible for calling notmuch_message_destroy.
 186  *
 187  * If no document exists in the database with document ID of 'doc_id'
 188  * then this function returns NULL and optionally sets *status to
 189  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
 190  *
 191  * This function can also fail to due lack of available memory,
 192  * returning NULL and optionally setting *status to
 193  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
 194  *
 195  * The caller can pass NULL for status if uninterested in
 196  * distinguishing these two cases.
 197  */
 198 notmuch_message_t *
 199 _notmuch_message_create (const void *talloc_owner,
 200                          notmuch_database_t *notmuch,
 201                          unsigned int doc_id,
 202                          notmuch_private_status_t *status)
 203 {
 204     Xapian::Document doc;
 205
 206     try {
 207         doc = notmuch->xapian_db->get_document (doc_id);
 208     } catch (const Xapian::DocNotFoundError &error) {
 209         if (status)
 210             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 211         return NULL;
 212     }
 213
 214     return _notmuch_message_create_for_document (talloc_owner, notmuch,
 215                                                  doc_id, doc, status);
 216 }
 217
 218 /* Create a new notmuch_message_t object for a specific message ID,
 219  * (which may or may not already exist in the database).
 220  *
 221  * The 'notmuch' database will be the talloc owner of the returned
 222  * message.
 223  *
 224  * This function returns a valid notmuch_message_t whether or not
 225  * there is already a document in the database with the given message
 226  * ID. These two cases can be distinguished by the value of *status:
 227  *
 228  *
 229  *   NOTMUCH_PRIVATE_STATUS_SUCCESS:
 230  *
 231  *     There is already a document with message ID 'message_id' in the
 232  *     database. The returned message can be used to query/modify the
 233  *     document. The message may be a ghost message.
 234  *
 235  *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
 236  *
 237  *     No document with 'message_id' exists in the database. The
 238  *     returned message contains a newly created document (not yet
 239  *     added to the database) and a document ID that is known not to
 240  *     exist in the database.  This message is "blank"; that is, it
 241  *     contains only a message ID and no other metadata. The caller
 242  *     can modify the message, and a call to _notmuch_message_sync
 243  *     will add the document to the database.
 244  *
 245  * If an error occurs, this function will return NULL and *status
 246  * will be set as appropriate. (The status pointer argument must
 247  * not be NULL.)
 248  */
 249 notmuch_message_t *
 250 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 251                                         const char *message_id,
 252                                         notmuch_private_status_t *status_ret)
 253 {
 254     notmuch_message_t *message;
 255     Xapian::Document doc;
 256     unsigned int doc_id;
 257     char *term;
 258
 259     *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
 260                                                                             message_id,
 261                                                                             &message);
 262     if (message)
 263         return talloc_steal (notmuch, message);
 264     else if (*status_ret)
 265         return NULL;
 266
 267     /* If the message ID is too long, substitute its sha1 instead. */
 268     if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
 269         message_id = _notmuch_message_id_compressed (message, message_id);
 270
 271     term = talloc_asprintf (NULL, "%s%s",
 272                             _find_prefix ("id"), message_id);
 273     if (term == NULL) {
 274         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 275         return NULL;
 276     }
 277
 278     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 279         INTERNAL_ERROR ("Failure to ensure database is writable.");
 280
 281     try {
 282         doc.add_term (term, 0);
 283         talloc_free (term);
 284
 285         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 286
 287         doc_id = _notmuch_database_generate_doc_id (notmuch);
 288     } catch (const Xapian::Error &error) {
 289         _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred creating message: %s\n",
 290                                error.get_msg ().c_str ());
 291         notmuch->exception_reported = true;
 292         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
 293         return NULL;
 294     }
 295
 296     message = _notmuch_message_create_for_document (notmuch, notmuch,
 297                                                     doc_id, doc, status_ret);
 298
 299     /* We want to inform the caller that we had to create a new
 300      * document. */
 301     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
 302         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 303
 304     return message;
 305 }
 306
 307 static char *
 308 _notmuch_message_get_term (notmuch_message_t *message,
 309                            Xapian::TermIterator &i, Xapian::TermIterator &end,
 310                            const char *prefix)
 311 {
 312     int prefix_len = strlen (prefix);
 313     char *value;
 314
 315     i.skip_to (prefix);
 316
 317     if (i == end)
 318         return NULL;
 319
 320     const std::string &term = *i;
 321     if (strncmp (term.c_str (), prefix, prefix_len))
 322         return NULL;
 323
 324     value = talloc_strdup (message, term.c_str () + prefix_len);
 325
 326 #if DEBUG_DATABASE_SANITY
 327     i++;
 328
 329     if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
 330         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
 331                         message->doc_id, prefix, value,
 332                         (*i).c_str () + prefix_len);
 333     }
 334 #endif
 335
 336     return value;
 337 }
 338
 339 /*
 340  * For special applications where we only want the thread id, reading
 341  * in all metadata is a heavy I/O penalty.
 342  */
 343 const char *
 344 _notmuch_message_get_thread_id_only (notmuch_message_t *message)
 345 {
 346
 347     Xapian::TermIterator i = message->doc.termlist_begin ();
 348     Xapian::TermIterator end = message->doc.termlist_end ();
 349
 350     message->thread_id = _notmuch_message_get_term (message, i, end,
 351                                                     _find_prefix ("thread"));
 352     return message->thread_id;
 353 }
 354
 355
 356 static void
 357 _notmuch_message_ensure_metadata (notmuch_message_t *message, void *field)
 358 {
 359     Xapian::TermIterator i, end;
 360
 361     if (field && (message->last_view >= message->notmuch->view))
 362         return;
 363
 364     const char *thread_prefix = _find_prefix ("thread"),
 365                *tag_prefix = _find_prefix ("tag"),
 366                *id_prefix = _find_prefix ("id"),
 367                *type_prefix = _find_prefix ("type"),
 368                *filename_prefix = _find_prefix ("file-direntry"),
 369                *property_prefix = _find_prefix ("property"),
 370                *reference_prefix = _find_prefix ("reference"),
 371                *replyto_prefix = _find_prefix ("replyto");
 372
 373     /* We do this all in a single pass because Xapian decompresses the
 374      * term list every time you iterate over it.  Thus, while this is
 375      * slightly more costly than looking up individual fields if only
 376      * one field of the message object is actually used, it's a huge
 377      * win as more fields are used. */
 378     for (int count = 0; count < 3; count++) {
 379         try {
 380             i = message->doc.termlist_begin ();
 381             end = message->doc.termlist_end ();
 382
 383             /* Get thread */
 384             if (! message->thread_id)
 385                 message->thread_id =
 386                     _notmuch_message_get_term (message, i, end, thread_prefix);
 387
 388             /* Get tags */
 389             assert (strcmp (thread_prefix, tag_prefix) < 0);
 390             if (! message->tag_list) {
 391                 message->tag_list =
 392                     _notmuch_database_get_terms_with_prefix (message, i, end,
 393                                                              tag_prefix);
 394                 _notmuch_string_list_sort (message->tag_list);
 395             }
 396
 397             /* Get id */
 398             assert (strcmp (tag_prefix, id_prefix) < 0);
 399             if (! message->message_id)
 400                 message->message_id =
 401                     _notmuch_message_get_term (message, i, end, id_prefix);
 402
 403             /* Get document type */
 404             assert (strcmp (id_prefix, type_prefix) < 0);
 405             if (! NOTMUCH_TEST_BIT (message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST)) {
 406                 i.skip_to (type_prefix);
 407                 /* "T" is the prefix "type" fields.  See
 408                  * BOOLEAN_PREFIX_INTERNAL. */
 409                 if (*i == "Tmail")
 410                     NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
 411                 else if (*i == "Tghost")
 412                     NOTMUCH_SET_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
 413                 else
 414                     INTERNAL_ERROR ("Message without type term");
 415                 NOTMUCH_SET_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
 416             }
 417
 418             /* Get filename list.  Here we get only the terms.  We lazily
 419              * expand them to full file names when needed in
 420              * _notmuch_message_ensure_filename_list. */
 421             assert (strcmp (type_prefix, filename_prefix) < 0);
 422             if (! message->filename_term_list && ! message->filename_list)
 423                 message->filename_term_list =
 424                     _notmuch_database_get_terms_with_prefix (message, i, end,
 425                                                              filename_prefix);
 426
 427
 428             /* Get property terms. Mimic the setup with filenames above */
 429             assert (strcmp (filename_prefix, property_prefix) < 0);
 430             if (! message->property_map && ! message->property_term_list)
 431                 message->property_term_list =
 432                     _notmuch_database_get_terms_with_prefix (message, i, end,
 433                                                              property_prefix);
 434
 435             /* get references */
 436             assert (strcmp (property_prefix, reference_prefix) < 0);
 437             if (! message->reference_list) {
 438                 message->reference_list =
 439                     _notmuch_database_get_terms_with_prefix (message, i, end,
 440                                                              reference_prefix);
 441             }
 442
 443             /* Get reply to */
 444             assert (strcmp (property_prefix, replyto_prefix) < 0);
 445             if (! message->in_reply_to)
 446                 message->in_reply_to =
 447                     _notmuch_message_get_term (message, i, end, replyto_prefix);
 448
 449
 450             /* It's perfectly valid for a message to have no In-Reply-To
 451              * header. For these cases, we return an empty string. */
 452             if (! message->in_reply_to)
 453                 message->in_reply_to = talloc_strdup (message, "");
 454
 455             /* all the way without an exception */
 456             break;
 457         } catch (const Xapian::DatabaseModifiedError &error) {
 458             notmuch_status_t status = _notmuch_database_reopen (message->notmuch);
 459             if (status != NOTMUCH_STATUS_SUCCESS)
 460                 INTERNAL_ERROR ("unhandled error from notmuch_database_reopen: %s\n",
 461                                 notmuch_status_to_string (status));
 462         }
 463     }
 464     message->last_view = message->notmuch->view;
 465 }
 466
 467 void
 468 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
 469                                       const char *prefix_name)
 470 {
 471     if (strcmp ("thread", prefix_name) == 0) {
 472         talloc_free (message->thread_id);
 473         message->thread_id = NULL;
 474     }
 475
 476     if (strcmp ("tag", prefix_name) == 0) {
 477         talloc_unlink (message, message->tag_list);
 478         message->tag_list = NULL;
 479     }
 480
 481     if (strcmp ("type", prefix_name) == 0) {
 482         NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
 483         NOTMUCH_CLEAR_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
 484     }
 485
 486     if (strcmp ("file-direntry", prefix_name) == 0) {
 487         talloc_free (message->filename_term_list);
 488         talloc_free (message->filename_list);
 489         message->filename_term_list = message->filename_list = NULL;
 490     }
 491
 492     if (strcmp ("property", prefix_name) == 0) {
 493
 494         if (message->property_term_list)
 495             talloc_free (message->property_term_list);
 496         message->property_term_list = NULL;
 497
 498         if (message->property_map)
 499             talloc_unlink (message, message->property_map);
 500
 501         message->property_map = NULL;
 502     }
 503
 504     if (strcmp ("replyto", prefix_name) == 0) {
 505         talloc_free (message->in_reply_to);
 506         message->in_reply_to = NULL;
 507     }
 508 }
 509
 510 unsigned int
 511 _notmuch_message_get_doc_id (notmuch_message_t *message)
 512 {
 513     return message->doc_id;
 514 }
 515
 516 const char *
 517 notmuch_message_get_message_id (notmuch_message_t *message)
 518 {
 519     try {
 520         _notmuch_message_ensure_metadata (message, message->message_id);
 521     } catch (const Xapian::Error &error) {
 522         LOG_XAPIAN_EXCEPTION (message, error);
 523         return NULL;
 524     }
 525
 526     if (! message->message_id)
 527         INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
 528                         message->doc_id);
 529     return message->message_id;
 530 }
 531
 532 static void
 533 _notmuch_message_ensure_message_file (notmuch_message_t *message)
 534 {
 535     const char *filename;
 536
 537     if (message->message_file)
 538         return;
 539
 540     filename = notmuch_message_get_filename (message);
 541     if (unlikely (filename == NULL))
 542         return;
 543
 544     message->message_file = _notmuch_message_file_open_ctx (
 545         notmuch_message_get_database (message), message, filename);
 546 }
 547
 548 const char *
 549 notmuch_message_get_header (notmuch_message_t *message, const char *header)
 550 {
 551     Xapian::valueno slot = Xapian::BAD_VALUENO;
 552
 553     /* Fetch header from the appropriate xapian value field if
 554      * available */
 555     if (strcasecmp (header, "from") == 0)
 556         slot = NOTMUCH_VALUE_FROM;
 557     else if (strcasecmp (header, "subject") == 0)
 558         slot = NOTMUCH_VALUE_SUBJECT;
 559     else if (strcasecmp (header, "message-id") == 0)
 560         slot = NOTMUCH_VALUE_MESSAGE_ID;
 561
 562     if (slot != Xapian::BAD_VALUENO) {
 563         try {
 564             std::string value = message->doc.get_value (slot);
 565
 566             /* If we have NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES, then
 567              * empty values indicate empty headers.  If we don't, then
 568              * it could just mean we didn't record the header. */
 569             if ((message->notmuch->features &
 570                  NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES) ||
 571                 ! value.empty ())
 572                 return talloc_strdup (message, value.c_str ());
 573
 574         } catch (Xapian::Error &error) {
 575             LOG_XAPIAN_EXCEPTION (message, error);
 576             return NULL;
 577         }
 578     }
 579
 580     /* Otherwise fall back to parsing the file */
 581     _notmuch_message_ensure_message_file (message);
 582     if (message->message_file == NULL)
 583         return NULL;
 584
 585     return _notmuch_message_file_get_header (message->message_file, header);
 586 }
 587
 588 /* Return the message ID from the In-Reply-To header of 'message'.
 589  *
 590  * Returns an empty string ("") if 'message' has no In-Reply-To
 591  * header.
 592  *
 593  * Returns NULL if any error occurs.
 594  */
 595 const char *
 596 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
 597 {
 598     _notmuch_message_ensure_metadata (message, message->in_reply_to);
 599     return message->in_reply_to;
 600 }
 601
 602 const char *
 603 notmuch_message_get_thread_id (notmuch_message_t *message)
 604 {
 605     try {
 606         _notmuch_message_ensure_metadata (message, message->thread_id);
 607     } catch (Xapian::Error &error) {
 608         LOG_XAPIAN_EXCEPTION (message, error);
 609         return NULL;
 610     }
 611     if (! message->thread_id)
 612         INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
 613                         message->doc_id);
 614     return message->thread_id;
 615 }
 616
 617 void
 618 _notmuch_message_add_reply (notmuch_message_t *message,
 619                             notmuch_message_t *reply)
 620 {
 621     _notmuch_message_list_add_message (message->replies, reply);
 622 }
 623
 624 size_t
 625 _notmuch_message_get_thread_depth (notmuch_message_t *message)
 626 {
 627     return message->thread_depth;
 628 }
 629
 630 void
 631 _notmuch_message_label_depths (notmuch_message_t *message,
 632                                size_t depth)
 633 {
 634     message->thread_depth = depth;
 635
 636     for (notmuch_messages_t *messages = _notmuch_messages_create (message->replies);
 637          notmuch_messages_valid (messages);
 638          notmuch_messages_move_to_next (messages)) {
 639         notmuch_message_t *child = notmuch_messages_get (messages);
 640         _notmuch_message_label_depths (child, depth + 1);
 641     }
 642 }
 643
 644 const notmuch_string_list_t *
 645 _notmuch_message_get_references (notmuch_message_t *message)
 646 {
 647     _notmuch_message_ensure_metadata (message, message->reference_list);
 648     return message->reference_list;
 649 }
 650
 651 static int
 652 _cmpmsg (const void *pa, const void *pb)
 653 {
 654     notmuch_message_t **a = (notmuch_message_t **) pa;
 655     notmuch_message_t **b = (notmuch_message_t **) pb;
 656     time_t time_a = notmuch_message_get_date (*a);
 657     time_t time_b = notmuch_message_get_date (*b);
 658
 659     if (time_a == time_b)
 660         return 0;
 661     else if (time_a < time_b)
 662         return -1;
 663     else
 664         return 1;
 665 }
 666
 667 notmuch_message_list_t *
 668 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list)
 669 {
 670
 671     size_t count = 0;
 672     size_t capacity = 16;
 673
 674     if (! list)
 675         return list;
 676
 677     void *local = talloc_new (NULL);
 678     notmuch_message_list_t *new_list = _notmuch_message_list_create (ctx);
 679     notmuch_message_t **message_array = talloc_zero_array (local, notmuch_message_t *, capacity);
 680
 681     for (notmuch_messages_t *messages = _notmuch_messages_create (list);
 682          notmuch_messages_valid (messages);
 683          notmuch_messages_move_to_next (messages)) {
 684         notmuch_message_t *root = notmuch_messages_get (messages);
 685         if (count >= capacity) {
 686             capacity *= 2;
 687             message_array = talloc_realloc (local, message_array, notmuch_message_t *, capacity);
 688         }
 689         message_array[count++] = root;
 690         root->replies = _notmuch_message_sort_subtrees (root, root->replies);
 691     }
 692
 693     qsort (message_array, count, sizeof (notmuch_message_t *), _cmpmsg);
 694     for (size_t i = 0; i < count; i++) {
 695         _notmuch_message_list_add_message (new_list, message_array[i]);
 696     }
 697
 698     talloc_free (local);
 699     talloc_free (list);
 700     return new_list;
 701 }
 702
 703 notmuch_messages_t *
 704 notmuch_message_get_replies (notmuch_message_t *message)
 705 {
 706     return _notmuch_messages_create (message->replies);
 707 }
 708
 709 void
 710 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
 711 {
 712     Xapian::TermIterator i;
 713     size_t prefix_len = 0;
 714
 715     prefix_len = strlen (prefix);
 716
 717     while (1) {
 718         i = message->doc.termlist_begin ();
 719         i.skip_to (prefix);
 720
 721         /* Terminate loop when no terms remain with desired prefix. */
 722         if (i == message->doc.termlist_end () ||
 723             strncmp ((*i).c_str (), prefix, prefix_len))
 724             break;
 725
 726         try {
 727             message->doc.remove_term ((*i));
 728             message->modified = true;
 729         } catch (const Xapian::InvalidArgumentError) {
 730             /* Ignore failure to remove non-existent term. */
 731         }
 732     }
 733 }
 734
 735
 736 /* Remove all terms generated by indexing, i.e. not tags or
 737  * properties, along with any automatic tags*/
 738 /* According to Xapian API docs, none of these calls throw
 739  * exceptions */
 740 notmuch_private_status_t
 741 _notmuch_message_remove_indexed_terms (notmuch_message_t *message)
 742 {
 743     Xapian::TermIterator i;
 744
 745     const std::string
 746         id_prefix = _find_prefix ("id"),
 747         property_prefix = _find_prefix ("property"),
 748         tag_prefix = _find_prefix ("tag"),
 749         type_prefix = _find_prefix ("type");
 750
 751     /* Make sure we have the data to restore to Xapian*/
 752     _notmuch_message_ensure_metadata (message, NULL);
 753
 754     /* Empirically, it turns out to be faster to remove all the terms,
 755      * and add back the ones we want. */
 756     message->doc.clear_terms ();
 757     message->modified = true;
 758
 759     /* still a mail message */
 760     message->doc.add_term (type_prefix + "mail");
 761
 762     /* Put back message-id */
 763     message->doc.add_term (id_prefix + message->message_id);
 764
 765     /* Put back non-automatic tags */
 766     for (notmuch_tags_t *tags = notmuch_message_get_tags (message);
 767          notmuch_tags_valid (tags);
 768          notmuch_tags_move_to_next (tags)) {
 769
 770         const char *tag = notmuch_tags_get (tags);
 771
 772         if (strcmp (tag, "encrypted") != 0 &&
 773             strcmp (tag, "signed") != 0 &&
 774             strcmp (tag, "attachment") != 0) {
 775             std::string term = tag_prefix + tag;
 776             message->doc.add_term (term);
 777         }
 778     }
 779
 780     /* Put back properties */
 781     notmuch_message_properties_t *list;
 782
 783     for (list = notmuch_message_get_properties (message, "", false);
 784          notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
 785         std::string term = property_prefix +
 786                            notmuch_message_properties_key (list) + "=" +
 787                            notmuch_message_properties_value (list);
 788
 789         message->doc.add_term (term);
 790     }
 791
 792     notmuch_message_properties_destroy (list);
 793
 794     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 795 }
 796
 797
 798 /* Return true if p points at "new" or "cur". */
 799 static bool
 800 is_maildir (const char *p)
 801 {
 802     return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
 803 }
 804
 805 /* Add "folder:" term for directory. */
 806 static notmuch_status_t
 807 _notmuch_message_add_folder_terms (notmuch_message_t *message,
 808                                    const char *directory)
 809 {
 810     char *folder, *last;
 811
 812     folder = talloc_strdup (NULL, directory);
 813     if (! folder)
 814         return NOTMUCH_STATUS_OUT_OF_MEMORY;
 815
 816     /*
 817      * If the message file is in a leaf directory named "new" or
 818      * "cur", presume maildir and index the parent directory. Thus a
 819      * "folder:" prefix search matches messages in the specified
 820      * maildir folder, i.e. in the specified directory and its "new"
 821      * and "cur" subdirectories.
 822      *
 823      * Note that this means the "folder:" prefix can't be used for
 824      * distinguishing between message files in "new" or "cur". The
 825      * "path:" prefix needs to be used for that.
 826      *
 827      * Note the deliberate difference to _filename_is_in_maildir(). We
 828      * don't want to index different things depending on the existence
 829      * or non-existence of all maildir sibling directories "new",
 830      * "cur", and "tmp". Doing so would be surprising, and difficult
 831      * for the user to fix in case all subdirectories were not in
 832      * place during indexing.
 833      */
 834     last = strrchr (folder, '/');
 835     if (last) {
 836         if (is_maildir (last + 1))
 837             *last = '\0';
 838     } else if (is_maildir (folder)) {
 839         *folder = '\0';
 840     }
 841
 842     _notmuch_message_add_term (message, "folder", folder);
 843
 844     talloc_free (folder);
 845
 846     message->modified = true;
 847     return NOTMUCH_STATUS_SUCCESS;
 848 }
 849
 850 #define RECURSIVE_SUFFIX "/**"
 851
 852 /* Add "path:" terms for directory. */
 853 static notmuch_status_t
 854 _notmuch_message_add_path_terms (notmuch_message_t *message,
 855                                  const char *directory)
 856 {
 857     /* Add exact "path:" term. */
 858     _notmuch_message_add_term (message, "path", directory);
 859
 860     if (strlen (directory)) {
 861         char *path, *p;
 862
 863         path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
 864         if (! path)
 865             return NOTMUCH_STATUS_OUT_OF_MEMORY;
 866
 867         /* Add recursive "path:" terms for directory and all parents. */
 868         for (p = path + strlen (path) - 1; p > path; p--) {
 869             if (*p == '/') {
 870                 strcpy (p, RECURSIVE_SUFFIX);
 871                 _notmuch_message_add_term (message, "path", path);
 872             }
 873         }
 874
 875         talloc_free (path);
 876     }
 877
 878     /* Recursive all-matching path:** for consistency. */
 879     _notmuch_message_add_term (message, "path", "**");
 880
 881     return NOTMUCH_STATUS_SUCCESS;
 882 }
 883
 884 /* Add directory based terms for all filenames of the message. */
 885 static notmuch_status_t
 886 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
 887 {
 888     const char *direntry_prefix = _find_prefix ("file-direntry");
 889     int direntry_prefix_len = strlen (direntry_prefix);
 890     Xapian::TermIterator i = message->doc.termlist_begin ();
 891     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
 892
 893     for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
 894         unsigned int directory_id;
 895         const char *direntry, *directory;
 896         char *colon;
 897         const std::string &term = *i;
 898
 899         /* Terminate loop at first term without desired prefix. */
 900         if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
 901             break;
 902
 903         /* Indicate that there are filenames remaining. */
 904         status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
 905
 906         direntry = term.c_str ();
 907         direntry += direntry_prefix_len;
 908
 909         directory_id = strtol (direntry, &colon, 10);
 910
 911         if (colon == NULL || *colon != ':')
 912             INTERNAL_ERROR ("malformed direntry");
 913
 914         directory = _notmuch_database_get_directory_path (ctx,
 915                                                           message->notmuch,
 916                                                           directory_id);
 917
 918         _notmuch_message_add_folder_terms (message, directory);
 919         _notmuch_message_add_path_terms (message, directory);
 920     }
 921
 922     return status;
 923 }
 924
 925 /* Add an additional 'filename' for 'message'.
 926  *
 927  * This change will not be reflected in the database until the next
 928  * call to _notmuch_message_sync. */
 929 notmuch_status_t
 930 _notmuch_message_add_filename (notmuch_message_t *message,
 931                                const char *filename)
 932 {
 933     const char *relative, *directory;
 934     notmuch_status_t status;
 935     void *local = talloc_new (message);
 936     char *direntry;
 937
 938     if (filename == NULL)
 939         INTERNAL_ERROR ("Message filename cannot be NULL.");
 940
 941     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
 942         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
 943         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
 944
 945     relative = _notmuch_database_relative_path (message->notmuch, filename);
 946
 947     status = _notmuch_database_split_path (local, relative, &directory, NULL);
 948     if (status)
 949         return status;
 950
 951     status = _notmuch_database_filename_to_direntry (
 952         local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
 953     if (status)
 954         return status;
 955
 956     /* New file-direntry allows navigating to this message with
 957      * notmuch_directory_get_child_files() . */
 958     _notmuch_message_add_term (message, "file-direntry", direntry);
 959
 960     _notmuch_message_add_folder_terms (message, directory);
 961     _notmuch_message_add_path_terms (message, directory);
 962
 963     talloc_free (local);
 964
 965     return NOTMUCH_STATUS_SUCCESS;
 966 }
 967
 968 /* Remove a particular 'filename' from 'message'.
 969  *
 970  * This change will not be reflected in the database until the next
 971  * call to _notmuch_message_sync.
 972  *
 973  * If this message still has other filenames, returns
 974  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
 975  *
 976  * Note: This function does not remove a document from the database,
 977  * even if the specified filename is the only filename for this
 978  * message. For that functionality, see
 979  * notmuch_database_remove_message. */
 980 notmuch_status_t
 981 _notmuch_message_remove_filename (notmuch_message_t *message,
 982                                   const char *filename)
 983 {
 984     void *local = talloc_new (message);
 985     char *direntry;
 986     notmuch_private_status_t private_status;
 987     notmuch_status_t status;
 988
 989     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
 990         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
 991         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
 992
 993     status = _notmuch_database_filename_to_direntry (
 994         local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
 995     if (status || ! direntry)
 996         return status;
 997
 998     /* Unlink this file from its parent directory. */
 999     private_status = _notmuch_message_remove_term (message,
1000                                                    "file-direntry", direntry);
1001     status = COERCE_STATUS (private_status,
1002                             "Unexpected error from _notmuch_message_remove_term");
1003     if (status)
1004         return status;
1005
1006     /* Re-synchronize "folder:" and "path:" terms for this message. */
1007
1008     /* Remove all "folder:" terms. */
1009     _notmuch_message_remove_terms (message, _find_prefix ("folder"));
1010
1011     /* Remove all "path:" terms. */
1012     _notmuch_message_remove_terms (message, _find_prefix ("path"));
1013
1014     /* Add back terms for all remaining filenames of the message. */
1015     status = _notmuch_message_add_directory_terms (local, message);
1016
1017     talloc_free (local);
1018
1019     return status;
1020 }
1021
1022 /* Upgrade the "folder:" prefix from V1 to V2. */
1023 #define FOLDER_PREFIX_V1       "XFOLDER"
1024 #define ZFOLDER_PREFIX_V1      "Z" FOLDER_PREFIX_V1
1025 void
1026 _notmuch_message_upgrade_folder (notmuch_message_t *message)
1027 {
1028     /* Remove all old "folder:" terms. */
1029     _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
1030
1031     /* Remove all old "folder:" stemmed terms. */
1032     _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
1033
1034     /* Add new boolean "folder:" and "path:" terms. */
1035     _notmuch_message_add_directory_terms (message, message);
1036 }
1037
1038 char *
1039 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
1040 {
1041     return talloc_strdup (message, message->doc.get_data ().c_str ());
1042 }
1043
1044 void
1045 _notmuch_message_clear_data (notmuch_message_t *message)
1046 {
1047     message->doc.set_data ("");
1048     message->modified = true;
1049 }
1050
1051 static void
1052 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
1053 {
1054     notmuch_string_node_t *node;
1055
1056     if (message->filename_list)
1057         return;
1058
1059     _notmuch_message_ensure_metadata (message, message->filename_term_list);
1060
1061     message->filename_list = _notmuch_string_list_create (message);
1062     node = message->filename_term_list->head;
1063
1064     if (! node) {
1065         /* A message document created by an old version of notmuch
1066          * (prior to rename support) will have the filename in the
1067          * data of the document rather than as a file-direntry term.
1068          *
1069          * It would be nice to do the upgrade of the document directly
1070          * here, but the database is likely open in read-only mode. */
1071
1072         std::string datastr = message->doc.get_data ();
1073         const char *data = datastr.c_str ();
1074
1075         if (data == NULL)
1076             INTERNAL_ERROR ("message with no filename");
1077
1078         _notmuch_string_list_append (message->filename_list, data);
1079
1080         return;
1081     }
1082
1083     for (; node; node = node->next) {
1084         void *local = talloc_new (message);
1085         const char *db_path, *directory, *basename, *filename;
1086         char *colon, *direntry = NULL;
1087         unsigned int directory_id;
1088
1089         direntry = node->string;
1090
1091         directory_id = strtol (direntry, &colon, 10);
1092
1093         if (colon == NULL || *colon != ':')
1094             INTERNAL_ERROR ("malformed direntry");
1095
1096         basename = colon + 1;
1097
1098         *colon = '\0';
1099
1100         db_path = notmuch_database_get_path (message->notmuch);
1101
1102         directory = _notmuch_database_get_directory_path (local,
1103                                                           message->notmuch,
1104                                                           directory_id);
1105
1106         if (strlen (directory))
1107             filename = talloc_asprintf (message, "%s/%s/%s",
1108                                         db_path, directory, basename);
1109         else
1110             filename = talloc_asprintf (message, "%s/%s",
1111                                         db_path, basename);
1112
1113         _notmuch_string_list_append (message->filename_list, filename);
1114
1115         talloc_free (local);
1116     }
1117
1118     talloc_free (message->filename_term_list);
1119     message->filename_term_list = NULL;
1120 }
1121
1122 const char *
1123 notmuch_message_get_filename (notmuch_message_t *message)
1124 {
1125     try {
1126         _notmuch_message_ensure_filename_list (message);
1127     } catch (Xapian::Error &error) {
1128         LOG_XAPIAN_EXCEPTION (message, error);
1129         return NULL;
1130     }
1131
1132     if (message->filename_list == NULL)
1133         return NULL;
1134
1135     if (message->filename_list->head == NULL ||
1136         message->filename_list->head->string == NULL) {
1137         INTERNAL_ERROR ("message with no filename");
1138     }
1139
1140     return message->filename_list->head->string;
1141 }
1142
1143 notmuch_filenames_t *
1144 notmuch_message_get_filenames (notmuch_message_t *message)
1145 {
1146     try {
1147         _notmuch_message_ensure_filename_list (message);
1148     } catch (Xapian::Error &error) {
1149         LOG_XAPIAN_EXCEPTION (message, error);
1150         return NULL;
1151     }
1152
1153     return _notmuch_filenames_create (message, message->filename_list);
1154 }
1155
1156 int
1157 notmuch_message_count_files (notmuch_message_t *message)
1158 {
1159     _notmuch_message_ensure_filename_list (message);
1160
1161     return _notmuch_string_list_length (message->filename_list);
1162 }
1163
1164 notmuch_bool_t
1165 notmuch_message_get_flag (notmuch_message_t *message,
1166                           notmuch_message_flag_t flag)
1167 {
1168     if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
1169         ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
1170         _notmuch_message_ensure_metadata (message, NULL);
1171
1172     return NOTMUCH_TEST_BIT (message->flags, flag);
1173 }
1174
1175 void
1176 notmuch_message_set_flag (notmuch_message_t *message,
1177                           notmuch_message_flag_t flag, notmuch_bool_t enable)
1178 {
1179     if (enable)
1180         NOTMUCH_SET_BIT (&message->flags, flag);
1181     else
1182         NOTMUCH_CLEAR_BIT (&message->flags, flag);
1183     NOTMUCH_SET_BIT (&message->lazy_flags, flag);
1184 }
1185
1186 time_t
1187 notmuch_message_get_date (notmuch_message_t *message)
1188 {
1189     std::string value;
1190
1191     try {
1192         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
1193     } catch (Xapian::Error &error) {
1194         LOG_XAPIAN_EXCEPTION (message, error);
1195         return 0;
1196     }
1197
1198     if (value.empty ())
1199         /* sortable_unserialise is undefined on empty string */
1200         return 0;
1201     return Xapian::sortable_unserialise (value);
1202 }
1203
1204 notmuch_tags_t *
1205 notmuch_message_get_tags (notmuch_message_t *message)
1206 {
1207     notmuch_tags_t *tags;
1208
1209     _notmuch_message_ensure_metadata (message, message->tag_list);
1210
1211     tags = _notmuch_tags_create (message, message->tag_list);
1212     /* _notmuch_tags_create steals the reference to the tag_list, but
1213      * in this case it's still used by the message, so we add an
1214      * *additional* talloc reference to the list.  As a result, it's
1215      * possible to modify the message tags (which talloc_unlink's the
1216      * current list from the message) while still iterating because
1217      * the iterator will keep the current list alive. */
1218     if (! talloc_reference (message, message->tag_list))
1219         return NULL;
1220
1221     return tags;
1222 }
1223
1224 const char *
1225 _notmuch_message_get_author (notmuch_message_t *message)
1226 {
1227     return message->author;
1228 }
1229
1230 void
1231 _notmuch_message_set_author (notmuch_message_t *message,
1232                              const char *author)
1233 {
1234     if (message->author)
1235         talloc_free (message->author);
1236     message->author = talloc_strdup (message, author);
1237     return;
1238 }
1239
1240 void
1241 _notmuch_message_set_header_values (notmuch_message_t *message,
1242                                     const char *date,
1243                                     const char *from,
1244                                     const char *subject)
1245 {
1246     time_t time_value;
1247
1248     /* GMime really doesn't want to see a NULL date, so protect its
1249      * sensibilities. */
1250     if (date == NULL || *date == '\0') {
1251         time_value = 0;
1252     } else {
1253         time_value = g_mime_utils_header_decode_date_unix (date);
1254         /*
1255          * Workaround for https://bugzilla.gnome.org/show_bug.cgi?id=779923
1256          */
1257         if (time_value < 0)
1258             time_value = 0;
1259     }
1260
1261     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1262                             Xapian::sortable_serialise (time_value));
1263     message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1264     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1265     message->modified = true;
1266 }
1267
1268 void
1269 _notmuch_message_update_subject (notmuch_message_t *message,
1270                                  const char *subject)
1271 {
1272     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1273     message->modified = true;
1274 }
1275
1276 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD.  The caller
1277  * must call _notmuch_message_sync. */
1278 void
1279 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1280 {
1281     /* _notmuch_message_sync will update the last modification
1282      * revision; we just have to ask it to. */
1283     message->modified = true;
1284 }
1285
1286 /* Synchronize changes made to message->doc out into the database. */
1287 void
1288 _notmuch_message_sync (notmuch_message_t *message)
1289 {
1290     Xapian::WritableDatabase *db;
1291
1292     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
1293         return;
1294
1295     if (! message->modified)
1296         return;
1297
1298     /* Update the last modification of this message. */
1299     if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1300         /* sortable_serialise gives a reasonably compact encoding,
1301          * which directly translates to reduced IO when scanning the
1302          * value stream.  Since it's built for doubles, we only get 53
1303          * effective bits, but that's still enough for the database to
1304          * last a few centuries at 1 million revisions per second. */
1305         message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1306                                 Xapian::sortable_serialise (
1307                                     _notmuch_database_new_revision (
1308                                         message->notmuch)));
1309
1310     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1311     db->replace_document (message->doc_id, message->doc);
1312     message->modified = false;
1313 }
1314
1315 /* Delete a message document from the database, leaving a ghost
1316  * message in its place */
1317 notmuch_status_t
1318 _notmuch_message_delete (notmuch_message_t *message)
1319 {
1320     notmuch_status_t status;
1321     Xapian::WritableDatabase *db;
1322     const char *mid, *tid, *query_string;
1323     notmuch_message_t *ghost;
1324     notmuch_private_status_t private_status;
1325     notmuch_database_t *notmuch;
1326     notmuch_query_t *query;
1327     unsigned int count = 0;
1328     bool is_ghost;
1329
1330     mid = notmuch_message_get_message_id (message);
1331     tid = notmuch_message_get_thread_id (message);
1332     notmuch = message->notmuch;
1333
1334     status = _notmuch_database_ensure_writable (message->notmuch);
1335     if (status)
1336         return status;
1337
1338     db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1339     db->delete_document (message->doc_id);
1340
1341     /* if this was a ghost to begin with, we are done */
1342     private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1343     if (private_status)
1344         return COERCE_STATUS (private_status,
1345                               "Error trying to determine whether message was a ghost");
1346     if (is_ghost)
1347         return NOTMUCH_STATUS_SUCCESS;
1348
1349     query_string = talloc_asprintf (message, "thread:%s", tid);
1350     query = notmuch_query_create (notmuch, query_string);
1351     if (query == NULL)
1352         return NOTMUCH_STATUS_OUT_OF_MEMORY;
1353     status = notmuch_query_count_messages (query, &count);
1354     if (status) {
1355         notmuch_query_destroy (query);
1356         return status;
1357     }
1358
1359     if (count > 0) {
1360         /* reintroduce a ghost in its place because there are still
1361          * other active messages in this thread: */
1362         ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1363         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1364             private_status = _notmuch_message_initialize_ghost (ghost, tid);
1365             if (! private_status)
1366                 _notmuch_message_sync (ghost);
1367         } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1368             /* this is deeply weird, and we should not have gotten
1369              * into this state.  is there a better error message to
1370              * return here? */
1371             status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1372         }
1373
1374         notmuch_message_destroy (ghost);
1375         status = COERCE_STATUS (private_status, "Error converting to ghost message");
1376     } else {
1377         /* the thread is empty; drop all ghost messages from it */
1378         notmuch_messages_t *messages;
1379         status = _notmuch_query_search_documents (query,
1380                                                   "ghost",
1381                                                   &messages);
1382         if (status == NOTMUCH_STATUS_SUCCESS) {
1383             notmuch_status_t last_error = NOTMUCH_STATUS_SUCCESS;
1384             while (notmuch_messages_valid (messages)) {
1385                 message = notmuch_messages_get (messages);
1386                 status = _notmuch_message_delete (message);
1387                 if (status) /* we'll report the last failure we see;
1388                                          * if there is more than one failure, we
1389                                          * forget about previous ones */
1390                     last_error = status;
1391                 notmuch_message_destroy (message);
1392                 notmuch_messages_move_to_next (messages);
1393             }
1394             status = last_error;
1395         }
1396     }
1397     notmuch_query_destroy (query);
1398     return status;
1399 }
1400
1401 /* Transform a blank message into a ghost message.  The caller must
1402  * _notmuch_message_sync the message. */
1403 notmuch_private_status_t
1404 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1405                                    const char *thread_id)
1406 {
1407     notmuch_private_status_t status;
1408
1409     status = _notmuch_message_add_term (message, "type", "ghost");
1410     if (status)
1411         return status;
1412     status = _notmuch_message_add_term (message, "thread", thread_id);
1413     if (status)
1414         return status;
1415
1416     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1417 }
1418
1419 /* Ensure that 'message' is not holding any file object open. Future
1420  * calls to various functions will still automatically open the
1421  * message file as needed.
1422  */
1423 void
1424 _notmuch_message_close (notmuch_message_t *message)
1425 {
1426     if (message->message_file) {
1427         _notmuch_message_file_close (message->message_file);
1428         message->message_file = NULL;
1429     }
1430 }
1431
1432 /* Add a name:value term to 'message', (the actual term will be
1433  * encoded by prefixing the value with a short prefix). See
1434  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1435  * names to prefix values.
1436  *
1437  * This change will not be reflected in the database until the next
1438  * call to _notmuch_message_sync. */
1439 notmuch_private_status_t
1440 _notmuch_message_add_term (notmuch_message_t *message,
1441                            const char *prefix_name,
1442                            const char *value)
1443 {
1444
1445     char *term;
1446
1447     if (value == NULL)
1448         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1449
1450     term = talloc_asprintf (message, "%s%s",
1451                             _find_prefix (prefix_name), value);
1452
1453     if (strlen (term) > NOTMUCH_TERM_MAX)
1454         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1455
1456     message->doc.add_term (term, 0);
1457     message->modified = true;
1458
1459     talloc_free (term);
1460
1461     _notmuch_message_invalidate_metadata (message, prefix_name);
1462
1463     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1464 }
1465
1466 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1467  * term will be added with the appropriate prefix if prefix_name is
1468  * non-NULL.
1469  */
1470 notmuch_private_status_t
1471 _notmuch_message_gen_terms (notmuch_message_t *message,
1472                             const char *prefix_name,
1473                             const char *text)
1474 {
1475     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1476
1477     if (text == NULL)
1478         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1479
1480     term_gen->set_document (message->doc);
1481     term_gen->set_termpos (message->termpos);
1482
1483     if (prefix_name) {
1484         const char *prefix = _notmuch_database_prefix (message->notmuch, prefix_name);
1485         if (prefix == NULL)
1486             return NOTMUCH_PRIVATE_STATUS_BAD_PREFIX;
1487
1488         _notmuch_message_invalidate_metadata (message, prefix_name);
1489         term_gen->index_text (text, 1, prefix);
1490     } else {
1491         term_gen->index_text (text);
1492     }
1493
1494     /* Create a gap between this an the next terms so they don't
1495      * appear to be a phrase. */
1496     message->termpos = term_gen->get_termpos () + 100;
1497
1498     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1499 }
1500
1501 /* Remove a name:value term from 'message', (the actual term will be
1502  * encoded by prefixing the value with a short prefix). See
1503  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1504  * names to prefix values.
1505  *
1506  * This change will not be reflected in the database until the next
1507  * call to _notmuch_message_sync. */
1508 notmuch_private_status_t
1509 _notmuch_message_remove_term (notmuch_message_t *message,
1510                               const char *prefix_name,
1511                               const char *value)
1512 {
1513     char *term;
1514
1515     if (value == NULL)
1516         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1517
1518     term = talloc_asprintf (message, "%s%s",
1519                             _find_prefix (prefix_name), value);
1520
1521     if (strlen (term) > NOTMUCH_TERM_MAX)
1522         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1523
1524     try {
1525         message->doc.remove_term (term);
1526         message->modified = true;
1527     } catch (const Xapian::InvalidArgumentError) {
1528         /* We'll let the philosophers try to wrestle with the
1529          * question of whether failing to remove that which was not
1530          * there in the first place is failure. For us, we'll silently
1531          * consider it all good. */
1532     }
1533
1534     talloc_free (term);
1535
1536     _notmuch_message_invalidate_metadata (message, prefix_name);
1537
1538     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1539 }
1540
1541 notmuch_private_status_t
1542 _notmuch_message_has_term (notmuch_message_t *message,
1543                            const char *prefix_name,
1544                            const char *value,
1545                            bool *result)
1546 {
1547     char *term;
1548     bool out = false;
1549     notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1550
1551     if (value == NULL)
1552         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1553
1554     term = talloc_asprintf (message, "%s%s",
1555                             _find_prefix (prefix_name), value);
1556
1557     if (strlen (term) > NOTMUCH_TERM_MAX)
1558         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1559
1560     try {
1561         /* Look for the exact term */
1562         Xapian::TermIterator i = message->doc.termlist_begin ();
1563         i.skip_to (term);
1564         if (i != message->doc.termlist_end () &&
1565             ! strcmp ((*i).c_str (), term))
1566             out = true;
1567     } catch (Xapian::Error &error) {
1568         status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1569     }
1570     talloc_free (term);
1571
1572     *result = out;
1573     return status;
1574 }
1575
1576 notmuch_status_t
1577 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1578 {
1579     notmuch_private_status_t private_status;
1580     notmuch_status_t status;
1581
1582     status = _notmuch_database_ensure_writable (message->notmuch);
1583     if (status)
1584         return status;
1585
1586     if (tag == NULL)
1587         return NOTMUCH_STATUS_NULL_POINTER;
1588
1589     if (strlen (tag) > NOTMUCH_TAG_MAX)
1590         return NOTMUCH_STATUS_TAG_TOO_LONG;
1591
1592     private_status = _notmuch_message_add_term (message, "tag", tag);
1593     if (private_status) {
1594         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1595                         private_status);
1596     }
1597
1598     if (! message->frozen)
1599         _notmuch_message_sync (message);
1600
1601     return NOTMUCH_STATUS_SUCCESS;
1602 }
1603
1604 notmuch_status_t
1605 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1606 {
1607     notmuch_private_status_t private_status;
1608     notmuch_status_t status;
1609
1610     status = _notmuch_database_ensure_writable (message->notmuch);
1611     if (status)
1612         return status;
1613
1614     if (tag == NULL)
1615         return NOTMUCH_STATUS_NULL_POINTER;
1616
1617     if (strlen (tag) > NOTMUCH_TAG_MAX)
1618         return NOTMUCH_STATUS_TAG_TOO_LONG;
1619
1620     private_status = _notmuch_message_remove_term (message, "tag", tag);
1621     if (private_status) {
1622         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1623                         private_status);
1624     }
1625
1626     if (! message->frozen)
1627         _notmuch_message_sync (message);
1628
1629     return NOTMUCH_STATUS_SUCCESS;
1630 }
1631
1632 /* Is the given filename within a maildir directory?
1633  *
1634  * Specifically, is the final directory component of 'filename' either
1635  * "cur" or "new". If so, return a pointer to that final directory
1636  * component within 'filename'. If not, return NULL.
1637  *
1638  * A non-NULL return value is guaranteed to be a valid string pointer
1639  * pointing to the characters "new/" or "cur/", (but not
1640  * NUL-terminated).
1641  */
1642 static const char *
1643 _filename_is_in_maildir (const char *filename)
1644 {
1645     const char *slash, *dir = NULL;
1646
1647     /* Find the last '/' separating directory from filename. */
1648     slash = strrchr (filename, '/');
1649     if (slash == NULL)
1650         return NULL;
1651
1652     /* Jump back 4 characters to where the previous '/' will be if the
1653      * directory is named "cur" or "new". */
1654     if (slash - filename < 4)
1655         return NULL;
1656
1657     slash -= 4;
1658
1659     if (*slash != '/')
1660         return NULL;
1661
1662     dir = slash + 1;
1663
1664     if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1665         STRNCMP_LITERAL (dir, "new/") == 0) {
1666         return dir;
1667     }
1668
1669     return NULL;
1670 }
1671
1672 static void
1673 _ensure_maildir_flags (notmuch_message_t *message, bool force)
1674 {
1675     const char *flags;
1676     notmuch_filenames_t *filenames;
1677     const char *filename, *dir;
1678     char *combined_flags = talloc_strdup (message, "");
1679     int seen_maildir_info = 0;
1680
1681     if (message->maildir_flags) {
1682         if (force) {
1683             talloc_free (message->maildir_flags);
1684             message->maildir_flags = NULL;
1685         }
1686     }
1687
1688     for (filenames = notmuch_message_get_filenames (message);
1689          notmuch_filenames_valid (filenames);
1690          notmuch_filenames_move_to_next (filenames)) {
1691         filename = notmuch_filenames_get (filenames);
1692         dir = _filename_is_in_maildir (filename);
1693
1694         if (! dir)
1695             continue;
1696
1697         flags = strstr (filename, ":2,");
1698         if (flags) {
1699             seen_maildir_info = 1;
1700             flags += 3;
1701             combined_flags = talloc_strdup_append (combined_flags, flags);
1702         } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1703             /* Messages are delivered to new/ with no "info" part, but
1704              * they effectively have default maildir flags.  According
1705              * to the spec, we should ignore the info part for
1706              * messages in new/, but some MUAs (mutt) can set maildir
1707              * flags on messages in new/, so we're liberal in what we
1708              * accept. */
1709             seen_maildir_info = 1;
1710         }
1711     }
1712     if (seen_maildir_info)
1713         message->maildir_flags = combined_flags;
1714 }
1715
1716 notmuch_bool_t
1717 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
1718 {
1719     _ensure_maildir_flags (message, false);
1720     return message->maildir_flags && (strchr (message->maildir_flags, flag) != NULL);
1721 }
1722
1723 notmuch_status_t
1724 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1725 {
1726     notmuch_status_t status;
1727     unsigned i;
1728
1729     _ensure_maildir_flags (message, true);
1730     /* If none of the filenames have any maildir info field (not even
1731      * an empty info with no flags set) then there's no information to
1732      * go on, so do nothing. */
1733     if (! message->maildir_flags)
1734         return NOTMUCH_STATUS_SUCCESS;
1735
1736     status = notmuch_message_freeze (message);
1737     if (status)
1738         return status;
1739
1740     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1741         if ((strchr (message->maildir_flags, flag2tag[i].flag) != NULL)
1742             ^
1743             flag2tag[i].inverse) {
1744             status = notmuch_message_add_tag (message, flag2tag[i].tag);
1745         } else {
1746             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1747         }
1748         if (status)
1749             return status;
1750     }
1751     status = notmuch_message_thaw (message);
1752
1753     return status;
1754 }
1755
1756 /* From the set of tags on 'message' and the flag2tag table, compute a
1757  * set of maildir-flag actions to be taken, (flags that should be
1758  * either set or cleared).
1759  *
1760  * The result is returned as two talloced strings: to_set, and to_clear
1761  */
1762 static void
1763 _get_maildir_flag_actions (notmuch_message_t *message,
1764                            char **to_set_ret,
1765                            char **to_clear_ret)
1766 {
1767     char *to_set, *to_clear;
1768     notmuch_tags_t *tags;
1769     const char *tag;
1770     unsigned i;
1771
1772     to_set = talloc_strdup (message, "");
1773     to_clear = talloc_strdup (message, "");
1774
1775     /* First, find flags for all set tags. */
1776     for (tags = notmuch_message_get_tags (message);
1777          notmuch_tags_valid (tags);
1778          notmuch_tags_move_to_next (tags)) {
1779         tag = notmuch_tags_get (tags);
1780
1781         for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1782             if (strcmp (tag, flag2tag[i].tag) == 0) {
1783                 if (flag2tag[i].inverse)
1784                     to_clear = talloc_asprintf_append (to_clear,
1785                                                        "%c",
1786                                                        flag2tag[i].flag);
1787                 else
1788                     to_set = talloc_asprintf_append (to_set,
1789                                                      "%c",
1790                                                      flag2tag[i].flag);
1791             }
1792         }
1793     }
1794
1795     /* Then, find the flags for all tags not present. */
1796     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1797         if (flag2tag[i].inverse) {
1798             if (strchr (to_clear, flag2tag[i].flag) == NULL)
1799                 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1800         } else {
1801             if (strchr (to_set, flag2tag[i].flag) == NULL)
1802                 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1803         }
1804     }
1805
1806     *to_set_ret = to_set;
1807     *to_clear_ret = to_clear;
1808 }
1809
1810 /* Given 'filename' and a set of maildir flags to set and to clear,
1811  * compute the new maildir filename.
1812  *
1813  * If the existing filename is in the directory "new", the new
1814  * filename will be in the directory "cur", except for the case when
1815  * no flags are changed and the existing filename does not contain
1816  * maildir info (starting with ",2:").
1817  *
1818  * After a sequence of ":2," in the filename, any subsequent
1819  * single-character flags will be added or removed according to the
1820  * characters in flags_to_set and flags_to_clear. Any existing flags
1821  * not mentioned in either string will remain. The final list of flags
1822  * will be in ASCII order.
1823  *
1824  * If the original flags seem invalid, (repeated characters or
1825  * non-ASCII ordering of flags), this function will return NULL
1826  * (meaning that renaming would not be safe and should not occur).
1827  */
1828 static char *
1829 _new_maildir_filename (void *ctx,
1830                        const char *filename,
1831                        const char *flags_to_set,
1832                        const char *flags_to_clear)
1833 {
1834     const char *info, *flags;
1835     unsigned int flag, last_flag;
1836     char *filename_new, *dir;
1837     char flag_map[128];
1838     int flags_in_map = 0;
1839     bool flags_changed = false;
1840     unsigned int i;
1841     char *s;
1842
1843     memset (flag_map, 0, sizeof (flag_map));
1844
1845     info = strstr (filename, ":2,");
1846
1847     if (info == NULL) {
1848         info = filename + strlen (filename);
1849     } else {
1850         /* Loop through existing flags in filename. */
1851         for (flags = info + 3, last_flag = 0;
1852              *flags;
1853              last_flag = flag, flags++) {
1854             flag = *flags;
1855
1856             /* Original flags not in ASCII order. Abort. */
1857             if (flag < last_flag)
1858                 return NULL;
1859
1860             /* Non-ASCII flag. Abort. */
1861             if (flag > sizeof (flag_map) - 1)
1862                 return NULL;
1863
1864             /* Repeated flag value. Abort. */
1865             if (flag_map[flag])
1866                 return NULL;
1867
1868             flag_map[flag] = 1;
1869             flags_in_map++;
1870         }
1871     }
1872
1873     /* Then set and clear our flags from tags. */
1874     for (flags = flags_to_set; *flags; flags++) {
1875         flag = *flags;
1876         if (flag_map[flag] == 0) {
1877             flag_map[flag] = 1;
1878             flags_in_map++;
1879             flags_changed = true;
1880         }
1881     }
1882
1883     for (flags = flags_to_clear; *flags; flags++) {
1884         flag = *flags;
1885         if (flag_map[flag]) {
1886             flag_map[flag] = 0;
1887             flags_in_map--;
1888             flags_changed = true;
1889         }
1890     }
1891
1892     /* Messages in new/ without maildir info can be kept in new/ if no
1893      * flags have changed. */
1894     dir = (char *) _filename_is_in_maildir (filename);
1895     if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && ! *info && ! flags_changed)
1896         return talloc_strdup (ctx, filename);
1897
1898     filename_new = (char *) talloc_size (ctx,
1899                                          info - filename +
1900                                          strlen (":2,") + flags_in_map + 1);
1901     if (unlikely (filename_new == NULL))
1902         return NULL;
1903
1904     strncpy (filename_new, filename, info - filename);
1905     filename_new[info - filename] = '\0';
1906
1907     strcat (filename_new, ":2,");
1908
1909     s = filename_new + strlen (filename_new);
1910     for (i = 0; i < sizeof (flag_map); i++) {
1911         if (flag_map[i]) {
1912             *s = i;
1913             s++;
1914         }
1915     }
1916     *s = '\0';
1917
1918     /* If message is in new/ move it under cur/. */
1919     dir = (char *) _filename_is_in_maildir (filename_new);
1920     if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1921         memcpy (dir, "cur/", 4);
1922
1923     return filename_new;
1924 }
1925
1926 notmuch_status_t
1927 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1928 {
1929     notmuch_filenames_t *filenames;
1930     const char *filename;
1931     char *filename_new;
1932     char *to_set, *to_clear;
1933     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1934
1935     _get_maildir_flag_actions (message, &to_set, &to_clear);
1936
1937     for (filenames = notmuch_message_get_filenames (message);
1938          notmuch_filenames_valid (filenames);
1939          notmuch_filenames_move_to_next (filenames)) {
1940         filename = notmuch_filenames_get (filenames);
1941
1942         if (! _filename_is_in_maildir (filename))
1943             continue;
1944
1945         filename_new = _new_maildir_filename (message, filename,
1946                                               to_set, to_clear);
1947         if (filename_new == NULL)
1948             continue;
1949
1950         if (strcmp (filename, filename_new)) {
1951             int err;
1952             notmuch_status_t new_status;
1953
1954             err = rename (filename, filename_new);
1955             if (err)
1956                 continue;
1957
1958             new_status = _notmuch_message_remove_filename (message,
1959                                                            filename);
1960             /* Hold on to only the first error. */
1961             if (! status && new_status
1962                 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1963                 status = new_status;
1964                 continue;
1965             }
1966
1967             new_status = _notmuch_message_add_filename (message,
1968                                                         filename_new);
1969             /* Hold on to only the first error. */
1970             if (! status && new_status) {
1971                 status = new_status;
1972                 continue;
1973             }
1974
1975             _notmuch_message_sync (message);
1976         }
1977
1978         talloc_free (filename_new);
1979     }
1980
1981     talloc_free (to_set);
1982     talloc_free (to_clear);
1983
1984     return status;
1985 }
1986
1987 notmuch_status_t
1988 notmuch_message_remove_all_tags (notmuch_message_t *message)
1989 {
1990     notmuch_private_status_t private_status;
1991     notmuch_status_t status;
1992     notmuch_tags_t *tags;
1993     const char *tag;
1994
1995     status = _notmuch_database_ensure_writable (message->notmuch);
1996     if (status)
1997         return status;
1998
1999     for (tags = notmuch_message_get_tags (message);
2000          notmuch_tags_valid (tags);
2001          notmuch_tags_move_to_next (tags)) {
2002         tag = notmuch_tags_get (tags);
2003
2004         private_status = _notmuch_message_remove_term (message, "tag", tag);
2005         if (private_status) {
2006             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
2007                             private_status);
2008         }
2009     }
2010
2011     if (! message->frozen)
2012         _notmuch_message_sync (message);
2013
2014     talloc_free (tags);
2015     return NOTMUCH_STATUS_SUCCESS;
2016 }
2017
2018 notmuch_status_t
2019 notmuch_message_freeze (notmuch_message_t *message)
2020 {
2021     notmuch_status_t status;
2022
2023     status = _notmuch_database_ensure_writable (message->notmuch);
2024     if (status)
2025         return status;
2026
2027     message->frozen++;
2028
2029     return NOTMUCH_STATUS_SUCCESS;
2030 }
2031
2032 notmuch_status_t
2033 notmuch_message_thaw (notmuch_message_t *message)
2034 {
2035     notmuch_status_t status;
2036
2037     status = _notmuch_database_ensure_writable (message->notmuch);
2038     if (status)
2039         return status;
2040
2041     if (message->frozen > 0) {
2042         message->frozen--;
2043         if (message->frozen == 0)
2044             _notmuch_message_sync (message);
2045         return NOTMUCH_STATUS_SUCCESS;
2046     } else {
2047         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
2048     }
2049 }
2050
2051 void
2052 notmuch_message_destroy (notmuch_message_t *message)
2053 {
2054     talloc_free (message);
2055 }
2056
2057 notmuch_database_t *
2058 notmuch_message_get_database (const notmuch_message_t *message)
2059 {
2060     return message->notmuch;
2061 }
2062
2063 static void
2064 _notmuch_message_ensure_property_map (notmuch_message_t *message)
2065 {
2066     notmuch_string_node_t *node;
2067
2068     if (message->property_map)
2069         return;
2070
2071     _notmuch_message_ensure_metadata (message, message->property_term_list);
2072
2073     message->property_map = _notmuch_string_map_create (message);
2074
2075     for (node = message->property_term_list->head; node; node = node->next) {
2076         const char *key;
2077         char *value;
2078
2079         value = strchr (node->string, '=');
2080         if (! value)
2081             INTERNAL_ERROR ("malformed property term");
2082
2083         *value = '\0';
2084         value++;
2085         key = node->string;
2086
2087         _notmuch_string_map_append (message->property_map, key, value);
2088
2089     }
2090
2091     talloc_free (message->property_term_list);
2092     message->property_term_list = NULL;
2093 }
2094
2095 notmuch_string_map_t *
2096 _notmuch_message_property_map (notmuch_message_t *message)
2097 {
2098     _notmuch_message_ensure_property_map (message);
2099
2100     return message->property_map;
2101 }
2102
2103 bool
2104 _notmuch_message_frozen (notmuch_message_t *message)
2105 {
2106     return message->frozen;
2107 }
2108
2109 notmuch_status_t
2110 notmuch_message_reindex (notmuch_message_t *message,
2111                          notmuch_indexopts_t *indexopts)
2112 {
2113     notmuch_database_t *notmuch = NULL;
2114     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2115     notmuch_private_status_t private_status;
2116     notmuch_filenames_t *orig_filenames = NULL;
2117     const char *orig_thread_id = NULL;
2118     notmuch_message_file_t *message_file = NULL;
2119
2120     int found = 0;
2121
2122     if (message == NULL)
2123         return NOTMUCH_STATUS_NULL_POINTER;
2124
2125     /* Save in case we need to delete message */
2126     orig_thread_id = notmuch_message_get_thread_id (message);
2127     if (! orig_thread_id) {
2128         /* XXX TODO: make up new error return? */
2129         INTERNAL_ERROR ("message without thread-id");
2130     }
2131
2132     /* strdup it because the metadata may be invalidated */
2133     orig_thread_id = talloc_strdup (message, orig_thread_id);
2134
2135     notmuch = notmuch_message_get_database (message);
2136
2137     ret = _notmuch_database_ensure_writable (notmuch);
2138     if (ret)
2139         return ret;
2140
2141     orig_filenames = notmuch_message_get_filenames (message);
2142
2143     private_status = _notmuch_message_remove_indexed_terms (message);
2144     if (private_status) {
2145         ret = COERCE_STATUS (private_status, "error removing terms");
2146         goto DONE;
2147     }
2148
2149     ret = notmuch_message_remove_all_properties_with_prefix (message, "index.");
2150     if (ret)
2151         goto DONE; /* XXX TODO: distinguish from other error returns above? */
2152     if (indexopts && notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE) {
2153         ret = notmuch_message_remove_all_properties (message, "session-key");
2154         if (ret)
2155             goto DONE;
2156     }
2157
2158     /* re-add the filenames with the associated indexopts */
2159     for (; notmuch_filenames_valid (orig_filenames);
2160          notmuch_filenames_move_to_next (orig_filenames)) {
2161
2162         const char *date;
2163         const char *from, *to, *subject;
2164         char *message_id = NULL;
2165         const char *thread_id = NULL;
2166
2167         const char *filename = notmuch_filenames_get (orig_filenames);
2168
2169         message_file = _notmuch_message_file_open (notmuch, filename);
2170         if (message_file == NULL)
2171             continue;
2172
2173         ret = _notmuch_message_file_get_headers (message_file,
2174                                                  &from, &subject, &to, &date,
2175                                                  &message_id);
2176         if (ret)
2177             goto DONE;
2178
2179         /* XXX TODO: deal with changing message id? */
2180
2181         _notmuch_message_add_filename (message, filename);
2182
2183         ret = _notmuch_database_link_message_to_parents (notmuch, message,
2184                                                          message_file,
2185                                                          &thread_id);
2186         if (ret)
2187             goto DONE;
2188
2189         if (thread_id == NULL)
2190             thread_id = orig_thread_id;
2191
2192         _notmuch_message_add_term (message, "thread", thread_id);
2193         /* Take header values only from first filename */
2194         if (found == 0)
2195             _notmuch_message_set_header_values (message, date, from, subject);
2196
2197         ret = _notmuch_message_index_file (message, indexopts, message_file);
2198
2199         if (ret == NOTMUCH_STATUS_FILE_ERROR)
2200             continue;
2201         if (ret)
2202             goto DONE;
2203
2204         found++;
2205         _notmuch_message_file_close (message_file);
2206         message_file = NULL;
2207     }
2208     if (found == 0) {
2209         /* put back thread id to help cleanup */
2210         _notmuch_message_add_term (message, "thread", orig_thread_id);
2211         ret = _notmuch_message_delete (message);
2212     } else {
2213         _notmuch_message_sync (message);
2214     }
2215
2216   DONE:
2217     if (message_file)
2218         _notmuch_message_file_close (message_file);
2219
2220     /* XXX TODO destroy orig_filenames? */
2221     return ret;
2222 }