1 /* message.cc - Results of message-based searches from a notmuch database
3 * Copyright © 2009 Carl Worth
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.
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.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-private.h"
22 #include "database-private.h"
23 #include "message-private.h"
27 #include <gmime/gmime.h>
29 struct visible _notmuch_message {
30 notmuch_database_t *notmuch;
36 notmuch_string_list_t *tag_list;
37 notmuch_string_list_t *filename_term_list;
38 notmuch_string_list_t *filename_list;
40 notmuch_message_file_t *message_file;
41 notmuch_string_list_t *property_term_list;
42 notmuch_string_map_t *property_map;
43 notmuch_message_list_t *replies;
45 /* For flags that are initialized on-demand, lazy_flags indicates
46 * if each flag has been initialized. */
47 unsigned long lazy_flags;
49 /* Message document modified since last sync */
50 notmuch_bool_t modified;
52 /* last view of database the struct is synced with */
53 unsigned long last_view;
56 Xapian::termcount termpos;
59 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
61 struct maildir_flag_tag {
64 notmuch_bool_t inverse;
67 /* ASCII ordered table of Maildir flags and associated tags */
68 static struct maildir_flag_tag flag2tag[] = {
69 { 'D', "draft", FALSE},
70 { 'F', "flagged", FALSE},
71 { 'P', "passed", FALSE},
72 { 'R', "replied", FALSE},
73 { 'S', "unread", TRUE }
76 /* We end up having to call the destructor explicitly because we had
77 * to use "placement new" in order to initialize C++ objects within a
78 * block that we allocated with talloc. So C++ is making talloc
79 * slightly less simple to use, (we wouldn't need
80 * talloc_set_destructor at all otherwise).
83 _notmuch_message_destructor (notmuch_message_t *message)
85 message->doc.~Document ();
90 static notmuch_message_t *
91 _notmuch_message_create_for_document (const void *talloc_owner,
92 notmuch_database_t *notmuch,
95 notmuch_private_status_t *status)
97 notmuch_message_t *message;
100 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
102 message = talloc (talloc_owner, notmuch_message_t);
103 if (unlikely (message == NULL)) {
105 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
109 message->notmuch = notmuch;
110 message->doc_id = doc_id;
114 message->lazy_flags = 0;
116 /* the message is initially not synchronized with Xapian */
117 message->last_view = 0;
119 /* Each of these will be lazily created as needed. */
120 message->message_id = NULL;
121 message->thread_id = NULL;
122 message->in_reply_to = NULL;
123 message->tag_list = NULL;
124 message->filename_term_list = NULL;
125 message->filename_list = NULL;
126 message->message_file = NULL;
127 message->author = NULL;
128 message->property_term_list = NULL;
129 message->property_map = NULL;
131 message->replies = _notmuch_message_list_create (message);
132 if (unlikely (message->replies == NULL)) {
134 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
138 /* This is C++'s creepy "placement new", which is really just an
139 * ugly way to call a constructor for a pre-allocated object. So
140 * it's really not an error to not be checking for OUT_OF_MEMORY
141 * here, since this "new" isn't actually allocating memory. This
142 * is language-design comedy of the wrong kind. */
144 new (&message->doc) Xapian::Document;
146 talloc_set_destructor (message, _notmuch_message_destructor);
149 message->termpos = 0;
154 /* Create a new notmuch_message_t object for an existing document in
157 * Here, 'talloc owner' is an optional talloc context to which the new
158 * message will belong. This allows for the caller to not bother
159 * calling notmuch_message_destroy on the message, and know that all
160 * memory will be reclaimed when 'talloc_owner' is freed. The caller
161 * still can call notmuch_message_destroy when finished with the
162 * message if desired.
164 * The 'talloc_owner' argument can also be NULL, in which case the
165 * caller *is* responsible for calling notmuch_message_destroy.
167 * If no document exists in the database with document ID of 'doc_id'
168 * then this function returns NULL and optionally sets *status to
169 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
171 * This function can also fail to due lack of available memory,
172 * returning NULL and optionally setting *status to
173 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
175 * The caller can pass NULL for status if uninterested in
176 * distinguishing these two cases.
179 _notmuch_message_create (const void *talloc_owner,
180 notmuch_database_t *notmuch,
182 notmuch_private_status_t *status)
184 Xapian::Document doc;
187 doc = notmuch->xapian_db->get_document (doc_id);
188 } catch (const Xapian::DocNotFoundError &error) {
190 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
194 return _notmuch_message_create_for_document (talloc_owner, notmuch,
195 doc_id, doc, status);
198 /* Create a new notmuch_message_t object for a specific message ID,
199 * (which may or may not already exist in the database).
201 * The 'notmuch' database will be the talloc owner of the returned
204 * This function returns a valid notmuch_message_t whether or not
205 * there is already a document in the database with the given message
206 * ID. These two cases can be distinguished by the value of *status:
209 * NOTMUCH_PRIVATE_STATUS_SUCCESS:
211 * There is already a document with message ID 'message_id' in the
212 * database. The returned message can be used to query/modify the
213 * document. The message may be a ghost message.
215 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
217 * No document with 'message_id' exists in the database. The
218 * returned message contains a newly created document (not yet
219 * added to the database) and a document ID that is known not to
220 * exist in the database. This message is "blank"; that is, it
221 * contains only a message ID and no other metadata. The caller
222 * can modify the message, and a call to _notmuch_message_sync
223 * will add the document to the database.
225 * If an error occurs, this function will return NULL and *status
226 * will be set as appropriate. (The status pointer argument must
230 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
231 const char *message_id,
232 notmuch_private_status_t *status_ret)
234 notmuch_message_t *message;
235 Xapian::Document doc;
239 *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
243 return talloc_steal (notmuch, message);
244 else if (*status_ret)
247 /* If the message ID is too long, substitute its sha1 instead. */
248 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
249 message_id = _notmuch_message_id_compressed (message, message_id);
251 term = talloc_asprintf (NULL, "%s%s",
252 _find_prefix ("id"), message_id);
254 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
258 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
259 INTERNAL_ERROR ("Failure to ensure database is writable.");
262 doc.add_term (term, 0);
265 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
267 doc_id = _notmuch_database_generate_doc_id (notmuch);
268 } catch (const Xapian::Error &error) {
269 _notmuch_database_log(_notmuch_message_database (message), "A Xapian exception occurred creating message: %s\n",
270 error.get_msg().c_str());
271 notmuch->exception_reported = TRUE;
272 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
276 message = _notmuch_message_create_for_document (notmuch, notmuch,
277 doc_id, doc, status_ret);
279 /* We want to inform the caller that we had to create a new
281 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
282 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
288 _notmuch_message_get_term (notmuch_message_t *message,
289 Xapian::TermIterator &i, Xapian::TermIterator &end,
292 int prefix_len = strlen (prefix);
300 const std::string &term = *i;
301 if (strncmp (term.c_str(), prefix, prefix_len))
304 value = talloc_strdup (message, term.c_str() + prefix_len);
306 #if DEBUG_DATABASE_SANITY
309 if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
310 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
311 message->doc_id, prefix, value,
312 (*i).c_str () + prefix_len);
320 _notmuch_message_ensure_metadata (notmuch_message_t *message)
322 Xapian::TermIterator i, end;
324 const char *thread_prefix = _find_prefix ("thread"),
325 *tag_prefix = _find_prefix ("tag"),
326 *id_prefix = _find_prefix ("id"),
327 *type_prefix = _find_prefix ("type"),
328 *filename_prefix = _find_prefix ("file-direntry"),
329 *property_prefix = _find_prefix ("property"),
330 *replyto_prefix = _find_prefix ("replyto");
332 /* We do this all in a single pass because Xapian decompresses the
333 * term list every time you iterate over it. Thus, while this is
334 * slightly more costly than looking up individual fields if only
335 * one field of the message object is actually used, it's a huge
336 * win as more fields are used. */
337 for (int count=0; count < 3; count++) {
339 i = message->doc.termlist_begin ();
340 end = message->doc.termlist_end ();
343 if (!message->thread_id)
345 _notmuch_message_get_term (message, i, end, thread_prefix);
348 assert (strcmp (thread_prefix, tag_prefix) < 0);
349 if (!message->tag_list) {
351 _notmuch_database_get_terms_with_prefix (message, i, end,
353 _notmuch_string_list_sort (message->tag_list);
357 assert (strcmp (tag_prefix, id_prefix) < 0);
358 if (!message->message_id)
359 message->message_id =
360 _notmuch_message_get_term (message, i, end, id_prefix);
362 /* Get document type */
363 assert (strcmp (id_prefix, type_prefix) < 0);
364 if (! NOTMUCH_TEST_BIT (message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST)) {
365 i.skip_to (type_prefix);
366 /* "T" is the prefix "type" fields. See
367 * BOOLEAN_PREFIX_INTERNAL. */
369 NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
370 else if (*i == "Tghost")
371 NOTMUCH_SET_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
373 INTERNAL_ERROR ("Message without type term");
374 NOTMUCH_SET_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
377 /* Get filename list. Here we get only the terms. We lazily
378 * expand them to full file names when needed in
379 * _notmuch_message_ensure_filename_list. */
380 assert (strcmp (type_prefix, filename_prefix) < 0);
381 if (!message->filename_term_list && !message->filename_list)
382 message->filename_term_list =
383 _notmuch_database_get_terms_with_prefix (message, i, end,
387 /* Get property terms. Mimic the setup with filenames above */
388 assert (strcmp (filename_prefix, property_prefix) < 0);
389 if (!message->property_map && !message->property_term_list)
390 message->property_term_list =
391 _notmuch_database_get_terms_with_prefix (message, i, end,
395 assert (strcmp (property_prefix, replyto_prefix) < 0);
396 if (!message->in_reply_to)
397 message->in_reply_to =
398 _notmuch_message_get_term (message, i, end, replyto_prefix);
401 /* It's perfectly valid for a message to have no In-Reply-To
402 * header. For these cases, we return an empty string. */
403 if (!message->in_reply_to)
404 message->in_reply_to = talloc_strdup (message, "");
406 /* all the way without an exception */
408 } catch (const Xapian::DatabaseModifiedError &error) {
409 notmuch_status_t status = _notmuch_database_reopen (message->notmuch);
410 if (status != NOTMUCH_STATUS_SUCCESS)
411 INTERNAL_ERROR ("unhandled error from notmuch_database_reopen: %s\n",
412 notmuch_status_to_string (status));
413 } catch (const Xapian::Error &error) {
414 INTERNAL_ERROR ("A Xapian exception occurred fetching message metadata: %s\n",
415 error.get_msg().c_str());
418 message->last_view = message->notmuch->view;
422 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
423 const char *prefix_name)
425 if (strcmp ("thread", prefix_name) == 0) {
426 talloc_free (message->thread_id);
427 message->thread_id = NULL;
430 if (strcmp ("tag", prefix_name) == 0) {
431 talloc_unlink (message, message->tag_list);
432 message->tag_list = NULL;
435 if (strcmp ("type", prefix_name) == 0) {
436 NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
437 NOTMUCH_CLEAR_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
440 if (strcmp ("file-direntry", prefix_name) == 0) {
441 talloc_free (message->filename_term_list);
442 talloc_free (message->filename_list);
443 message->filename_term_list = message->filename_list = NULL;
446 if (strcmp ("property", prefix_name) == 0) {
448 if (message->property_term_list)
449 talloc_free (message->property_term_list);
450 message->property_term_list = NULL;
452 if (message->property_map)
453 talloc_unlink (message, message->property_map);
455 message->property_map = NULL;
458 if (strcmp ("replyto", prefix_name) == 0) {
459 talloc_free (message->in_reply_to);
460 message->in_reply_to = NULL;
465 _notmuch_message_get_doc_id (notmuch_message_t *message)
467 return message->doc_id;
471 notmuch_message_get_message_id (notmuch_message_t *message)
473 if (!message->message_id)
474 _notmuch_message_ensure_metadata (message);
475 if (!message->message_id)
476 INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
478 return message->message_id;
482 _notmuch_message_ensure_message_file (notmuch_message_t *message)
484 const char *filename;
486 if (message->message_file)
489 filename = notmuch_message_get_filename (message);
490 if (unlikely (filename == NULL))
493 message->message_file = _notmuch_message_file_open_ctx (
494 _notmuch_message_database (message), message, filename);
498 notmuch_message_get_header (notmuch_message_t *message, const char *header)
500 Xapian::valueno slot = Xapian::BAD_VALUENO;
502 /* Fetch header from the appropriate xapian value field if
504 if (strcasecmp (header, "from") == 0)
505 slot = NOTMUCH_VALUE_FROM;
506 else if (strcasecmp (header, "subject") == 0)
507 slot = NOTMUCH_VALUE_SUBJECT;
508 else if (strcasecmp (header, "message-id") == 0)
509 slot = NOTMUCH_VALUE_MESSAGE_ID;
511 if (slot != Xapian::BAD_VALUENO) {
513 std::string value = message->doc.get_value (slot);
515 /* If we have NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES, then
516 * empty values indicate empty headers. If we don't, then
517 * it could just mean we didn't record the header. */
518 if ((message->notmuch->features &
519 NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES) ||
521 return talloc_strdup (message, value.c_str ());
523 } catch (Xapian::Error &error) {
524 _notmuch_database_log(_notmuch_message_database (message), "A Xapian exception occurred when reading header: %s\n",
525 error.get_msg().c_str());
526 message->notmuch->exception_reported = TRUE;
531 /* Otherwise fall back to parsing the file */
532 _notmuch_message_ensure_message_file (message);
533 if (message->message_file == NULL)
536 return _notmuch_message_file_get_header (message->message_file, header);
539 /* Return the message ID from the In-Reply-To header of 'message'.
541 * Returns an empty string ("") if 'message' has no In-Reply-To
544 * Returns NULL if any error occurs.
547 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
549 if (!message->in_reply_to)
550 _notmuch_message_ensure_metadata (message);
551 return message->in_reply_to;
555 notmuch_message_get_thread_id (notmuch_message_t *message)
557 if (!message->thread_id)
558 _notmuch_message_ensure_metadata (message);
559 if (!message->thread_id)
560 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
562 return message->thread_id;
566 _notmuch_message_add_reply (notmuch_message_t *message,
567 notmuch_message_t *reply)
569 _notmuch_message_list_add_message (message->replies, reply);
573 notmuch_message_get_replies (notmuch_message_t *message)
575 return _notmuch_messages_create (message->replies);
579 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
581 Xapian::TermIterator i;
582 size_t prefix_len = strlen (prefix);
585 i = message->doc.termlist_begin ();
588 /* Terminate loop when no terms remain with desired prefix. */
589 if (i == message->doc.termlist_end () ||
590 strncmp ((*i).c_str (), prefix, prefix_len))
594 message->doc.remove_term ((*i));
595 message->modified = TRUE;
596 } catch (const Xapian::InvalidArgumentError) {
597 /* Ignore failure to remove non-existent term. */
602 /* Return true if p points at "new" or "cur". */
603 static bool is_maildir (const char *p)
605 return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
608 /* Add "folder:" term for directory. */
609 static notmuch_status_t
610 _notmuch_message_add_folder_terms (notmuch_message_t *message,
611 const char *directory)
615 folder = talloc_strdup (NULL, directory);
617 return NOTMUCH_STATUS_OUT_OF_MEMORY;
620 * If the message file is in a leaf directory named "new" or
621 * "cur", presume maildir and index the parent directory. Thus a
622 * "folder:" prefix search matches messages in the specified
623 * maildir folder, i.e. in the specified directory and its "new"
624 * and "cur" subdirectories.
626 * Note that this means the "folder:" prefix can't be used for
627 * distinguishing between message files in "new" or "cur". The
628 * "path:" prefix needs to be used for that.
630 * Note the deliberate difference to _filename_is_in_maildir(). We
631 * don't want to index different things depending on the existence
632 * or non-existence of all maildir sibling directories "new",
633 * "cur", and "tmp". Doing so would be surprising, and difficult
634 * for the user to fix in case all subdirectories were not in
635 * place during indexing.
637 last = strrchr (folder, '/');
639 if (is_maildir (last + 1))
641 } else if (is_maildir (folder)) {
645 _notmuch_message_add_term (message, "folder", folder);
647 talloc_free (folder);
649 return NOTMUCH_STATUS_SUCCESS;
652 #define RECURSIVE_SUFFIX "/**"
654 /* Add "path:" terms for directory. */
655 static notmuch_status_t
656 _notmuch_message_add_path_terms (notmuch_message_t *message,
657 const char *directory)
659 /* Add exact "path:" term. */
660 _notmuch_message_add_term (message, "path", directory);
662 if (strlen (directory)) {
665 path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
667 return NOTMUCH_STATUS_OUT_OF_MEMORY;
669 /* Add recursive "path:" terms for directory and all parents. */
670 for (p = path + strlen (path) - 1; p > path; p--) {
672 strcpy (p, RECURSIVE_SUFFIX);
673 _notmuch_message_add_term (message, "path", path);
680 /* Recursive all-matching path:** for consistency. */
681 _notmuch_message_add_term (message, "path", "**");
683 return NOTMUCH_STATUS_SUCCESS;
686 /* Add directory based terms for all filenames of the message. */
687 static notmuch_status_t
688 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
690 const char *direntry_prefix = _find_prefix ("file-direntry");
691 int direntry_prefix_len = strlen (direntry_prefix);
692 Xapian::TermIterator i = message->doc.termlist_begin ();
693 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
695 for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
696 unsigned int directory_id;
697 const char *direntry, *directory;
699 const std::string &term = *i;
701 /* Terminate loop at first term without desired prefix. */
702 if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
705 /* Indicate that there are filenames remaining. */
706 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
708 direntry = term.c_str ();
709 direntry += direntry_prefix_len;
711 directory_id = strtol (direntry, &colon, 10);
713 if (colon == NULL || *colon != ':')
714 INTERNAL_ERROR ("malformed direntry");
716 directory = _notmuch_database_get_directory_path (ctx,
720 _notmuch_message_add_folder_terms (message, directory);
721 _notmuch_message_add_path_terms (message, directory);
727 /* Add an additional 'filename' for 'message'.
729 * This change will not be reflected in the database until the next
730 * call to _notmuch_message_sync. */
732 _notmuch_message_add_filename (notmuch_message_t *message,
733 const char *filename)
735 const char *relative, *directory;
736 notmuch_status_t status;
737 void *local = talloc_new (message);
740 if (filename == NULL)
741 INTERNAL_ERROR ("Message filename cannot be NULL.");
743 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
744 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
745 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
747 relative = _notmuch_database_relative_path (message->notmuch, filename);
749 status = _notmuch_database_split_path (local, relative, &directory, NULL);
753 status = _notmuch_database_filename_to_direntry (
754 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
758 /* New file-direntry allows navigating to this message with
759 * notmuch_directory_get_child_files() . */
760 _notmuch_message_add_term (message, "file-direntry", direntry);
762 _notmuch_message_add_folder_terms (message, directory);
763 _notmuch_message_add_path_terms (message, directory);
767 return NOTMUCH_STATUS_SUCCESS;
770 /* Remove a particular 'filename' from 'message'.
772 * This change will not be reflected in the database until the next
773 * call to _notmuch_message_sync.
775 * If this message still has other filenames, returns
776 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
778 * Note: This function does not remove a document from the database,
779 * even if the specified filename is the only filename for this
780 * message. For that functionality, see
781 * notmuch_database_remove_message. */
783 _notmuch_message_remove_filename (notmuch_message_t *message,
784 const char *filename)
786 void *local = talloc_new (message);
788 notmuch_private_status_t private_status;
789 notmuch_status_t status;
791 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
792 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
793 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
795 status = _notmuch_database_filename_to_direntry (
796 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
797 if (status || !direntry)
800 /* Unlink this file from its parent directory. */
801 private_status = _notmuch_message_remove_term (message,
802 "file-direntry", direntry);
803 status = COERCE_STATUS (private_status,
804 "Unexpected error from _notmuch_message_remove_term");
808 /* Re-synchronize "folder:" and "path:" terms for this message. */
810 /* Remove all "folder:" terms. */
811 _notmuch_message_remove_terms (message, _find_prefix ("folder"));
813 /* Remove all "path:" terms. */
814 _notmuch_message_remove_terms (message, _find_prefix ("path"));
816 /* Add back terms for all remaining filenames of the message. */
817 status = _notmuch_message_add_directory_terms (local, message);
824 /* Upgrade the "folder:" prefix from V1 to V2. */
825 #define FOLDER_PREFIX_V1 "XFOLDER"
826 #define ZFOLDER_PREFIX_V1 "Z" FOLDER_PREFIX_V1
828 _notmuch_message_upgrade_folder (notmuch_message_t *message)
830 /* Remove all old "folder:" terms. */
831 _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
833 /* Remove all old "folder:" stemmed terms. */
834 _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
836 /* Add new boolean "folder:" and "path:" terms. */
837 _notmuch_message_add_directory_terms (message, message);
841 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
843 return talloc_strdup (message, message->doc.get_data ().c_str ());
847 _notmuch_message_clear_data (notmuch_message_t *message)
849 message->doc.set_data ("");
850 message->modified = TRUE;
854 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
856 notmuch_string_node_t *node;
858 if (message->filename_list)
861 if (!message->filename_term_list)
862 _notmuch_message_ensure_metadata (message);
864 message->filename_list = _notmuch_string_list_create (message);
865 node = message->filename_term_list->head;
868 /* A message document created by an old version of notmuch
869 * (prior to rename support) will have the filename in the
870 * data of the document rather than as a file-direntry term.
872 * It would be nice to do the upgrade of the document directly
873 * here, but the database is likely open in read-only mode. */
876 data = message->doc.get_data ().c_str ();
879 INTERNAL_ERROR ("message with no filename");
881 _notmuch_string_list_append (message->filename_list, data);
886 for (; node; node = node->next) {
887 void *local = talloc_new (message);
888 const char *db_path, *directory, *basename, *filename;
889 char *colon, *direntry = NULL;
890 unsigned int directory_id;
892 direntry = node->string;
894 directory_id = strtol (direntry, &colon, 10);
896 if (colon == NULL || *colon != ':')
897 INTERNAL_ERROR ("malformed direntry");
899 basename = colon + 1;
903 db_path = notmuch_database_get_path (message->notmuch);
905 directory = _notmuch_database_get_directory_path (local,
909 if (strlen (directory))
910 filename = talloc_asprintf (message, "%s/%s/%s",
911 db_path, directory, basename);
913 filename = talloc_asprintf (message, "%s/%s",
916 _notmuch_string_list_append (message->filename_list, filename);
921 talloc_free (message->filename_term_list);
922 message->filename_term_list = NULL;
926 notmuch_message_get_filename (notmuch_message_t *message)
928 _notmuch_message_ensure_filename_list (message);
930 if (message->filename_list == NULL)
933 if (message->filename_list->head == NULL ||
934 message->filename_list->head->string == NULL)
936 INTERNAL_ERROR ("message with no filename");
939 return message->filename_list->head->string;
942 notmuch_filenames_t *
943 notmuch_message_get_filenames (notmuch_message_t *message)
945 _notmuch_message_ensure_filename_list (message);
947 return _notmuch_filenames_create (message, message->filename_list);
951 notmuch_message_get_flag (notmuch_message_t *message,
952 notmuch_message_flag_t flag)
954 if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
955 ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
956 _notmuch_message_ensure_metadata (message);
958 return NOTMUCH_TEST_BIT (message->flags, flag);
962 notmuch_message_set_flag (notmuch_message_t *message,
963 notmuch_message_flag_t flag, notmuch_bool_t enable)
966 NOTMUCH_SET_BIT (&message->flags, flag);
968 NOTMUCH_CLEAR_BIT (&message->flags, flag);
969 NOTMUCH_SET_BIT (&message->lazy_flags, flag);
973 notmuch_message_get_date (notmuch_message_t *message)
978 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
979 } catch (Xapian::Error &error) {
980 _notmuch_database_log(_notmuch_message_database (message), "A Xapian exception occurred when reading date: %s\n",
981 error.get_msg().c_str());
982 message->notmuch->exception_reported = TRUE;
987 /* sortable_unserialise is undefined on empty string */
989 return Xapian::sortable_unserialise (value);
993 notmuch_message_get_tags (notmuch_message_t *message)
995 notmuch_tags_t *tags;
997 if (!message->tag_list)
998 _notmuch_message_ensure_metadata (message);
1000 tags = _notmuch_tags_create (message, message->tag_list);
1001 /* _notmuch_tags_create steals the reference to the tag_list, but
1002 * in this case it's still used by the message, so we add an
1003 * *additional* talloc reference to the list. As a result, it's
1004 * possible to modify the message tags (which talloc_unlink's the
1005 * current list from the message) while still iterating because
1006 * the iterator will keep the current list alive. */
1007 if (!talloc_reference (message, message->tag_list))
1014 _notmuch_message_get_author (notmuch_message_t *message)
1016 return message->author;
1020 _notmuch_message_set_author (notmuch_message_t *message,
1023 if (message->author)
1024 talloc_free(message->author);
1025 message->author = talloc_strdup(message, author);
1030 _notmuch_message_set_header_values (notmuch_message_t *message,
1033 const char *subject)
1037 /* GMime really doesn't want to see a NULL date, so protect its
1039 if (date == NULL || *date == '\0')
1042 time_value = g_mime_utils_header_decode_date (date, NULL);
1044 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1045 Xapian::sortable_serialise (time_value));
1046 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1047 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1048 message->modified = TRUE;
1051 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD. The caller
1052 * must call _notmuch_message_sync. */
1054 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1056 /* _notmuch_message_sync will update the last modification
1057 * revision; we just have to ask it to. */
1058 message->modified = TRUE;
1061 /* Synchronize changes made to message->doc out into the database. */
1063 _notmuch_message_sync (notmuch_message_t *message)
1065 Xapian::WritableDatabase *db;
1067 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
1070 if (! message->modified)
1073 /* Update the last modification of this message. */
1074 if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1075 /* sortable_serialise gives a reasonably compact encoding,
1076 * which directly translates to reduced IO when scanning the
1077 * value stream. Since it's built for doubles, we only get 53
1078 * effective bits, but that's still enough for the database to
1079 * last a few centuries at 1 million revisions per second. */
1080 message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1081 Xapian::sortable_serialise (
1082 _notmuch_database_new_revision (
1083 message->notmuch)));
1085 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1086 db->replace_document (message->doc_id, message->doc);
1087 message->modified = FALSE;
1090 /* Delete a message document from the database, leaving a ghost
1091 * message in its place */
1093 _notmuch_message_delete (notmuch_message_t *message)
1095 notmuch_status_t status;
1096 Xapian::WritableDatabase *db;
1097 const char *mid, *tid, *query_string;
1098 notmuch_message_t *ghost;
1099 notmuch_private_status_t private_status;
1100 notmuch_database_t *notmuch;
1101 notmuch_query_t *query;
1102 unsigned int count = 0;
1103 notmuch_bool_t is_ghost;
1105 mid = notmuch_message_get_message_id (message);
1106 tid = notmuch_message_get_thread_id (message);
1107 notmuch = message->notmuch;
1109 status = _notmuch_database_ensure_writable (message->notmuch);
1113 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1114 db->delete_document (message->doc_id);
1116 /* if this was a ghost to begin with, we are done */
1117 private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1119 return COERCE_STATUS (private_status,
1120 "Error trying to determine whether message was a ghost");
1122 return NOTMUCH_STATUS_SUCCESS;
1124 query_string = talloc_asprintf (message, "thread:%s", tid);
1125 query = notmuch_query_create (notmuch, query_string);
1127 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1128 status = notmuch_query_count_messages_st (query, &count);
1130 notmuch_query_destroy (query);
1135 /* reintroduce a ghost in its place because there are still
1136 * other active messages in this thread: */
1137 ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1138 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1139 private_status = _notmuch_message_initialize_ghost (ghost, tid);
1140 if (! private_status)
1141 _notmuch_message_sync (ghost);
1142 } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1143 /* this is deeply weird, and we should not have gotten
1144 into this state. is there a better error message to
1146 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1149 notmuch_message_destroy (ghost);
1150 status = COERCE_STATUS (private_status, "Error converting to ghost message");
1152 /* the thread is empty; drop all ghost messages from it */
1153 notmuch_messages_t *messages;
1154 status = _notmuch_query_search_documents (query,
1157 if (status == NOTMUCH_STATUS_SUCCESS) {
1158 notmuch_status_t last_error = NOTMUCH_STATUS_SUCCESS;
1159 while (notmuch_messages_valid (messages)) {
1160 message = notmuch_messages_get (messages);
1161 status = _notmuch_message_delete (message);
1162 if (status) /* we'll report the last failure we see;
1163 * if there is more than one failure, we
1164 * forget about previous ones */
1165 last_error = status;
1166 notmuch_message_destroy (message);
1167 notmuch_messages_move_to_next (messages);
1169 status = last_error;
1172 notmuch_query_destroy (query);
1176 /* Transform a blank message into a ghost message. The caller must
1177 * _notmuch_message_sync the message. */
1178 notmuch_private_status_t
1179 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1180 const char *thread_id)
1182 notmuch_private_status_t status;
1184 status = _notmuch_message_add_term (message, "type", "ghost");
1187 status = _notmuch_message_add_term (message, "thread", thread_id);
1191 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1194 /* Ensure that 'message' is not holding any file object open. Future
1195 * calls to various functions will still automatically open the
1196 * message file as needed.
1199 _notmuch_message_close (notmuch_message_t *message)
1201 if (message->message_file) {
1202 _notmuch_message_file_close (message->message_file);
1203 message->message_file = NULL;
1207 /* Add a name:value term to 'message', (the actual term will be
1208 * encoded by prefixing the value with a short prefix). See
1209 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1210 * names to prefix values.
1212 * This change will not be reflected in the database until the next
1213 * call to _notmuch_message_sync. */
1214 notmuch_private_status_t
1215 _notmuch_message_add_term (notmuch_message_t *message,
1216 const char *prefix_name,
1223 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1225 term = talloc_asprintf (message, "%s%s",
1226 _find_prefix (prefix_name), value);
1228 if (strlen (term) > NOTMUCH_TERM_MAX)
1229 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1231 message->doc.add_term (term, 0);
1232 message->modified = TRUE;
1236 _notmuch_message_invalidate_metadata (message, prefix_name);
1238 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1241 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1242 * term will be added both prefixed (if prefix_name is not NULL) and
1243 * also non-prefixed). */
1244 notmuch_private_status_t
1245 _notmuch_message_gen_terms (notmuch_message_t *message,
1246 const char *prefix_name,
1249 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1252 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1254 term_gen->set_document (message->doc);
1257 const char *prefix = _find_prefix (prefix_name);
1259 term_gen->set_termpos (message->termpos);
1260 term_gen->index_text (text, 1, prefix);
1261 /* Create a gap between this an the next terms so they don't
1262 * appear to be a phrase. */
1263 message->termpos = term_gen->get_termpos () + 100;
1265 _notmuch_message_invalidate_metadata (message, prefix_name);
1268 term_gen->set_termpos (message->termpos);
1269 term_gen->index_text (text);
1270 /* Create a term gap, as above. */
1271 message->termpos = term_gen->get_termpos () + 100;
1273 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1276 /* Remove a name:value term from 'message', (the actual term will be
1277 * encoded by prefixing the value with a short prefix). See
1278 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1279 * names to prefix values.
1281 * This change will not be reflected in the database until the next
1282 * call to _notmuch_message_sync. */
1283 notmuch_private_status_t
1284 _notmuch_message_remove_term (notmuch_message_t *message,
1285 const char *prefix_name,
1291 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1293 term = talloc_asprintf (message, "%s%s",
1294 _find_prefix (prefix_name), value);
1296 if (strlen (term) > NOTMUCH_TERM_MAX)
1297 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1300 message->doc.remove_term (term);
1301 message->modified = TRUE;
1302 } catch (const Xapian::InvalidArgumentError) {
1303 /* We'll let the philosophers try to wrestle with the
1304 * question of whether failing to remove that which was not
1305 * there in the first place is failure. For us, we'll silently
1306 * consider it all good. */
1311 _notmuch_message_invalidate_metadata (message, prefix_name);
1313 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1316 notmuch_private_status_t
1317 _notmuch_message_has_term (notmuch_message_t *message,
1318 const char *prefix_name,
1320 notmuch_bool_t *result)
1323 notmuch_bool_t out = FALSE;
1324 notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1327 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1329 term = talloc_asprintf (message, "%s%s",
1330 _find_prefix (prefix_name), value);
1332 if (strlen (term) > NOTMUCH_TERM_MAX)
1333 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1336 /* Look for the exact term */
1337 Xapian::TermIterator i = message->doc.termlist_begin ();
1339 if (i != message->doc.termlist_end () &&
1340 !strcmp ((*i).c_str (), term))
1342 } catch (Xapian::Error &error) {
1343 status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1352 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1354 notmuch_private_status_t private_status;
1355 notmuch_status_t status;
1357 status = _notmuch_database_ensure_writable (message->notmuch);
1362 return NOTMUCH_STATUS_NULL_POINTER;
1364 if (strlen (tag) > NOTMUCH_TAG_MAX)
1365 return NOTMUCH_STATUS_TAG_TOO_LONG;
1367 private_status = _notmuch_message_add_term (message, "tag", tag);
1368 if (private_status) {
1369 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1373 if (! message->frozen)
1374 _notmuch_message_sync (message);
1376 return NOTMUCH_STATUS_SUCCESS;
1380 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1382 notmuch_private_status_t private_status;
1383 notmuch_status_t status;
1385 status = _notmuch_database_ensure_writable (message->notmuch);
1390 return NOTMUCH_STATUS_NULL_POINTER;
1392 if (strlen (tag) > NOTMUCH_TAG_MAX)
1393 return NOTMUCH_STATUS_TAG_TOO_LONG;
1395 private_status = _notmuch_message_remove_term (message, "tag", tag);
1396 if (private_status) {
1397 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1401 if (! message->frozen)
1402 _notmuch_message_sync (message);
1404 return NOTMUCH_STATUS_SUCCESS;
1407 /* Is the given filename within a maildir directory?
1409 * Specifically, is the final directory component of 'filename' either
1410 * "cur" or "new". If so, return a pointer to that final directory
1411 * component within 'filename'. If not, return NULL.
1413 * A non-NULL return value is guaranteed to be a valid string pointer
1414 * pointing to the characters "new/" or "cur/", (but not
1418 _filename_is_in_maildir (const char *filename)
1420 const char *slash, *dir = NULL;
1422 /* Find the last '/' separating directory from filename. */
1423 slash = strrchr (filename, '/');
1427 /* Jump back 4 characters to where the previous '/' will be if the
1428 * directory is named "cur" or "new". */
1429 if (slash - filename < 4)
1439 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1440 STRNCMP_LITERAL (dir, "new/") == 0)
1449 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1452 notmuch_status_t status;
1453 notmuch_filenames_t *filenames;
1454 const char *filename, *dir;
1455 char *combined_flags = talloc_strdup (message, "");
1457 int seen_maildir_info = 0;
1459 for (filenames = notmuch_message_get_filenames (message);
1460 notmuch_filenames_valid (filenames);
1461 notmuch_filenames_move_to_next (filenames))
1463 filename = notmuch_filenames_get (filenames);
1464 dir = _filename_is_in_maildir (filename);
1469 flags = strstr (filename, ":2,");
1471 seen_maildir_info = 1;
1473 combined_flags = talloc_strdup_append (combined_flags, flags);
1474 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1475 /* Messages are delivered to new/ with no "info" part, but
1476 * they effectively have default maildir flags. According
1477 * to the spec, we should ignore the info part for
1478 * messages in new/, but some MUAs (mutt) can set maildir
1479 * flags on messages in new/, so we're liberal in what we
1481 seen_maildir_info = 1;
1485 /* If none of the filenames have any maildir info field (not even
1486 * an empty info with no flags set) then there's no information to
1487 * go on, so do nothing. */
1488 if (! seen_maildir_info)
1489 return NOTMUCH_STATUS_SUCCESS;
1491 status = notmuch_message_freeze (message);
1495 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1496 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1498 flag2tag[i].inverse)
1500 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1502 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1507 status = notmuch_message_thaw (message);
1509 talloc_free (combined_flags);
1514 /* From the set of tags on 'message' and the flag2tag table, compute a
1515 * set of maildir-flag actions to be taken, (flags that should be
1516 * either set or cleared).
1518 * The result is returned as two talloced strings: to_set, and to_clear
1521 _get_maildir_flag_actions (notmuch_message_t *message,
1523 char **to_clear_ret)
1525 char *to_set, *to_clear;
1526 notmuch_tags_t *tags;
1530 to_set = talloc_strdup (message, "");
1531 to_clear = talloc_strdup (message, "");
1533 /* First, find flags for all set tags. */
1534 for (tags = notmuch_message_get_tags (message);
1535 notmuch_tags_valid (tags);
1536 notmuch_tags_move_to_next (tags))
1538 tag = notmuch_tags_get (tags);
1540 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1541 if (strcmp (tag, flag2tag[i].tag) == 0) {
1542 if (flag2tag[i].inverse)
1543 to_clear = talloc_asprintf_append (to_clear,
1547 to_set = talloc_asprintf_append (to_set,
1554 /* Then, find the flags for all tags not present. */
1555 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1556 if (flag2tag[i].inverse) {
1557 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1558 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1560 if (strchr (to_set, flag2tag[i].flag) == NULL)
1561 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1565 *to_set_ret = to_set;
1566 *to_clear_ret = to_clear;
1569 /* Given 'filename' and a set of maildir flags to set and to clear,
1570 * compute the new maildir filename.
1572 * If the existing filename is in the directory "new", the new
1573 * filename will be in the directory "cur", except for the case when
1574 * no flags are changed and the existing filename does not contain
1575 * maildir info (starting with ",2:").
1577 * After a sequence of ":2," in the filename, any subsequent
1578 * single-character flags will be added or removed according to the
1579 * characters in flags_to_set and flags_to_clear. Any existing flags
1580 * not mentioned in either string will remain. The final list of flags
1581 * will be in ASCII order.
1583 * If the original flags seem invalid, (repeated characters or
1584 * non-ASCII ordering of flags), this function will return NULL
1585 * (meaning that renaming would not be safe and should not occur).
1588 _new_maildir_filename (void *ctx,
1589 const char *filename,
1590 const char *flags_to_set,
1591 const char *flags_to_clear)
1593 const char *info, *flags;
1594 unsigned int flag, last_flag;
1595 char *filename_new, *dir;
1597 int flags_in_map = 0;
1598 notmuch_bool_t flags_changed = FALSE;
1602 memset (flag_map, 0, sizeof (flag_map));
1604 info = strstr (filename, ":2,");
1607 info = filename + strlen(filename);
1609 /* Loop through existing flags in filename. */
1610 for (flags = info + 3, last_flag = 0;
1612 last_flag = flag, flags++)
1616 /* Original flags not in ASCII order. Abort. */
1617 if (flag < last_flag)
1620 /* Non-ASCII flag. Abort. */
1621 if (flag > sizeof(flag_map) - 1)
1624 /* Repeated flag value. Abort. */
1633 /* Then set and clear our flags from tags. */
1634 for (flags = flags_to_set; *flags; flags++) {
1636 if (flag_map[flag] == 0) {
1639 flags_changed = TRUE;
1643 for (flags = flags_to_clear; *flags; flags++) {
1645 if (flag_map[flag]) {
1648 flags_changed = TRUE;
1652 /* Messages in new/ without maildir info can be kept in new/ if no
1653 * flags have changed. */
1654 dir = (char *) _filename_is_in_maildir (filename);
1655 if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && !*info && !flags_changed)
1656 return talloc_strdup (ctx, filename);
1658 filename_new = (char *) talloc_size (ctx,
1660 strlen (":2,") + flags_in_map + 1);
1661 if (unlikely (filename_new == NULL))
1664 strncpy (filename_new, filename, info - filename);
1665 filename_new[info - filename] = '\0';
1667 strcat (filename_new, ":2,");
1669 s = filename_new + strlen (filename_new);
1670 for (i = 0; i < sizeof (flag_map); i++)
1679 /* If message is in new/ move it under cur/. */
1680 dir = (char *) _filename_is_in_maildir (filename_new);
1681 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1682 memcpy (dir, "cur/", 4);
1684 return filename_new;
1688 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1690 notmuch_filenames_t *filenames;
1691 const char *filename;
1693 char *to_set, *to_clear;
1694 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1696 _get_maildir_flag_actions (message, &to_set, &to_clear);
1698 for (filenames = notmuch_message_get_filenames (message);
1699 notmuch_filenames_valid (filenames);
1700 notmuch_filenames_move_to_next (filenames))
1702 filename = notmuch_filenames_get (filenames);
1704 if (! _filename_is_in_maildir (filename))
1707 filename_new = _new_maildir_filename (message, filename,
1709 if (filename_new == NULL)
1712 if (strcmp (filename, filename_new)) {
1714 notmuch_status_t new_status;
1716 err = rename (filename, filename_new);
1720 new_status = _notmuch_message_remove_filename (message,
1722 /* Hold on to only the first error. */
1723 if (! status && new_status
1724 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1725 status = new_status;
1729 new_status = _notmuch_message_add_filename (message,
1731 /* Hold on to only the first error. */
1732 if (! status && new_status) {
1733 status = new_status;
1737 _notmuch_message_sync (message);
1740 talloc_free (filename_new);
1743 talloc_free (to_set);
1744 talloc_free (to_clear);
1750 notmuch_message_remove_all_tags (notmuch_message_t *message)
1752 notmuch_private_status_t private_status;
1753 notmuch_status_t status;
1754 notmuch_tags_t *tags;
1757 status = _notmuch_database_ensure_writable (message->notmuch);
1761 for (tags = notmuch_message_get_tags (message);
1762 notmuch_tags_valid (tags);
1763 notmuch_tags_move_to_next (tags))
1765 tag = notmuch_tags_get (tags);
1767 private_status = _notmuch_message_remove_term (message, "tag", tag);
1768 if (private_status) {
1769 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1774 if (! message->frozen)
1775 _notmuch_message_sync (message);
1778 return NOTMUCH_STATUS_SUCCESS;
1782 notmuch_message_freeze (notmuch_message_t *message)
1784 notmuch_status_t status;
1786 status = _notmuch_database_ensure_writable (message->notmuch);
1792 return NOTMUCH_STATUS_SUCCESS;
1796 notmuch_message_thaw (notmuch_message_t *message)
1798 notmuch_status_t status;
1800 status = _notmuch_database_ensure_writable (message->notmuch);
1804 if (message->frozen > 0) {
1806 if (message->frozen == 0)
1807 _notmuch_message_sync (message);
1808 return NOTMUCH_STATUS_SUCCESS;
1810 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1815 notmuch_message_destroy (notmuch_message_t *message)
1817 talloc_free (message);
1820 notmuch_database_t *
1821 _notmuch_message_database (notmuch_message_t *message)
1823 return message->notmuch;
1827 _notmuch_message_ensure_property_map (notmuch_message_t *message)
1829 notmuch_string_node_t *node;
1831 if (message->property_map)
1834 if (!message->property_term_list)
1835 _notmuch_message_ensure_metadata (message);
1837 message->property_map = _notmuch_string_map_create (message);
1839 for (node = message->property_term_list->head; node; node = node->next) {
1843 value = index(node->string, '=');
1845 INTERNAL_ERROR ("malformed property term");
1851 _notmuch_string_map_append (message->property_map, key, value);
1855 talloc_free (message->property_term_list);
1856 message->property_term_list = NULL;
1859 notmuch_string_map_t *
1860 _notmuch_message_property_map (notmuch_message_t *message)
1862 _notmuch_message_ensure_property_map (message);
1864 return message->property_map;
1868 _notmuch_message_frozen (notmuch_message_t *message)
1870 return message->frozen;