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 NODISCARD 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     if (notmuch_status_t status = COERCE_STATUS (_notmuch_message_add_term (message, "folder",
 832                                                                             folder),
 833                                                  "adding folder term"))
 834         return status;
 835
 836     talloc_free (folder);
 837
 838     message->modified = true;
 839     return NOTMUCH_STATUS_SUCCESS;
 840 }
 841
 842 #define RECURSIVE_SUFFIX "/**"
 843
 844 /* Add "path:" terms for directory. */
 845 NODISCARD static notmuch_status_t
 846 _notmuch_message_add_path_terms (notmuch_message_t *message,
 847                                  const char *directory)
 848 {
 849     notmuch_status_t status;
 850
 851     /* Add exact "path:" term. */
 852     status = COERCE_STATUS (_notmuch_message_add_term (message, "path", directory),
 853                             "adding path term");
 854     if (status)
 855         return status;
 856
 857     if (strlen (directory)) {
 858         char *path, *p;
 859
 860         path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
 861         if (! path)
 862             return NOTMUCH_STATUS_OUT_OF_MEMORY;
 863
 864         /* Add recursive "path:" terms for directory and all parents. */
 865         for (p = path + strlen (path) - 1; p > path; p--) {
 866             if (*p == '/') {
 867                 strcpy (p, RECURSIVE_SUFFIX);
 868                 status = COERCE_STATUS (_notmuch_message_add_term (message, "path", path),
 869                                         "adding path term");
 870                 if (status)
 871                     return status;
 872             }
 873         }
 874
 875         talloc_free (path);
 876     }
 877
 878     /* Recursive all-matching path:** for consistency. */
 879     status = COERCE_STATUS (_notmuch_message_add_term (message, "path", "**"),
 880                             "adding path term");
 881     if (status)
 882         return status;
 883
 884     return NOTMUCH_STATUS_SUCCESS;
 885 }
 886
 887 /* Add directory based terms for all filenames of the message. */
 888 static notmuch_status_t
 889 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
 890 {
 891     const char *direntry_prefix = _find_prefix ("file-direntry");
 892     int direntry_prefix_len = strlen (direntry_prefix);
 893     Xapian::TermIterator i = message->doc.termlist_begin ();
 894     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
 895
 896     for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
 897         unsigned int directory_id;
 898         const char *direntry, *directory;
 899         char *colon;
 900         const std::string &term = *i;
 901         notmuch_status_t term_status;
 902
 903         /* Terminate loop at first term without desired prefix. */
 904         if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
 905             break;
 906
 907         /* Indicate that there are filenames remaining. */
 908         status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
 909
 910         direntry = term.c_str ();
 911         direntry += direntry_prefix_len;
 912
 913         directory_id = strtol (direntry, &colon, 10);
 914
 915         if (colon == NULL || *colon != ':')
 916             INTERNAL_ERROR ("malformed direntry");
 917
 918         directory = _notmuch_database_get_directory_path (ctx,
 919                                                           message->notmuch,
 920                                                           directory_id);
 921
 922         term_status = _notmuch_message_add_folder_terms (message, directory);
 923         if (term_status)
 924             return term_status;
 925
 926         term_status = _notmuch_message_add_path_terms (message, directory);
 927         if (term_status)
 928             return term_status;
 929     }
 930
 931     return status;
 932 }
 933
 934 /* Add an additional 'filename' for 'message'.
 935  *
 936  * This change will not be reflected in the database until the next
 937  * call to _notmuch_message_sync. */
 938 notmuch_status_t
 939 _notmuch_message_add_filename (notmuch_message_t *message,
 940                                const char *filename)
 941 {
 942     const char *relative, *directory;
 943     notmuch_status_t status;
 944     void *local = talloc_new (message);
 945     char *direntry;
 946
 947     if (filename == NULL)
 948         INTERNAL_ERROR ("Message filename cannot be NULL.");
 949
 950     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
 951         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
 952         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
 953
 954     relative = _notmuch_database_relative_path (message->notmuch, filename);
 955
 956     status = _notmuch_database_split_path (local, relative, &directory, NULL);
 957     if (status)
 958         return status;
 959
 960     status = _notmuch_database_filename_to_direntry (
 961         local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
 962     if (status)
 963         return status;
 964
 965     /* New file-direntry allows navigating to this message with
 966      * notmuch_directory_get_child_files() . */
 967     status = COERCE_STATUS (_notmuch_message_add_term (message, "file-direntry", direntry),
 968                             "adding file-direntry term");
 969     if (status)
 970         return status;
 971
 972     status = _notmuch_message_add_folder_terms (message, directory);
 973     if (status)
 974         return status;
 975
 976     status = _notmuch_message_add_path_terms (message, directory);
 977     if (status)
 978         return status;
 979
 980     talloc_free (local);
 981
 982     return NOTMUCH_STATUS_SUCCESS;
 983 }
 984
 985 /* Remove a particular 'filename' from 'message'.
 986  *
 987  * This change will not be reflected in the database until the next
 988  * call to _notmuch_message_sync.
 989  *
 990  * If this message still has other filenames, returns
 991  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
 992  *
 993  * Note: This function does not remove a document from the database,
 994  * even if the specified filename is the only filename for this
 995  * message. For that functionality, see
 996  * notmuch_database_remove_message. */
 997 notmuch_status_t
 998 _notmuch_message_remove_filename (notmuch_message_t *message,
 999                                   const char *filename)
1000 {
1001     void *local = talloc_new (message);
1002     char *direntry;
1003     notmuch_private_status_t private_status;
1004     notmuch_status_t status;
1005
1006     if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
1007         ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
1008         return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1009
1010     status = _notmuch_database_filename_to_direntry (
1011         local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
1012     if (status || ! direntry)
1013         return status;
1014
1015     /* Unlink this file from its parent directory. */
1016     private_status = _notmuch_message_remove_term (message,
1017                                                    "file-direntry", direntry);
1018     status = COERCE_STATUS (private_status,
1019                             "Unexpected error from _notmuch_message_remove_term");
1020     if (status)
1021         return status;
1022
1023     /* Re-synchronize "folder:" and "path:" terms for this message. */
1024
1025     /* Remove all "folder:" terms. */
1026     _notmuch_message_remove_terms (message, _find_prefix ("folder"));
1027
1028     /* Remove all "path:" terms. */
1029     _notmuch_message_remove_terms (message, _find_prefix ("path"));
1030
1031     /* Add back terms for all remaining filenames of the message. */
1032     status = _notmuch_message_add_directory_terms (local, message);
1033
1034     talloc_free (local);
1035
1036     return status;
1037 }
1038
1039 /* Upgrade the "folder:" prefix from V1 to V2. */
1040 #define FOLDER_PREFIX_V1       "XFOLDER"
1041 #define ZFOLDER_PREFIX_V1      "Z" FOLDER_PREFIX_V1
1042 void
1043 _notmuch_message_upgrade_folder (notmuch_message_t *message)
1044 {
1045     /* Remove all old "folder:" terms. */
1046     _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
1047
1048     /* Remove all old "folder:" stemmed terms. */
1049     _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
1050
1051     /* Add new boolean "folder:" and "path:" terms. */
1052     _notmuch_message_add_directory_terms (message, message);
1053 }
1054
1055 char *
1056 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
1057 {
1058     return talloc_strdup (message, message->doc.get_data ().c_str ());
1059 }
1060
1061 void
1062 _notmuch_message_clear_data (notmuch_message_t *message)
1063 {
1064     message->doc.set_data ("");
1065     message->modified = true;
1066 }
1067
1068 static void
1069 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
1070 {
1071     notmuch_string_node_t *node;
1072
1073     if (message->filename_list)
1074         return;
1075
1076     _notmuch_message_ensure_metadata (message, message->filename_term_list);
1077
1078     message->filename_list = _notmuch_string_list_create (message);
1079     node = message->filename_term_list->head;
1080
1081     if (! node) {
1082         /* A message document created by an old version of notmuch
1083          * (prior to rename support) will have the filename in the
1084          * data of the document rather than as a file-direntry term.
1085          *
1086          * It would be nice to do the upgrade of the document directly
1087          * here, but the database is likely open in read-only mode. */
1088
1089         std::string datastr = message->doc.get_data ();
1090         const char *data = datastr.c_str ();
1091
1092         if (data == NULL)
1093             INTERNAL_ERROR ("message with no filename");
1094
1095         _notmuch_string_list_append (message->filename_list, data);
1096
1097         return;
1098     }
1099
1100     for (; node; node = node->next) {
1101         void *local = talloc_new (message);
1102         const char *db_path, *directory, *basename, *filename;
1103         char *colon, *direntry = NULL;
1104         unsigned int directory_id;
1105
1106         direntry = node->string;
1107
1108         directory_id = strtol (direntry, &colon, 10);
1109
1110         if (colon == NULL || *colon != ':')
1111             INTERNAL_ERROR ("malformed direntry");
1112
1113         basename = colon + 1;
1114
1115         *colon = '\0';
1116
1117         db_path = notmuch_config_get (message->notmuch, NOTMUCH_CONFIG_MAIL_ROOT);
1118
1119         directory = _notmuch_database_get_directory_path (local,
1120                                                           message->notmuch,
1121                                                           directory_id);
1122
1123         if (strlen (directory))
1124             filename = talloc_asprintf (message, "%s/%s/%s",
1125                                         db_path, directory, basename);
1126         else
1127             filename = talloc_asprintf (message, "%s/%s",
1128                                         db_path, basename);
1129
1130         _notmuch_string_list_append (message->filename_list, filename);
1131
1132         talloc_free (local);
1133     }
1134
1135     talloc_free (message->filename_term_list);
1136     message->filename_term_list = NULL;
1137 }
1138
1139 const char *
1140 notmuch_message_get_filename (notmuch_message_t *message)
1141 {
1142     try {
1143         _notmuch_message_ensure_filename_list (message);
1144     } catch (Xapian::Error &error) {
1145         LOG_XAPIAN_EXCEPTION (message, error);
1146         return NULL;
1147     }
1148
1149     if (message->filename_list == NULL)
1150         return NULL;
1151
1152     if (message->filename_list->head == NULL ||
1153         message->filename_list->head->string == NULL) {
1154         INTERNAL_ERROR ("message with no filename");
1155     }
1156
1157     return message->filename_list->head->string;
1158 }
1159
1160 notmuch_filenames_t *
1161 notmuch_message_get_filenames (notmuch_message_t *message)
1162 {
1163     try {
1164         _notmuch_message_ensure_filename_list (message);
1165     } catch (Xapian::Error &error) {
1166         LOG_XAPIAN_EXCEPTION (message, error);
1167         return NULL;
1168     }
1169
1170     return _notmuch_filenames_create (message, message->filename_list);
1171 }
1172
1173 int
1174 notmuch_message_count_files (notmuch_message_t *message)
1175 {
1176     try {
1177         _notmuch_message_ensure_filename_list (message);
1178     } catch (Xapian::Error &error) {
1179         LOG_XAPIAN_EXCEPTION (message, error);
1180         return -1;
1181     }
1182
1183     return _notmuch_string_list_length (message->filename_list);
1184 }
1185
1186 notmuch_status_t
1187 notmuch_message_get_flag_st (notmuch_message_t *message,
1188                              notmuch_message_flag_t flag,
1189                              notmuch_bool_t *is_set)
1190 {
1191     if (! is_set)
1192         return NOTMUCH_STATUS_NULL_POINTER;
1193
1194     try {
1195         if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
1196             ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
1197             _notmuch_message_ensure_metadata (message, NULL);
1198     } catch (Xapian::Error &error) {
1199         LOG_XAPIAN_EXCEPTION (message, error);
1200         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1201     }
1202
1203     *is_set = NOTMUCH_TEST_BIT (message->flags, flag);
1204     return NOTMUCH_STATUS_SUCCESS;
1205 }
1206
1207 notmuch_bool_t
1208 notmuch_message_get_flag (notmuch_message_t *message,
1209                           notmuch_message_flag_t flag)
1210 {
1211     notmuch_bool_t is_set;
1212     notmuch_status_t status;
1213
1214     status = notmuch_message_get_flag_st (message, flag, &is_set);
1215
1216     if (status)
1217         return FALSE;
1218     else
1219         return is_set;
1220 }
1221
1222 void
1223 notmuch_message_set_flag (notmuch_message_t *message,
1224                           notmuch_message_flag_t flag, notmuch_bool_t enable)
1225 {
1226     if (enable)
1227         NOTMUCH_SET_BIT (&message->flags, flag);
1228     else
1229         NOTMUCH_CLEAR_BIT (&message->flags, flag);
1230     NOTMUCH_SET_BIT (&message->lazy_flags, flag);
1231 }
1232
1233 time_t
1234 notmuch_message_get_date (notmuch_message_t *message)
1235 {
1236     std::string value;
1237
1238     try {
1239         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
1240     } catch (Xapian::Error &error) {
1241         LOG_XAPIAN_EXCEPTION (message, error);
1242         return 0;
1243     }
1244
1245     if (value.empty ())
1246         /* sortable_unserialise is undefined on empty string */
1247         return 0;
1248     return Xapian::sortable_unserialise (value);
1249 }
1250
1251 notmuch_tags_t *
1252 notmuch_message_get_tags (notmuch_message_t *message)
1253 {
1254     notmuch_tags_t *tags;
1255
1256     try {
1257         _notmuch_message_ensure_metadata (message, message->tag_list);
1258     } catch (Xapian::Error &error) {
1259         LOG_XAPIAN_EXCEPTION (message, error);
1260         return NULL;
1261     }
1262
1263     tags = _notmuch_tags_create (message, message->tag_list);
1264     /* _notmuch_tags_create steals the reference to the tag_list, but
1265      * in this case it's still used by the message, so we add an
1266      * *additional* talloc reference to the list.  As a result, it's
1267      * possible to modify the message tags (which talloc_unlink's the
1268      * current list from the message) while still iterating because
1269      * the iterator will keep the current list alive. */
1270     if (! talloc_reference (message, message->tag_list))
1271         return NULL;
1272
1273     return tags;
1274 }
1275
1276 const char *
1277 _notmuch_message_get_author (notmuch_message_t *message)
1278 {
1279     return message->author;
1280 }
1281
1282 void
1283 _notmuch_message_set_author (notmuch_message_t *message,
1284                              const char *author)
1285 {
1286     if (message->author)
1287         talloc_free (message->author);
1288     message->author = talloc_strdup (message, author);
1289     return;
1290 }
1291
1292 void
1293 _notmuch_message_set_header_values (notmuch_message_t *message,
1294                                     const char *date,
1295                                     const char *from,
1296                                     const char *subject)
1297 {
1298     time_t time_value;
1299
1300     /* GMime really doesn't want to see a NULL date, so protect its
1301      * sensibilities. */
1302     if (date == NULL || *date == '\0') {
1303         time_value = 0;
1304     } else {
1305         time_value = g_mime_utils_header_decode_date_unix (date);
1306         /*
1307          * Workaround for https://bugzilla.gnome.org/show_bug.cgi?id=779923
1308          */
1309         if (time_value < 0)
1310             time_value = 0;
1311     }
1312
1313     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1314                             Xapian::sortable_serialise (time_value));
1315     message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1316     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1317     message->modified = true;
1318 }
1319
1320 void
1321 _notmuch_message_update_subject (notmuch_message_t *message,
1322                                  const char *subject)
1323 {
1324     message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1325     message->modified = true;
1326 }
1327
1328 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD.  The caller
1329  * must call _notmuch_message_sync. */
1330 void
1331 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1332 {
1333     /* _notmuch_message_sync will update the last modification
1334      * revision; we just have to ask it to. */
1335     message->modified = true;
1336 }
1337
1338 /* Synchronize changes made to message->doc out into the database. */
1339 void
1340 _notmuch_message_sync (notmuch_message_t *message)
1341 {
1342     if (_notmuch_database_mode (message->notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY)
1343         return;
1344
1345     if (! message->modified)
1346         return;
1347
1348     /* Update the last modification of this message. */
1349     if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1350         /* sortable_serialise gives a reasonably compact encoding,
1351          * which directly translates to reduced IO when scanning the
1352          * value stream.  Since it's built for doubles, we only get 53
1353          * effective bits, but that's still enough for the database to
1354          * last a few centuries at 1 million revisions per second. */
1355         message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1356                                 Xapian::sortable_serialise (
1357                                     _notmuch_database_new_revision (
1358                                         message->notmuch)));
1359
1360     message->notmuch->writable_xapian_db->
1361         replace_document (message->doc_id, message->doc);
1362     message->modified = false;
1363 }
1364
1365 /* Delete a message document from the database, leaving a ghost
1366  * message in its place */
1367 notmuch_status_t
1368 _notmuch_message_delete (notmuch_message_t *message)
1369 {
1370     notmuch_status_t status;
1371     const char *mid, *tid;
1372     notmuch_message_t *ghost;
1373     notmuch_private_status_t private_status;
1374     notmuch_database_t *notmuch;
1375     unsigned int count = 0;
1376     bool is_ghost;
1377
1378     mid = notmuch_message_get_message_id (message);
1379     tid = notmuch_message_get_thread_id (message);
1380     notmuch = message->notmuch;
1381
1382     status = _notmuch_database_ensure_writable (message->notmuch);
1383     if (status)
1384         return status;
1385
1386     try {
1387         Xapian::PostingIterator thread_doc, thread_doc_end;
1388         Xapian::PostingIterator mail_doc, mail_doc_end;
1389
1390         message->notmuch->writable_xapian_db->delete_document (message->doc_id);
1391
1392         /* look for a non-ghost message in the same thread */
1393         /* if this was a ghost to begin with, we are done */
1394         private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1395         if (private_status)
1396             return COERCE_STATUS (private_status,
1397                                   "Error trying to determine whether message was a ghost");
1398         if (is_ghost)
1399             return NOTMUCH_STATUS_SUCCESS;
1400
1401         _notmuch_database_find_doc_ids (message->notmuch, "thread", tid, &thread_doc,
1402                                         &thread_doc_end);
1403         _notmuch_database_find_doc_ids (message->notmuch, "type", "mail", &mail_doc, &mail_doc_end);
1404
1405         while (count == 0 &&
1406                thread_doc != thread_doc_end &&
1407                mail_doc != mail_doc_end) {
1408             thread_doc.skip_to (*mail_doc);
1409             if (thread_doc != thread_doc_end) {
1410                 if (*thread_doc == *mail_doc) {
1411                     count++;
1412                 } else {
1413                     mail_doc.skip_to (*thread_doc);
1414                     if (mail_doc != mail_doc_end && *thread_doc == *mail_doc)
1415                         count++;
1416                 }
1417             }
1418         }
1419     } catch (Xapian::Error &error) {
1420         LOG_XAPIAN_EXCEPTION (message, error);
1421         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1422     }
1423     if (count > 0) {
1424         /* reintroduce a ghost in its place because there are still
1425          * other active messages in this thread: */
1426         ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1427         if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1428             private_status = _notmuch_message_initialize_ghost (ghost, tid);
1429             if (! private_status)
1430                 _notmuch_message_sync (ghost);
1431         } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1432             /* this is deeply weird, and we should not have gotten
1433              * into this state.  is there a better error message to
1434              * return here? */
1435             status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1436         }
1437
1438         notmuch_message_destroy (ghost);
1439         status = COERCE_STATUS (private_status, "Error converting to ghost message");
1440     } else {
1441         /* the thread now contains only ghosts: delete them */
1442         try {
1443             Xapian::PostingIterator doc, doc_end;
1444
1445             _notmuch_database_find_doc_ids (message->notmuch, "thread", tid, &doc, &doc_end);
1446
1447             for (; doc != doc_end; doc++) {
1448                 message->notmuch->writable_xapian_db->delete_document (*doc);
1449             }
1450         } catch (Xapian::Error &error) {
1451             LOG_XAPIAN_EXCEPTION (message, error);
1452             return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1453         }
1454
1455     }
1456     return status;
1457 }
1458
1459 /* Transform a blank message into a ghost message.  The caller must
1460  * _notmuch_message_sync the message. */
1461 notmuch_private_status_t
1462 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1463                                    const char *thread_id)
1464 {
1465     notmuch_private_status_t status;
1466
1467     status = _notmuch_message_add_term (message, "type", "ghost");
1468     if (status)
1469         return status;
1470     status = _notmuch_message_add_term (message, "thread", thread_id);
1471     if (status)
1472         return status;
1473
1474     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1475 }
1476
1477 /* Ensure that 'message' is not holding any file object open. Future
1478  * calls to various functions will still automatically open the
1479  * message file as needed.
1480  */
1481 void
1482 _notmuch_message_close (notmuch_message_t *message)
1483 {
1484     if (message->message_file) {
1485         _notmuch_message_file_close (message->message_file);
1486         message->message_file = NULL;
1487     }
1488 }
1489
1490 /* Add a name:value term to 'message', (the actual term will be
1491  * encoded by prefixing the value with a short prefix). See
1492  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1493  * names to prefix values.
1494  *
1495  * This change will not be reflected in the database until the next
1496  * call to _notmuch_message_sync. */
1497 NODISCARD notmuch_private_status_t
1498 _notmuch_message_add_term (notmuch_message_t *message,
1499                            const char *prefix_name,
1500                            const char *value)
1501 {
1502
1503     char *term;
1504     notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1505
1506     if (value == NULL)
1507         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1508
1509     term = talloc_asprintf (message, "%s%s",
1510                             _find_prefix (prefix_name), value);
1511     if (strlen (term) > NOTMUCH_TERM_MAX) {
1512         status = NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1513         goto DONE;
1514     }
1515
1516     try {
1517         message->doc.add_term (term, 0);
1518         message->modified = true;
1519         _notmuch_message_invalidate_metadata (message, prefix_name);
1520     } catch (Xapian::Error &error) {
1521         LOG_XAPIAN_EXCEPTION (message, error);
1522         status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1523     }
1524
1525   DONE:
1526     talloc_free (term);
1527     return status;
1528 }
1529
1530 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1531  * term will be added with the appropriate prefix if prefix_name is
1532  * non-NULL.
1533  */
1534 notmuch_private_status_t
1535 _notmuch_message_gen_terms (notmuch_message_t *message,
1536                             const char *prefix_name,
1537                             const char *text)
1538 {
1539     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1540
1541     if (text == NULL)
1542         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1543
1544     term_gen->set_document (message->doc);
1545     term_gen->set_termpos (message->termpos);
1546
1547     if (prefix_name) {
1548         const char *prefix = _notmuch_database_prefix (message->notmuch, prefix_name);
1549         if (prefix == NULL)
1550             return NOTMUCH_PRIVATE_STATUS_BAD_PREFIX;
1551
1552         _notmuch_message_invalidate_metadata (message, prefix_name);
1553         term_gen->index_text (text, 1, prefix);
1554     } else {
1555         term_gen->index_text (text);
1556     }
1557
1558     /* Create a gap between this an the next terms so they don't
1559      * appear to be a phrase. */
1560     message->termpos = term_gen->get_termpos () + 100;
1561
1562     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1563 }
1564
1565 /* Remove a name:value term from 'message', (the actual term will be
1566  * encoded by prefixing the value with a short prefix). See
1567  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1568  * names to prefix values.
1569  *
1570  * This change will not be reflected in the database until the next
1571  * call to _notmuch_message_sync. */
1572 NODISCARD notmuch_private_status_t
1573 _notmuch_message_remove_term (notmuch_message_t *message,
1574                               const char *prefix_name,
1575                               const char *value)
1576 {
1577     char *term;
1578
1579     if (value == NULL)
1580         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1581
1582     term = talloc_asprintf (message, "%s%s",
1583                             _find_prefix (prefix_name), value);
1584
1585     if (strlen (term) > NOTMUCH_TERM_MAX)
1586         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1587
1588     try {
1589         message->doc.remove_term (term);
1590         message->modified = true;
1591     } catch (const Xapian::InvalidArgumentError &error) {
1592         /* We'll let the philosophers try to wrestle with the
1593          * question of whether failing to remove that which was not
1594          * there in the first place is failure. For us, we'll silently
1595          * consider it all good. */
1596         LOG_XAPIAN_EXCEPTION (message, error);
1597     }
1598
1599     talloc_free (term);
1600
1601     _notmuch_message_invalidate_metadata (message, prefix_name);
1602
1603     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1604 }
1605
1606 notmuch_private_status_t
1607 _notmuch_message_has_term (notmuch_message_t *message,
1608                            const char *prefix_name,
1609                            const char *value,
1610                            bool *result)
1611 {
1612     char *term;
1613     bool out = false;
1614     notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1615
1616     if (value == NULL)
1617         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1618
1619     term = talloc_asprintf (message, "%s%s",
1620                             _find_prefix (prefix_name), value);
1621
1622     if (strlen (term) > NOTMUCH_TERM_MAX)
1623         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1624
1625     try {
1626         /* Look for the exact term */
1627         Xapian::TermIterator i = message->doc.termlist_begin ();
1628         i.skip_to (term);
1629         if (i != message->doc.termlist_end () &&
1630             ! strcmp ((*i).c_str (), term))
1631             out = true;
1632     } catch (Xapian::Error &error) {
1633         status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1634     }
1635     talloc_free (term);
1636
1637     *result = out;
1638     return status;
1639 }
1640
1641 notmuch_status_t
1642 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1643 {
1644     notmuch_private_status_t private_status;
1645     notmuch_status_t status;
1646
1647     try {
1648         status = _notmuch_database_ensure_writable (message->notmuch);
1649         if (status)
1650             return status;
1651
1652         if (tag == NULL)
1653             return NOTMUCH_STATUS_NULL_POINTER;
1654
1655         if (strlen (tag) > NOTMUCH_TAG_MAX)
1656             return NOTMUCH_STATUS_TAG_TOO_LONG;
1657
1658         private_status = _notmuch_message_add_term (message, "tag", tag);
1659         if (private_status) {
1660             return COERCE_STATUS (private_status,
1661                                   "_notmuch_message_remove_term return unexpected value: %d\n",
1662                                   private_status);
1663         }
1664
1665         if (! message->frozen)
1666             _notmuch_message_sync (message);
1667
1668     } catch (Xapian::Error &error) {
1669         LOG_XAPIAN_EXCEPTION (message, error);
1670         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1671     }
1672
1673     return NOTMUCH_STATUS_SUCCESS;
1674 }
1675
1676 notmuch_status_t
1677 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1678 {
1679     notmuch_private_status_t private_status;
1680     notmuch_status_t status;
1681
1682     try {
1683         status = _notmuch_database_ensure_writable (message->notmuch);
1684         if (status)
1685             return status;
1686
1687         if (tag == NULL)
1688             return NOTMUCH_STATUS_NULL_POINTER;
1689
1690         if (strlen (tag) > NOTMUCH_TAG_MAX)
1691             return NOTMUCH_STATUS_TAG_TOO_LONG;
1692
1693         private_status = _notmuch_message_remove_term (message, "tag", tag);
1694         if (private_status) {
1695             return COERCE_STATUS (private_status,
1696                                   "_notmuch_message_remove_term return unexpected value: %d\n",
1697                                   private_status);
1698         }
1699
1700         if (! message->frozen)
1701             _notmuch_message_sync (message);
1702     } catch (Xapian::Error &error) {
1703         LOG_XAPIAN_EXCEPTION (message, error);
1704         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1705     }
1706
1707     return NOTMUCH_STATUS_SUCCESS;
1708 }
1709
1710 /* Is the given filename within a maildir directory?
1711  *
1712  * Specifically, is the final directory component of 'filename' either
1713  * "cur" or "new". If so, return a pointer to that final directory
1714  * component within 'filename'. If not, return NULL.
1715  *
1716  * A non-NULL return value is guaranteed to be a valid string pointer
1717  * pointing to the characters "new/" or "cur/", (but not
1718  * NUL-terminated).
1719  */
1720 static const char *
1721 _filename_is_in_maildir (const char *filename)
1722 {
1723     const char *slash, *dir = NULL;
1724
1725     /* Find the last '/' separating directory from filename. */
1726     slash = strrchr (filename, '/');
1727     if (slash == NULL)
1728         return NULL;
1729
1730     /* Jump back 4 characters to where the previous '/' will be if the
1731      * directory is named "cur" or "new". */
1732     if (slash - filename < 4)
1733         return NULL;
1734
1735     slash -= 4;
1736
1737     if (*slash != '/')
1738         return NULL;
1739
1740     dir = slash + 1;
1741
1742     if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1743         STRNCMP_LITERAL (dir, "new/") == 0) {
1744         return dir;
1745     }
1746
1747     return NULL;
1748 }
1749
1750 static notmuch_status_t
1751 _ensure_maildir_flags (notmuch_message_t *message, bool force)
1752 {
1753     const char *flags;
1754     notmuch_filenames_t *filenames;
1755     const char *filename, *dir;
1756     char *combined_flags = talloc_strdup (message, "");
1757     int seen_maildir_info = 0;
1758
1759     if (message->maildir_flags) {
1760         if (force) {
1761             talloc_free (message->maildir_flags);
1762             message->maildir_flags = NULL;
1763         }
1764     }
1765     filenames = notmuch_message_get_filenames (message);
1766     if (! filenames)
1767         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1768     for (;
1769          notmuch_filenames_valid (filenames);
1770          notmuch_filenames_move_to_next (filenames)) {
1771         filename = notmuch_filenames_get (filenames);
1772         dir = _filename_is_in_maildir (filename);
1773
1774         if (! dir)
1775             continue;
1776
1777         flags = strstr (filename, ":2,");
1778         if (flags) {
1779             seen_maildir_info = 1;
1780             flags += 3;
1781             combined_flags = talloc_strdup_append (combined_flags, flags);
1782         } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1783             /* Messages are delivered to new/ with no "info" part, but
1784              * they effectively have default maildir flags.  According
1785              * to the spec, we should ignore the info part for
1786              * messages in new/, but some MUAs (mutt) can set maildir
1787              * flags on messages in new/, so we're liberal in what we
1788              * accept. */
1789             seen_maildir_info = 1;
1790         }
1791     }
1792     if (seen_maildir_info)
1793         message->maildir_flags = combined_flags;
1794     return NOTMUCH_STATUS_SUCCESS;
1795 }
1796
1797 notmuch_bool_t
1798 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
1799 {
1800     notmuch_status_t status;
1801     notmuch_bool_t ret;
1802
1803     status = notmuch_message_has_maildir_flag_st (message, flag, &ret);
1804     if (status)
1805         return FALSE;
1806
1807     return ret;
1808 }
1809
1810 notmuch_status_t
1811 notmuch_message_has_maildir_flag_st (notmuch_message_t *message,
1812                                      char flag,
1813                                      notmuch_bool_t *is_set)
1814 {
1815     notmuch_status_t status;
1816
1817     if (! is_set)
1818         return NOTMUCH_STATUS_NULL_POINTER;
1819
1820     status = _ensure_maildir_flags (message, false);
1821     if (status)
1822         return status;
1823
1824     *is_set =  message->maildir_flags && (strchr (message->maildir_flags, flag) != NULL);
1825     return NOTMUCH_STATUS_SUCCESS;
1826 }
1827
1828 notmuch_status_t
1829 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1830 {
1831     notmuch_status_t status;
1832     unsigned i;
1833
1834     status = _ensure_maildir_flags (message, true);
1835     if (status)
1836         return status;
1837     /* If none of the filenames have any maildir info field (not even
1838      * an empty info with no flags set) then there's no information to
1839      * go on, so do nothing. */
1840     if (! message->maildir_flags)
1841         return NOTMUCH_STATUS_SUCCESS;
1842
1843     status = notmuch_message_freeze (message);
1844     if (status)
1845         return status;
1846
1847     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1848         if ((strchr (message->maildir_flags, flag2tag[i].flag) != NULL)
1849             ^
1850             flag2tag[i].inverse) {
1851             status = notmuch_message_add_tag (message, flag2tag[i].tag);
1852         } else {
1853             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1854         }
1855         if (status)
1856             return status;
1857     }
1858     status = notmuch_message_thaw (message);
1859
1860     return status;
1861 }
1862
1863 /* From the set of tags on 'message' and the flag2tag table, compute a
1864  * set of maildir-flag actions to be taken, (flags that should be
1865  * either set or cleared).
1866  *
1867  * The result is returned as two talloced strings: to_set, and to_clear
1868  */
1869 static void
1870 _get_maildir_flag_actions (notmuch_message_t *message,
1871                            char **to_set_ret,
1872                            char **to_clear_ret)
1873 {
1874     char *to_set, *to_clear;
1875     notmuch_tags_t *tags;
1876     const char *tag;
1877     unsigned i;
1878
1879     to_set = talloc_strdup (message, "");
1880     to_clear = talloc_strdup (message, "");
1881
1882     /* First, find flags for all set tags. */
1883     for (tags = notmuch_message_get_tags (message);
1884          notmuch_tags_valid (tags);
1885          notmuch_tags_move_to_next (tags)) {
1886         tag = notmuch_tags_get (tags);
1887
1888         for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1889             if (strcmp (tag, flag2tag[i].tag) == 0) {
1890                 if (flag2tag[i].inverse)
1891                     to_clear = talloc_asprintf_append (to_clear,
1892                                                        "%c",
1893                                                        flag2tag[i].flag);
1894                 else
1895                     to_set = talloc_asprintf_append (to_set,
1896                                                      "%c",
1897                                                      flag2tag[i].flag);
1898             }
1899         }
1900     }
1901
1902     /* Then, find the flags for all tags not present. */
1903     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1904         if (flag2tag[i].inverse) {
1905             if (strchr (to_clear, flag2tag[i].flag) == NULL)
1906                 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1907         } else {
1908             if (strchr (to_set, flag2tag[i].flag) == NULL)
1909                 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1910         }
1911     }
1912
1913     *to_set_ret = to_set;
1914     *to_clear_ret = to_clear;
1915 }
1916
1917 /* Given 'filename' and a set of maildir flags to set and to clear,
1918  * compute the new maildir filename.
1919  *
1920  * If the existing filename is in the directory "new", the new
1921  * filename will be in the directory "cur", except for the case when
1922  * no flags are changed and the existing filename does not contain
1923  * maildir info (starting with ",2:").
1924  *
1925  * After a sequence of ":2," in the filename, any subsequent
1926  * single-character flags will be added or removed according to the
1927  * characters in flags_to_set and flags_to_clear. Any existing flags
1928  * not mentioned in either string will remain. The final list of flags
1929  * will be in ASCII order.
1930  *
1931  * If the original flags seem invalid, (repeated characters or
1932  * non-ASCII ordering of flags), this function will return NULL
1933  * (meaning that renaming would not be safe and should not occur).
1934  */
1935 static char *
1936 _new_maildir_filename (void *ctx,
1937                        const char *filename,
1938                        const char *flags_to_set,
1939                        const char *flags_to_clear)
1940 {
1941     const char *info, *flags;
1942     unsigned int flag, last_flag;
1943     char *filename_new, *dir;
1944     char flag_map[128];
1945     int flags_in_map = 0;
1946     bool flags_changed = false;
1947     unsigned int i;
1948     char *s;
1949
1950     memset (flag_map, 0, sizeof (flag_map));
1951
1952     info = strstr (filename, ":2,");
1953
1954     if (info == NULL) {
1955         info = filename + strlen (filename);
1956     } else {
1957         /* Loop through existing flags in filename. */
1958         for (flags = info + 3, last_flag = 0;
1959              *flags;
1960              last_flag = flag, flags++) {
1961             flag = *flags;
1962
1963             /* Original flags not in ASCII order. Abort. */
1964             if (flag < last_flag)
1965                 return NULL;
1966
1967             /* Non-ASCII flag. Abort. */
1968             if (flag > sizeof (flag_map) - 1)
1969                 return NULL;
1970
1971             /* Repeated flag value. Abort. */
1972             if (flag_map[flag])
1973                 return NULL;
1974
1975             flag_map[flag] = 1;
1976             flags_in_map++;
1977         }
1978     }
1979
1980     /* Then set and clear our flags from tags. */
1981     for (flags = flags_to_set; *flags; flags++) {
1982         flag = *flags;
1983         if (flag_map[flag] == 0) {
1984             flag_map[flag] = 1;
1985             flags_in_map++;
1986             flags_changed = true;
1987         }
1988     }
1989
1990     for (flags = flags_to_clear; *flags; flags++) {
1991         flag = *flags;
1992         if (flag_map[flag]) {
1993             flag_map[flag] = 0;
1994             flags_in_map--;
1995             flags_changed = true;
1996         }
1997     }
1998
1999     /* Messages in new/ without maildir info can be kept in new/ if no
2000      * flags have changed. */
2001     dir = (char *) _filename_is_in_maildir (filename);
2002     if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && ! *info && ! flags_changed)
2003         return talloc_strdup (ctx, filename);
2004
2005     filename_new = (char *) talloc_size (ctx,
2006                                          info - filename +
2007                                          strlen (":2,") + flags_in_map + 1);
2008     if (unlikely (filename_new == NULL))
2009         return NULL;
2010
2011     strncpy (filename_new, filename, info - filename);
2012     filename_new[info - filename] = '\0';
2013
2014     strcat (filename_new, ":2,");
2015
2016     s = filename_new + strlen (filename_new);
2017     for (i = 0; i < sizeof (flag_map); i++) {
2018         if (flag_map[i]) {
2019             *s = i;
2020             s++;
2021         }
2022     }
2023     *s = '\0';
2024
2025     /* If message is in new/ move it under cur/. */
2026     dir = (char *) _filename_is_in_maildir (filename_new);
2027     if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
2028         memcpy (dir, "cur/", 4);
2029
2030     return filename_new;
2031 }
2032
2033 notmuch_status_t
2034 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
2035 {
2036     notmuch_filenames_t *filenames;
2037     const char *filename;
2038     char *filename_new;
2039     char *to_set, *to_clear;
2040     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
2041
2042     status = _notmuch_database_ensure_writable (message->notmuch);
2043     if (status)
2044         return status;
2045
2046     _get_maildir_flag_actions (message, &to_set, &to_clear);
2047
2048     for (filenames = notmuch_message_get_filenames (message);
2049          notmuch_filenames_valid (filenames);
2050          notmuch_filenames_move_to_next (filenames)) {
2051         filename = notmuch_filenames_get (filenames);
2052
2053         if (! _filename_is_in_maildir (filename))
2054             continue;
2055
2056         filename_new = _new_maildir_filename (message, filename,
2057                                               to_set, to_clear);
2058         if (filename_new == NULL)
2059             continue;
2060
2061         if (strcmp (filename, filename_new)) {
2062             int err;
2063             notmuch_status_t new_status;
2064
2065             err = rename (filename, filename_new);
2066             if (err)
2067                 continue;
2068
2069             new_status = _notmuch_message_remove_filename (message,
2070                                                            filename);
2071             /* Hold on to only the first error. */
2072             if (! status && new_status
2073                 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
2074                 status = new_status;
2075                 continue;
2076             }
2077
2078             new_status = _notmuch_message_add_filename (message,
2079                                                         filename_new);
2080             /* Hold on to only the first error. */
2081             if (! status && new_status) {
2082                 status = new_status;
2083                 continue;
2084             }
2085
2086             _notmuch_message_sync (message);
2087         }
2088
2089         talloc_free (filename_new);
2090     }
2091
2092     talloc_free (to_set);
2093     talloc_free (to_clear);
2094
2095     return status;
2096 }
2097
2098 notmuch_status_t
2099 notmuch_message_remove_all_tags (notmuch_message_t *message)
2100 {
2101     notmuch_private_status_t private_status;
2102     notmuch_status_t status;
2103     notmuch_tags_t *tags;
2104     const char *tag;
2105
2106     status = _notmuch_database_ensure_writable (message->notmuch);
2107     if (status)
2108         return status;
2109     tags = notmuch_message_get_tags (message);
2110     if (! tags)
2111         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2112
2113     for (;
2114          notmuch_tags_valid (tags);
2115          notmuch_tags_move_to_next (tags)) {
2116         tag = notmuch_tags_get (tags);
2117
2118         private_status = _notmuch_message_remove_term (message, "tag", tag);
2119         if (private_status) {
2120             return COERCE_STATUS (private_status,
2121                                   "_notmuch_message_remove_term return unexpected value: %d\n",
2122                                   private_status);
2123         }
2124     }
2125
2126     if (! message->frozen)
2127         _notmuch_message_sync (message);
2128
2129     talloc_free (tags);
2130     return NOTMUCH_STATUS_SUCCESS;
2131 }
2132
2133 notmuch_status_t
2134 notmuch_message_freeze (notmuch_message_t *message)
2135 {
2136     notmuch_status_t status;
2137
2138     status = _notmuch_database_ensure_writable (message->notmuch);
2139     if (status)
2140         return status;
2141
2142     message->frozen++;
2143
2144     return NOTMUCH_STATUS_SUCCESS;
2145 }
2146
2147 notmuch_status_t
2148 notmuch_message_thaw (notmuch_message_t *message)
2149 {
2150     notmuch_status_t status;
2151
2152     status = _notmuch_database_ensure_writable (message->notmuch);
2153     if (status)
2154         return status;
2155
2156     if (message->frozen > 0) {
2157         message->frozen--;
2158         if (message->frozen == 0)
2159             _notmuch_message_sync (message);
2160         return NOTMUCH_STATUS_SUCCESS;
2161     } else {
2162         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
2163     }
2164 }
2165
2166 void
2167 notmuch_message_destroy (notmuch_message_t *message)
2168 {
2169     talloc_free (message);
2170 }
2171
2172 notmuch_database_t *
2173 notmuch_message_get_database (const notmuch_message_t *message)
2174 {
2175     return message->notmuch;
2176 }
2177
2178 static void
2179 _notmuch_message_ensure_property_map (notmuch_message_t *message)
2180 {
2181     notmuch_string_node_t *node;
2182
2183     if (message->property_map)
2184         return;
2185
2186     _notmuch_message_ensure_metadata (message, message->property_term_list);
2187
2188     message->property_map = _notmuch_string_map_create (message);
2189
2190     for (node = message->property_term_list->head; node; node = node->next) {
2191         const char *key;
2192         char *value;
2193
2194         value = strchr (node->string, '=');
2195         if (! value)
2196             INTERNAL_ERROR ("malformed property term");
2197
2198         *value = '\0';
2199         value++;
2200         key = node->string;
2201
2202         _notmuch_string_map_append (message->property_map, key, value);
2203
2204     }
2205
2206     talloc_free (message->property_term_list);
2207     message->property_term_list = NULL;
2208 }
2209
2210 notmuch_string_map_t *
2211 _notmuch_message_property_map (notmuch_message_t *message)
2212 {
2213     _notmuch_message_ensure_property_map (message);
2214
2215     return message->property_map;
2216 }
2217
2218 bool
2219 _notmuch_message_frozen (notmuch_message_t *message)
2220 {
2221     return message->frozen;
2222 }
2223
2224 notmuch_status_t
2225 notmuch_message_reindex (notmuch_message_t *message,
2226                          notmuch_indexopts_t *indexopts)
2227 {
2228     notmuch_database_t *notmuch = NULL;
2229     notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2230     notmuch_private_status_t private_status;
2231     notmuch_filenames_t *orig_filenames = NULL;
2232     const char *orig_thread_id = NULL;
2233     notmuch_message_file_t *message_file = NULL;
2234
2235     int found = 0;
2236
2237     if (message == NULL)
2238         return NOTMUCH_STATUS_NULL_POINTER;
2239
2240     /* Save in case we need to delete message */
2241     orig_thread_id = notmuch_message_get_thread_id (message);
2242     if (! orig_thread_id) {
2243         /* the following is correct as long as there is only one reason
2244          * n_m_get_thread_id returns NULL
2245          */
2246         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2247     }
2248
2249     /* strdup it because the metadata may be invalidated */
2250     orig_thread_id = talloc_strdup (message, orig_thread_id);
2251
2252     notmuch = notmuch_message_get_database (message);
2253
2254     ret = _notmuch_database_ensure_writable (notmuch);
2255     if (ret)
2256         return ret;
2257
2258     orig_filenames = notmuch_message_get_filenames (message);
2259
2260     private_status = _notmuch_message_remove_indexed_terms (message);
2261     if (private_status) {
2262         ret = COERCE_STATUS (private_status, "error removing terms");
2263         goto DONE;
2264     }
2265
2266     ret = notmuch_message_remove_all_properties_with_prefix (message, "index.");
2267     if (ret)
2268         goto DONE; /* XXX TODO: distinguish from other error returns above? */
2269     if (indexopts && notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE) {
2270         ret = notmuch_message_remove_all_properties (message, "session-key");
2271         if (ret)
2272             goto DONE;
2273     }
2274
2275     /* re-add the filenames with the associated indexopts */
2276     for (; notmuch_filenames_valid (orig_filenames);
2277          notmuch_filenames_move_to_next (orig_filenames)) {
2278
2279         const char *date;
2280         const char *from, *to, *subject;
2281         char *message_id = NULL;
2282         const char *thread_id = NULL;
2283
2284         const char *filename = notmuch_filenames_get (orig_filenames);
2285
2286         message_file = _notmuch_message_file_open (notmuch, filename);
2287         if (message_file == NULL)
2288             continue;
2289
2290         ret = _notmuch_message_file_get_headers (message_file,
2291                                                  &from, &subject, &to, &date,
2292                                                  &message_id);
2293         if (ret)
2294             goto DONE;
2295
2296         /* XXX TODO: deal with changing message id? */
2297
2298         _notmuch_message_add_filename (message, filename);
2299
2300         ret = _notmuch_database_link_message_to_parents (notmuch, message,
2301                                                          message_file,
2302                                                          &thread_id);
2303         if (ret)
2304             goto DONE;
2305
2306         if (thread_id == NULL)
2307             thread_id = orig_thread_id;
2308
2309         ret = COERCE_STATUS (_notmuch_message_add_term (message, "thread", thread_id),
2310                              "adding thread term");
2311         if (ret)
2312             goto DONE;
2313
2314         /* Take header values only from first filename */
2315         if (found == 0)
2316             _notmuch_message_set_header_values (message, date, from, subject);
2317
2318         ret = _notmuch_message_index_file (message, indexopts, message_file);
2319
2320         if (ret == NOTMUCH_STATUS_FILE_ERROR)
2321             continue;
2322         if (ret)
2323             goto DONE;
2324
2325         found++;
2326         _notmuch_message_file_close (message_file);
2327         message_file = NULL;
2328     }
2329     if (found == 0) {
2330         /* put back thread id to help cleanup */
2331         ret = COERCE_STATUS (_notmuch_message_add_term (message, "thread", orig_thread_id),
2332                              "adding thread term");
2333         if (ret)
2334             goto DONE;
2335
2336         ret = _notmuch_message_delete (message);
2337     } else {
2338         _notmuch_message_sync (message);
2339     }
2340
2341   DONE:
2342     if (message_file)
2343         _notmuch_message_file_close (message_file);
2344
2345     /* XXX TODO destroy orig_filenames? */
2346     return ret;
2347 }