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

   1 /* message.cc - Results of message-based searches from a notmuch database
   2  *
   3  * Copyright © 2009 Carl Worth
   4  *
   5  * This program is free software: you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation, either version 3 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License
  16  * along with this program.  If not, see http://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
  24 #include <stdint.h>
  25
  26 #include <gmime/gmime.h>
  27
  28 struct _notmuch_message {
  29     notmuch_database_t *notmuch;
  30     Xapian::docid doc_id;
  31     int frozen;
  32     char *message_id;
  33     char *thread_id;
  34     char *in_reply_to;
  35     char *filename;
  36     char *author;
  37     notmuch_message_file_t *message_file;
  38     notmuch_message_list_t *replies;
  39     unsigned long flags;
  40
  41     Xapian::Document doc;
  42 };
  43
  44 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  45
  46 struct maildir_flag_tag {
  47     char flag;
  48     const char *tag;
  49     bool inverse;
  50 };
  51
  52 /* ASCII ordered table of Maildir flags and associated tags */
  53 struct maildir_flag_tag flag2tag[] = {
  54     { 'D', "draft",   false},
  55     { 'F', "flagged", false},
  56     { 'P', "passed",  false},
  57     { 'R', "replied", false},
  58     { 'S', "unread",  true }
  59 };
  60
  61 /* We end up having to call the destructor explicitly because we had
  62  * to use "placement new" in order to initialize C++ objects within a
  63  * block that we allocated with talloc. So C++ is making talloc
  64  * slightly less simple to use, (we wouldn't need
  65  * talloc_set_destructor at all otherwise).
  66  */
  67 static int
  68 _notmuch_message_destructor (notmuch_message_t *message)
  69 {
  70     message->doc.~Document ();
  71
  72     return 0;
  73 }
  74
  75 static notmuch_message_t *
  76 _notmuch_message_create_for_document (const void *talloc_owner,
  77                                       notmuch_database_t *notmuch,
  78                                       unsigned int doc_id,
  79                                       Xapian::Document doc,
  80                                       notmuch_private_status_t *status)
  81 {
  82     notmuch_message_t *message;
  83
  84     if (status)
  85         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
  86
  87     message = talloc (talloc_owner, notmuch_message_t);
  88     if (unlikely (message == NULL)) {
  89         if (status)
  90             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
  91         return NULL;
  92     }
  93
  94     message->notmuch = notmuch;
  95     message->doc_id = doc_id;
  96
  97     message->frozen = 0;
  98     message->flags = 0;
  99
 100     /* Each of these will be lazily created as needed. */
 101     message->message_id = NULL;
 102     message->thread_id = NULL;
 103     message->in_reply_to = NULL;
 104     message->filename = NULL;
 105     message->message_file = NULL;
 106     message->author = NULL;
 107
 108     message->replies = _notmuch_message_list_create (message);
 109     if (unlikely (message->replies == NULL)) {
 110         if (status)
 111             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 112         return NULL;
 113     }
 114
 115     /* This is C++'s creepy "placement new", which is really just an
 116      * ugly way to call a constructor for a pre-allocated object. So
 117      * it's really not an error to not be checking for OUT_OF_MEMORY
 118      * here, since this "new" isn't actually allocating memory. This
 119      * is language-design comedy of the wrong kind. */
 120
 121     new (&message->doc) Xapian::Document;
 122
 123     talloc_set_destructor (message, _notmuch_message_destructor);
 124
 125     message->doc = doc;
 126
 127     return message;
 128 }
 129
 130 /* Create a new notmuch_message_t object for an existing document in
 131  * the database.
 132  *
 133  * Here, 'talloc owner' is an optional talloc context to which the new
 134  * message will belong. This allows for the caller to not bother
 135  * calling notmuch_message_destroy on the message, and no that all
 136  * memory will be reclaimed with 'talloc_owner' is free. The caller
 137  * still can call notmuch_message_destroy when finished with the
 138  * message if desired.
 139  *
 140  * The 'talloc_owner' argument can also be NULL, in which case the
 141  * caller *is* responsible for calling notmuch_message_destroy.
 142  *
 143  * If no document exists in the database with document ID of 'doc_id'
 144  * then this function returns NULL and optionally sets *status to
 145  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
 146  *
 147  * This function can also fail to due lack of available memory,
 148  * returning NULL and optionally setting *status to
 149  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
 150  *
 151  * The caller can pass NULL for status if uninterested in
 152  * distinguishing these two cases.
 153  */
 154 notmuch_message_t *
 155 _notmuch_message_create (const void *talloc_owner,
 156                          notmuch_database_t *notmuch,
 157                          unsigned int doc_id,
 158                          notmuch_private_status_t *status)
 159 {
 160     Xapian::Document doc;
 161
 162     try {
 163         doc = notmuch->xapian_db->get_document (doc_id);
 164     } catch (const Xapian::DocNotFoundError &error) {
 165         if (status)
 166             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 167         return NULL;
 168     }
 169
 170     return _notmuch_message_create_for_document (talloc_owner, notmuch,
 171                                                  doc_id, doc, status);
 172 }
 173
 174 /* Create a new notmuch_message_t object for a specific message ID,
 175  * (which may or may not already exist in the database).
 176  *
 177  * The 'notmuch' database will be the talloc owner of the returned
 178  * message.
 179  *
 180  * This function returns a valid notmuch_message_t whether or not
 181  * there is already a document in the database with the given message
 182  * ID. These two cases can be distinguished by the value of *status:
 183  *
 184  *
 185  *   NOTMUCH_PRIVATE_STATUS_SUCCESS:
 186  *
 187  *     There is already a document with message ID 'message_id' in the
 188  *     database. The returned message can be used to query/modify the
 189  *     document.
 190  *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
 191  *
 192  *     No document with 'message_id' exists in the database. The
 193  *     returned message contains a newly created document (not yet
 194  *     added to the database) and a document ID that is known not to
 195  *     exist in the database. The caller can modify the message, and a
 196  *     call to _notmuch_message_sync will add * the document to the
 197  *     database.
 198  *
 199  * If an error occurs, this function will return NULL and *status
 200  * will be set as appropriate. (The status pointer argument must
 201  * not be NULL.)
 202  */
 203 notmuch_message_t *
 204 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 205                                         const char *message_id,
 206                                         notmuch_private_status_t *status_ret)
 207 {
 208     notmuch_message_t *message;
 209     Xapian::Document doc;
 210     Xapian::WritableDatabase *db;
 211     unsigned int doc_id;
 212     char *term;
 213
 214     *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
 215
 216     message = notmuch_database_find_message (notmuch, message_id);
 217     if (message)
 218         return talloc_steal (notmuch, message);
 219
 220     term = talloc_asprintf (NULL, "%s%s",
 221                             _find_prefix ("id"), message_id);
 222     if (term == NULL) {
 223         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 224         return NULL;
 225     }
 226
 227     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 228         INTERNAL_ERROR ("Failure to ensure database is writable.");
 229
 230     db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
 231     try {
 232         doc.add_term (term, 0);
 233         talloc_free (term);
 234
 235         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 236
 237         doc_id = _notmuch_database_generate_doc_id (notmuch);
 238     } catch (const Xapian::Error &error) {
 239         fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
 240                  error.get_msg().c_str());
 241         notmuch->exception_reported = TRUE;
 242         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
 243         return NULL;
 244     }
 245
 246     message = _notmuch_message_create_for_document (notmuch, notmuch,
 247                                                     doc_id, doc, status_ret);
 248
 249     /* We want to inform the caller that we had to create a new
 250      * document. */
 251     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
 252         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 253
 254     return message;
 255 }
 256
 257 const char *
 258 notmuch_message_get_message_id (notmuch_message_t *message)
 259 {
 260     Xapian::TermIterator i;
 261
 262     if (message->message_id)
 263         return message->message_id;
 264
 265     i = message->doc.termlist_begin ();
 266     i.skip_to (_find_prefix ("id"));
 267
 268     if (i == message->doc.termlist_end ())
 269         INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
 270                         message->doc_id);
 271
 272     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
 273
 274 #if DEBUG_DATABASE_SANITY
 275     i++;
 276
 277     if (i != message->doc.termlist_end () &&
 278         strncmp ((*i).c_str (), _find_prefix ("id"),
 279                  strlen (_find_prefix ("id"))) == 0)
 280     {
 281         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
 282                         message->doc_id);
 283     }
 284 #endif
 285
 286     return message->message_id;
 287 }
 288
 289 static void
 290 _notmuch_message_ensure_message_file (notmuch_message_t *message)
 291 {
 292     const char *filename;
 293
 294     if (message->message_file)
 295         return;
 296
 297     filename = notmuch_message_get_filename (message);
 298     if (unlikely (filename == NULL))
 299         return;
 300
 301     message->message_file = _notmuch_message_file_open_ctx (message, filename);
 302 }
 303
 304 const char *
 305 notmuch_message_get_header (notmuch_message_t *message, const char *header)
 306 {
 307     _notmuch_message_ensure_message_file (message);
 308     if (message->message_file == NULL)
 309         return NULL;
 310
 311     return notmuch_message_file_get_header (message->message_file, header);
 312 }
 313
 314 /* Return the message ID from the In-Reply-To header of 'message'.
 315  *
 316  * Returns an empty string ("") if 'message' has no In-Reply-To
 317  * header.
 318  *
 319  * Returns NULL if any error occurs.
 320  */
 321 const char *
 322 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
 323 {
 324     const char *prefix = _find_prefix ("replyto");
 325     int prefix_len = strlen (prefix);
 326     Xapian::TermIterator i;
 327     std::string in_reply_to;
 328
 329     if (message->in_reply_to)
 330         return message->in_reply_to;
 331
 332     i = message->doc.termlist_begin ();
 333     i.skip_to (prefix);
 334
 335     if (i != message->doc.termlist_end ())
 336         in_reply_to = *i;
 337
 338     /* It's perfectly valid for a message to have no In-Reply-To
 339      * header. For these cases, we return an empty string. */
 340     if (i == message->doc.termlist_end () ||
 341         strncmp (in_reply_to.c_str (), prefix, prefix_len))
 342     {
 343         message->in_reply_to = talloc_strdup (message, "");
 344         return message->in_reply_to;
 345     }
 346
 347     message->in_reply_to = talloc_strdup (message,
 348                                           in_reply_to.c_str () + prefix_len);
 349
 350 #if DEBUG_DATABASE_SANITY
 351     i++;
 352
 353     in_reply_to = *i;
 354
 355     if (i != message->doc.termlist_end () &&
 356         strncmp ((*i).c_str (), prefix, prefix_len) == 0)
 357     {
 358        INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n",
 359                         notmuch_message_get_message_id (message),
 360                         message->in_reply_to,
 361                         (*i).c_str () + prefix_len);
 362     }
 363 #endif
 364
 365     return message->in_reply_to;
 366 }
 367
 368 const char *
 369 notmuch_message_get_thread_id (notmuch_message_t *message)
 370 {
 371     const char *prefix = _find_prefix ("thread");
 372     Xapian::TermIterator i;
 373     std::string id;
 374
 375     /* This code is written with the assumption that "thread" has a
 376      * single-character prefix. */
 377     assert (strlen (prefix) == 1);
 378
 379     if (message->thread_id)
 380         return message->thread_id;
 381
 382     i = message->doc.termlist_begin ();
 383     i.skip_to (prefix);
 384
 385     if (i != message->doc.termlist_end ())
 386         id = *i;
 387
 388     if (i == message->doc.termlist_end () || id[0] != *prefix)
 389         INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
 390                         message->doc_id);
 391
 392     message->thread_id = talloc_strdup (message, id.c_str () + 1);
 393
 394 #if DEBUG_DATABASE_SANITY
 395     i++;
 396     id = *i;
 397
 398     if (i != message->doc.termlist_end () && id[0] == *prefix)
 399     {
 400         INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
 401                         notmuch_message_get_message_id (message),
 402                         message->thread_id,
 403                         id.c_str () + 1);
 404     }
 405 #endif
 406
 407     return message->thread_id;
 408 }
 409
 410 void
 411 _notmuch_message_add_reply (notmuch_message_t *message,
 412                             notmuch_message_node_t *reply)
 413 {
 414     _notmuch_message_list_append (message->replies, reply);
 415 }
 416
 417 notmuch_messages_t *
 418 notmuch_message_get_replies (notmuch_message_t *message)
 419 {
 420     return _notmuch_messages_create (message->replies);
 421 }
 422
 423 /* Add an additional 'filename' for 'message'.
 424  *
 425  * This change will not be reflected in the database until the next
 426  * call to _notmuch_message_sync. */
 427 notmuch_status_t
 428 _notmuch_message_add_filename (notmuch_message_t *message,
 429                                const char *filename)
 430 {
 431     notmuch_status_t status;
 432     void *local = talloc_new (message);
 433     char *direntry;
 434
 435     if (message->filename) {
 436         talloc_free (message->filename);
 437         message->filename = NULL;
 438     }
 439
 440     if (filename == NULL)
 441         INTERNAL_ERROR ("Message filename cannot be NULL.");
 442
 443     status = _notmuch_database_filename_to_direntry (local,
 444                                                      message->notmuch,
 445                                                      filename, &direntry);
 446     if (status)
 447         return status;
 448
 449     _notmuch_message_add_term (message, "file-direntry", direntry);
 450
 451     talloc_free (local);
 452
 453     return NOTMUCH_STATUS_SUCCESS;
 454 }
 455
 456 char *
 457 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
 458 {
 459     return talloc_strdup (message, message->doc.get_data ().c_str ());
 460 }
 461
 462 void
 463 _notmuch_message_clear_data (notmuch_message_t *message)
 464 {
 465     message->doc.set_data ("");
 466 }
 467
 468 const char *
 469 notmuch_message_get_filename (notmuch_message_t *message)
 470 {
 471     const char *prefix = _find_prefix ("file-direntry");
 472     int prefix_len = strlen (prefix);
 473     Xapian::TermIterator i;
 474     char *colon, *direntry = NULL;
 475     const char *db_path, *directory, *basename;
 476     unsigned int directory_id;
 477     void *local = talloc_new (message);
 478
 479     if (message->filename)
 480         return message->filename;
 481
 482     i = message->doc.termlist_begin ();
 483     i.skip_to (prefix);
 484
 485     if (i != message->doc.termlist_end ())
 486         direntry = talloc_strdup (local, (*i).c_str ());
 487
 488     if (i == message->doc.termlist_end () ||
 489         strncmp (direntry, prefix, prefix_len))
 490     {
 491         /* A message document created by an old version of notmuch
 492          * (prior to rename support) will have the filename in the
 493          * data of the document rather than as a file-direntry term.
 494          *
 495          * It would be nice to do the upgrade of the document directly
 496          * here, but the database is likely open in read-only mode. */
 497         const char *data;
 498
 499         data = message->doc.get_data ().c_str ();
 500
 501         if (data == NULL)
 502             INTERNAL_ERROR ("message with no filename");
 503
 504         message->filename = talloc_strdup (message, data);
 505
 506         return message->filename;
 507     }
 508
 509     direntry += prefix_len;
 510
 511     directory_id = strtol (direntry, &colon, 10);
 512
 513     if (colon == NULL || *colon != ':')
 514         INTERNAL_ERROR ("malformed direntry");
 515
 516     basename = colon + 1;
 517
 518     *colon = '\0';
 519
 520     db_path = notmuch_database_get_path (message->notmuch);
 521
 522     directory = _notmuch_database_get_directory_path (local,
 523                                                       message->notmuch,
 524                                                       directory_id);
 525
 526     if (strlen (directory))
 527         message->filename = talloc_asprintf (message, "%s/%s/%s",
 528                                              db_path, directory, basename);
 529     else
 530         message->filename = talloc_asprintf (message, "%s/%s",
 531                                              db_path, basename);
 532     talloc_free ((void *) directory);
 533
 534     talloc_free (local);
 535
 536     return message->filename;
 537 }
 538
 539 notmuch_bool_t
 540 notmuch_message_get_flag (notmuch_message_t *message,
 541                           notmuch_message_flag_t flag)
 542 {
 543     return message->flags & (1 << flag);
 544 }
 545
 546 void
 547 notmuch_message_set_flag (notmuch_message_t *message,
 548                           notmuch_message_flag_t flag, notmuch_bool_t enable)
 549 {
 550     if (enable)
 551         message->flags |= (1 << flag);
 552     else
 553         message->flags &= ~(1 << flag);
 554 }
 555
 556 time_t
 557 notmuch_message_get_date (notmuch_message_t *message)
 558 {
 559     std::string value;
 560
 561     try {
 562         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
 563     } catch (Xapian::Error &error) {
 564         INTERNAL_ERROR ("Failed to read timestamp value from document.");
 565         return 0;
 566     }
 567
 568     return Xapian::sortable_unserialise (value);
 569 }
 570
 571 notmuch_tags_t *
 572 notmuch_message_get_tags (notmuch_message_t *message)
 573 {
 574     Xapian::TermIterator i, end;
 575     i = message->doc.termlist_begin();
 576     end = message->doc.termlist_end();
 577     return _notmuch_convert_tags(message, i, end);
 578 }
 579
 580 const char *
 581 notmuch_message_get_author (notmuch_message_t *message)
 582 {
 583     return message->author;
 584 }
 585
 586 void
 587 notmuch_message_set_author (notmuch_message_t *message,
 588                             const char *author)
 589 {
 590     if (message->author)
 591         talloc_free(message->author);
 592     message->author = talloc_strdup(message, author);
 593     return;
 594 }
 595
 596 void
 597 _notmuch_message_set_date (notmuch_message_t *message,
 598                            const char *date)
 599 {
 600     time_t time_value;
 601
 602     /* GMime really doesn't want to see a NULL date, so protect its
 603      * sensibilities. */
 604     if (date == NULL || *date == '\0')
 605         time_value = 0;
 606     else
 607         time_value = g_mime_utils_header_decode_date (date, NULL);
 608
 609     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
 610                             Xapian::sortable_serialise (time_value));
 611 }
 612
 613 static notmuch_private_status_t
 614 _notmuch_message_tags_to_maildir (notmuch_message_t *message);
 615
 616 /* Synchronize changes made to message->doc out into the database. */
 617 void
 618 _notmuch_message_sync (notmuch_message_t *message)
 619 {
 620     Xapian::WritableDatabase *db;
 621     notmuch_private_status_t status;
 622
 623     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 624         return;
 625
 626     if (message->notmuch->maildir_sync &&
 627         !notmuch_message_get_flag(message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID)) {
 628         status = _notmuch_message_tags_to_maildir (message);
 629         if (status != NOTMUCH_PRIVATE_STATUS_SUCCESS) {
 630             fprintf (stderr, "Error: Cannot sync tags to maildir (%s)\n",
 631                      notmuch_status_to_string ((notmuch_status_t)status));
 632             /* Exit to avoid unsynchronized mailstore. */
 633             exit(1);
 634         }
 635     }
 636     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
 637     db->replace_document (message->doc_id, message->doc);
 638 }
 639
 640 /* Ensure that 'message' is not holding any file object open. Future
 641  * calls to various functions will still automatically open the
 642  * message file as needed.
 643  */
 644 void
 645 _notmuch_message_close (notmuch_message_t *message)
 646 {
 647     if (message->message_file) {
 648         notmuch_message_file_close (message->message_file);
 649         message->message_file = NULL;
 650     }
 651 }
 652
 653 /* Add a name:value term to 'message', (the actual term will be
 654  * encoded by prefixing the value with a short prefix). See
 655  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 656  * names to prefix values.
 657  *
 658  * This change will not be reflected in the database until the next
 659  * call to _notmuch_message_sync. */
 660 notmuch_private_status_t
 661 _notmuch_message_add_term (notmuch_message_t *message,
 662                            const char *prefix_name,
 663                            const char *value)
 664 {
 665
 666     char *term;
 667
 668     if (value == NULL)
 669         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 670
 671     term = talloc_asprintf (message, "%s%s",
 672                             _find_prefix (prefix_name), value);
 673
 674     if (strlen (term) > NOTMUCH_TERM_MAX)
 675         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 676
 677     message->doc.add_term (term, 0);
 678
 679     talloc_free (term);
 680
 681     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 682 }
 683
 684 /* Parse 'text' and add a term to 'message' for each parsed word. Each
 685  * term will be added both prefixed (if prefix_name is not NULL) and
 686  * also unprefixed). */
 687 notmuch_private_status_t
 688 _notmuch_message_gen_terms (notmuch_message_t *message,
 689                             const char *prefix_name,
 690                             const char *text)
 691 {
 692     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
 693
 694     if (text == NULL)
 695         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 696
 697     term_gen->set_document (message->doc);
 698
 699     if (prefix_name) {
 700         const char *prefix = _find_prefix (prefix_name);
 701
 702         term_gen->index_text (text, 1, prefix);
 703     }
 704
 705     term_gen->index_text (text);
 706
 707     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 708 }
 709
 710 /* Remove a name:value term from 'message', (the actual term will be
 711  * encoded by prefixing the value with a short prefix). See
 712  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 713  * names to prefix values.
 714  *
 715  * This change will not be reflected in the database until the next
 716  * call to _notmuch_message_sync. */
 717 notmuch_private_status_t
 718 _notmuch_message_remove_term (notmuch_message_t *message,
 719                               const char *prefix_name,
 720                               const char *value)
 721 {
 722     char *term;
 723
 724     if (value == NULL)
 725         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 726
 727     term = talloc_asprintf (message, "%s%s",
 728                             _find_prefix (prefix_name), value);
 729
 730     if (strlen (term) > NOTMUCH_TERM_MAX)
 731         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 732
 733     try {
 734         message->doc.remove_term (term);
 735     } catch (const Xapian::InvalidArgumentError) {
 736         /* We'll let the philosopher's try to wrestle with the
 737          * question of whether failing to remove that which was not
 738          * there in the first place is failure. For us, we'll silently
 739          * consider it all good. */
 740     }
 741
 742     talloc_free (term);
 743
 744     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 745 }
 746
 747 /* Change the message filename stored in the database.
 748  *
 749  * This change will not be reflected in the database until the next
 750  * call to _notmuch_message_sync.
 751  */
 752 notmuch_private_status_t
 753 _notmuch_message_rename (notmuch_message_t *message,
 754                          const char *new_filename)
 755 {
 756     void *local = talloc_new (message);
 757     char *direntry;
 758     Xapian::PostingIterator i, end;
 759     Xapian::Document document;
 760     notmuch_private_status_t pstatus;
 761     notmuch_status_t status;
 762     const char *old_filename;
 763
 764     old_filename = notmuch_message_get_filename(message);
 765     old_filename = talloc_reference(local, old_filename);
 766     if (unlikely(!old_filename))
 767         return NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 768
 769     status = _notmuch_message_add_filename (message, new_filename);
 770     if (status)
 771         return (notmuch_private_status_t)status;
 772
 773     status = _notmuch_database_filename_to_direntry (local, message->notmuch,
 774                                                      old_filename, &direntry);
 775     if (status)
 776         return (notmuch_private_status_t)status;
 777
 778     pstatus = _notmuch_message_remove_term (message, "file-direntry", direntry);
 779
 780     talloc_free (local);
 781
 782     return pstatus;
 783 }
 784
 785 notmuch_status_t
 786 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 787 {
 788     notmuch_private_status_t private_status;
 789     notmuch_status_t status;
 790
 791     status = _notmuch_database_ensure_writable (message->notmuch);
 792     if (status)
 793         return status;
 794
 795     if (tag == NULL)
 796         return NOTMUCH_STATUS_NULL_POINTER;
 797
 798     if (strlen (tag) > NOTMUCH_TAG_MAX)
 799         return NOTMUCH_STATUS_TAG_TOO_LONG;
 800
 801     private_status = _notmuch_message_add_term (message, "tag", tag);
 802     if (private_status) {
 803         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
 804                         private_status);
 805     }
 806
 807     if (! message->frozen)
 808         _notmuch_message_sync (message);
 809
 810     return NOTMUCH_STATUS_SUCCESS;
 811 }
 812
 813 notmuch_status_t
 814 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
 815 {
 816     notmuch_private_status_t private_status;
 817     notmuch_status_t status;
 818
 819     status = _notmuch_database_ensure_writable (message->notmuch);
 820     if (status)
 821         return status;
 822
 823     if (tag == NULL)
 824         return NOTMUCH_STATUS_NULL_POINTER;
 825
 826     if (strlen (tag) > NOTMUCH_TAG_MAX)
 827         return NOTMUCH_STATUS_TAG_TOO_LONG;
 828
 829     private_status = _notmuch_message_remove_term (message, "tag", tag);
 830     if (private_status) {
 831         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
 832                         private_status);
 833     }
 834
 835     if (! message->frozen)
 836         _notmuch_message_sync (message);
 837
 838     return NOTMUCH_STATUS_SUCCESS;
 839 }
 840
 841 notmuch_status_t
 842 notmuch_message_maildir_to_tags (notmuch_message_t *message, const char *filename)
 843 {
 844     const char *flags, *p;
 845     char f;
 846     bool valid, unread;
 847     unsigned i;
 848     notmuch_status_t status;
 849
 850     flags = strstr (filename, ":2,");
 851     if (!flags)
 852         return NOTMUCH_STATUS_FILE_NOT_EMAIL;
 853     flags += 3;
 854
 855     /*  Check that the letters are valid Maildir flags */
 856     f = 0;
 857     valid = true;
 858     for (p=flags; valid && *p; p++) {
 859         switch (*p) {
 860         case 'P':
 861         case 'R':
 862         case 'S':
 863         case 'T':
 864         case 'D':
 865         case 'F':
 866             if (*p > f) f=*p;
 867             else valid = false;
 868         break;
 869         default:
 870             valid = false;
 871         }
 872     }
 873     if (!valid) {
 874         fprintf (stderr, "Warning: Invalid maildir flags in filename %s\n", filename);
 875         return NOTMUCH_STATUS_FILE_NOT_EMAIL;
 876     }
 877
 878     status = notmuch_message_freeze (message);
 879     if (status)
 880         return status;
 881     unread = true;
 882     for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
 883         if ((strchr (flags, flag2tag[i].flag) != NULL) ^ flag2tag[i].inverse) {
 884             status = notmuch_message_add_tag (message, flag2tag[i].tag);
 885         } else {
 886             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
 887         }
 888         if (status)
 889             return status;
 890     }
 891     status = notmuch_message_thaw (message);
 892
 893     /* From now on, we can synchronize the tags from the database to
 894      * the mailstore. */
 895     notmuch_message_set_flag (message, NOTMUCH_MESSAGE_FLAG_TAGS_INVALID, FALSE);
 896     return status;
 897 }
 898
 899 static void
 900 maildir_get_new_flags(notmuch_message_t *message, char *flags)
 901 {
 902     notmuch_tags_t *tags;
 903     const char *tag;
 904     unsigned i;
 905     char *p;
 906
 907     for (i = 0; i < ARRAY_SIZE(flag2tag); i++)
 908         flags[i] = flag2tag[i].inverse ? flag2tag[i].flag : '\0';
 909
 910     for (tags = notmuch_message_get_tags (message);
 911          notmuch_tags_valid (tags);
 912          notmuch_tags_move_to_next (tags))
 913     {
 914         tag = notmuch_tags_get (tags);
 915         for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
 916             if (strcmp(tag, flag2tag[i].tag) == 0)
 917                 flags[i] = flag2tag[i].inverse ? '\0' : flag2tag[i].flag;
 918         }
 919     }
 920
 921     p = flags;
 922     for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
 923         if (flags[i])
 924             *p++ = flags[i];
 925     }
 926     *p = '\0';
 927 }
 928
 929 static char *
 930 maildir_get_subdir (char *filename)
 931 {
 932     char *p, *subdir = NULL;
 933
 934     p = filename + strlen (filename) - 1;
 935     while (p > filename + 3 && *p != '/')
 936         p--;
 937     if (*p == '/') {
 938         subdir = p - 3;
 939         if (subdir > filename && *(subdir - 1) != '/')
 940             subdir = NULL;
 941     }
 942     return subdir;
 943 }
 944
 945 /* Rename the message file so that maildir flags corresponds to the
 946  * tags and, if aplicable, move the message from new/ to cur/. */
 947 static notmuch_private_status_t
 948 _notmuch_message_tags_to_maildir (notmuch_message_t *message)
 949 {
 950     char flags[ARRAY_SIZE(flag2tag)+1];
 951     const char *filename, *p;
 952     char *filename_new, *subdir = NULL;
 953     int ret;
 954
 955     maildir_get_new_flags (message, flags);
 956
 957     filename = notmuch_message_get_filename (message);
 958     /* TODO: Iterate over all file names. */
 959     p = strstr(filename, ":2,");
 960     if ((p && strcmp (p+3, flags) == 0) ||
 961         (!p && flags[0] == '\0')) {
 962         // Return if flags are not to be changed - this suppresses
 963         // moving the message from new/ to cur/ during initial
 964         // tagging.
 965         return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 966     }
 967     if (!p)
 968         p = filename + strlen(filename);
 969
 970     filename_new = (char*)talloc_size(message, (p-filename) + 3 + sizeof(flags));
 971     if (unlikely (filename_new == NULL))
 972         return NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 973     memcpy(filename_new, filename, p-filename);
 974     filename_new[p-filename] = '\0';
 975
 976     /* If message is in new/ move it under cur/. */
 977     subdir = maildir_get_subdir (filename_new);
 978     if (subdir && memcmp (subdir, "new/", 4) == 0)
 979         memcpy (subdir, "cur/", 4);
 980
 981     strcpy (filename_new+(p-filename), ":2,");
 982     strcpy (filename_new+(p-filename)+3, flags);
 983
 984     if (strcmp (filename, filename_new) != 0) {
 985         ret = rename (filename, filename_new);
 986         if (ret == -1) {
 987             perror (talloc_asprintf (message, "rename of %s to %s failed",
 988                                      filename, filename_new));
 989             exit (1);
 990         }
 991         return _notmuch_message_rename (message, filename_new);
 992         /* _notmuch_message_sync is our caller. Do not call it here. */
 993     }
 994     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 995 }
 996
 997 notmuch_status_t
 998 notmuch_message_remove_all_tags (notmuch_message_t *message)
 999 {
1000     notmuch_private_status_t private_status;
1001     notmuch_status_t status;
1002     notmuch_tags_t *tags;
1003     const char *tag;
1004
1005     status = _notmuch_database_ensure_writable (message->notmuch);
1006     if (status)
1007         return status;
1008
1009     for (tags = notmuch_message_get_tags (message);
1010          notmuch_tags_valid (tags);
1011          notmuch_tags_move_to_next (tags))
1012     {
1013         tag = notmuch_tags_get (tags);
1014
1015         private_status = _notmuch_message_remove_term (message, "tag", tag);
1016         if (private_status) {
1017             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1018                             private_status);
1019         }
1020     }
1021
1022     if (! message->frozen)
1023         _notmuch_message_sync (message);
1024
1025     return NOTMUCH_STATUS_SUCCESS;
1026 }
1027
1028 notmuch_status_t
1029 notmuch_message_freeze (notmuch_message_t *message)
1030 {
1031     notmuch_status_t status;
1032
1033     status = _notmuch_database_ensure_writable (message->notmuch);
1034     if (status)
1035         return status;
1036
1037     message->frozen++;
1038
1039     return NOTMUCH_STATUS_SUCCESS;
1040 }
1041
1042 notmuch_status_t
1043 notmuch_message_thaw (notmuch_message_t *message)
1044 {
1045     notmuch_status_t status;
1046
1047     status = _notmuch_database_ensure_writable (message->notmuch);
1048     if (status)
1049         return status;
1050
1051     if (message->frozen > 0) {
1052         message->frozen--;
1053         if (message->frozen == 0)
1054             _notmuch_message_sync (message);
1055         return NOTMUCH_STATUS_SUCCESS;
1056     } else {
1057         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1058     }
1059 }
1060
1061 void
1062 notmuch_message_destroy (notmuch_message_t *message)
1063 {
1064     talloc_free (message);
1065 }