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 visible _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     notmuch_string_list_t *tag_list;
  36     notmuch_string_list_t *filename_term_list;
  37     notmuch_string_list_t *filename_list;
  38     char *author;
  39     notmuch_message_file_t *message_file;
  40     notmuch_message_list_t *replies;
  41     unsigned long flags;
  42
  43     Xapian::Document doc;
  44     Xapian::termcount termpos;
  45 };
  46
  47 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
  48
  49 struct maildir_flag_tag {
  50     char flag;
  51     const char *tag;
  52     bool inverse;
  53 };
  54
  55 /* ASCII ordered table of Maildir flags and associated tags */
  56 static struct maildir_flag_tag flag2tag[] = {
  57     { 'D', "draft",   false},
  58     { 'F', "flagged", false},
  59     { 'P', "passed",  false},
  60     { 'R', "replied", false},
  61     { 'S', "unread",  true }
  62 };
  63
  64 /* We end up having to call the destructor explicitly because we had
  65  * to use "placement new" in order to initialize C++ objects within a
  66  * block that we allocated with talloc. So C++ is making talloc
  67  * slightly less simple to use, (we wouldn't need
  68  * talloc_set_destructor at all otherwise).
  69  */
  70 static int
  71 _notmuch_message_destructor (notmuch_message_t *message)
  72 {
  73     message->doc.~Document ();
  74
  75     return 0;
  76 }
  77
  78 static notmuch_message_t *
  79 _notmuch_message_create_for_document (const void *talloc_owner,
  80                                       notmuch_database_t *notmuch,
  81                                       unsigned int doc_id,
  82                                       Xapian::Document doc,
  83                                       notmuch_private_status_t *status)
  84 {
  85     notmuch_message_t *message;
  86
  87     if (status)
  88         *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
  89
  90     message = talloc (talloc_owner, notmuch_message_t);
  91     if (unlikely (message == NULL)) {
  92         if (status)
  93             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
  94         return NULL;
  95     }
  96
  97     message->notmuch = notmuch;
  98     message->doc_id = doc_id;
  99
 100     message->frozen = 0;
 101     message->flags = 0;
 102
 103     /* Each of these will be lazily created as needed. */
 104     message->message_id = NULL;
 105     message->thread_id = NULL;
 106     message->in_reply_to = NULL;
 107     message->tag_list = NULL;
 108     message->filename_term_list = NULL;
 109     message->filename_list = NULL;
 110     message->message_file = NULL;
 111     message->author = NULL;
 112
 113     message->replies = _notmuch_message_list_create (message);
 114     if (unlikely (message->replies == NULL)) {
 115         if (status)
 116             *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 117         return NULL;
 118     }
 119
 120     /* This is C++'s creepy "placement new", which is really just an
 121      * ugly way to call a constructor for a pre-allocated object. So
 122      * it's really not an error to not be checking for OUT_OF_MEMORY
 123      * here, since this "new" isn't actually allocating memory. This
 124      * is language-design comedy of the wrong kind. */
 125
 126     new (&message->doc) Xapian::Document;
 127
 128     talloc_set_destructor (message, _notmuch_message_destructor);
 129
 130     message->doc = doc;
 131     message->termpos = 0;
 132
 133     return message;
 134 }
 135
 136 /* Create a new notmuch_message_t object for an existing document in
 137  * the database.
 138  *
 139  * Here, 'talloc owner' is an optional talloc context to which the new
 140  * message will belong. This allows for the caller to not bother
 141  * calling notmuch_message_destroy on the message, and know that all
 142  * memory will be reclaimed when 'talloc_owner' is freed. The caller
 143  * still can call notmuch_message_destroy when finished with the
 144  * message if desired.
 145  *
 146  * The 'talloc_owner' argument can also be NULL, in which case the
 147  * caller *is* responsible for calling notmuch_message_destroy.
 148  *
 149  * If no document exists in the database with document ID of 'doc_id'
 150  * then this function returns NULL and optionally sets *status to
 151  * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
 152  *
 153  * This function can also fail to due lack of available memory,
 154  * returning NULL and optionally setting *status to
 155  * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
 156  *
 157  * The caller can pass NULL for status if uninterested in
 158  * distinguishing these two cases.
 159  */
 160 notmuch_message_t *
 161 _notmuch_message_create (const void *talloc_owner,
 162                          notmuch_database_t *notmuch,
 163                          unsigned int doc_id,
 164                          notmuch_private_status_t *status)
 165 {
 166     Xapian::Document doc;
 167
 168     try {
 169         doc = notmuch->xapian_db->get_document (doc_id);
 170     } catch (const Xapian::DocNotFoundError &error) {
 171         if (status)
 172             *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 173         return NULL;
 174     }
 175
 176     return _notmuch_message_create_for_document (talloc_owner, notmuch,
 177                                                  doc_id, doc, status);
 178 }
 179
 180 /* Create a new notmuch_message_t object for a specific message ID,
 181  * (which may or may not already exist in the database).
 182  *
 183  * The 'notmuch' database will be the talloc owner of the returned
 184  * message.
 185  *
 186  * This function returns a valid notmuch_message_t whether or not
 187  * there is already a document in the database with the given message
 188  * ID. These two cases can be distinguished by the value of *status:
 189  *
 190  *
 191  *   NOTMUCH_PRIVATE_STATUS_SUCCESS:
 192  *
 193  *     There is already a document with message ID 'message_id' in the
 194  *     database. The returned message can be used to query/modify the
 195  *     document.
 196  *   NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
 197  *
 198  *     No document with 'message_id' exists in the database. The
 199  *     returned message contains a newly created document (not yet
 200  *     added to the database) and a document ID that is known not to
 201  *     exist in the database. The caller can modify the message, and a
 202  *     call to _notmuch_message_sync will add * the document to the
 203  *     database.
 204  *
 205  * If an error occurs, this function will return NULL and *status
 206  * will be set as appropriate. (The status pointer argument must
 207  * not be NULL.)
 208  */
 209 notmuch_message_t *
 210 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
 211                                         const char *message_id,
 212                                         notmuch_private_status_t *status_ret)
 213 {
 214     notmuch_message_t *message;
 215     Xapian::Document doc;
 216     unsigned int doc_id;
 217     char *term;
 218
 219     *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
 220                                                                             message_id,
 221                                                                             &message);
 222     if (message)
 223         return talloc_steal (notmuch, message);
 224     else if (*status_ret)
 225         return NULL;
 226
 227     term = talloc_asprintf (NULL, "%s%s",
 228                             _find_prefix ("id"), message_id);
 229     if (term == NULL) {
 230         *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
 231         return NULL;
 232     }
 233
 234     if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 235         INTERNAL_ERROR ("Failure to ensure database is writable.");
 236
 237     try {
 238         doc.add_term (term, 0);
 239         talloc_free (term);
 240
 241         doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
 242
 243         doc_id = _notmuch_database_generate_doc_id (notmuch);
 244     } catch (const Xapian::Error &error) {
 245         fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
 246                  error.get_msg().c_str());
 247         notmuch->exception_reported = TRUE;
 248         *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
 249         return NULL;
 250     }
 251
 252     message = _notmuch_message_create_for_document (notmuch, notmuch,
 253                                                     doc_id, doc, status_ret);
 254
 255     /* We want to inform the caller that we had to create a new
 256      * document. */
 257     if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
 258         *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
 259
 260     return message;
 261 }
 262
 263 static char *
 264 _notmuch_message_get_term (notmuch_message_t *message,
 265                            Xapian::TermIterator &i, Xapian::TermIterator &end,
 266                            const char *prefix)
 267 {
 268     int prefix_len = strlen (prefix);
 269     const char *term = NULL;
 270     char *value;
 271
 272     i.skip_to (prefix);
 273
 274     if (i != end)
 275         term = (*i).c_str ();
 276
 277     if (!term || strncmp (term, prefix, prefix_len))
 278         return NULL;
 279
 280     value = talloc_strdup (message, term + prefix_len);
 281
 282 #if DEBUG_DATABASE_SANITY
 283     i++;
 284
 285     if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
 286         INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
 287                         message->doc_id, prefix, value,
 288                         (*i).c_str () + prefix_len);
 289     }
 290 #endif
 291
 292     return value;
 293 }
 294
 295 void
 296 _notmuch_message_ensure_metadata (notmuch_message_t *message)
 297 {
 298     Xapian::TermIterator i, end;
 299     const char *thread_prefix = _find_prefix ("thread"),
 300         *tag_prefix = _find_prefix ("tag"),
 301         *id_prefix = _find_prefix ("id"),
 302         *filename_prefix = _find_prefix ("file-direntry"),
 303         *replyto_prefix = _find_prefix ("replyto");
 304
 305     /* We do this all in a single pass because Xapian decompresses the
 306      * term list every time you iterate over it.  Thus, while this is
 307      * slightly more costly than looking up individual fields if only
 308      * one field of the message object is actually used, it's a huge
 309      * win as more fields are used. */
 310
 311     i = message->doc.termlist_begin ();
 312     end = message->doc.termlist_end ();
 313
 314     /* Get thread */
 315     if (!message->thread_id)
 316         message->thread_id =
 317             _notmuch_message_get_term (message, i, end, thread_prefix);
 318
 319     /* Get tags */
 320     assert (strcmp (thread_prefix, tag_prefix) < 0);
 321     if (!message->tag_list) {
 322         message->tag_list =
 323             _notmuch_database_get_terms_with_prefix (message, i, end,
 324                                                      tag_prefix);
 325         _notmuch_string_list_sort (message->tag_list);
 326     }
 327
 328     /* Get id */
 329     assert (strcmp (tag_prefix, id_prefix) < 0);
 330     if (!message->message_id)
 331         message->message_id =
 332             _notmuch_message_get_term (message, i, end, id_prefix);
 333
 334     /* Get filename list.  Here we get only the terms.  We lazily
 335      * expand them to full file names when needed in
 336      * _notmuch_message_ensure_filename_list. */
 337     assert (strcmp (id_prefix, filename_prefix) < 0);
 338     if (!message->filename_term_list && !message->filename_list)
 339         message->filename_term_list =
 340             _notmuch_database_get_terms_with_prefix (message, i, end,
 341                                                      filename_prefix);
 342
 343     /* Get reply to */
 344     assert (strcmp (filename_prefix, replyto_prefix) < 0);
 345     if (!message->in_reply_to)
 346         message->in_reply_to =
 347             _notmuch_message_get_term (message, i, end, replyto_prefix);
 348     /* It's perfectly valid for a message to have no In-Reply-To
 349      * header. For these cases, we return an empty string. */
 350     if (!message->in_reply_to)
 351         message->in_reply_to = talloc_strdup (message, "");
 352 }
 353
 354 static void
 355 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
 356                                       const char *prefix_name)
 357 {
 358     if (strcmp ("thread", prefix_name) == 0) {
 359         talloc_free (message->thread_id);
 360         message->thread_id = NULL;
 361     }
 362
 363     if (strcmp ("tag", prefix_name) == 0) {
 364         talloc_unlink (message, message->tag_list);
 365         message->tag_list = NULL;
 366     }
 367
 368     if (strcmp ("file-direntry", prefix_name) == 0) {
 369         talloc_free (message->filename_term_list);
 370         talloc_free (message->filename_list);
 371         message->filename_term_list = message->filename_list = NULL;
 372     }
 373
 374     if (strcmp ("replyto", prefix_name) == 0) {
 375         talloc_free (message->in_reply_to);
 376         message->in_reply_to = NULL;
 377     }
 378 }
 379
 380 unsigned int
 381 _notmuch_message_get_doc_id (notmuch_message_t *message)
 382 {
 383     return message->doc_id;
 384 }
 385
 386 const char *
 387 notmuch_message_get_message_id (notmuch_message_t *message)
 388 {
 389     if (!message->message_id)
 390         _notmuch_message_ensure_metadata (message);
 391     if (!message->message_id)
 392         INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
 393                         message->doc_id);
 394     return message->message_id;
 395 }
 396
 397 static void
 398 _notmuch_message_ensure_message_file (notmuch_message_t *message)
 399 {
 400     const char *filename;
 401
 402     if (message->message_file)
 403         return;
 404
 405     filename = notmuch_message_get_filename (message);
 406     if (unlikely (filename == NULL))
 407         return;
 408
 409     message->message_file = _notmuch_message_file_open_ctx (message, filename);
 410 }
 411
 412 const char *
 413 notmuch_message_get_header (notmuch_message_t *message, const char *header)
 414 {
 415     _notmuch_message_ensure_message_file (message);
 416     if (message->message_file == NULL)
 417         return NULL;
 418
 419     return notmuch_message_file_get_header (message->message_file, header);
 420 }
 421
 422 /* Return the message ID from the In-Reply-To header of 'message'.
 423  *
 424  * Returns an empty string ("") if 'message' has no In-Reply-To
 425  * header.
 426  *
 427  * Returns NULL if any error occurs.
 428  */
 429 const char *
 430 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
 431 {
 432     if (!message->in_reply_to)
 433         _notmuch_message_ensure_metadata (message);
 434     return message->in_reply_to;
 435 }
 436
 437 const char *
 438 notmuch_message_get_thread_id (notmuch_message_t *message)
 439 {
 440     if (!message->thread_id)
 441         _notmuch_message_ensure_metadata (message);
 442     if (!message->thread_id)
 443         INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
 444                         message->doc_id);
 445     return message->thread_id;
 446 }
 447
 448 void
 449 _notmuch_message_add_reply (notmuch_message_t *message,
 450                             notmuch_message_node_t *reply)
 451 {
 452     _notmuch_message_list_append (message->replies, reply);
 453 }
 454
 455 notmuch_messages_t *
 456 notmuch_message_get_replies (notmuch_message_t *message)
 457 {
 458     return _notmuch_messages_create (message->replies);
 459 }
 460
 461 /* Add an additional 'filename' for 'message'.
 462  *
 463  * This change will not be reflected in the database until the next
 464  * call to _notmuch_message_sync. */
 465 notmuch_status_t
 466 _notmuch_message_add_filename (notmuch_message_t *message,
 467                                const char *filename)
 468 {
 469     const char *relative, *directory;
 470     notmuch_status_t status;
 471     void *local = talloc_new (message);
 472     char *direntry;
 473
 474     if (filename == NULL)
 475         INTERNAL_ERROR ("Message filename cannot be NULL.");
 476
 477     relative = _notmuch_database_relative_path (message->notmuch, filename);
 478
 479     status = _notmuch_database_split_path (local, relative, &directory, NULL);
 480     if (status)
 481         return status;
 482
 483     status = _notmuch_database_filename_to_direntry (local,
 484                                                      message->notmuch,
 485                                                      filename, &direntry);
 486     if (status)
 487         return status;
 488
 489     /* New file-direntry allows navigating to this message with
 490      * notmuch_directory_get_child_files() . */
 491     _notmuch_message_add_term (message, "file-direntry", direntry);
 492
 493     /* New terms allow user to search with folder: specification. */
 494     _notmuch_message_gen_terms (message, "folder", directory);
 495
 496     talloc_free (local);
 497
 498     return NOTMUCH_STATUS_SUCCESS;
 499 }
 500
 501 /* Remove a particular 'filename' from 'message'.
 502  *
 503  * This change will not be reflected in the database until the next
 504  * call to _notmuch_message_sync.
 505  *
 506  * If this message still has other filenames, returns
 507  * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
 508  *
 509  * Note: This function does not remove a document from the database,
 510  * even if the specified filename is the only filename for this
 511  * message. For that functionality, see
 512  * _notmuch_database_remove_message. */
 513 notmuch_status_t
 514 _notmuch_message_remove_filename (notmuch_message_t *message,
 515                                   const char *filename)
 516 {
 517     const char *direntry_prefix = _find_prefix ("file-direntry");
 518     int direntry_prefix_len = strlen (direntry_prefix);
 519     const char *folder_prefix = _find_prefix ("folder");
 520     int folder_prefix_len = strlen (folder_prefix);
 521     void *local = talloc_new (message);
 522     char *zfolder_prefix = talloc_asprintf(local, "Z%s", folder_prefix);
 523     int zfolder_prefix_len = strlen (zfolder_prefix);
 524     char *direntry;
 525     notmuch_private_status_t private_status;
 526     notmuch_status_t status;
 527     Xapian::TermIterator i, last;
 528
 529     status = _notmuch_database_filename_to_direntry (local, message->notmuch,
 530                                                      filename, &direntry);
 531     if (status)
 532         return status;
 533
 534     /* Unlink this file from its parent directory. */
 535     private_status = _notmuch_message_remove_term (message,
 536                                                    "file-direntry", direntry);
 537     status = COERCE_STATUS (private_status,
 538                             "Unexpected error from _notmuch_message_remove_term");
 539     if (status)
 540         return status;
 541
 542     /* Re-synchronize "folder:" terms for this message. This requires:
 543      *  1. removing all "folder:" terms
 544      *  2. removing all "folder:" stemmed terms
 545      *  3. adding back terms for all remaining filenames of the message. */
 546
 547     /* 1. removing all "folder:" terms */
 548     while (1) {
 549         i = message->doc.termlist_begin ();
 550         i.skip_to (folder_prefix);
 551
 552         /* Terminate loop when no terms remain with desired prefix. */
 553         if (i == message->doc.termlist_end () ||
 554             strncmp ((*i).c_str (), folder_prefix, folder_prefix_len))
 555         {
 556             break;
 557         }
 558
 559         try {
 560             message->doc.remove_term ((*i));
 561         } catch (const Xapian::InvalidArgumentError) {
 562             /* Ignore failure to remove non-existent term. */
 563         }
 564     }
 565
 566     /* 2. removing all "folder:" stemmed terms */
 567     while (1) {
 568         i = message->doc.termlist_begin ();
 569         i.skip_to (zfolder_prefix);
 570
 571         /* Terminate loop when no terms remain with desired prefix. */
 572         if (i == message->doc.termlist_end () ||
 573             strncmp ((*i).c_str (), zfolder_prefix, zfolder_prefix_len))
 574         {
 575             break;
 576         }
 577
 578         try {
 579             message->doc.remove_term ((*i));
 580         } catch (const Xapian::InvalidArgumentError) {
 581             /* Ignore failure to remove non-existent term. */
 582         }
 583     }
 584
 585     /* 3. adding back terms for all remaining filenames of the message. */
 586     i = message->doc.termlist_begin ();
 587     i.skip_to (direntry_prefix);
 588
 589     for (; i != message->doc.termlist_end (); i++) {
 590         unsigned int directory_id;
 591         const char *direntry, *directory;
 592         char *colon;
 593
 594         /* Terminate loop at first term without desired prefix. */
 595         if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
 596             break;
 597
 598         /* Indicate that there are filenames remaining. */
 599         status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
 600
 601         direntry = (*i).c_str ();
 602         direntry += direntry_prefix_len;
 603
 604         directory_id = strtol (direntry, &colon, 10);
 605
 606         if (colon == NULL || *colon != ':')
 607             INTERNAL_ERROR ("malformed direntry");
 608
 609         directory = _notmuch_database_get_directory_path (local,
 610                                                           message->notmuch,
 611                                                           directory_id);
 612         if (strlen (directory))
 613             _notmuch_message_gen_terms (message, "folder", directory);
 614     }
 615
 616     talloc_free (local);
 617
 618     return status;
 619 }
 620
 621 char *
 622 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
 623 {
 624     return talloc_strdup (message, message->doc.get_data ().c_str ());
 625 }
 626
 627 void
 628 _notmuch_message_clear_data (notmuch_message_t *message)
 629 {
 630     message->doc.set_data ("");
 631 }
 632
 633 static void
 634 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
 635 {
 636     notmuch_string_node_t *node;
 637
 638     if (message->filename_list)
 639         return;
 640
 641     if (!message->filename_term_list)
 642         _notmuch_message_ensure_metadata (message);
 643
 644     message->filename_list = _notmuch_string_list_create (message);
 645     node = message->filename_term_list->head;
 646
 647     if (!node) {
 648         /* A message document created by an old version of notmuch
 649          * (prior to rename support) will have the filename in the
 650          * data of the document rather than as a file-direntry term.
 651          *
 652          * It would be nice to do the upgrade of the document directly
 653          * here, but the database is likely open in read-only mode. */
 654         const char *data;
 655
 656         data = message->doc.get_data ().c_str ();
 657
 658         if (data == NULL)
 659             INTERNAL_ERROR ("message with no filename");
 660
 661         _notmuch_string_list_append (message->filename_list, data);
 662
 663         return;
 664     }
 665
 666     for (; node; node = node->next) {
 667         void *local = talloc_new (message);
 668         const char *db_path, *directory, *basename, *filename;
 669         char *colon, *direntry = NULL;
 670         unsigned int directory_id;
 671
 672         direntry = node->string;
 673
 674         directory_id = strtol (direntry, &colon, 10);
 675
 676         if (colon == NULL || *colon != ':')
 677             INTERNAL_ERROR ("malformed direntry");
 678
 679         basename = colon + 1;
 680
 681         *colon = '\0';
 682
 683         db_path = notmuch_database_get_path (message->notmuch);
 684
 685         directory = _notmuch_database_get_directory_path (local,
 686                                                           message->notmuch,
 687                                                           directory_id);
 688
 689         if (strlen (directory))
 690             filename = talloc_asprintf (message, "%s/%s/%s",
 691                                         db_path, directory, basename);
 692         else
 693             filename = talloc_asprintf (message, "%s/%s",
 694                                         db_path, basename);
 695
 696         _notmuch_string_list_append (message->filename_list, filename);
 697
 698         talloc_free (local);
 699     }
 700
 701     talloc_free (message->filename_term_list);
 702     message->filename_term_list = NULL;
 703 }
 704
 705 const char *
 706 notmuch_message_get_filename (notmuch_message_t *message)
 707 {
 708     _notmuch_message_ensure_filename_list (message);
 709
 710     if (message->filename_list == NULL)
 711         return NULL;
 712
 713     if (message->filename_list->head == NULL ||
 714         message->filename_list->head->string == NULL)
 715     {
 716         INTERNAL_ERROR ("message with no filename");
 717     }
 718
 719     return message->filename_list->head->string;
 720 }
 721
 722 notmuch_filenames_t *
 723 notmuch_message_get_filenames (notmuch_message_t *message)
 724 {
 725     _notmuch_message_ensure_filename_list (message);
 726
 727     return _notmuch_filenames_create (message, message->filename_list);
 728 }
 729
 730 notmuch_bool_t
 731 notmuch_message_get_flag (notmuch_message_t *message,
 732                           notmuch_message_flag_t flag)
 733 {
 734     return message->flags & (1 << flag);
 735 }
 736
 737 void
 738 notmuch_message_set_flag (notmuch_message_t *message,
 739                           notmuch_message_flag_t flag, notmuch_bool_t enable)
 740 {
 741     if (enable)
 742         message->flags |= (1 << flag);
 743     else
 744         message->flags &= ~(1 << flag);
 745 }
 746
 747 time_t
 748 notmuch_message_get_date (notmuch_message_t *message)
 749 {
 750     std::string value;
 751
 752     try {
 753         value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
 754     } catch (Xapian::Error &error) {
 755         INTERNAL_ERROR ("Failed to read timestamp value from document.");
 756         return 0;
 757     }
 758
 759     return Xapian::sortable_unserialise (value);
 760 }
 761
 762 notmuch_tags_t *
 763 notmuch_message_get_tags (notmuch_message_t *message)
 764 {
 765     notmuch_tags_t *tags;
 766
 767     if (!message->tag_list)
 768         _notmuch_message_ensure_metadata (message);
 769
 770     tags = _notmuch_tags_create (message, message->tag_list);
 771     /* _notmuch_tags_create steals the reference to the tag_list, but
 772      * in this case it's still used by the message, so we add an
 773      * *additional* talloc reference to the list.  As a result, it's
 774      * possible to modify the message tags (which talloc_unlink's the
 775      * current list from the message) while still iterating because
 776      * the iterator will keep the current list alive. */
 777     talloc_reference (message, message->tag_list);
 778     return tags;
 779 }
 780
 781 const char *
 782 notmuch_message_get_author (notmuch_message_t *message)
 783 {
 784     return message->author;
 785 }
 786
 787 void
 788 notmuch_message_set_author (notmuch_message_t *message,
 789                             const char *author)
 790 {
 791     if (message->author)
 792         talloc_free(message->author);
 793     message->author = talloc_strdup(message, author);
 794     return;
 795 }
 796
 797 void
 798 _notmuch_message_set_date (notmuch_message_t *message,
 799                            const char *date)
 800 {
 801     time_t time_value;
 802
 803     /* GMime really doesn't want to see a NULL date, so protect its
 804      * sensibilities. */
 805     if (date == NULL || *date == '\0')
 806         time_value = 0;
 807     else
 808         time_value = g_mime_utils_header_decode_date (date, NULL);
 809
 810     message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
 811                             Xapian::sortable_serialise (time_value));
 812 }
 813
 814 /* Synchronize changes made to message->doc out into the database. */
 815 void
 816 _notmuch_message_sync (notmuch_message_t *message)
 817 {
 818     Xapian::WritableDatabase *db;
 819
 820     if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
 821         return;
 822
 823     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
 824     db->replace_document (message->doc_id, message->doc);
 825 }
 826
 827 /* Delete a message document from the database. */
 828 notmuch_status_t
 829 _notmuch_message_delete (notmuch_message_t *message)
 830 {
 831     notmuch_status_t status;
 832     Xapian::WritableDatabase *db;
 833
 834     status = _notmuch_database_ensure_writable (message->notmuch);
 835     if (status)
 836         return status;
 837
 838     db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
 839     db->delete_document (message->doc_id);
 840     return NOTMUCH_STATUS_SUCCESS;
 841 }
 842
 843 /* Ensure that 'message' is not holding any file object open. Future
 844  * calls to various functions will still automatically open the
 845  * message file as needed.
 846  */
 847 void
 848 _notmuch_message_close (notmuch_message_t *message)
 849 {
 850     if (message->message_file) {
 851         notmuch_message_file_close (message->message_file);
 852         message->message_file = NULL;
 853     }
 854 }
 855
 856 /* Add a name:value term to 'message', (the actual term will be
 857  * encoded by prefixing the value with a short prefix). See
 858  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 859  * names to prefix values.
 860  *
 861  * This change will not be reflected in the database until the next
 862  * call to _notmuch_message_sync. */
 863 notmuch_private_status_t
 864 _notmuch_message_add_term (notmuch_message_t *message,
 865                            const char *prefix_name,
 866                            const char *value)
 867 {
 868
 869     char *term;
 870
 871     if (value == NULL)
 872         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 873
 874     term = talloc_asprintf (message, "%s%s",
 875                             _find_prefix (prefix_name), value);
 876
 877     if (strlen (term) > NOTMUCH_TERM_MAX)
 878         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 879
 880     message->doc.add_term (term, 0);
 881
 882     talloc_free (term);
 883
 884     _notmuch_message_invalidate_metadata (message, prefix_name);
 885
 886     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 887 }
 888
 889 /* Parse 'text' and add a term to 'message' for each parsed word. Each
 890  * term will be added both prefixed (if prefix_name is not NULL) and
 891  * also non-prefixed). */
 892 notmuch_private_status_t
 893 _notmuch_message_gen_terms (notmuch_message_t *message,
 894                             const char *prefix_name,
 895                             const char *text)
 896 {
 897     Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
 898
 899     if (text == NULL)
 900         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 901
 902     term_gen->set_document (message->doc);
 903     term_gen->set_termpos (message->termpos);
 904
 905     if (prefix_name) {
 906         const char *prefix = _find_prefix (prefix_name);
 907
 908         term_gen->index_text (text, 1, prefix);
 909         message->termpos = term_gen->get_termpos ();
 910     }
 911
 912     term_gen->index_text (text);
 913
 914     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 915 }
 916
 917 /* Remove a name:value term from 'message', (the actual term will be
 918  * encoded by prefixing the value with a short prefix). See
 919  * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
 920  * names to prefix values.
 921  *
 922  * This change will not be reflected in the database until the next
 923  * call to _notmuch_message_sync. */
 924 notmuch_private_status_t
 925 _notmuch_message_remove_term (notmuch_message_t *message,
 926                               const char *prefix_name,
 927                               const char *value)
 928 {
 929     char *term;
 930
 931     if (value == NULL)
 932         return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
 933
 934     term = talloc_asprintf (message, "%s%s",
 935                             _find_prefix (prefix_name), value);
 936
 937     if (strlen (term) > NOTMUCH_TERM_MAX)
 938         return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
 939
 940     try {
 941         message->doc.remove_term (term);
 942     } catch (const Xapian::InvalidArgumentError) {
 943         /* We'll let the philosopher's try to wrestle with the
 944          * question of whether failing to remove that which was not
 945          * there in the first place is failure. For us, we'll silently
 946          * consider it all good. */
 947     }
 948
 949     talloc_free (term);
 950
 951     _notmuch_message_invalidate_metadata (message, prefix_name);
 952
 953     return NOTMUCH_PRIVATE_STATUS_SUCCESS;
 954 }
 955
 956 notmuch_status_t
 957 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
 958 {
 959     notmuch_private_status_t private_status;
 960     notmuch_status_t status;
 961
 962     status = _notmuch_database_ensure_writable (message->notmuch);
 963     if (status)
 964         return status;
 965
 966     if (tag == NULL)
 967         return NOTMUCH_STATUS_NULL_POINTER;
 968
 969     if (strlen (tag) > NOTMUCH_TAG_MAX)
 970         return NOTMUCH_STATUS_TAG_TOO_LONG;
 971
 972     private_status = _notmuch_message_add_term (message, "tag", tag);
 973     if (private_status) {
 974         INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
 975                         private_status);
 976     }
 977
 978     if (! message->frozen)
 979         _notmuch_message_sync (message);
 980
 981     return NOTMUCH_STATUS_SUCCESS;
 982 }
 983
 984 notmuch_status_t
 985 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
 986 {
 987     notmuch_private_status_t private_status;
 988     notmuch_status_t status;
 989
 990     status = _notmuch_database_ensure_writable (message->notmuch);
 991     if (status)
 992         return status;
 993
 994     if (tag == NULL)
 995         return NOTMUCH_STATUS_NULL_POINTER;
 996
 997     if (strlen (tag) > NOTMUCH_TAG_MAX)
 998         return NOTMUCH_STATUS_TAG_TOO_LONG;
 999
1000     private_status = _notmuch_message_remove_term (message, "tag", tag);
1001     if (private_status) {
1002         INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1003                         private_status);
1004     }
1005
1006     if (! message->frozen)
1007         _notmuch_message_sync (message);
1008
1009     return NOTMUCH_STATUS_SUCCESS;
1010 }
1011
1012 notmuch_status_t
1013 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1014 {
1015     const char *flags;
1016     notmuch_status_t status;
1017     notmuch_filenames_t *filenames;
1018     const char *filename;
1019     char *combined_flags = talloc_strdup (message, "");
1020     unsigned i;
1021     int seen_maildir_info = 0;
1022
1023     for (filenames = notmuch_message_get_filenames (message);
1024          notmuch_filenames_valid (filenames);
1025          notmuch_filenames_move_to_next (filenames))
1026     {
1027         filename = notmuch_filenames_get (filenames);
1028
1029         flags = strstr (filename, ":2,");
1030         if (! flags)
1031             continue;
1032
1033         seen_maildir_info = 1;
1034         flags += 3;
1035
1036         combined_flags = talloc_strdup_append (combined_flags, flags);
1037     }
1038
1039     /* If none of the filenames have any maildir info field (not even
1040      * an empty info with no flags set) then there's no information to
1041      * go on, so do nothing. */
1042     if (! seen_maildir_info)
1043         return NOTMUCH_STATUS_SUCCESS;
1044
1045     status = notmuch_message_freeze (message);
1046     if (status)
1047         return status;
1048
1049     for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1050         if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1051             ^
1052             flag2tag[i].inverse)
1053         {
1054             status = notmuch_message_add_tag (message, flag2tag[i].tag);
1055         } else {
1056             status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1057         }
1058         if (status)
1059             return status;
1060     }
1061     status = notmuch_message_thaw (message);
1062
1063     talloc_free (combined_flags);
1064
1065     return status;
1066 }
1067
1068 /* Is the given filename within a maildir directory?
1069  *
1070  * Specifically, is the final directory component of 'filename' either
1071  * "cur" or "new". If so, return a pointer to that final directory
1072  * component within 'filename'. If not, return NULL.
1073  *
1074  * A non-NULL return value is guaranteed to be a valid string pointer
1075  * pointing to the characters "new/" or "cur/", (but not
1076  * NUL-terminated).
1077  */
1078 static const char *
1079 _filename_is_in_maildir (const char *filename)
1080 {
1081     const char *slash, *dir = NULL;
1082
1083     /* Find the last '/' separating directory from filename. */
1084     slash = strrchr (filename, '/');
1085     if (slash == NULL)
1086         return NULL;
1087
1088     /* Jump back 4 characters to where the previous '/' will be if the
1089      * directory is named "cur" or "new". */
1090     if (slash - filename < 4)
1091         return NULL;
1092
1093     slash -= 4;
1094
1095     if (*slash != '/')
1096         return NULL;
1097
1098     dir = slash + 1;
1099
1100     if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1101         STRNCMP_LITERAL (dir, "new/") == 0)
1102     {
1103         return dir;
1104     }
1105
1106     return NULL;
1107 }
1108
1109 /* From the set of tags on 'message' and the flag2tag table, compute a
1110  * set of maildir-flag actions to be taken, (flags that should be
1111  * either set or cleared).
1112  *
1113  * The result is returned as two talloced strings: to_set, and to_clear
1114  */
1115 static void
1116 _get_maildir_flag_actions (notmuch_message_t *message,
1117                            char **to_set_ret,
1118                            char **to_clear_ret)
1119 {
1120     char *to_set, *to_clear;
1121     notmuch_tags_t *tags;
1122     const char *tag;
1123     unsigned i;
1124
1125     to_set = talloc_strdup (message, "");
1126     to_clear = talloc_strdup (message, "");
1127
1128     /* First, find flags for all set tags. */
1129     for (tags = notmuch_message_get_tags (message);
1130          notmuch_tags_valid (tags);
1131          notmuch_tags_move_to_next (tags))
1132     {
1133         tag = notmuch_tags_get (tags);
1134
1135         for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1136             if (strcmp (tag, flag2tag[i].tag) == 0) {
1137                 if (flag2tag[i].inverse)
1138                     to_clear = talloc_asprintf_append (to_clear,
1139                                                        "%c",
1140                                                        flag2tag[i].flag);
1141                 else
1142                     to_set = talloc_asprintf_append (to_set,
1143                                                      "%c",
1144                                                      flag2tag[i].flag);
1145             }
1146         }
1147     }
1148
1149     /* Then, find the flags for all tags not present. */
1150     for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1151         if (flag2tag[i].inverse) {
1152             if (strchr (to_clear, flag2tag[i].flag) == NULL)
1153                 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1154         } else {
1155             if (strchr (to_set, flag2tag[i].flag) == NULL)
1156                 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1157         }
1158     }
1159
1160     *to_set_ret = to_set;
1161     *to_clear_ret = to_clear;
1162 }
1163
1164 /* Given 'filename' and a set of maildir flags to set and to clear,
1165  * compute the new maildir filename.
1166  *
1167  * If the existing filename is in the directory "new", the new
1168  * filename will be in the directory "cur".
1169  *
1170  * After a sequence of ":2," in the filename, any subsequent
1171  * single-character flags will be added or removed according to the
1172  * characters in flags_to_set and flags_to_clear. Any existing flags
1173  * not mentioned in either string will remain. The final list of flags
1174  * will be in ASCII order.
1175  *
1176  * If the original flags seem invalid, (repeated characters or
1177  * non-ASCII ordering of flags), this function will return NULL
1178  * (meaning that renaming would not be safe and should not occur).
1179  */
1180 static char*
1181 _new_maildir_filename (void *ctx,
1182                        const char *filename,
1183                        const char *flags_to_set,
1184                        const char *flags_to_clear)
1185 {
1186     const char *info, *flags;
1187     unsigned int flag, last_flag;
1188     char *filename_new, *dir;
1189     char flag_map[128];
1190     int flags_in_map = 0;
1191     unsigned int i;
1192     char *s;
1193
1194     memset (flag_map, 0, sizeof (flag_map));
1195
1196     info = strstr (filename, ":2,");
1197
1198     if (info == NULL) {
1199         info = filename + strlen(filename);
1200     } else {
1201         flags = info + 3;
1202
1203         /* Loop through existing flags in filename. */
1204         for (flags = info + 3, last_flag = 0;
1205              *flags;
1206              last_flag = flag, flags++)
1207         {
1208             flag = *flags;
1209
1210             /* Original flags not in ASCII order. Abort. */
1211             if (flag < last_flag)
1212                 return NULL;
1213
1214             /* Non-ASCII flag. Abort. */
1215             if (flag > sizeof(flag_map) - 1)
1216                 return NULL;
1217
1218             /* Repeated flag value. Abort. */
1219             if (flag_map[flag])
1220                 return NULL;
1221
1222             flag_map[flag] = 1;
1223             flags_in_map++;
1224         }
1225     }
1226
1227     /* Then set and clear our flags from tags. */
1228     for (flags = flags_to_set; *flags; flags++) {
1229         flag = *flags;
1230         if (flag_map[flag] == 0) {
1231             flag_map[flag] = 1;
1232             flags_in_map++;
1233         }
1234     }
1235
1236     for (flags = flags_to_clear; *flags; flags++) {
1237         flag = *flags;
1238         if (flag_map[flag]) {
1239             flag_map[flag] = 0;
1240             flags_in_map--;
1241         }
1242     }
1243
1244     filename_new = (char *) talloc_size (ctx,
1245                                          info - filename +
1246                                          strlen (":2,") + flags_in_map + 1);
1247     if (unlikely (filename_new == NULL))
1248         return NULL;
1249
1250     strncpy (filename_new, filename, info - filename);
1251     filename_new[info - filename] = '\0';
1252
1253     strcat (filename_new, ":2,");
1254
1255     s = filename_new + strlen (filename_new);
1256     for (i = 0; i < sizeof (flag_map); i++)
1257     {
1258         if (flag_map[i]) {
1259             *s = i;
1260             s++;
1261         }
1262     }
1263     *s = '\0';
1264
1265     /* If message is in new/ move it under cur/. */
1266     dir = (char *) _filename_is_in_maildir (filename_new);
1267     if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1268         memcpy (dir, "cur/", 4);
1269
1270     return filename_new;
1271 }
1272
1273 notmuch_status_t
1274 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1275 {
1276     notmuch_filenames_t *filenames;
1277     const char *filename;
1278     char *filename_new;
1279     char *to_set, *to_clear;
1280     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1281
1282     _get_maildir_flag_actions (message, &to_set, &to_clear);
1283
1284     for (filenames = notmuch_message_get_filenames (message);
1285          notmuch_filenames_valid (filenames);
1286          notmuch_filenames_move_to_next (filenames))
1287     {
1288         filename = notmuch_filenames_get (filenames);
1289
1290         if (! _filename_is_in_maildir (filename))
1291             continue;
1292
1293         filename_new = _new_maildir_filename (message, filename,
1294                                               to_set, to_clear);
1295         if (filename_new == NULL)
1296             continue;
1297
1298         if (strcmp (filename, filename_new)) {
1299             int err;
1300             notmuch_status_t new_status;
1301
1302             err = rename (filename, filename_new);
1303             if (err)
1304                 continue;
1305
1306             new_status = _notmuch_message_remove_filename (message,
1307                                                            filename);
1308             /* Hold on to only the first error. */
1309             if (! status && new_status
1310                 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1311                 status = new_status;
1312                 continue;
1313             }
1314
1315             new_status = _notmuch_message_add_filename (message,
1316                                                         filename_new);
1317             /* Hold on to only the first error. */
1318             if (! status && new_status) {
1319                 status = new_status;
1320                 continue;
1321             }
1322
1323             _notmuch_message_sync (message);
1324         }
1325
1326         talloc_free (filename_new);
1327     }
1328
1329     talloc_free (to_set);
1330     talloc_free (to_clear);
1331
1332     return NOTMUCH_STATUS_SUCCESS;
1333 }
1334
1335 notmuch_status_t
1336 notmuch_message_remove_all_tags (notmuch_message_t *message)
1337 {
1338     notmuch_private_status_t private_status;
1339     notmuch_status_t status;
1340     notmuch_tags_t *tags;
1341     const char *tag;
1342
1343     status = _notmuch_database_ensure_writable (message->notmuch);
1344     if (status)
1345         return status;
1346
1347     for (tags = notmuch_message_get_tags (message);
1348          notmuch_tags_valid (tags);
1349          notmuch_tags_move_to_next (tags))
1350     {
1351         tag = notmuch_tags_get (tags);
1352
1353         private_status = _notmuch_message_remove_term (message, "tag", tag);
1354         if (private_status) {
1355             INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1356                             private_status);
1357         }
1358     }
1359
1360     if (! message->frozen)
1361         _notmuch_message_sync (message);
1362
1363     talloc_free (tags);
1364     return NOTMUCH_STATUS_SUCCESS;
1365 }
1366
1367 notmuch_status_t
1368 notmuch_message_freeze (notmuch_message_t *message)
1369 {
1370     notmuch_status_t status;
1371
1372     status = _notmuch_database_ensure_writable (message->notmuch);
1373     if (status)
1374         return status;
1375
1376     message->frozen++;
1377
1378     return NOTMUCH_STATUS_SUCCESS;
1379 }
1380
1381 notmuch_status_t
1382 notmuch_message_thaw (notmuch_message_t *message)
1383 {
1384     notmuch_status_t status;
1385
1386     status = _notmuch_database_ensure_writable (message->notmuch);
1387     if (status)
1388         return status;
1389
1390     if (message->frozen > 0) {
1391         message->frozen--;
1392         if (message->frozen == 0)
1393             _notmuch_message_sync (message);
1394         return NOTMUCH_STATUS_SUCCESS;
1395     } else {
1396         return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1397     }
1398 }
1399
1400 void
1401 notmuch_message_destroy (notmuch_message_t *message)
1402 {
1403     talloc_free (message);
1404 }