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 _notmuch_message {
30 notmuch_database_t *notmuch;
37 notmuch_string_list_t *tag_list;
38 notmuch_string_list_t *filename_term_list;
39 notmuch_string_list_t *filename_list;
42 notmuch_message_file_t *message_file;
43 notmuch_string_list_t *property_term_list;
44 notmuch_string_map_t *property_map;
45 notmuch_string_list_t *reference_list;
46 notmuch_message_list_t *replies;
48 /* For flags that are initialized on-demand, lazy_flags indicates
49 * if each flag has been initialized. */
50 unsigned long lazy_flags;
52 /* Message document modified since last sync */
55 /* last view of database the struct is synced with */
56 unsigned long last_view;
59 Xapian::termcount termpos;
62 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
64 struct maildir_flag_tag {
70 /* ASCII ordered table of Maildir flags and associated tags */
71 static struct maildir_flag_tag flag2tag[] = {
72 { 'D', "draft", false },
73 { 'F', "flagged", false },
74 { 'P', "passed", false },
75 { 'R', "replied", false },
76 { 'S', "unread", true }
79 /* We end up having to call the destructor explicitly because we had
80 * to use "placement new" in order to initialize C++ objects within a
81 * block that we allocated with talloc. So C++ is making talloc
82 * slightly less simple to use, (we wouldn't need
83 * talloc_set_destructor at all otherwise).
86 _notmuch_message_destructor (notmuch_message_t *message)
88 message->doc.~Document ();
93 #define LOG_XAPIAN_EXCEPTION(message, error) _log_xapian_exception (__location__, message, error)
96 _log_xapian_exception (const char *where, notmuch_message_t *message, const Xapian::Error error) {
97 notmuch_database_t *notmuch = notmuch_message_get_database (message);
98 _notmuch_database_log (notmuch,
99 "A Xapian exception occurred %s retrieving %s : %s\n",
101 error.get_msg ().c_str ());
102 notmuch->exception_reported = true;
105 static notmuch_message_t *
106 _notmuch_message_create_for_document (const void *talloc_owner,
107 notmuch_database_t *notmuch,
109 Xapian::Document doc,
110 notmuch_private_status_t *status)
112 notmuch_message_t *message;
115 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
117 message = talloc (talloc_owner, notmuch_message_t);
118 if (unlikely (message == NULL)) {
120 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
124 message->notmuch = notmuch;
125 message->doc_id = doc_id;
129 message->lazy_flags = 0;
131 /* the message is initially not synchronized with Xapian */
132 message->last_view = 0;
134 /* Calculated after the thread structure is computed */
135 message->thread_depth = 0;
137 /* Each of these will be lazily created as needed. */
138 message->message_id = NULL;
139 message->thread_id = NULL;
140 message->in_reply_to = NULL;
141 message->tag_list = NULL;
142 message->filename_term_list = NULL;
143 message->filename_list = NULL;
144 message->maildir_flags = NULL;
145 message->message_file = NULL;
146 message->author = NULL;
147 message->property_term_list = NULL;
148 message->property_map = NULL;
149 message->reference_list = NULL;
151 message->replies = _notmuch_message_list_create (message);
152 if (unlikely (message->replies == NULL)) {
154 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
158 /* This is C++'s creepy "placement new", which is really just an
159 * ugly way to call a constructor for a pre-allocated object. So
160 * it's really not an error to not be checking for OUT_OF_MEMORY
161 * here, since this "new" isn't actually allocating memory. This
162 * is language-design comedy of the wrong kind. */
164 new (&message->doc) Xapian::Document;
166 talloc_set_destructor (message, _notmuch_message_destructor);
169 message->termpos = 0;
174 /* Create a new notmuch_message_t object for an existing document in
177 * Here, 'talloc owner' is an optional talloc context to which the new
178 * message will belong. This allows for the caller to not bother
179 * calling notmuch_message_destroy on the message, and know that all
180 * memory will be reclaimed when 'talloc_owner' is freed. The caller
181 * still can call notmuch_message_destroy when finished with the
182 * message if desired.
184 * The 'talloc_owner' argument can also be NULL, in which case the
185 * caller *is* responsible for calling notmuch_message_destroy.
187 * If no document exists in the database with document ID of 'doc_id'
188 * then this function returns NULL and optionally sets *status to
189 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
191 * This function can also fail to due lack of available memory,
192 * returning NULL and optionally setting *status to
193 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
195 * The caller can pass NULL for status if uninterested in
196 * distinguishing these two cases.
199 _notmuch_message_create (const void *talloc_owner,
200 notmuch_database_t *notmuch,
202 notmuch_private_status_t *status)
204 Xapian::Document doc;
207 doc = notmuch->xapian_db->get_document (doc_id);
208 } catch (const Xapian::DocNotFoundError &error) {
210 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
214 return _notmuch_message_create_for_document (talloc_owner, notmuch,
215 doc_id, doc, status);
218 /* Create a new notmuch_message_t object for a specific message ID,
219 * (which may or may not already exist in the database).
221 * The 'notmuch' database will be the talloc owner of the returned
224 * This function returns a valid notmuch_message_t whether or not
225 * there is already a document in the database with the given message
226 * ID. These two cases can be distinguished by the value of *status:
229 * NOTMUCH_PRIVATE_STATUS_SUCCESS:
231 * There is already a document with message ID 'message_id' in the
232 * database. The returned message can be used to query/modify the
233 * document. The message may be a ghost message.
235 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
237 * No document with 'message_id' exists in the database. The
238 * returned message contains a newly created document (not yet
239 * added to the database) and a document ID that is known not to
240 * exist in the database. This message is "blank"; that is, it
241 * contains only a message ID and no other metadata. The caller
242 * can modify the message, and a call to _notmuch_message_sync
243 * will add the document to the database.
245 * If an error occurs, this function will return NULL and *status
246 * will be set as appropriate. (The status pointer argument must
250 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
251 const char *message_id,
252 notmuch_private_status_t *status_ret)
254 notmuch_message_t *message;
255 Xapian::Document doc;
259 *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
263 return talloc_steal (notmuch, message);
264 else if (*status_ret)
267 /* If the message ID is too long, substitute its sha1 instead. */
268 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
269 message_id = _notmuch_message_id_compressed (message, message_id);
271 term = talloc_asprintf (NULL, "%s%s",
272 _find_prefix ("id"), message_id);
274 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
278 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
279 INTERNAL_ERROR ("Failure to ensure database is writable.");
282 doc.add_term (term, 0);
285 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
287 doc_id = _notmuch_database_generate_doc_id (notmuch);
288 } catch (const Xapian::Error &error) {
289 _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred creating message: %s\n",
290 error.get_msg ().c_str ());
291 notmuch->exception_reported = true;
292 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
296 message = _notmuch_message_create_for_document (notmuch, notmuch,
297 doc_id, doc, status_ret);
299 /* We want to inform the caller that we had to create a new
301 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
302 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
308 _notmuch_message_get_term (notmuch_message_t *message,
309 Xapian::TermIterator &i, Xapian::TermIterator &end,
312 int prefix_len = strlen (prefix);
320 const std::string &term = *i;
321 if (strncmp (term.c_str (), prefix, prefix_len))
324 value = talloc_strdup (message, term.c_str () + prefix_len);
326 #if DEBUG_DATABASE_SANITY
329 if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
330 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
331 message->doc_id, prefix, value,
332 (*i).c_str () + prefix_len);
340 * For special applications where we only want the thread id, reading
341 * in all metadata is a heavy I/O penalty.
344 _notmuch_message_get_thread_id_only (notmuch_message_t *message)
347 Xapian::TermIterator i = message->doc.termlist_begin ();
348 Xapian::TermIterator end = message->doc.termlist_end ();
350 message->thread_id = _notmuch_message_get_term (message, i, end,
351 _find_prefix ("thread"));
352 return message->thread_id;
357 _notmuch_message_ensure_metadata (notmuch_message_t *message, void *field)
359 Xapian::TermIterator i, end;
361 if (field && (message->last_view >= message->notmuch->view))
364 const char *thread_prefix = _find_prefix ("thread"),
365 *tag_prefix = _find_prefix ("tag"),
366 *id_prefix = _find_prefix ("id"),
367 *type_prefix = _find_prefix ("type"),
368 *filename_prefix = _find_prefix ("file-direntry"),
369 *property_prefix = _find_prefix ("property"),
370 *reference_prefix = _find_prefix ("reference"),
371 *replyto_prefix = _find_prefix ("replyto");
373 /* We do this all in a single pass because Xapian decompresses the
374 * term list every time you iterate over it. Thus, while this is
375 * slightly more costly than looking up individual fields if only
376 * one field of the message object is actually used, it's a huge
377 * win as more fields are used. */
378 for (int count = 0; count < 3; count++) {
380 i = message->doc.termlist_begin ();
381 end = message->doc.termlist_end ();
384 if (! message->thread_id)
386 _notmuch_message_get_term (message, i, end, thread_prefix);
389 assert (strcmp (thread_prefix, tag_prefix) < 0);
390 if (! message->tag_list) {
392 _notmuch_database_get_terms_with_prefix (message, i, end,
394 _notmuch_string_list_sort (message->tag_list);
398 assert (strcmp (tag_prefix, id_prefix) < 0);
399 if (! message->message_id)
400 message->message_id =
401 _notmuch_message_get_term (message, i, end, id_prefix);
403 /* Get document type */
404 assert (strcmp (id_prefix, type_prefix) < 0);
405 if (! NOTMUCH_TEST_BIT (message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST)) {
406 i.skip_to (type_prefix);
407 /* "T" is the prefix "type" fields. See
408 * BOOLEAN_PREFIX_INTERNAL. */
410 NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
411 else if (*i == "Tghost")
412 NOTMUCH_SET_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
414 INTERNAL_ERROR ("Message without type term");
415 NOTMUCH_SET_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
418 /* Get filename list. Here we get only the terms. We lazily
419 * expand them to full file names when needed in
420 * _notmuch_message_ensure_filename_list. */
421 assert (strcmp (type_prefix, filename_prefix) < 0);
422 if (! message->filename_term_list && ! message->filename_list)
423 message->filename_term_list =
424 _notmuch_database_get_terms_with_prefix (message, i, end,
428 /* Get property terms. Mimic the setup with filenames above */
429 assert (strcmp (filename_prefix, property_prefix) < 0);
430 if (! message->property_map && ! message->property_term_list)
431 message->property_term_list =
432 _notmuch_database_get_terms_with_prefix (message, i, end,
436 assert (strcmp (property_prefix, reference_prefix) < 0);
437 if (! message->reference_list) {
438 message->reference_list =
439 _notmuch_database_get_terms_with_prefix (message, i, end,
444 assert (strcmp (property_prefix, replyto_prefix) < 0);
445 if (! message->in_reply_to)
446 message->in_reply_to =
447 _notmuch_message_get_term (message, i, end, replyto_prefix);
450 /* It's perfectly valid for a message to have no In-Reply-To
451 * header. For these cases, we return an empty string. */
452 if (! message->in_reply_to)
453 message->in_reply_to = talloc_strdup (message, "");
455 /* all the way without an exception */
457 } catch (const Xapian::DatabaseModifiedError &error) {
458 notmuch_status_t status = _notmuch_database_reopen (message->notmuch);
459 if (status != NOTMUCH_STATUS_SUCCESS)
460 INTERNAL_ERROR ("unhandled error from notmuch_database_reopen: %s\n",
461 notmuch_status_to_string (status));
464 message->last_view = message->notmuch->view;
468 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
469 const char *prefix_name)
471 if (strcmp ("thread", prefix_name) == 0) {
472 talloc_free (message->thread_id);
473 message->thread_id = NULL;
476 if (strcmp ("tag", prefix_name) == 0) {
477 talloc_unlink (message, message->tag_list);
478 message->tag_list = NULL;
481 if (strcmp ("type", prefix_name) == 0) {
482 NOTMUCH_CLEAR_BIT (&message->flags, NOTMUCH_MESSAGE_FLAG_GHOST);
483 NOTMUCH_CLEAR_BIT (&message->lazy_flags, NOTMUCH_MESSAGE_FLAG_GHOST);
486 if (strcmp ("file-direntry", prefix_name) == 0) {
487 talloc_free (message->filename_term_list);
488 talloc_free (message->filename_list);
489 message->filename_term_list = message->filename_list = NULL;
492 if (strcmp ("property", prefix_name) == 0) {
494 if (message->property_term_list)
495 talloc_free (message->property_term_list);
496 message->property_term_list = NULL;
498 if (message->property_map)
499 talloc_unlink (message, message->property_map);
501 message->property_map = NULL;
504 if (strcmp ("replyto", prefix_name) == 0) {
505 talloc_free (message->in_reply_to);
506 message->in_reply_to = NULL;
511 _notmuch_message_get_doc_id (notmuch_message_t *message)
513 return message->doc_id;
517 notmuch_message_get_message_id (notmuch_message_t *message)
520 _notmuch_message_ensure_metadata (message, message->message_id);
521 } catch (const Xapian::Error &error) {
522 LOG_XAPIAN_EXCEPTION (message, error);
526 if (! message->message_id)
527 INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
529 return message->message_id;
533 _notmuch_message_ensure_message_file (notmuch_message_t *message)
535 const char *filename;
537 if (message->message_file)
540 filename = notmuch_message_get_filename (message);
541 if (unlikely (filename == NULL))
544 message->message_file = _notmuch_message_file_open_ctx (
545 notmuch_message_get_database (message), message, filename);
549 notmuch_message_get_header (notmuch_message_t *message, const char *header)
551 Xapian::valueno slot = Xapian::BAD_VALUENO;
553 /* Fetch header from the appropriate xapian value field if
555 if (strcasecmp (header, "from") == 0)
556 slot = NOTMUCH_VALUE_FROM;
557 else if (strcasecmp (header, "subject") == 0)
558 slot = NOTMUCH_VALUE_SUBJECT;
559 else if (strcasecmp (header, "message-id") == 0)
560 slot = NOTMUCH_VALUE_MESSAGE_ID;
562 if (slot != Xapian::BAD_VALUENO) {
564 std::string value = message->doc.get_value (slot);
566 /* If we have NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES, then
567 * empty values indicate empty headers. If we don't, then
568 * it could just mean we didn't record the header. */
569 if ((message->notmuch->features &
570 NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES) ||
572 return talloc_strdup (message, value.c_str ());
574 } catch (Xapian::Error &error) {
575 _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred when reading header: %s\n",
576 error.get_msg ().c_str ());
577 message->notmuch->exception_reported = true;
582 /* Otherwise fall back to parsing the file */
583 _notmuch_message_ensure_message_file (message);
584 if (message->message_file == NULL)
587 return _notmuch_message_file_get_header (message->message_file, header);
590 /* Return the message ID from the In-Reply-To header of 'message'.
592 * Returns an empty string ("") if 'message' has no In-Reply-To
595 * Returns NULL if any error occurs.
598 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
600 _notmuch_message_ensure_metadata (message, message->in_reply_to);
601 return message->in_reply_to;
605 notmuch_message_get_thread_id (notmuch_message_t *message)
608 _notmuch_message_ensure_metadata (message, message->thread_id);
609 } catch (Xapian::Error &error) {
610 LOG_XAPIAN_EXCEPTION (message, error);
613 if (! message->thread_id)
614 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
616 return message->thread_id;
620 _notmuch_message_add_reply (notmuch_message_t *message,
621 notmuch_message_t *reply)
623 _notmuch_message_list_add_message (message->replies, reply);
627 _notmuch_message_get_thread_depth (notmuch_message_t *message)
629 return message->thread_depth;
633 _notmuch_message_label_depths (notmuch_message_t *message,
636 message->thread_depth = depth;
638 for (notmuch_messages_t *messages = _notmuch_messages_create (message->replies);
639 notmuch_messages_valid (messages);
640 notmuch_messages_move_to_next (messages)) {
641 notmuch_message_t *child = notmuch_messages_get (messages);
642 _notmuch_message_label_depths (child, depth + 1);
646 const notmuch_string_list_t *
647 _notmuch_message_get_references (notmuch_message_t *message)
649 _notmuch_message_ensure_metadata (message, message->reference_list);
650 return message->reference_list;
654 _cmpmsg (const void *pa, const void *pb)
656 notmuch_message_t **a = (notmuch_message_t **) pa;
657 notmuch_message_t **b = (notmuch_message_t **) pb;
658 time_t time_a = notmuch_message_get_date (*a);
659 time_t time_b = notmuch_message_get_date (*b);
661 if (time_a == time_b)
663 else if (time_a < time_b)
669 notmuch_message_list_t *
670 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list)
674 size_t capacity = 16;
679 void *local = talloc_new (NULL);
680 notmuch_message_list_t *new_list = _notmuch_message_list_create (ctx);
681 notmuch_message_t **message_array = talloc_zero_array (local, notmuch_message_t *, capacity);
683 for (notmuch_messages_t *messages = _notmuch_messages_create (list);
684 notmuch_messages_valid (messages);
685 notmuch_messages_move_to_next (messages)) {
686 notmuch_message_t *root = notmuch_messages_get (messages);
687 if (count >= capacity) {
689 message_array = talloc_realloc (local, message_array, notmuch_message_t *, capacity);
691 message_array[count++] = root;
692 root->replies = _notmuch_message_sort_subtrees (root, root->replies);
695 qsort (message_array, count, sizeof (notmuch_message_t *), _cmpmsg);
696 for (size_t i = 0; i < count; i++) {
697 _notmuch_message_list_add_message (new_list, message_array[i]);
706 notmuch_message_get_replies (notmuch_message_t *message)
708 return _notmuch_messages_create (message->replies);
712 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
714 Xapian::TermIterator i;
715 size_t prefix_len = 0;
717 prefix_len = strlen (prefix);
720 i = message->doc.termlist_begin ();
723 /* Terminate loop when no terms remain with desired prefix. */
724 if (i == message->doc.termlist_end () ||
725 strncmp ((*i).c_str (), prefix, prefix_len))
729 message->doc.remove_term ((*i));
730 message->modified = true;
731 } catch (const Xapian::InvalidArgumentError) {
732 /* Ignore failure to remove non-existent term. */
738 /* Remove all terms generated by indexing, i.e. not tags or
739 * properties, along with any automatic tags*/
740 /* According to Xapian API docs, none of these calls throw
742 notmuch_private_status_t
743 _notmuch_message_remove_indexed_terms (notmuch_message_t *message)
745 Xapian::TermIterator i;
748 id_prefix = _find_prefix ("id"),
749 property_prefix = _find_prefix ("property"),
750 tag_prefix = _find_prefix ("tag"),
751 type_prefix = _find_prefix ("type");
753 /* Make sure we have the data to restore to Xapian*/
754 _notmuch_message_ensure_metadata (message, NULL);
756 /* Empirically, it turns out to be faster to remove all the terms,
757 * and add back the ones we want. */
758 message->doc.clear_terms ();
759 message->modified = true;
761 /* still a mail message */
762 message->doc.add_term (type_prefix + "mail");
764 /* Put back message-id */
765 message->doc.add_term (id_prefix + message->message_id);
767 /* Put back non-automatic tags */
768 for (notmuch_tags_t *tags = notmuch_message_get_tags (message);
769 notmuch_tags_valid (tags);
770 notmuch_tags_move_to_next (tags)) {
772 const char *tag = notmuch_tags_get (tags);
774 if (strcmp (tag, "encrypted") != 0 &&
775 strcmp (tag, "signed") != 0 &&
776 strcmp (tag, "attachment") != 0) {
777 std::string term = tag_prefix + tag;
778 message->doc.add_term (term);
782 /* Put back properties */
783 notmuch_message_properties_t *list;
785 for (list = notmuch_message_get_properties (message, "", false);
786 notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
787 std::string term = property_prefix +
788 notmuch_message_properties_key (list) + "=" +
789 notmuch_message_properties_value (list);
791 message->doc.add_term (term);
794 notmuch_message_properties_destroy (list);
796 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
800 /* Return true if p points at "new" or "cur". */
802 is_maildir (const char *p)
804 return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
807 /* Add "folder:" term for directory. */
808 static notmuch_status_t
809 _notmuch_message_add_folder_terms (notmuch_message_t *message,
810 const char *directory)
814 folder = talloc_strdup (NULL, directory);
816 return NOTMUCH_STATUS_OUT_OF_MEMORY;
819 * If the message file is in a leaf directory named "new" or
820 * "cur", presume maildir and index the parent directory. Thus a
821 * "folder:" prefix search matches messages in the specified
822 * maildir folder, i.e. in the specified directory and its "new"
823 * and "cur" subdirectories.
825 * Note that this means the "folder:" prefix can't be used for
826 * distinguishing between message files in "new" or "cur". The
827 * "path:" prefix needs to be used for that.
829 * Note the deliberate difference to _filename_is_in_maildir(). We
830 * don't want to index different things depending on the existence
831 * or non-existence of all maildir sibling directories "new",
832 * "cur", and "tmp". Doing so would be surprising, and difficult
833 * for the user to fix in case all subdirectories were not in
834 * place during indexing.
836 last = strrchr (folder, '/');
838 if (is_maildir (last + 1))
840 } else if (is_maildir (folder)) {
844 _notmuch_message_add_term (message, "folder", folder);
846 talloc_free (folder);
848 message->modified = true;
849 return NOTMUCH_STATUS_SUCCESS;
852 #define RECURSIVE_SUFFIX "/**"
854 /* Add "path:" terms for directory. */
855 static notmuch_status_t
856 _notmuch_message_add_path_terms (notmuch_message_t *message,
857 const char *directory)
859 /* Add exact "path:" term. */
860 _notmuch_message_add_term (message, "path", directory);
862 if (strlen (directory)) {
865 path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
867 return NOTMUCH_STATUS_OUT_OF_MEMORY;
869 /* Add recursive "path:" terms for directory and all parents. */
870 for (p = path + strlen (path) - 1; p > path; p--) {
872 strcpy (p, RECURSIVE_SUFFIX);
873 _notmuch_message_add_term (message, "path", path);
880 /* Recursive all-matching path:** for consistency. */
881 _notmuch_message_add_term (message, "path", "**");
883 return NOTMUCH_STATUS_SUCCESS;
886 /* Add directory based terms for all filenames of the message. */
887 static notmuch_status_t
888 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
890 const char *direntry_prefix = _find_prefix ("file-direntry");
891 int direntry_prefix_len = strlen (direntry_prefix);
892 Xapian::TermIterator i = message->doc.termlist_begin ();
893 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
895 for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
896 unsigned int directory_id;
897 const char *direntry, *directory;
899 const std::string &term = *i;
901 /* Terminate loop at first term without desired prefix. */
902 if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
905 /* Indicate that there are filenames remaining. */
906 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
908 direntry = term.c_str ();
909 direntry += direntry_prefix_len;
911 directory_id = strtol (direntry, &colon, 10);
913 if (colon == NULL || *colon != ':')
914 INTERNAL_ERROR ("malformed direntry");
916 directory = _notmuch_database_get_directory_path (ctx,
920 _notmuch_message_add_folder_terms (message, directory);
921 _notmuch_message_add_path_terms (message, directory);
927 /* Add an additional 'filename' for 'message'.
929 * This change will not be reflected in the database until the next
930 * call to _notmuch_message_sync. */
932 _notmuch_message_add_filename (notmuch_message_t *message,
933 const char *filename)
935 const char *relative, *directory;
936 notmuch_status_t status;
937 void *local = talloc_new (message);
940 if (filename == NULL)
941 INTERNAL_ERROR ("Message filename cannot be NULL.");
943 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
944 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
945 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
947 relative = _notmuch_database_relative_path (message->notmuch, filename);
949 status = _notmuch_database_split_path (local, relative, &directory, NULL);
953 status = _notmuch_database_filename_to_direntry (
954 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
958 /* New file-direntry allows navigating to this message with
959 * notmuch_directory_get_child_files() . */
960 _notmuch_message_add_term (message, "file-direntry", direntry);
962 _notmuch_message_add_folder_terms (message, directory);
963 _notmuch_message_add_path_terms (message, directory);
967 return NOTMUCH_STATUS_SUCCESS;
970 /* Remove a particular 'filename' from 'message'.
972 * This change will not be reflected in the database until the next
973 * call to _notmuch_message_sync.
975 * If this message still has other filenames, returns
976 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
978 * Note: This function does not remove a document from the database,
979 * even if the specified filename is the only filename for this
980 * message. For that functionality, see
981 * notmuch_database_remove_message. */
983 _notmuch_message_remove_filename (notmuch_message_t *message,
984 const char *filename)
986 void *local = talloc_new (message);
988 notmuch_private_status_t private_status;
989 notmuch_status_t status;
991 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
992 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
993 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
995 status = _notmuch_database_filename_to_direntry (
996 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
997 if (status || ! direntry)
1000 /* Unlink this file from its parent directory. */
1001 private_status = _notmuch_message_remove_term (message,
1002 "file-direntry", direntry);
1003 status = COERCE_STATUS (private_status,
1004 "Unexpected error from _notmuch_message_remove_term");
1008 /* Re-synchronize "folder:" and "path:" terms for this message. */
1010 /* Remove all "folder:" terms. */
1011 _notmuch_message_remove_terms (message, _find_prefix ("folder"));
1013 /* Remove all "path:" terms. */
1014 _notmuch_message_remove_terms (message, _find_prefix ("path"));
1016 /* Add back terms for all remaining filenames of the message. */
1017 status = _notmuch_message_add_directory_terms (local, message);
1019 talloc_free (local);
1024 /* Upgrade the "folder:" prefix from V1 to V2. */
1025 #define FOLDER_PREFIX_V1 "XFOLDER"
1026 #define ZFOLDER_PREFIX_V1 "Z" FOLDER_PREFIX_V1
1028 _notmuch_message_upgrade_folder (notmuch_message_t *message)
1030 /* Remove all old "folder:" terms. */
1031 _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
1033 /* Remove all old "folder:" stemmed terms. */
1034 _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
1036 /* Add new boolean "folder:" and "path:" terms. */
1037 _notmuch_message_add_directory_terms (message, message);
1041 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
1043 return talloc_strdup (message, message->doc.get_data ().c_str ());
1047 _notmuch_message_clear_data (notmuch_message_t *message)
1049 message->doc.set_data ("");
1050 message->modified = true;
1054 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
1056 notmuch_string_node_t *node;
1058 if (message->filename_list)
1061 _notmuch_message_ensure_metadata (message, message->filename_term_list);
1063 message->filename_list = _notmuch_string_list_create (message);
1064 node = message->filename_term_list->head;
1067 /* A message document created by an old version of notmuch
1068 * (prior to rename support) will have the filename in the
1069 * data of the document rather than as a file-direntry term.
1071 * It would be nice to do the upgrade of the document directly
1072 * here, but the database is likely open in read-only mode. */
1074 std::string datastr = message->doc.get_data ();
1075 const char *data = datastr.c_str ();
1078 INTERNAL_ERROR ("message with no filename");
1080 _notmuch_string_list_append (message->filename_list, data);
1085 for (; node; node = node->next) {
1086 void *local = talloc_new (message);
1087 const char *db_path, *directory, *basename, *filename;
1088 char *colon, *direntry = NULL;
1089 unsigned int directory_id;
1091 direntry = node->string;
1093 directory_id = strtol (direntry, &colon, 10);
1095 if (colon == NULL || *colon != ':')
1096 INTERNAL_ERROR ("malformed direntry");
1098 basename = colon + 1;
1102 db_path = notmuch_database_get_path (message->notmuch);
1104 directory = _notmuch_database_get_directory_path (local,
1108 if (strlen (directory))
1109 filename = talloc_asprintf (message, "%s/%s/%s",
1110 db_path, directory, basename);
1112 filename = talloc_asprintf (message, "%s/%s",
1115 _notmuch_string_list_append (message->filename_list, filename);
1117 talloc_free (local);
1120 talloc_free (message->filename_term_list);
1121 message->filename_term_list = NULL;
1125 notmuch_message_get_filename (notmuch_message_t *message)
1127 _notmuch_message_ensure_filename_list (message);
1129 if (message->filename_list == NULL)
1132 if (message->filename_list->head == NULL ||
1133 message->filename_list->head->string == NULL) {
1134 INTERNAL_ERROR ("message with no filename");
1137 return message->filename_list->head->string;
1140 notmuch_filenames_t *
1141 notmuch_message_get_filenames (notmuch_message_t *message)
1143 _notmuch_message_ensure_filename_list (message);
1145 return _notmuch_filenames_create (message, message->filename_list);
1149 notmuch_message_count_files (notmuch_message_t *message)
1151 _notmuch_message_ensure_filename_list (message);
1153 return _notmuch_string_list_length (message->filename_list);
1157 notmuch_message_get_flag (notmuch_message_t *message,
1158 notmuch_message_flag_t flag)
1160 if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
1161 ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
1162 _notmuch_message_ensure_metadata (message, NULL);
1164 return NOTMUCH_TEST_BIT (message->flags, flag);
1168 notmuch_message_set_flag (notmuch_message_t *message,
1169 notmuch_message_flag_t flag, notmuch_bool_t enable)
1172 NOTMUCH_SET_BIT (&message->flags, flag);
1174 NOTMUCH_CLEAR_BIT (&message->flags, flag);
1175 NOTMUCH_SET_BIT (&message->lazy_flags, flag);
1179 notmuch_message_get_date (notmuch_message_t *message)
1184 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
1185 } catch (Xapian::Error &error) {
1186 _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred when reading date: %s\n",
1187 error.get_msg ().c_str ());
1188 message->notmuch->exception_reported = true;
1193 /* sortable_unserialise is undefined on empty string */
1195 return Xapian::sortable_unserialise (value);
1199 notmuch_message_get_tags (notmuch_message_t *message)
1201 notmuch_tags_t *tags;
1203 _notmuch_message_ensure_metadata (message, message->tag_list);
1205 tags = _notmuch_tags_create (message, message->tag_list);
1206 /* _notmuch_tags_create steals the reference to the tag_list, but
1207 * in this case it's still used by the message, so we add an
1208 * *additional* talloc reference to the list. As a result, it's
1209 * possible to modify the message tags (which talloc_unlink's the
1210 * current list from the message) while still iterating because
1211 * the iterator will keep the current list alive. */
1212 if (! talloc_reference (message, message->tag_list))
1219 _notmuch_message_get_author (notmuch_message_t *message)
1221 return message->author;
1225 _notmuch_message_set_author (notmuch_message_t *message,
1228 if (message->author)
1229 talloc_free (message->author);
1230 message->author = talloc_strdup (message, author);
1235 _notmuch_message_set_header_values (notmuch_message_t *message,
1238 const char *subject)
1242 /* GMime really doesn't want to see a NULL date, so protect its
1244 if (date == NULL || *date == '\0') {
1247 time_value = g_mime_utils_header_decode_date_unix (date);
1249 * Workaround for https://bugzilla.gnome.org/show_bug.cgi?id=779923
1255 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1256 Xapian::sortable_serialise (time_value));
1257 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1258 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1259 message->modified = true;
1263 _notmuch_message_update_subject (notmuch_message_t *message,
1264 const char *subject)
1266 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1267 message->modified = true;
1270 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD. The caller
1271 * must call _notmuch_message_sync. */
1273 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1275 /* _notmuch_message_sync will update the last modification
1276 * revision; we just have to ask it to. */
1277 message->modified = true;
1280 /* Synchronize changes made to message->doc out into the database. */
1282 _notmuch_message_sync (notmuch_message_t *message)
1284 Xapian::WritableDatabase *db;
1286 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
1289 if (! message->modified)
1292 /* Update the last modification of this message. */
1293 if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1294 /* sortable_serialise gives a reasonably compact encoding,
1295 * which directly translates to reduced IO when scanning the
1296 * value stream. Since it's built for doubles, we only get 53
1297 * effective bits, but that's still enough for the database to
1298 * last a few centuries at 1 million revisions per second. */
1299 message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1300 Xapian::sortable_serialise (
1301 _notmuch_database_new_revision (
1302 message->notmuch)));
1304 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1305 db->replace_document (message->doc_id, message->doc);
1306 message->modified = false;
1309 /* Delete a message document from the database, leaving a ghost
1310 * message in its place */
1312 _notmuch_message_delete (notmuch_message_t *message)
1314 notmuch_status_t status;
1315 Xapian::WritableDatabase *db;
1316 const char *mid, *tid, *query_string;
1317 notmuch_message_t *ghost;
1318 notmuch_private_status_t private_status;
1319 notmuch_database_t *notmuch;
1320 notmuch_query_t *query;
1321 unsigned int count = 0;
1324 mid = notmuch_message_get_message_id (message);
1325 tid = notmuch_message_get_thread_id (message);
1326 notmuch = message->notmuch;
1328 status = _notmuch_database_ensure_writable (message->notmuch);
1332 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1333 db->delete_document (message->doc_id);
1335 /* if this was a ghost to begin with, we are done */
1336 private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1338 return COERCE_STATUS (private_status,
1339 "Error trying to determine whether message was a ghost");
1341 return NOTMUCH_STATUS_SUCCESS;
1343 query_string = talloc_asprintf (message, "thread:%s", tid);
1344 query = notmuch_query_create (notmuch, query_string);
1346 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1347 status = notmuch_query_count_messages (query, &count);
1349 notmuch_query_destroy (query);
1354 /* reintroduce a ghost in its place because there are still
1355 * other active messages in this thread: */
1356 ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1357 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1358 private_status = _notmuch_message_initialize_ghost (ghost, tid);
1359 if (! private_status)
1360 _notmuch_message_sync (ghost);
1361 } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1362 /* this is deeply weird, and we should not have gotten
1363 * into this state. is there a better error message to
1365 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1368 notmuch_message_destroy (ghost);
1369 status = COERCE_STATUS (private_status, "Error converting to ghost message");
1371 /* the thread is empty; drop all ghost messages from it */
1372 notmuch_messages_t *messages;
1373 status = _notmuch_query_search_documents (query,
1376 if (status == NOTMUCH_STATUS_SUCCESS) {
1377 notmuch_status_t last_error = NOTMUCH_STATUS_SUCCESS;
1378 while (notmuch_messages_valid (messages)) {
1379 message = notmuch_messages_get (messages);
1380 status = _notmuch_message_delete (message);
1381 if (status) /* we'll report the last failure we see;
1382 * if there is more than one failure, we
1383 * forget about previous ones */
1384 last_error = status;
1385 notmuch_message_destroy (message);
1386 notmuch_messages_move_to_next (messages);
1388 status = last_error;
1391 notmuch_query_destroy (query);
1395 /* Transform a blank message into a ghost message. The caller must
1396 * _notmuch_message_sync the message. */
1397 notmuch_private_status_t
1398 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1399 const char *thread_id)
1401 notmuch_private_status_t status;
1403 status = _notmuch_message_add_term (message, "type", "ghost");
1406 status = _notmuch_message_add_term (message, "thread", thread_id);
1410 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1413 /* Ensure that 'message' is not holding any file object open. Future
1414 * calls to various functions will still automatically open the
1415 * message file as needed.
1418 _notmuch_message_close (notmuch_message_t *message)
1420 if (message->message_file) {
1421 _notmuch_message_file_close (message->message_file);
1422 message->message_file = NULL;
1426 /* Add a name:value term to 'message', (the actual term will be
1427 * encoded by prefixing the value with a short prefix). See
1428 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1429 * names to prefix values.
1431 * This change will not be reflected in the database until the next
1432 * call to _notmuch_message_sync. */
1433 notmuch_private_status_t
1434 _notmuch_message_add_term (notmuch_message_t *message,
1435 const char *prefix_name,
1442 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1444 term = talloc_asprintf (message, "%s%s",
1445 _find_prefix (prefix_name), value);
1447 if (strlen (term) > NOTMUCH_TERM_MAX)
1448 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1450 message->doc.add_term (term, 0);
1451 message->modified = true;
1455 _notmuch_message_invalidate_metadata (message, prefix_name);
1457 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1460 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1461 * term will be added with the appropriate prefix if prefix_name is
1464 notmuch_private_status_t
1465 _notmuch_message_gen_terms (notmuch_message_t *message,
1466 const char *prefix_name,
1469 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1472 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1474 term_gen->set_document (message->doc);
1475 term_gen->set_termpos (message->termpos);
1478 const char *prefix = _notmuch_database_prefix (message->notmuch, prefix_name);
1480 return NOTMUCH_PRIVATE_STATUS_BAD_PREFIX;
1482 _notmuch_message_invalidate_metadata (message, prefix_name);
1483 term_gen->index_text (text, 1, prefix);
1485 term_gen->index_text (text);
1488 /* Create a gap between this an the next terms so they don't
1489 * appear to be a phrase. */
1490 message->termpos = term_gen->get_termpos () + 100;
1492 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1495 /* Remove a name:value term from 'message', (the actual term will be
1496 * encoded by prefixing the value with a short prefix). See
1497 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1498 * names to prefix values.
1500 * This change will not be reflected in the database until the next
1501 * call to _notmuch_message_sync. */
1502 notmuch_private_status_t
1503 _notmuch_message_remove_term (notmuch_message_t *message,
1504 const char *prefix_name,
1510 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1512 term = talloc_asprintf (message, "%s%s",
1513 _find_prefix (prefix_name), value);
1515 if (strlen (term) > NOTMUCH_TERM_MAX)
1516 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1519 message->doc.remove_term (term);
1520 message->modified = true;
1521 } catch (const Xapian::InvalidArgumentError) {
1522 /* We'll let the philosophers try to wrestle with the
1523 * question of whether failing to remove that which was not
1524 * there in the first place is failure. For us, we'll silently
1525 * consider it all good. */
1530 _notmuch_message_invalidate_metadata (message, prefix_name);
1532 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1535 notmuch_private_status_t
1536 _notmuch_message_has_term (notmuch_message_t *message,
1537 const char *prefix_name,
1543 notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1546 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1548 term = talloc_asprintf (message, "%s%s",
1549 _find_prefix (prefix_name), value);
1551 if (strlen (term) > NOTMUCH_TERM_MAX)
1552 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1555 /* Look for the exact term */
1556 Xapian::TermIterator i = message->doc.termlist_begin ();
1558 if (i != message->doc.termlist_end () &&
1559 ! strcmp ((*i).c_str (), term))
1561 } catch (Xapian::Error &error) {
1562 status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1571 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1573 notmuch_private_status_t private_status;
1574 notmuch_status_t status;
1576 status = _notmuch_database_ensure_writable (message->notmuch);
1581 return NOTMUCH_STATUS_NULL_POINTER;
1583 if (strlen (tag) > NOTMUCH_TAG_MAX)
1584 return NOTMUCH_STATUS_TAG_TOO_LONG;
1586 private_status = _notmuch_message_add_term (message, "tag", tag);
1587 if (private_status) {
1588 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1592 if (! message->frozen)
1593 _notmuch_message_sync (message);
1595 return NOTMUCH_STATUS_SUCCESS;
1599 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1601 notmuch_private_status_t private_status;
1602 notmuch_status_t status;
1604 status = _notmuch_database_ensure_writable (message->notmuch);
1609 return NOTMUCH_STATUS_NULL_POINTER;
1611 if (strlen (tag) > NOTMUCH_TAG_MAX)
1612 return NOTMUCH_STATUS_TAG_TOO_LONG;
1614 private_status = _notmuch_message_remove_term (message, "tag", tag);
1615 if (private_status) {
1616 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1620 if (! message->frozen)
1621 _notmuch_message_sync (message);
1623 return NOTMUCH_STATUS_SUCCESS;
1626 /* Is the given filename within a maildir directory?
1628 * Specifically, is the final directory component of 'filename' either
1629 * "cur" or "new". If so, return a pointer to that final directory
1630 * component within 'filename'. If not, return NULL.
1632 * A non-NULL return value is guaranteed to be a valid string pointer
1633 * pointing to the characters "new/" or "cur/", (but not
1637 _filename_is_in_maildir (const char *filename)
1639 const char *slash, *dir = NULL;
1641 /* Find the last '/' separating directory from filename. */
1642 slash = strrchr (filename, '/');
1646 /* Jump back 4 characters to where the previous '/' will be if the
1647 * directory is named "cur" or "new". */
1648 if (slash - filename < 4)
1658 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1659 STRNCMP_LITERAL (dir, "new/") == 0) {
1667 _ensure_maildir_flags (notmuch_message_t *message, bool force)
1670 notmuch_filenames_t *filenames;
1671 const char *filename, *dir;
1672 char *combined_flags = talloc_strdup (message, "");
1673 int seen_maildir_info = 0;
1675 if (message->maildir_flags) {
1677 talloc_free (message->maildir_flags);
1678 message->maildir_flags = NULL;
1682 for (filenames = notmuch_message_get_filenames (message);
1683 notmuch_filenames_valid (filenames);
1684 notmuch_filenames_move_to_next (filenames)) {
1685 filename = notmuch_filenames_get (filenames);
1686 dir = _filename_is_in_maildir (filename);
1691 flags = strstr (filename, ":2,");
1693 seen_maildir_info = 1;
1695 combined_flags = talloc_strdup_append (combined_flags, flags);
1696 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1697 /* Messages are delivered to new/ with no "info" part, but
1698 * they effectively have default maildir flags. According
1699 * to the spec, we should ignore the info part for
1700 * messages in new/, but some MUAs (mutt) can set maildir
1701 * flags on messages in new/, so we're liberal in what we
1703 seen_maildir_info = 1;
1706 if (seen_maildir_info)
1707 message->maildir_flags = combined_flags;
1711 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
1713 _ensure_maildir_flags (message, false);
1714 return message->maildir_flags && (strchr (message->maildir_flags, flag) != NULL);
1718 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1720 notmuch_status_t status;
1723 _ensure_maildir_flags (message, true);
1724 /* If none of the filenames have any maildir info field (not even
1725 * an empty info with no flags set) then there's no information to
1726 * go on, so do nothing. */
1727 if (! message->maildir_flags)
1728 return NOTMUCH_STATUS_SUCCESS;
1730 status = notmuch_message_freeze (message);
1734 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1735 if ((strchr (message->maildir_flags, flag2tag[i].flag) != NULL)
1737 flag2tag[i].inverse) {
1738 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1740 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1745 status = notmuch_message_thaw (message);
1750 /* From the set of tags on 'message' and the flag2tag table, compute a
1751 * set of maildir-flag actions to be taken, (flags that should be
1752 * either set or cleared).
1754 * The result is returned as two talloced strings: to_set, and to_clear
1757 _get_maildir_flag_actions (notmuch_message_t *message,
1759 char **to_clear_ret)
1761 char *to_set, *to_clear;
1762 notmuch_tags_t *tags;
1766 to_set = talloc_strdup (message, "");
1767 to_clear = talloc_strdup (message, "");
1769 /* First, find flags for all set tags. */
1770 for (tags = notmuch_message_get_tags (message);
1771 notmuch_tags_valid (tags);
1772 notmuch_tags_move_to_next (tags)) {
1773 tag = notmuch_tags_get (tags);
1775 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1776 if (strcmp (tag, flag2tag[i].tag) == 0) {
1777 if (flag2tag[i].inverse)
1778 to_clear = talloc_asprintf_append (to_clear,
1782 to_set = talloc_asprintf_append (to_set,
1789 /* Then, find the flags for all tags not present. */
1790 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1791 if (flag2tag[i].inverse) {
1792 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1793 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1795 if (strchr (to_set, flag2tag[i].flag) == NULL)
1796 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1800 *to_set_ret = to_set;
1801 *to_clear_ret = to_clear;
1804 /* Given 'filename' and a set of maildir flags to set and to clear,
1805 * compute the new maildir filename.
1807 * If the existing filename is in the directory "new", the new
1808 * filename will be in the directory "cur", except for the case when
1809 * no flags are changed and the existing filename does not contain
1810 * maildir info (starting with ",2:").
1812 * After a sequence of ":2," in the filename, any subsequent
1813 * single-character flags will be added or removed according to the
1814 * characters in flags_to_set and flags_to_clear. Any existing flags
1815 * not mentioned in either string will remain. The final list of flags
1816 * will be in ASCII order.
1818 * If the original flags seem invalid, (repeated characters or
1819 * non-ASCII ordering of flags), this function will return NULL
1820 * (meaning that renaming would not be safe and should not occur).
1823 _new_maildir_filename (void *ctx,
1824 const char *filename,
1825 const char *flags_to_set,
1826 const char *flags_to_clear)
1828 const char *info, *flags;
1829 unsigned int flag, last_flag;
1830 char *filename_new, *dir;
1832 int flags_in_map = 0;
1833 bool flags_changed = false;
1837 memset (flag_map, 0, sizeof (flag_map));
1839 info = strstr (filename, ":2,");
1842 info = filename + strlen (filename);
1844 /* Loop through existing flags in filename. */
1845 for (flags = info + 3, last_flag = 0;
1847 last_flag = flag, flags++) {
1850 /* Original flags not in ASCII order. Abort. */
1851 if (flag < last_flag)
1854 /* Non-ASCII flag. Abort. */
1855 if (flag > sizeof (flag_map) - 1)
1858 /* Repeated flag value. Abort. */
1867 /* Then set and clear our flags from tags. */
1868 for (flags = flags_to_set; *flags; flags++) {
1870 if (flag_map[flag] == 0) {
1873 flags_changed = true;
1877 for (flags = flags_to_clear; *flags; flags++) {
1879 if (flag_map[flag]) {
1882 flags_changed = true;
1886 /* Messages in new/ without maildir info can be kept in new/ if no
1887 * flags have changed. */
1888 dir = (char *) _filename_is_in_maildir (filename);
1889 if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && ! *info && ! flags_changed)
1890 return talloc_strdup (ctx, filename);
1892 filename_new = (char *) talloc_size (ctx,
1894 strlen (":2,") + flags_in_map + 1);
1895 if (unlikely (filename_new == NULL))
1898 strncpy (filename_new, filename, info - filename);
1899 filename_new[info - filename] = '\0';
1901 strcat (filename_new, ":2,");
1903 s = filename_new + strlen (filename_new);
1904 for (i = 0; i < sizeof (flag_map); i++) {
1912 /* If message is in new/ move it under cur/. */
1913 dir = (char *) _filename_is_in_maildir (filename_new);
1914 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1915 memcpy (dir, "cur/", 4);
1917 return filename_new;
1921 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1923 notmuch_filenames_t *filenames;
1924 const char *filename;
1926 char *to_set, *to_clear;
1927 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1929 _get_maildir_flag_actions (message, &to_set, &to_clear);
1931 for (filenames = notmuch_message_get_filenames (message);
1932 notmuch_filenames_valid (filenames);
1933 notmuch_filenames_move_to_next (filenames)) {
1934 filename = notmuch_filenames_get (filenames);
1936 if (! _filename_is_in_maildir (filename))
1939 filename_new = _new_maildir_filename (message, filename,
1941 if (filename_new == NULL)
1944 if (strcmp (filename, filename_new)) {
1946 notmuch_status_t new_status;
1948 err = rename (filename, filename_new);
1952 new_status = _notmuch_message_remove_filename (message,
1954 /* Hold on to only the first error. */
1955 if (! status && new_status
1956 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1957 status = new_status;
1961 new_status = _notmuch_message_add_filename (message,
1963 /* Hold on to only the first error. */
1964 if (! status && new_status) {
1965 status = new_status;
1969 _notmuch_message_sync (message);
1972 talloc_free (filename_new);
1975 talloc_free (to_set);
1976 talloc_free (to_clear);
1982 notmuch_message_remove_all_tags (notmuch_message_t *message)
1984 notmuch_private_status_t private_status;
1985 notmuch_status_t status;
1986 notmuch_tags_t *tags;
1989 status = _notmuch_database_ensure_writable (message->notmuch);
1993 for (tags = notmuch_message_get_tags (message);
1994 notmuch_tags_valid (tags);
1995 notmuch_tags_move_to_next (tags)) {
1996 tag = notmuch_tags_get (tags);
1998 private_status = _notmuch_message_remove_term (message, "tag", tag);
1999 if (private_status) {
2000 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
2005 if (! message->frozen)
2006 _notmuch_message_sync (message);
2009 return NOTMUCH_STATUS_SUCCESS;
2013 notmuch_message_freeze (notmuch_message_t *message)
2015 notmuch_status_t status;
2017 status = _notmuch_database_ensure_writable (message->notmuch);
2023 return NOTMUCH_STATUS_SUCCESS;
2027 notmuch_message_thaw (notmuch_message_t *message)
2029 notmuch_status_t status;
2031 status = _notmuch_database_ensure_writable (message->notmuch);
2035 if (message->frozen > 0) {
2037 if (message->frozen == 0)
2038 _notmuch_message_sync (message);
2039 return NOTMUCH_STATUS_SUCCESS;
2041 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
2046 notmuch_message_destroy (notmuch_message_t *message)
2048 talloc_free (message);
2051 notmuch_database_t *
2052 notmuch_message_get_database (const notmuch_message_t *message)
2054 return message->notmuch;
2058 _notmuch_message_ensure_property_map (notmuch_message_t *message)
2060 notmuch_string_node_t *node;
2062 if (message->property_map)
2065 _notmuch_message_ensure_metadata (message, message->property_term_list);
2067 message->property_map = _notmuch_string_map_create (message);
2069 for (node = message->property_term_list->head; node; node = node->next) {
2073 value = strchr (node->string, '=');
2075 INTERNAL_ERROR ("malformed property term");
2081 _notmuch_string_map_append (message->property_map, key, value);
2085 talloc_free (message->property_term_list);
2086 message->property_term_list = NULL;
2089 notmuch_string_map_t *
2090 _notmuch_message_property_map (notmuch_message_t *message)
2092 _notmuch_message_ensure_property_map (message);
2094 return message->property_map;
2098 _notmuch_message_frozen (notmuch_message_t *message)
2100 return message->frozen;
2104 notmuch_message_reindex (notmuch_message_t *message,
2105 notmuch_indexopts_t *indexopts)
2107 notmuch_database_t *notmuch = NULL;
2108 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2109 notmuch_private_status_t private_status;
2110 notmuch_filenames_t *orig_filenames = NULL;
2111 const char *orig_thread_id = NULL;
2112 notmuch_message_file_t *message_file = NULL;
2116 if (message == NULL)
2117 return NOTMUCH_STATUS_NULL_POINTER;
2119 /* Save in case we need to delete message */
2120 orig_thread_id = notmuch_message_get_thread_id (message);
2121 if (! orig_thread_id) {
2122 /* XXX TODO: make up new error return? */
2123 INTERNAL_ERROR ("message without thread-id");
2126 /* strdup it because the metadata may be invalidated */
2127 orig_thread_id = talloc_strdup (message, orig_thread_id);
2129 notmuch = notmuch_message_get_database (message);
2131 ret = _notmuch_database_ensure_writable (notmuch);
2135 orig_filenames = notmuch_message_get_filenames (message);
2137 private_status = _notmuch_message_remove_indexed_terms (message);
2138 if (private_status) {
2139 ret = COERCE_STATUS (private_status, "error removing terms");
2143 ret = notmuch_message_remove_all_properties_with_prefix (message, "index.");
2145 goto DONE; /* XXX TODO: distinguish from other error returns above? */
2146 if (indexopts && notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE) {
2147 ret = notmuch_message_remove_all_properties (message, "session-key");
2152 /* re-add the filenames with the associated indexopts */
2153 for (; notmuch_filenames_valid (orig_filenames);
2154 notmuch_filenames_move_to_next (orig_filenames)) {
2157 const char *from, *to, *subject;
2158 char *message_id = NULL;
2159 const char *thread_id = NULL;
2161 const char *filename = notmuch_filenames_get (orig_filenames);
2163 message_file = _notmuch_message_file_open (notmuch, filename);
2164 if (message_file == NULL)
2167 ret = _notmuch_message_file_get_headers (message_file,
2168 &from, &subject, &to, &date,
2173 /* XXX TODO: deal with changing message id? */
2175 _notmuch_message_add_filename (message, filename);
2177 ret = _notmuch_database_link_message_to_parents (notmuch, message,
2183 if (thread_id == NULL)
2184 thread_id = orig_thread_id;
2186 _notmuch_message_add_term (message, "thread", thread_id);
2187 /* Take header values only from first filename */
2189 _notmuch_message_set_header_values (message, date, from, subject);
2191 ret = _notmuch_message_index_file (message, indexopts, message_file);
2193 if (ret == NOTMUCH_STATUS_FILE_ERROR)
2199 _notmuch_message_file_close (message_file);
2200 message_file = NULL;
2203 /* put back thread id to help cleanup */
2204 _notmuch_message_add_term (message, "thread", orig_thread_id);
2205 ret = _notmuch_message_delete (message);
2207 _notmuch_message_sync (message);
2212 _notmuch_message_file_close (message_file);
2214 /* XXX TODO destroy orig_filenames? */