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 http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-private.h"
22 #include "database-private.h"
26 #include <gmime/gmime.h>
28 struct _notmuch_message {
29 notmuch_database_t *notmuch;
35 notmuch_filename_list_t *filename_list;
37 notmuch_message_file_t *message_file;
38 notmuch_message_list_t *replies;
44 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
46 struct maildir_flag_tag {
52 /* ASCII ordered table of Maildir flags and associated tags */
53 static struct maildir_flag_tag flag2tag[] = {
54 { 'D', "draft", false},
55 { 'F', "flagged", false},
56 { 'P', "passed", false},
57 { 'R', "replied", false},
58 { 'S', "unread", true }
61 /* We end up having to call the destructor explicitly because we had
62 * to use "placement new" in order to initialize C++ objects within a
63 * block that we allocated with talloc. So C++ is making talloc
64 * slightly less simple to use, (we wouldn't need
65 * talloc_set_destructor at all otherwise).
68 _notmuch_message_destructor (notmuch_message_t *message)
70 message->doc.~Document ();
75 static notmuch_message_t *
76 _notmuch_message_create_for_document (const void *talloc_owner,
77 notmuch_database_t *notmuch,
80 notmuch_private_status_t *status)
82 notmuch_message_t *message;
85 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
87 message = talloc (talloc_owner, notmuch_message_t);
88 if (unlikely (message == NULL)) {
90 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
94 message->notmuch = notmuch;
95 message->doc_id = doc_id;
100 /* Each of these will be lazily created as needed. */
101 message->message_id = NULL;
102 message->thread_id = NULL;
103 message->in_reply_to = NULL;
104 message->filename_list = NULL;
105 message->message_file = NULL;
106 message->author = NULL;
108 message->replies = _notmuch_message_list_create (message);
109 if (unlikely (message->replies == NULL)) {
111 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
115 /* This is C++'s creepy "placement new", which is really just an
116 * ugly way to call a constructor for a pre-allocated object. So
117 * it's really not an error to not be checking for OUT_OF_MEMORY
118 * here, since this "new" isn't actually allocating memory. This
119 * is language-design comedy of the wrong kind. */
121 new (&message->doc) Xapian::Document;
123 talloc_set_destructor (message, _notmuch_message_destructor);
130 /* Create a new notmuch_message_t object for an existing document in
133 * Here, 'talloc owner' is an optional talloc context to which the new
134 * message will belong. This allows for the caller to not bother
135 * calling notmuch_message_destroy on the message, and no that all
136 * memory will be reclaimed with 'talloc_owner' is free. The caller
137 * still can call notmuch_message_destroy when finished with the
138 * message if desired.
140 * The 'talloc_owner' argument can also be NULL, in which case the
141 * caller *is* responsible for calling notmuch_message_destroy.
143 * If no document exists in the database with document ID of 'doc_id'
144 * then this function returns NULL and optionally sets *status to
145 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
147 * This function can also fail to due lack of available memory,
148 * returning NULL and optionally setting *status to
149 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
151 * The caller can pass NULL for status if uninterested in
152 * distinguishing these two cases.
155 _notmuch_message_create (const void *talloc_owner,
156 notmuch_database_t *notmuch,
158 notmuch_private_status_t *status)
160 Xapian::Document doc;
163 doc = notmuch->xapian_db->get_document (doc_id);
164 } catch (const Xapian::DocNotFoundError &error) {
166 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
170 return _notmuch_message_create_for_document (talloc_owner, notmuch,
171 doc_id, doc, status);
174 /* Create a new notmuch_message_t object for a specific message ID,
175 * (which may or may not already exist in the database).
177 * The 'notmuch' database will be the talloc owner of the returned
180 * This function returns a valid notmuch_message_t whether or not
181 * there is already a document in the database with the given message
182 * ID. These two cases can be distinguished by the value of *status:
185 * NOTMUCH_PRIVATE_STATUS_SUCCESS:
187 * There is already a document with message ID 'message_id' in the
188 * database. The returned message can be used to query/modify the
190 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
192 * No document with 'message_id' exists in the database. The
193 * returned message contains a newly created document (not yet
194 * added to the database) and a document ID that is known not to
195 * exist in the database. The caller can modify the message, and a
196 * call to _notmuch_message_sync will add * the document to the
199 * If an error occurs, this function will return NULL and *status
200 * will be set as appropriate. (The status pointer argument must
204 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
205 const char *message_id,
206 notmuch_private_status_t *status_ret)
208 notmuch_message_t *message;
209 Xapian::Document doc;
210 Xapian::WritableDatabase *db;
214 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
216 message = notmuch_database_find_message (notmuch, message_id);
218 return talloc_steal (notmuch, message);
220 term = talloc_asprintf (NULL, "%s%s",
221 _find_prefix ("id"), message_id);
223 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
227 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
228 INTERNAL_ERROR ("Failure to ensure database is writable.");
230 db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
232 doc.add_term (term, 0);
235 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
237 doc_id = _notmuch_database_generate_doc_id (notmuch);
238 } catch (const Xapian::Error &error) {
239 fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
240 error.get_msg().c_str());
241 notmuch->exception_reported = TRUE;
242 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
246 message = _notmuch_message_create_for_document (notmuch, notmuch,
247 doc_id, doc, status_ret);
249 /* We want to inform the caller that we had to create a new
251 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
252 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
258 notmuch_message_get_message_id (notmuch_message_t *message)
260 Xapian::TermIterator i;
262 if (message->message_id)
263 return message->message_id;
265 i = message->doc.termlist_begin ();
266 i.skip_to (_find_prefix ("id"));
268 if (i == message->doc.termlist_end ())
269 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
272 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
274 #if DEBUG_DATABASE_SANITY
277 if (i != message->doc.termlist_end () &&
278 strncmp ((*i).c_str (), _find_prefix ("id"),
279 strlen (_find_prefix ("id"))) == 0)
281 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
286 return message->message_id;
290 _notmuch_message_ensure_message_file (notmuch_message_t *message)
292 const char *filename;
294 if (message->message_file)
297 filename = notmuch_message_get_filename (message);
298 if (unlikely (filename == NULL))
301 message->message_file = _notmuch_message_file_open_ctx (message, filename);
305 notmuch_message_get_header (notmuch_message_t *message, const char *header)
307 _notmuch_message_ensure_message_file (message);
308 if (message->message_file == NULL)
311 return notmuch_message_file_get_header (message->message_file, header);
314 /* Return the message ID from the In-Reply-To header of 'message'.
316 * Returns an empty string ("") if 'message' has no In-Reply-To
319 * Returns NULL if any error occurs.
322 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
324 const char *prefix = _find_prefix ("replyto");
325 int prefix_len = strlen (prefix);
326 Xapian::TermIterator i;
327 std::string in_reply_to;
329 if (message->in_reply_to)
330 return message->in_reply_to;
332 i = message->doc.termlist_begin ();
335 if (i != message->doc.termlist_end ())
338 /* It's perfectly valid for a message to have no In-Reply-To
339 * header. For these cases, we return an empty string. */
340 if (i == message->doc.termlist_end () ||
341 strncmp (in_reply_to.c_str (), prefix, prefix_len))
343 message->in_reply_to = talloc_strdup (message, "");
344 return message->in_reply_to;
347 message->in_reply_to = talloc_strdup (message,
348 in_reply_to.c_str () + prefix_len);
350 #if DEBUG_DATABASE_SANITY
355 if (i != message->doc.termlist_end () &&
356 strncmp ((*i).c_str (), prefix, prefix_len) == 0)
358 INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n",
359 notmuch_message_get_message_id (message),
360 message->in_reply_to,
361 (*i).c_str () + prefix_len);
365 return message->in_reply_to;
369 notmuch_message_get_thread_id (notmuch_message_t *message)
371 const char *prefix = _find_prefix ("thread");
372 Xapian::TermIterator i;
375 /* This code is written with the assumption that "thread" has a
376 * single-character prefix. */
377 assert (strlen (prefix) == 1);
379 if (message->thread_id)
380 return message->thread_id;
382 i = message->doc.termlist_begin ();
385 if (i != message->doc.termlist_end ())
388 if (i == message->doc.termlist_end () || id[0] != *prefix)
389 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
392 message->thread_id = talloc_strdup (message, id.c_str () + 1);
394 #if DEBUG_DATABASE_SANITY
398 if (i != message->doc.termlist_end () && id[0] == *prefix)
400 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
401 notmuch_message_get_message_id (message),
407 return message->thread_id;
411 _notmuch_message_add_reply (notmuch_message_t *message,
412 notmuch_message_node_t *reply)
414 _notmuch_message_list_append (message->replies, reply);
418 notmuch_message_get_replies (notmuch_message_t *message)
420 return _notmuch_messages_create (message->replies);
423 /* Add an additional 'filename' for 'message'.
425 * This change will not be reflected in the database until the next
426 * call to _notmuch_message_sync. */
428 _notmuch_message_add_filename (notmuch_message_t *message,
429 const char *filename)
431 notmuch_status_t status;
432 void *local = talloc_new (message);
435 if (message->filename_list) {
436 _notmuch_filename_list_destroy (message->filename_list);
437 message->filename_list = NULL;
440 if (filename == NULL)
441 INTERNAL_ERROR ("Message filename cannot be NULL.");
443 status = _notmuch_database_filename_to_direntry (local,
445 filename, &direntry);
449 _notmuch_message_add_term (message, "file-direntry", direntry);
453 return NOTMUCH_STATUS_SUCCESS;
456 /* Change a particular filename for 'message' from 'old_filename' to
459 * This change will not be reflected in the database until the next
460 * call to _notmuch_message_sync.
462 static notmuch_status_t
463 _notmuch_message_rename (notmuch_message_t *message,
464 const char *old_filename,
465 const char *new_filename)
467 void *local = talloc_new (message);
469 notmuch_private_status_t private_status;
470 notmuch_status_t status;
472 status = _notmuch_message_add_filename (message, new_filename);
476 status = _notmuch_database_filename_to_direntry (local, message->notmuch,
477 old_filename, &direntry);
481 private_status = _notmuch_message_remove_term (message,
482 "file-direntry", direntry);
483 status = COERCE_STATUS (private_status,
484 "Unexpected error from _notmuch_message_remove_term");
492 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
494 return talloc_strdup (message, message->doc.get_data ().c_str ());
498 _notmuch_message_clear_data (notmuch_message_t *message)
500 message->doc.set_data ("");
504 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
506 const char *prefix = _find_prefix ("file-direntry");
507 int prefix_len = strlen (prefix);
508 Xapian::TermIterator i;
510 if (message->filename_list)
513 message->filename_list = _notmuch_filename_list_create (message);
515 i = message->doc.termlist_begin ();
518 if (i == message->doc.termlist_end () ||
519 strncmp ((*i).c_str (), prefix, prefix_len))
521 /* A message document created by an old version of notmuch
522 * (prior to rename support) will have the filename in the
523 * data of the document rather than as a file-direntry term.
525 * It would be nice to do the upgrade of the document directly
526 * here, but the database is likely open in read-only mode. */
529 data = message->doc.get_data ().c_str ();
532 INTERNAL_ERROR ("message with no filename");
534 _notmuch_filename_list_add_filename (message->filename_list, data);
539 for (; i != message->doc.termlist_end (); i++) {
540 void *local = talloc_new (message);
541 const char *db_path, *directory, *basename, *filename;
542 char *colon, *direntry = NULL;
543 unsigned int directory_id;
545 /* Terminate loop at first term without desired prefix. */
546 if (strncmp ((*i).c_str (), prefix, prefix_len))
549 direntry = talloc_strdup (local, (*i).c_str ());
551 direntry += prefix_len;
553 directory_id = strtol (direntry, &colon, 10);
555 if (colon == NULL || *colon != ':')
556 INTERNAL_ERROR ("malformed direntry");
558 basename = colon + 1;
562 db_path = notmuch_database_get_path (message->notmuch);
564 directory = _notmuch_database_get_directory_path (local,
568 if (strlen (directory))
569 filename = talloc_asprintf (message, "%s/%s/%s",
570 db_path, directory, basename);
572 filename = talloc_asprintf (message, "%s/%s",
575 _notmuch_filename_list_add_filename (message->filename_list,
583 notmuch_message_get_filename (notmuch_message_t *message)
585 _notmuch_message_ensure_filename_list (message);
587 if (message->filename_list == NULL)
590 if (message->filename_list->head == NULL ||
591 message->filename_list->head->filename == NULL)
593 INTERNAL_ERROR ("message with no filename");
596 return message->filename_list->head->filename;
599 notmuch_filenames_t *
600 notmuch_message_get_filenames (notmuch_message_t *message)
602 _notmuch_message_ensure_filename_list (message);
604 return _notmuch_filenames_create (message, message->filename_list);
608 notmuch_message_get_flag (notmuch_message_t *message,
609 notmuch_message_flag_t flag)
611 return message->flags & (1 << flag);
615 notmuch_message_set_flag (notmuch_message_t *message,
616 notmuch_message_flag_t flag, notmuch_bool_t enable)
619 message->flags |= (1 << flag);
621 message->flags &= ~(1 << flag);
625 notmuch_message_get_date (notmuch_message_t *message)
630 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
631 } catch (Xapian::Error &error) {
632 INTERNAL_ERROR ("Failed to read timestamp value from document.");
636 return Xapian::sortable_unserialise (value);
640 notmuch_message_get_tags (notmuch_message_t *message)
642 Xapian::TermIterator i, end;
643 i = message->doc.termlist_begin();
644 end = message->doc.termlist_end();
645 return _notmuch_convert_tags(message, i, end);
649 notmuch_message_get_author (notmuch_message_t *message)
651 return message->author;
655 notmuch_message_set_author (notmuch_message_t *message,
659 talloc_free(message->author);
660 message->author = talloc_strdup(message, author);
665 _notmuch_message_set_date (notmuch_message_t *message,
670 /* GMime really doesn't want to see a NULL date, so protect its
672 if (date == NULL || *date == '\0')
675 time_value = g_mime_utils_header_decode_date (date, NULL);
677 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
678 Xapian::sortable_serialise (time_value));
681 /* Synchronize changes made to message->doc out into the database. */
683 _notmuch_message_sync (notmuch_message_t *message)
685 Xapian::WritableDatabase *db;
687 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
690 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
691 db->replace_document (message->doc_id, message->doc);
694 /* Ensure that 'message' is not holding any file object open. Future
695 * calls to various functions will still automatically open the
696 * message file as needed.
699 _notmuch_message_close (notmuch_message_t *message)
701 if (message->message_file) {
702 notmuch_message_file_close (message->message_file);
703 message->message_file = NULL;
707 /* Add a name:value term to 'message', (the actual term will be
708 * encoded by prefixing the value with a short prefix). See
709 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
710 * names to prefix values.
712 * This change will not be reflected in the database until the next
713 * call to _notmuch_message_sync. */
714 notmuch_private_status_t
715 _notmuch_message_add_term (notmuch_message_t *message,
716 const char *prefix_name,
723 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
725 term = talloc_asprintf (message, "%s%s",
726 _find_prefix (prefix_name), value);
728 if (strlen (term) > NOTMUCH_TERM_MAX)
729 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
731 message->doc.add_term (term, 0);
735 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
738 /* Parse 'text' and add a term to 'message' for each parsed word. Each
739 * term will be added both prefixed (if prefix_name is not NULL) and
740 * also unprefixed). */
741 notmuch_private_status_t
742 _notmuch_message_gen_terms (notmuch_message_t *message,
743 const char *prefix_name,
746 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
749 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
751 term_gen->set_document (message->doc);
754 const char *prefix = _find_prefix (prefix_name);
756 term_gen->index_text (text, 1, prefix);
759 term_gen->index_text (text);
761 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
764 /* Remove a name:value term from 'message', (the actual term will be
765 * encoded by prefixing the value with a short prefix). See
766 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
767 * names to prefix values.
769 * This change will not be reflected in the database until the next
770 * call to _notmuch_message_sync. */
771 notmuch_private_status_t
772 _notmuch_message_remove_term (notmuch_message_t *message,
773 const char *prefix_name,
779 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
781 term = talloc_asprintf (message, "%s%s",
782 _find_prefix (prefix_name), value);
784 if (strlen (term) > NOTMUCH_TERM_MAX)
785 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
788 message->doc.remove_term (term);
789 } catch (const Xapian::InvalidArgumentError) {
790 /* We'll let the philosopher's try to wrestle with the
791 * question of whether failing to remove that which was not
792 * there in the first place is failure. For us, we'll silently
793 * consider it all good. */
798 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
802 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
804 notmuch_private_status_t private_status;
805 notmuch_status_t status;
807 status = _notmuch_database_ensure_writable (message->notmuch);
812 return NOTMUCH_STATUS_NULL_POINTER;
814 if (strlen (tag) > NOTMUCH_TAG_MAX)
815 return NOTMUCH_STATUS_TAG_TOO_LONG;
817 private_status = _notmuch_message_add_term (message, "tag", tag);
818 if (private_status) {
819 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
823 if (! message->frozen)
824 _notmuch_message_sync (message);
826 return NOTMUCH_STATUS_SUCCESS;
830 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
832 notmuch_private_status_t private_status;
833 notmuch_status_t status;
835 status = _notmuch_database_ensure_writable (message->notmuch);
840 return NOTMUCH_STATUS_NULL_POINTER;
842 if (strlen (tag) > NOTMUCH_TAG_MAX)
843 return NOTMUCH_STATUS_TAG_TOO_LONG;
845 private_status = _notmuch_message_remove_term (message, "tag", tag);
846 if (private_status) {
847 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
851 if (! message->frozen)
852 _notmuch_message_sync (message);
854 return NOTMUCH_STATUS_SUCCESS;
858 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
861 notmuch_status_t status;
862 notmuch_filenames_t *filenames;
863 const char *filename;
864 char *combined_flags = talloc_strdup (message, "");
866 int seen_maildir_info = 0;
868 for (filenames = notmuch_message_get_filenames (message);
869 notmuch_filenames_valid (filenames);
870 notmuch_filenames_move_to_next (filenames))
872 filename = notmuch_filenames_get (filenames);
874 flags = strstr (filename, ":2,");
878 seen_maildir_info = 1;
881 combined_flags = talloc_strdup_append (combined_flags, flags);
884 /* If none of the filenames have any maildir info field (not even
885 * an empty info with no flags set) then there's no information to
886 * go on, so do nothing. */
887 if (! seen_maildir_info)
888 return NOTMUCH_STATUS_SUCCESS;
890 status = notmuch_message_freeze (message);
894 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
895 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
899 status = notmuch_message_add_tag (message, flag2tag[i].tag);
901 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
906 status = notmuch_message_thaw (message);
908 talloc_free (combined_flags);
913 /* Is the given filename within a maildir directory?
915 * Specifically, is the final directory component of 'filename' either
916 * "cur" or "new". If so, return a pointer to that final directory
917 * component within 'filename'. If not, return NULL.
919 * A non-NULL return value is guaranteed to be a valid string pointer
920 * pointing to the characters "new/" or "cur/", (but not
924 _filename_is_in_maildir (const char *filename)
926 const char *slash, *dir = NULL;
928 /* Find the last '/' separating directory from filename. */
929 slash = strrchr (filename, '/');
933 /* Jump back 4 characters to where the previous '/' will be if the
934 * directory is named "cur" or "new". */
935 if (slash - filename < 4)
945 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
946 STRNCMP_LITERAL (dir, "new/") == 0)
954 /* From the set of tags on 'message' and the flag2tag table, compute a
955 * set of maildir-flag actions to be taken, (flags that should be
956 * either set or cleared).
958 * The result is returned as two talloced strings: to_set, and to_clear
961 _get_maildir_flag_actions (notmuch_message_t *message,
965 char *to_set, *to_clear;
966 notmuch_tags_t *tags;
970 to_set = talloc_strdup (message, "");
971 to_clear = talloc_strdup (message, "");
973 /* First, find flags for all set tags. */
974 for (tags = notmuch_message_get_tags (message);
975 notmuch_tags_valid (tags);
976 notmuch_tags_move_to_next (tags))
978 tag = notmuch_tags_get (tags);
980 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
981 if (strcmp (tag, flag2tag[i].tag) == 0) {
982 if (flag2tag[i].inverse)
983 to_clear = talloc_asprintf_append (to_clear,
987 to_set = talloc_asprintf_append (to_set,
994 /* Then, find the flags for all tags not present. */
995 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
996 if (flag2tag[i].inverse) {
997 if (strchr (to_clear, flag2tag[i].flag) == NULL)
998 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1000 if (strchr (to_set, flag2tag[i].flag) == NULL)
1001 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1005 *to_set_ret = to_set;
1006 *to_clear_ret = to_clear;
1009 /* Given 'filename' and a set of maildir flags to set and to clear,
1010 * compute the new maildir filename.
1012 * If the existing filename is in the directory "new", the new
1013 * filename will be in the directory "cur".
1015 * After a sequence of ":2," in the filename, any subsequent
1016 * single-character flags will be added or removed according to the
1017 * characters in flags_to_set and flags_to_clear. Any existing flags
1018 * not mentioned in either string will remain. The final list of flags
1019 * will be in ASCII order.
1021 * If the original flags seem invalid, (repeated characters or
1022 * non-ASCII ordering of flags), this function will return NULL
1023 * (meaning that renaming would not be safe and should not occur).
1026 _new_maildir_filename (void *ctx,
1027 const char *filename,
1028 const char *flags_to_set,
1029 const char *flags_to_clear)
1031 const char *info, *flags;
1032 unsigned int flag, last_flag;
1033 char *filename_new, *dir;
1035 int flags_in_map = 0;
1039 memset (flag_map, 0, sizeof (flag_map));
1041 info = strstr (filename, ":2,");
1044 info = filename + strlen(filename);
1048 /* Loop through existing flags in filename. */
1049 for (flags = info + 3, last_flag = 0;
1051 last_flag = flag, flags++)
1055 /* Original flags not in ASCII order. Abort. */
1056 if (flag < last_flag)
1059 /* Non-ASCII flag. Abort. */
1060 if (flag > sizeof(flag_map) - 1)
1063 /* Repeated flag value. Abort. */
1072 /* Then set and clear our flags from tags. */
1073 for (flags = flags_to_set; *flags; flags++) {
1075 if (flag_map[flag] == 0) {
1081 for (flags = flags_to_clear; *flags; flags++) {
1083 if (flag_map[flag]) {
1089 filename_new = (char *) talloc_size (ctx,
1091 strlen (":2,") + flags_in_map + 1);
1092 if (unlikely (filename_new == NULL))
1095 strncpy (filename_new, filename, info - filename);
1096 filename_new[info - filename] = '\0';
1098 strcat (filename_new, ":2,");
1100 s = filename_new + strlen (filename_new);
1101 for (i = 0; i < sizeof (flag_map); i++)
1110 /* If message is in new/ move it under cur/. */
1111 dir = (char *) _filename_is_in_maildir (filename_new);
1112 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1113 memcpy (dir, "cur/", 4);
1115 return filename_new;
1119 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1121 notmuch_filenames_t *filenames;
1122 const char *filename;
1124 char *to_set, *to_clear;
1125 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1127 _get_maildir_flag_actions (message, &to_set, &to_clear);
1129 for (filenames = notmuch_message_get_filenames (message);
1130 notmuch_filenames_valid (filenames);
1131 notmuch_filenames_move_to_next (filenames))
1133 filename = notmuch_filenames_get (filenames);
1135 if (! _filename_is_in_maildir (filename))
1138 filename_new = _new_maildir_filename (message, filename,
1140 if (filename_new == NULL)
1143 if (strcmp (filename, filename_new)) {
1145 notmuch_status_t new_status;
1147 err = rename (filename, filename_new);
1151 new_status = _notmuch_message_rename (message,
1152 filename, filename_new);
1153 /* Hold on to only the first error. */
1154 if (! status && new_status) {
1155 status = new_status;
1159 _notmuch_message_sync (message);
1162 talloc_free (filename_new);
1165 talloc_free (to_set);
1166 talloc_free (to_clear);
1168 return NOTMUCH_STATUS_SUCCESS;
1172 notmuch_message_remove_all_tags (notmuch_message_t *message)
1174 notmuch_private_status_t private_status;
1175 notmuch_status_t status;
1176 notmuch_tags_t *tags;
1179 status = _notmuch_database_ensure_writable (message->notmuch);
1183 for (tags = notmuch_message_get_tags (message);
1184 notmuch_tags_valid (tags);
1185 notmuch_tags_move_to_next (tags))
1187 tag = notmuch_tags_get (tags);
1189 private_status = _notmuch_message_remove_term (message, "tag", tag);
1190 if (private_status) {
1191 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1196 if (! message->frozen)
1197 _notmuch_message_sync (message);
1199 return NOTMUCH_STATUS_SUCCESS;
1203 notmuch_message_freeze (notmuch_message_t *message)
1205 notmuch_status_t status;
1207 status = _notmuch_database_ensure_writable (message->notmuch);
1213 return NOTMUCH_STATUS_SUCCESS;
1217 notmuch_message_thaw (notmuch_message_t *message)
1219 notmuch_status_t status;
1221 status = _notmuch_database_ensure_writable (message->notmuch);
1225 if (message->frozen > 0) {
1227 if (message->frozen == 0)
1228 _notmuch_message_sync (message);
1229 return NOTMUCH_STATUS_SUCCESS;
1231 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1236 notmuch_message_destroy (notmuch_message_t *message)
1238 talloc_free (message);