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