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 #include <xapian.h>
  29
  30 struct _notmuch_message {
  31     notmuch_database_t *notmuch;
  32     Xapian::docid doc_id;
  33     int frozen;
  34     char *message_id;
  35     char *thread_id;
  36     char *in_reply_to;
  37     char *filename;
  38     notmuch_message_file_t *message_file;
  39     notmuch_message_list_t *replies;
  40     unsigned long flags;
  41
  42     Xapian::Document doc;
  43 };
  44
  45 /* "128 bits of thread-id ought to be enough for anybody" */
  46 #define NOTMUCH_THREAD_ID_BITS   128
  47 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
  48 typedef struct _thread_id {
  49     char str[NOTMUCH_THREAD_ID_DIGITS + 1];
  50 } thread_id_t;
  51
  52 /* We end up having to call the destructor explicitly because we had
  53  * to use "placement new" in order to initialize C++ objects within a
  54  * block that we allocated with talloc. So C++ is making talloc
  55  * slightly less simple to use, (we wouldn't need
  56  * talloc_set_destructor at all otherwise).
  57  */
  58 static int
  59 _notmuch_message_destructor (notmuch_message_t *message)
  60 {
  61     message->doc.~Document ();
  62
  63     return 0;
  64 }
  65
  66 /* Create a new notmuch_message_t object for an existing document in
  67  * the database.
  68  *
  69  * Here, 'talloc owner' is an optional talloc context to which the new
  70  * message will belong. This allows for the caller to not bother
  71  * calling notmuch_message_destroy on the message, and no that all
  72  * memory will be reclaimed with 'talloc_owner' is free. The caller
  73  * still can call notmuch_message_destroy when finished with the
  74  * message if desired.
  75  *
  76  * The 'talloc_owner' argument can also be NULL, in which case the
  77  * caller *is* responsible for calling notmuch_message_destroy.
  78  *
  79  * If no document exists in the database with document ID of 'doc_id'
  80  * then this function returns NULL and optionally sets *status to
  81  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
  82  *
  83  * This function can also fail to due lack of available memory,
  84  * returning NULL and optionally setting *status to
  85  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
  86  *
  87  * The caller can pass NULL for status if uninterested in
  88  * distinguishing these two cases.
  89  */
  90 notmuch_message_t *
  91 _notmuch_message_create (const void *talloc_owner,
  92                          notmuch_database_t *notmuch,
  93                          unsigned int doc_id,
  94                          notmuch_private_status_t *status)
  95 {
  96     notmuch_message_t *message;
  97
  98     if (status)
  99         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
 100
 101     message = talloc (talloc_owner, notmuch_message_t);
 102     if (unlikely (message == NULL)) {
 103         if (status)
 104             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 105         return NULL;
 106     }
 107
 108     message->notmuch = notmuch;
 109     message->doc_id = doc_id;
 110
 111     message->frozen = 0;
 112     message->flags = 0;
 113
 114     /* Each of these will be lazily created as needed. */
 115     message->message_id = NULL;
 116     message->thread_id = NULL;
 117     message->in_reply_to = NULL;
 118     message->filename = NULL;
 119     message->message_file = NULL;
 120
 121     message->replies = _notmuch_message_list_create (message);
 122     if (unlikely (message->replies == NULL)) {
 123         if (status)
 124             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 125         return NULL;
 126     }
 127
 128     /* This is C++'s creepy "placement new", which is really just an
 129      * ugly way to call a constructor for a pre-allocated object. So
 130      * it's really not an error to not be checking for OUT_OF_MEMORY
 131      * here, since this "new" isn't actually allocating memory. This
 132      * is language-design comedy of the wrong kind. */
 133
 134     new (&message->doc) Xapian::Document;
 135
 136     talloc_set_destructor (message, _notmuch_message_destructor);
 137
 138     try {
 139         message->doc = notmuch->xapian_db->get_document (doc_id);
 140     } catch (const Xapian::DocNotFoundError &error) {
 141         talloc_free (message);
 142         if (status)
 143             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 144         return NULL;
 145     }
 146
 147     return message;
 148 }
 149
 150 /* Create a new notmuch_message_t object for a specific message ID,
 151  * (which may or may not already exist in the database).
 152  *
 153  * The 'notmuch' database will be the talloc owner of the returned
 154  * message.
 155  *
 156  * If there is already a document with message ID 'message_id' in the
 157  * database, then the returned message can be used to query/modify the
 158  * document. Otherwise, a new document will be inserted into the
 159  * database before this function returns, (and *status will be set
 160  * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
 161  *
 162  * If an error occurs, this function will return NULL and *status
 163  * will be set as appropriate. (The status pointer argument must
 164  * not be NULL.)
 165  */
 166 notmuch_message_t *
 167 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 168                                         const char *message_id,
 169                                         notmuch_private_status_t *status_ret)
 170 {
 171     notmuch_message_t *message;
 172     Xapian::Document doc;
 173     Xapian::WritableDatabase *db;
 174     unsigned int doc_id;
 175     char *term;
 176
 177     *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
 178
 179     message = notmuch_database_find_message (notmuch, message_id);
 180     if (message)
 181         return talloc_steal (notmuch, message);
 182
 183     term = talloc_asprintf (NULL, "%s%s",
 184                             _find_prefix ("id"), message_id);
 185     if (term == NULL) {
 186         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 187         return NULL;
 188     }
 189
 190     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 191         INTERNAL_ERROR ("Failure to ensure database is writable.");
 192
 193     db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
 194     try {
 195         doc.add_term (term);
 196         talloc_free (term);
 197
 198         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 199
 200         doc_id = db->add_document (doc);
 201     } catch (const Xapian::Error &error) {
 202         fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
 203                  error.get_msg().c_str());
 204         notmuch->exception_reported = TRUE;
 205         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
 206         return NULL;
 207     }
 208
 209     message = _notmuch_message_create (notmuch, notmuch,
 210                                        doc_id, status_ret);
 211
 212     /* We want to inform the caller that we had to create a new
 213      * document. */
 214     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
 215         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 216
 217     return message;
 218 }
 219
 220 const char *
 221 notmuch_message_get_message_id (notmuch_message_t *message)
 222 {
 223     Xapian::TermIterator i;
 224
 225     if (message->message_id)
 226         return message->message_id;
 227
 228     i = message->doc.termlist_begin ();
 229     i.skip_to (_find_prefix ("id"));
 230
 231     if (i == message->doc.termlist_end ())
 232         INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
 233                         message->doc_id);
 234
 235     message->message_id = talloc_strdup (message, (*i).c_str () + 1);
 236
 237 #if DEBUG_DATABASE_SANITY
 238     i++;
 239
 240     if (i != message->doc.termlist_end () &&
 241         strncmp ((*i).c_str (), _find_prefix ("id"),
 242                  strlen (_find_prefix ("id"))) == 0)
 243     {
 244         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
 245                         message->doc_id);
 246     }
 247 #endif
 248
 249     return message->message_id;
 250 }
 251
 252 static void
 253 _notmuch_message_ensure_message_file (notmuch_message_t *message)
 254 {
 255     const char *filename;
 256
 257     if (message->message_file)
 258         return;
 259
 260     filename = notmuch_message_get_filename (message);
 261     if (unlikely (filename == NULL))
 262         return;
 263
 264     message->message_file = _notmuch_message_file_open_ctx (message, filename);
 265 }
 266
 267 const char *
 268 notmuch_message_get_header (notmuch_message_t *message, const char *header)
 269 {
 270     _notmuch_message_ensure_message_file (message);
 271     if (message->message_file == NULL)
 272         return NULL;
 273
 274     return notmuch_message_file_get_header (message->message_file, header);
 275 }
 276
 277 /* Return the message ID from the In-Reply-To header of 'message'.
 278  *
 279  * Returns an empty string ("") if 'message' has no In-Reply-To
 280  * header.
 281  *
 282  * Returns NULL if any error occurs.
 283  */
 284 const char *
 285 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
 286 {
 287     const char *prefix = _find_prefix ("replyto");
 288     int prefix_len = strlen (prefix);
 289     Xapian::TermIterator i;
 290     std::string in_reply_to;
 291
 292     if (message->in_reply_to)
 293         return message->in_reply_to;
 294
 295     i = message->doc.termlist_begin ();
 296     i.skip_to (prefix);
 297
 298     if (i != message->doc.termlist_end ())
 299         in_reply_to = *i;
 300
 301     /* It's perfectly valid for a message to have no In-Reply-To
 302      * header. For these cases, we return an empty string. */
 303     if (i == message->doc.termlist_end () ||
 304         strncmp (in_reply_to.c_str (), prefix, prefix_len))
 305     {
 306         message->in_reply_to = talloc_strdup (message, "");
 307         return message->in_reply_to;
 308     }
 309
 310     message->in_reply_to = talloc_strdup (message,
 311                                           in_reply_to.c_str () + prefix_len);
 312
 313 #if DEBUG_DATABASE_SANITY
 314     i++;
 315
 316     in_reply_to = *i;
 317
 318     if (i != message->doc.termlist_end () &&
 319         strncmp ((*i).c_str (), prefix, prefix_len) == 0)
 320     {
 321        INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n",
 322                         notmuch_message_get_message_id (message),
 323                         message->in_reply_to,
 324                         (*i).c_str () + prefix_len);
 325     }
 326 #endif
 327
 328     return message->in_reply_to;
 329 }
 330
 331 const char *
 332 notmuch_message_get_thread_id (notmuch_message_t *message)
 333 {
 334     const char *prefix = _find_prefix ("thread");
 335     Xapian::TermIterator i;
 336     std::string id;
 337
 338     /* This code is written with the assumption that "thread" has a
 339      * single-character prefix. */
 340     assert (strlen (prefix) == 1);
 341
 342     if (message->thread_id)
 343         return message->thread_id;
 344
 345     i = message->doc.termlist_begin ();
 346     i.skip_to (prefix);
 347
 348     if (i != message->doc.termlist_end ())
 349         id = *i;
 350
 351     if (i == message->doc.termlist_end () || id[0] != *prefix)
 352         INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
 353                         message->doc_id);
 354
 355     message->thread_id = talloc_strdup (message, id.c_str () + 1);
 356
 357 #if DEBUG_DATABASE_SANITY
 358     i++;
 359     id = *i;
 360
 361     if (i != message->doc.termlist_end () && id[0] == *prefix)
 362     {
 363         INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
 364                         notmuch_message_get_message_id (message),
 365                         message->thread_id,
 366                         id.c_str () + 1);
 367     }
 368 #endif
 369
 370     return message->thread_id;
 371 }
 372
 373 void
 374 _notmuch_message_add_reply (notmuch_message_t *message,
 375                             notmuch_message_node_t *reply)
 376 {
 377     _notmuch_message_list_append (message->replies, reply);
 378 }
 379
 380 notmuch_messages_t *
 381 notmuch_message_get_replies (notmuch_message_t *message)
 382 {
 383     return _notmuch_messages_create (message->replies);
 384 }
 385
 386 /* Add an additional 'filename' for 'message'.
 387  *
 388  * This change will not be reflected in the database until the next
 389  * call to _notmuch_message_set_sync. */
 390 notmuch_status_t
 391 _notmuch_message_add_filename (notmuch_message_t *message,
 392                                const char *filename)
 393 {
 394     notmuch_status_t status;
 395     void *local = talloc_new (message);
 396     char *direntry;
 397
 398     if (message->filename) {
 399         talloc_free (message->filename);
 400         message->filename = NULL;
 401     }
 402
 403     if (filename == NULL)
 404         INTERNAL_ERROR ("Message filename cannot be NULL.");
 405
 406     status = _notmuch_database_filename_to_direntry (local,
 407                                                      message->notmuch,
 408                                                      filename, &direntry);
 409     if (status)
 410         return status;
 411
 412     _notmuch_message_add_term (message, "file-direntry", direntry);
 413
 414     talloc_free (local);
 415
 416     return NOTMUCH_STATUS_SUCCESS;
 417 }
 418
 419 const char *
 420 notmuch_message_get_filename (notmuch_message_t *message)
 421 {
 422     const char *prefix = _find_prefix ("file-direntry");
 423     int prefix_len = strlen (prefix);
 424     Xapian::TermIterator i;
 425     char *direntry, *colon;
 426     const char *db_path, *directory, *basename;
 427     unsigned int directory_id;
 428     void *local = talloc_new (message);
 429
 430     if (message->filename)
 431         return message->filename;
 432
 433     i = message->doc.termlist_begin ();
 434     i.skip_to (prefix);
 435
 436     if (i != message->doc.termlist_end ())
 437         direntry = talloc_strdup (local, (*i).c_str ());
 438
 439     if (i == message->doc.termlist_end () ||
 440         strncmp (direntry, prefix, prefix_len))
 441     {
 442         /* A message document created by an old version of notmuch
 443          * (prior to rename support) will have the filename in the
 444          * data of the document rather than as a file-direntry term. */
 445         const char *data;
 446
 447         data = message->doc.get_data ().c_str ();
 448
 449         if (data == NULL)
 450             INTERNAL_ERROR ("message with no filename");
 451
 452         message->filename = talloc_strdup (message, data);
 453
 454         return message->filename;
 455     }
 456
 457     direntry += prefix_len;
 458
 459     directory_id = strtol (direntry, &colon, 10);
 460
 461     if (colon == NULL || *colon != ':')
 462         INTERNAL_ERROR ("malformed direntry");
 463
 464     basename = colon + 1;
 465
 466     *colon = '\0';
 467
 468     db_path = notmuch_database_get_path (message->notmuch);
 469
 470     directory = _notmuch_database_get_directory_path (local,
 471                                                       message->notmuch,
 472                                                       directory_id);
 473
 474     if (strlen (directory))
 475         message->filename = talloc_asprintf (message, "%s/%s/%s",
 476                                              db_path, directory, basename);
 477     else
 478         message->filename = talloc_asprintf (message, "%s/%s",
 479                                              db_path, basename);
 480     talloc_free ((void *) directory);
 481
 482     talloc_free (local);
 483
 484     return message->filename;
 485 }
 486
 487 notmuch_bool_t
 488 notmuch_message_get_flag (notmuch_message_t *message,
 489                           notmuch_message_flag_t flag)
 490 {
 491     return message->flags & (1 << flag);
 492 }
 493
 494 void
 495 notmuch_message_set_flag (notmuch_message_t *message,
 496                           notmuch_message_flag_t flag, notmuch_bool_t enable)
 497 {
 498     if (enable)
 499         message->flags |= (1 << flag);
 500     else
 501         message->flags &= ~(1 << flag);
 502 }
 503
 504 time_t
 505 notmuch_message_get_date (notmuch_message_t *message)
 506 {
 507     std::string value;
 508
 509     try {
 510         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
 511     } catch (Xapian::Error &error) {
 512         INTERNAL_ERROR ("Failed to read timestamp value from document.");
 513         return 0;
 514     }
 515
 516     return Xapian::sortable_unserialise (value);
 517 }
 518
 519 notmuch_tags_t *
 520 notmuch_message_get_tags (notmuch_message_t *message)
 521 {
 522     Xapian::TermIterator i, end;
 523     i = message->doc.termlist_begin();
 524     end = message->doc.termlist_end();
 525     return _notmuch_convert_tags(message, i, end);
 526 }
 527
 528 void
 529 _notmuch_message_set_date (notmuch_message_t *message,
 530                            const char *date)
 531 {
 532     time_t time_value;
 533
 534     /* GMime really doesn't want to see a NULL date, so protect its
 535      * sensibilities. */
 536     if (date == NULL || *date == '\0')
 537         time_value = 0;
 538     else
 539         time_value = g_mime_utils_header_decode_date (date, NULL);
 540
 541     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
 542                             Xapian::sortable_serialise (time_value));
 543 }
 544
 545 static void
 546 thread_id_generate (thread_id_t *thread_id)
 547 {
 548     static int seeded = 0;
 549     FILE *dev_random;
 550     uint32_t value;
 551     char *s;
 552     int i;
 553
 554     if (! seeded) {
 555         dev_random = fopen ("/dev/random", "r");
 556         if (dev_random == NULL) {
 557             srand (time (NULL));
 558         } else {
 559             fread ((void *) &value, sizeof (value), 1, dev_random);
 560             srand (value);
 561             fclose (dev_random);
 562         }
 563         seeded = 1;
 564     }
 565
 566     s = thread_id->str;
 567     for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
 568         value = rand ();
 569         sprintf (s, "%08x", value);
 570         s += 8;
 571     }
 572 }
 573
 574 void
 575 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
 576 {
 577     /* If not part of any existing thread, generate a new thread_id. */
 578     thread_id_t thread_id;
 579
 580     thread_id_generate (&thread_id);
 581     _notmuch_message_add_term (message, "thread", thread_id.str);
 582 }
 583
 584 /* Synchronize changes made to message->doc out into the database. */
 585 void
 586 _notmuch_message_sync (notmuch_message_t *message)
 587 {
 588     Xapian::WritableDatabase *db;
 589
 590     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 591         return;
 592
 593     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
 594     db->replace_document (message->doc_id, message->doc);
 595 }
 596
 597 /* Ensure that 'message' is not holding any file object open. Future
 598  * calls to various functions will still automatically open the
 599  * message file as needed.
 600  */
 601 void
 602 _notmuch_message_close (notmuch_message_t *message)
 603 {
 604     if (message->message_file) {
 605         notmuch_message_file_close (message->message_file);
 606         message->message_file = NULL;
 607     }
 608 }
 609
 610 /* Add a name:value term to 'message', (the actual term will be
 611  * encoded by prefixing the value with a short prefix). See
 612  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 613  * names to prefix values.
 614  *
 615  * This change will not be reflected in the database until the next
 616  * call to _notmuch_message_set_sync. */
 617 notmuch_private_status_t
 618 _notmuch_message_add_term (notmuch_message_t *message,
 619                            const char *prefix_name,
 620                            const char *value)
 621 {
 622
 623     char *term;
 624
 625     if (value == NULL)
 626         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 627
 628     term = talloc_asprintf (message, "%s%s",
 629                             _find_prefix (prefix_name), value);
 630
 631     if (strlen (term) > NOTMUCH_TERM_MAX)
 632         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 633
 634     message->doc.add_term (term);
 635
 636     talloc_free (term);
 637
 638     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 639 }
 640
 641 /* Parse 'text' and add a term to 'message' for each parsed word. Each
 642  * term will be added both prefixed (if prefix_name is not NULL) and
 643  * also unprefixed). */
 644 notmuch_private_status_t
 645 _notmuch_message_gen_terms (notmuch_message_t *message,
 646                             const char *prefix_name,
 647                             const char *text)
 648 {
 649     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
 650
 651     if (text == NULL)
 652         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 653
 654     term_gen->set_document (message->doc);
 655
 656     if (prefix_name) {
 657         const char *prefix = _find_prefix (prefix_name);
 658
 659         term_gen->index_text (text, 1, prefix);
 660     }
 661
 662     term_gen->index_text (text);
 663
 664     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 665 }
 666
 667 /* Remove a name:value term from 'message', (the actual term will be
 668  * encoded by prefixing the value with a short prefix). See
 669  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 670  * names to prefix values.
 671  *
 672  * This change will not be reflected in the database until the next
 673  * call to _notmuch_message_set_sync. */
 674 notmuch_private_status_t
 675 _notmuch_message_remove_term (notmuch_message_t *message,
 676                               const char *prefix_name,
 677                               const char *value)
 678 {
 679     char *term;
 680
 681     if (value == NULL)
 682         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 683
 684     term = talloc_asprintf (message, "%s%s",
 685                             _find_prefix (prefix_name), value);
 686
 687     if (strlen (term) > NOTMUCH_TERM_MAX)
 688         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 689
 690     try {
 691         message->doc.remove_term (term);
 692     } catch (const Xapian::InvalidArgumentError) {
 693         /* We'll let the philosopher's try to wrestle with the
 694          * question of whether failing to remove that which was not
 695          * there in the first place is failure. For us, we'll silently
 696          * consider it all good. */
 697     }
 698
 699     talloc_free (term);
 700
 701     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 702 }
 703
 704 notmuch_status_t
 705 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 706 {
 707     notmuch_private_status_t private_status;
 708     notmuch_status_t status;
 709
 710     status = _notmuch_database_ensure_writable (message->notmuch);
 711     if (status)
 712         return status;
 713
 714     if (tag == NULL)
 715         return NOTMUCH_STATUS_NULL_POINTER;
 716
 717     if (strlen (tag) > NOTMUCH_TAG_MAX)
 718         return NOTMUCH_STATUS_TAG_TOO_LONG;
 719
 720     private_status = _notmuch_message_add_term (message, "tag", tag);
 721     if (private_status) {
 722         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
 723                         private_status);
 724     }
 725
 726     if (! message->frozen)
 727         _notmuch_message_sync (message);
 728
 729     return NOTMUCH_STATUS_SUCCESS;
 730 }
 731
 732 notmuch_status_t
 733 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
 734 {
 735     notmuch_private_status_t private_status;
 736     notmuch_status_t status;
 737
 738     status = _notmuch_database_ensure_writable (message->notmuch);
 739     if (status)
 740         return status;
 741
 742     if (tag == NULL)
 743         return NOTMUCH_STATUS_NULL_POINTER;
 744
 745     if (strlen (tag) > NOTMUCH_TAG_MAX)
 746         return NOTMUCH_STATUS_TAG_TOO_LONG;
 747
 748     private_status = _notmuch_message_remove_term (message, "tag", tag);
 749     if (private_status) {
 750         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
 751                         private_status);
 752     }
 753
 754     if (! message->frozen)
 755         _notmuch_message_sync (message);
 756
 757     return NOTMUCH_STATUS_SUCCESS;
 758 }
 759
 760 notmuch_status_t
 761 notmuch_message_remove_all_tags (notmuch_message_t *message)
 762 {
 763     notmuch_private_status_t private_status;
 764     notmuch_status_t status;
 765     notmuch_tags_t *tags;
 766     const char *tag;
 767
 768     status = _notmuch_database_ensure_writable (message->notmuch);
 769     if (status)
 770         return status;
 771
 772     for (tags = notmuch_message_get_tags (message);
 773          notmuch_tags_has_more (tags);
 774          notmuch_tags_advance (tags))
 775     {
 776         tag = notmuch_tags_get (tags);
 777
 778         private_status = _notmuch_message_remove_term (message, "tag", tag);
 779         if (private_status) {
 780             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
 781                             private_status);
 782         }
 783     }
 784
 785     if (! message->frozen)
 786         _notmuch_message_sync (message);
 787
 788     return NOTMUCH_STATUS_SUCCESS;
 789 }
 790
 791 notmuch_status_t
 792 notmuch_message_freeze (notmuch_message_t *message)
 793 {
 794     notmuch_status_t status;
 795
 796     status = _notmuch_database_ensure_writable (message->notmuch);
 797     if (status)
 798         return status;
 799
 800     message->frozen++;
 801
 802     return NOTMUCH_STATUS_SUCCESS;
 803 }
 804
 805 notmuch_status_t
 806 notmuch_message_thaw (notmuch_message_t *message)
 807 {
 808     notmuch_status_t status;
 809
 810     status = _notmuch_database_ensure_writable (message->notmuch);
 811     if (status)
 812         return status;
 813
 814     if (message->frozen > 0) {
 815         message->frozen--;
 816         if (message->frozen == 0)
 817             _notmuch_message_sync (message);
 818         return NOTMUCH_STATUS_SUCCESS;
 819     } else {
 820         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
 821     }
 822 }
 823
 824 void
 825 notmuch_message_destroy (notmuch_message_t *message)
 826 {
 827     talloc_free (message);
 828 }