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)
607 _notmuch_message_ensure_metadata (message, message->thread_id);
608 if (! message->thread_id)
609 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
611 return message->thread_id;
615 _notmuch_message_add_reply (notmuch_message_t *message,
616 notmuch_message_t *reply)
618 _notmuch_message_list_add_message (message->replies, reply);
622 _notmuch_message_get_thread_depth (notmuch_message_t *message)
624 return message->thread_depth;
628 _notmuch_message_label_depths (notmuch_message_t *message,
631 message->thread_depth = depth;
633 for (notmuch_messages_t *messages = _notmuch_messages_create (message->replies);
634 notmuch_messages_valid (messages);
635 notmuch_messages_move_to_next (messages)) {
636 notmuch_message_t *child = notmuch_messages_get (messages);
637 _notmuch_message_label_depths (child, depth + 1);
641 const notmuch_string_list_t *
642 _notmuch_message_get_references (notmuch_message_t *message)
644 _notmuch_message_ensure_metadata (message, message->reference_list);
645 return message->reference_list;
649 _cmpmsg (const void *pa, const void *pb)
651 notmuch_message_t **a = (notmuch_message_t **) pa;
652 notmuch_message_t **b = (notmuch_message_t **) pb;
653 time_t time_a = notmuch_message_get_date (*a);
654 time_t time_b = notmuch_message_get_date (*b);
656 if (time_a == time_b)
658 else if (time_a < time_b)
664 notmuch_message_list_t *
665 _notmuch_message_sort_subtrees (void *ctx, notmuch_message_list_t *list)
669 size_t capacity = 16;
674 void *local = talloc_new (NULL);
675 notmuch_message_list_t *new_list = _notmuch_message_list_create (ctx);
676 notmuch_message_t **message_array = talloc_zero_array (local, notmuch_message_t *, capacity);
678 for (notmuch_messages_t *messages = _notmuch_messages_create (list);
679 notmuch_messages_valid (messages);
680 notmuch_messages_move_to_next (messages)) {
681 notmuch_message_t *root = notmuch_messages_get (messages);
682 if (count >= capacity) {
684 message_array = talloc_realloc (local, message_array, notmuch_message_t *, capacity);
686 message_array[count++] = root;
687 root->replies = _notmuch_message_sort_subtrees (root, root->replies);
690 qsort (message_array, count, sizeof (notmuch_message_t *), _cmpmsg);
691 for (size_t i = 0; i < count; i++) {
692 _notmuch_message_list_add_message (new_list, message_array[i]);
701 notmuch_message_get_replies (notmuch_message_t *message)
703 return _notmuch_messages_create (message->replies);
707 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
709 Xapian::TermIterator i;
710 size_t prefix_len = 0;
712 prefix_len = strlen (prefix);
715 i = message->doc.termlist_begin ();
718 /* Terminate loop when no terms remain with desired prefix. */
719 if (i == message->doc.termlist_end () ||
720 strncmp ((*i).c_str (), prefix, prefix_len))
724 message->doc.remove_term ((*i));
725 message->modified = true;
726 } catch (const Xapian::InvalidArgumentError) {
727 /* Ignore failure to remove non-existent term. */
733 /* Remove all terms generated by indexing, i.e. not tags or
734 * properties, along with any automatic tags*/
735 /* According to Xapian API docs, none of these calls throw
737 notmuch_private_status_t
738 _notmuch_message_remove_indexed_terms (notmuch_message_t *message)
740 Xapian::TermIterator i;
743 id_prefix = _find_prefix ("id"),
744 property_prefix = _find_prefix ("property"),
745 tag_prefix = _find_prefix ("tag"),
746 type_prefix = _find_prefix ("type");
748 /* Make sure we have the data to restore to Xapian*/
749 _notmuch_message_ensure_metadata (message, NULL);
751 /* Empirically, it turns out to be faster to remove all the terms,
752 * and add back the ones we want. */
753 message->doc.clear_terms ();
754 message->modified = true;
756 /* still a mail message */
757 message->doc.add_term (type_prefix + "mail");
759 /* Put back message-id */
760 message->doc.add_term (id_prefix + message->message_id);
762 /* Put back non-automatic tags */
763 for (notmuch_tags_t *tags = notmuch_message_get_tags (message);
764 notmuch_tags_valid (tags);
765 notmuch_tags_move_to_next (tags)) {
767 const char *tag = notmuch_tags_get (tags);
769 if (strcmp (tag, "encrypted") != 0 &&
770 strcmp (tag, "signed") != 0 &&
771 strcmp (tag, "attachment") != 0) {
772 std::string term = tag_prefix + tag;
773 message->doc.add_term (term);
777 /* Put back properties */
778 notmuch_message_properties_t *list;
780 for (list = notmuch_message_get_properties (message, "", false);
781 notmuch_message_properties_valid (list); notmuch_message_properties_move_to_next (list)) {
782 std::string term = property_prefix +
783 notmuch_message_properties_key (list) + "=" +
784 notmuch_message_properties_value (list);
786 message->doc.add_term (term);
789 notmuch_message_properties_destroy (list);
791 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
795 /* Return true if p points at "new" or "cur". */
797 is_maildir (const char *p)
799 return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
802 /* Add "folder:" term for directory. */
803 static notmuch_status_t
804 _notmuch_message_add_folder_terms (notmuch_message_t *message,
805 const char *directory)
809 folder = talloc_strdup (NULL, directory);
811 return NOTMUCH_STATUS_OUT_OF_MEMORY;
814 * If the message file is in a leaf directory named "new" or
815 * "cur", presume maildir and index the parent directory. Thus a
816 * "folder:" prefix search matches messages in the specified
817 * maildir folder, i.e. in the specified directory and its "new"
818 * and "cur" subdirectories.
820 * Note that this means the "folder:" prefix can't be used for
821 * distinguishing between message files in "new" or "cur". The
822 * "path:" prefix needs to be used for that.
824 * Note the deliberate difference to _filename_is_in_maildir(). We
825 * don't want to index different things depending on the existence
826 * or non-existence of all maildir sibling directories "new",
827 * "cur", and "tmp". Doing so would be surprising, and difficult
828 * for the user to fix in case all subdirectories were not in
829 * place during indexing.
831 last = strrchr (folder, '/');
833 if (is_maildir (last + 1))
835 } else if (is_maildir (folder)) {
839 _notmuch_message_add_term (message, "folder", folder);
841 talloc_free (folder);
843 message->modified = true;
844 return NOTMUCH_STATUS_SUCCESS;
847 #define RECURSIVE_SUFFIX "/**"
849 /* Add "path:" terms for directory. */
850 static notmuch_status_t
851 _notmuch_message_add_path_terms (notmuch_message_t *message,
852 const char *directory)
854 /* Add exact "path:" term. */
855 _notmuch_message_add_term (message, "path", directory);
857 if (strlen (directory)) {
860 path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
862 return NOTMUCH_STATUS_OUT_OF_MEMORY;
864 /* Add recursive "path:" terms for directory and all parents. */
865 for (p = path + strlen (path) - 1; p > path; p--) {
867 strcpy (p, RECURSIVE_SUFFIX);
868 _notmuch_message_add_term (message, "path", path);
875 /* Recursive all-matching path:** for consistency. */
876 _notmuch_message_add_term (message, "path", "**");
878 return NOTMUCH_STATUS_SUCCESS;
881 /* Add directory based terms for all filenames of the message. */
882 static notmuch_status_t
883 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
885 const char *direntry_prefix = _find_prefix ("file-direntry");
886 int direntry_prefix_len = strlen (direntry_prefix);
887 Xapian::TermIterator i = message->doc.termlist_begin ();
888 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
890 for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
891 unsigned int directory_id;
892 const char *direntry, *directory;
894 const std::string &term = *i;
896 /* Terminate loop at first term without desired prefix. */
897 if (strncmp (term.c_str (), direntry_prefix, direntry_prefix_len))
900 /* Indicate that there are filenames remaining. */
901 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
903 direntry = term.c_str ();
904 direntry += direntry_prefix_len;
906 directory_id = strtol (direntry, &colon, 10);
908 if (colon == NULL || *colon != ':')
909 INTERNAL_ERROR ("malformed direntry");
911 directory = _notmuch_database_get_directory_path (ctx,
915 _notmuch_message_add_folder_terms (message, directory);
916 _notmuch_message_add_path_terms (message, directory);
922 /* Add an additional 'filename' for 'message'.
924 * This change will not be reflected in the database until the next
925 * call to _notmuch_message_sync. */
927 _notmuch_message_add_filename (notmuch_message_t *message,
928 const char *filename)
930 const char *relative, *directory;
931 notmuch_status_t status;
932 void *local = talloc_new (message);
935 if (filename == NULL)
936 INTERNAL_ERROR ("Message filename cannot be NULL.");
938 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
939 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
940 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
942 relative = _notmuch_database_relative_path (message->notmuch, filename);
944 status = _notmuch_database_split_path (local, relative, &directory, NULL);
948 status = _notmuch_database_filename_to_direntry (
949 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
953 /* New file-direntry allows navigating to this message with
954 * notmuch_directory_get_child_files() . */
955 _notmuch_message_add_term (message, "file-direntry", direntry);
957 _notmuch_message_add_folder_terms (message, directory);
958 _notmuch_message_add_path_terms (message, directory);
962 return NOTMUCH_STATUS_SUCCESS;
965 /* Remove a particular 'filename' from 'message'.
967 * This change will not be reflected in the database until the next
968 * call to _notmuch_message_sync.
970 * If this message still has other filenames, returns
971 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
973 * Note: This function does not remove a document from the database,
974 * even if the specified filename is the only filename for this
975 * message. For that functionality, see
976 * notmuch_database_remove_message. */
978 _notmuch_message_remove_filename (notmuch_message_t *message,
979 const char *filename)
981 void *local = talloc_new (message);
983 notmuch_private_status_t private_status;
984 notmuch_status_t status;
986 if (! (message->notmuch->features & NOTMUCH_FEATURE_FILE_TERMS) ||
987 ! (message->notmuch->features & NOTMUCH_FEATURE_BOOL_FOLDER))
988 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
990 status = _notmuch_database_filename_to_direntry (
991 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
992 if (status || ! direntry)
995 /* Unlink this file from its parent directory. */
996 private_status = _notmuch_message_remove_term (message,
997 "file-direntry", direntry);
998 status = COERCE_STATUS (private_status,
999 "Unexpected error from _notmuch_message_remove_term");
1003 /* Re-synchronize "folder:" and "path:" terms for this message. */
1005 /* Remove all "folder:" terms. */
1006 _notmuch_message_remove_terms (message, _find_prefix ("folder"));
1008 /* Remove all "path:" terms. */
1009 _notmuch_message_remove_terms (message, _find_prefix ("path"));
1011 /* Add back terms for all remaining filenames of the message. */
1012 status = _notmuch_message_add_directory_terms (local, message);
1014 talloc_free (local);
1019 /* Upgrade the "folder:" prefix from V1 to V2. */
1020 #define FOLDER_PREFIX_V1 "XFOLDER"
1021 #define ZFOLDER_PREFIX_V1 "Z" FOLDER_PREFIX_V1
1023 _notmuch_message_upgrade_folder (notmuch_message_t *message)
1025 /* Remove all old "folder:" terms. */
1026 _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
1028 /* Remove all old "folder:" stemmed terms. */
1029 _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
1031 /* Add new boolean "folder:" and "path:" terms. */
1032 _notmuch_message_add_directory_terms (message, message);
1036 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
1038 return talloc_strdup (message, message->doc.get_data ().c_str ());
1042 _notmuch_message_clear_data (notmuch_message_t *message)
1044 message->doc.set_data ("");
1045 message->modified = true;
1049 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
1051 notmuch_string_node_t *node;
1053 if (message->filename_list)
1056 _notmuch_message_ensure_metadata (message, message->filename_term_list);
1058 message->filename_list = _notmuch_string_list_create (message);
1059 node = message->filename_term_list->head;
1062 /* A message document created by an old version of notmuch
1063 * (prior to rename support) will have the filename in the
1064 * data of the document rather than as a file-direntry term.
1066 * It would be nice to do the upgrade of the document directly
1067 * here, but the database is likely open in read-only mode. */
1069 std::string datastr = message->doc.get_data ();
1070 const char *data = datastr.c_str ();
1073 INTERNAL_ERROR ("message with no filename");
1075 _notmuch_string_list_append (message->filename_list, data);
1080 for (; node; node = node->next) {
1081 void *local = talloc_new (message);
1082 const char *db_path, *directory, *basename, *filename;
1083 char *colon, *direntry = NULL;
1084 unsigned int directory_id;
1086 direntry = node->string;
1088 directory_id = strtol (direntry, &colon, 10);
1090 if (colon == NULL || *colon != ':')
1091 INTERNAL_ERROR ("malformed direntry");
1093 basename = colon + 1;
1097 db_path = notmuch_database_get_path (message->notmuch);
1099 directory = _notmuch_database_get_directory_path (local,
1103 if (strlen (directory))
1104 filename = talloc_asprintf (message, "%s/%s/%s",
1105 db_path, directory, basename);
1107 filename = talloc_asprintf (message, "%s/%s",
1110 _notmuch_string_list_append (message->filename_list, filename);
1112 talloc_free (local);
1115 talloc_free (message->filename_term_list);
1116 message->filename_term_list = NULL;
1120 notmuch_message_get_filename (notmuch_message_t *message)
1122 _notmuch_message_ensure_filename_list (message);
1124 if (message->filename_list == NULL)
1127 if (message->filename_list->head == NULL ||
1128 message->filename_list->head->string == NULL) {
1129 INTERNAL_ERROR ("message with no filename");
1132 return message->filename_list->head->string;
1135 notmuch_filenames_t *
1136 notmuch_message_get_filenames (notmuch_message_t *message)
1138 _notmuch_message_ensure_filename_list (message);
1140 return _notmuch_filenames_create (message, message->filename_list);
1144 notmuch_message_count_files (notmuch_message_t *message)
1146 _notmuch_message_ensure_filename_list (message);
1148 return _notmuch_string_list_length (message->filename_list);
1152 notmuch_message_get_flag (notmuch_message_t *message,
1153 notmuch_message_flag_t flag)
1155 if (flag == NOTMUCH_MESSAGE_FLAG_GHOST &&
1156 ! NOTMUCH_TEST_BIT (message->lazy_flags, flag))
1157 _notmuch_message_ensure_metadata (message, NULL);
1159 return NOTMUCH_TEST_BIT (message->flags, flag);
1163 notmuch_message_set_flag (notmuch_message_t *message,
1164 notmuch_message_flag_t flag, notmuch_bool_t enable)
1167 NOTMUCH_SET_BIT (&message->flags, flag);
1169 NOTMUCH_CLEAR_BIT (&message->flags, flag);
1170 NOTMUCH_SET_BIT (&message->lazy_flags, flag);
1174 notmuch_message_get_date (notmuch_message_t *message)
1179 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
1180 } catch (Xapian::Error &error) {
1181 _notmuch_database_log (notmuch_message_get_database (message), "A Xapian exception occurred when reading date: %s\n",
1182 error.get_msg ().c_str ());
1183 message->notmuch->exception_reported = true;
1188 /* sortable_unserialise is undefined on empty string */
1190 return Xapian::sortable_unserialise (value);
1194 notmuch_message_get_tags (notmuch_message_t *message)
1196 notmuch_tags_t *tags;
1198 _notmuch_message_ensure_metadata (message, message->tag_list);
1200 tags = _notmuch_tags_create (message, message->tag_list);
1201 /* _notmuch_tags_create steals the reference to the tag_list, but
1202 * in this case it's still used by the message, so we add an
1203 * *additional* talloc reference to the list. As a result, it's
1204 * possible to modify the message tags (which talloc_unlink's the
1205 * current list from the message) while still iterating because
1206 * the iterator will keep the current list alive. */
1207 if (! talloc_reference (message, message->tag_list))
1214 _notmuch_message_get_author (notmuch_message_t *message)
1216 return message->author;
1220 _notmuch_message_set_author (notmuch_message_t *message,
1223 if (message->author)
1224 talloc_free (message->author);
1225 message->author = talloc_strdup (message, author);
1230 _notmuch_message_set_header_values (notmuch_message_t *message,
1233 const char *subject)
1237 /* GMime really doesn't want to see a NULL date, so protect its
1239 if (date == NULL || *date == '\0') {
1242 time_value = g_mime_utils_header_decode_date_unix (date);
1244 * Workaround for https://bugzilla.gnome.org/show_bug.cgi?id=779923
1250 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
1251 Xapian::sortable_serialise (time_value));
1252 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
1253 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1254 message->modified = true;
1258 _notmuch_message_update_subject (notmuch_message_t *message,
1259 const char *subject)
1261 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
1262 message->modified = true;
1265 /* Upgrade a message to support NOTMUCH_FEATURE_LAST_MOD. The caller
1266 * must call _notmuch_message_sync. */
1268 _notmuch_message_upgrade_last_mod (notmuch_message_t *message)
1270 /* _notmuch_message_sync will update the last modification
1271 * revision; we just have to ask it to. */
1272 message->modified = true;
1275 /* Synchronize changes made to message->doc out into the database. */
1277 _notmuch_message_sync (notmuch_message_t *message)
1279 Xapian::WritableDatabase *db;
1281 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
1284 if (! message->modified)
1287 /* Update the last modification of this message. */
1288 if (message->notmuch->features & NOTMUCH_FEATURE_LAST_MOD)
1289 /* sortable_serialise gives a reasonably compact encoding,
1290 * which directly translates to reduced IO when scanning the
1291 * value stream. Since it's built for doubles, we only get 53
1292 * effective bits, but that's still enough for the database to
1293 * last a few centuries at 1 million revisions per second. */
1294 message->doc.add_value (NOTMUCH_VALUE_LAST_MOD,
1295 Xapian::sortable_serialise (
1296 _notmuch_database_new_revision (
1297 message->notmuch)));
1299 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
1300 db->replace_document (message->doc_id, message->doc);
1301 message->modified = false;
1304 /* Delete a message document from the database, leaving a ghost
1305 * message in its place */
1307 _notmuch_message_delete (notmuch_message_t *message)
1309 notmuch_status_t status;
1310 Xapian::WritableDatabase *db;
1311 const char *mid, *tid, *query_string;
1312 notmuch_message_t *ghost;
1313 notmuch_private_status_t private_status;
1314 notmuch_database_t *notmuch;
1315 notmuch_query_t *query;
1316 unsigned int count = 0;
1319 mid = notmuch_message_get_message_id (message);
1320 tid = notmuch_message_get_thread_id (message);
1321 notmuch = message->notmuch;
1323 status = _notmuch_database_ensure_writable (message->notmuch);
1327 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1328 db->delete_document (message->doc_id);
1330 /* if this was a ghost to begin with, we are done */
1331 private_status = _notmuch_message_has_term (message, "type", "ghost", &is_ghost);
1333 return COERCE_STATUS (private_status,
1334 "Error trying to determine whether message was a ghost");
1336 return NOTMUCH_STATUS_SUCCESS;
1338 query_string = talloc_asprintf (message, "thread:%s", tid);
1339 query = notmuch_query_create (notmuch, query_string);
1341 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1342 status = notmuch_query_count_messages (query, &count);
1344 notmuch_query_destroy (query);
1349 /* reintroduce a ghost in its place because there are still
1350 * other active messages in this thread: */
1351 ghost = _notmuch_message_create_for_message_id (notmuch, mid, &private_status);
1352 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1353 private_status = _notmuch_message_initialize_ghost (ghost, tid);
1354 if (! private_status)
1355 _notmuch_message_sync (ghost);
1356 } else if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1357 /* this is deeply weird, and we should not have gotten
1358 * into this state. is there a better error message to
1360 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1363 notmuch_message_destroy (ghost);
1364 status = COERCE_STATUS (private_status, "Error converting to ghost message");
1366 /* the thread is empty; drop all ghost messages from it */
1367 notmuch_messages_t *messages;
1368 status = _notmuch_query_search_documents (query,
1371 if (status == NOTMUCH_STATUS_SUCCESS) {
1372 notmuch_status_t last_error = NOTMUCH_STATUS_SUCCESS;
1373 while (notmuch_messages_valid (messages)) {
1374 message = notmuch_messages_get (messages);
1375 status = _notmuch_message_delete (message);
1376 if (status) /* we'll report the last failure we see;
1377 * if there is more than one failure, we
1378 * forget about previous ones */
1379 last_error = status;
1380 notmuch_message_destroy (message);
1381 notmuch_messages_move_to_next (messages);
1383 status = last_error;
1386 notmuch_query_destroy (query);
1390 /* Transform a blank message into a ghost message. The caller must
1391 * _notmuch_message_sync the message. */
1392 notmuch_private_status_t
1393 _notmuch_message_initialize_ghost (notmuch_message_t *message,
1394 const char *thread_id)
1396 notmuch_private_status_t status;
1398 status = _notmuch_message_add_term (message, "type", "ghost");
1401 status = _notmuch_message_add_term (message, "thread", thread_id);
1405 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1408 /* Ensure that 'message' is not holding any file object open. Future
1409 * calls to various functions will still automatically open the
1410 * message file as needed.
1413 _notmuch_message_close (notmuch_message_t *message)
1415 if (message->message_file) {
1416 _notmuch_message_file_close (message->message_file);
1417 message->message_file = NULL;
1421 /* Add a name:value term to 'message', (the actual term will be
1422 * encoded by prefixing the value with a short prefix). See
1423 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1424 * names to prefix values.
1426 * This change will not be reflected in the database until the next
1427 * call to _notmuch_message_sync. */
1428 notmuch_private_status_t
1429 _notmuch_message_add_term (notmuch_message_t *message,
1430 const char *prefix_name,
1437 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1439 term = talloc_asprintf (message, "%s%s",
1440 _find_prefix (prefix_name), value);
1442 if (strlen (term) > NOTMUCH_TERM_MAX)
1443 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1445 message->doc.add_term (term, 0);
1446 message->modified = true;
1450 _notmuch_message_invalidate_metadata (message, prefix_name);
1452 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1455 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1456 * term will be added with the appropriate prefix if prefix_name is
1459 notmuch_private_status_t
1460 _notmuch_message_gen_terms (notmuch_message_t *message,
1461 const char *prefix_name,
1464 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1467 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1469 term_gen->set_document (message->doc);
1470 term_gen->set_termpos (message->termpos);
1473 const char *prefix = _notmuch_database_prefix (message->notmuch, prefix_name);
1475 return NOTMUCH_PRIVATE_STATUS_BAD_PREFIX;
1477 _notmuch_message_invalidate_metadata (message, prefix_name);
1478 term_gen->index_text (text, 1, prefix);
1480 term_gen->index_text (text);
1483 /* Create a gap between this an the next terms so they don't
1484 * appear to be a phrase. */
1485 message->termpos = term_gen->get_termpos () + 100;
1487 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1490 /* Remove a name:value term from 'message', (the actual term will be
1491 * encoded by prefixing the value with a short prefix). See
1492 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1493 * names to prefix values.
1495 * This change will not be reflected in the database until the next
1496 * call to _notmuch_message_sync. */
1497 notmuch_private_status_t
1498 _notmuch_message_remove_term (notmuch_message_t *message,
1499 const char *prefix_name,
1505 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1507 term = talloc_asprintf (message, "%s%s",
1508 _find_prefix (prefix_name), value);
1510 if (strlen (term) > NOTMUCH_TERM_MAX)
1511 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1514 message->doc.remove_term (term);
1515 message->modified = true;
1516 } catch (const Xapian::InvalidArgumentError) {
1517 /* We'll let the philosophers try to wrestle with the
1518 * question of whether failing to remove that which was not
1519 * there in the first place is failure. For us, we'll silently
1520 * consider it all good. */
1525 _notmuch_message_invalidate_metadata (message, prefix_name);
1527 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1530 notmuch_private_status_t
1531 _notmuch_message_has_term (notmuch_message_t *message,
1532 const char *prefix_name,
1538 notmuch_private_status_t status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
1541 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1543 term = talloc_asprintf (message, "%s%s",
1544 _find_prefix (prefix_name), value);
1546 if (strlen (term) > NOTMUCH_TERM_MAX)
1547 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1550 /* Look for the exact term */
1551 Xapian::TermIterator i = message->doc.termlist_begin ();
1553 if (i != message->doc.termlist_end () &&
1554 ! strcmp ((*i).c_str (), term))
1556 } catch (Xapian::Error &error) {
1557 status = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
1566 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1568 notmuch_private_status_t private_status;
1569 notmuch_status_t status;
1571 status = _notmuch_database_ensure_writable (message->notmuch);
1576 return NOTMUCH_STATUS_NULL_POINTER;
1578 if (strlen (tag) > NOTMUCH_TAG_MAX)
1579 return NOTMUCH_STATUS_TAG_TOO_LONG;
1581 private_status = _notmuch_message_add_term (message, "tag", tag);
1582 if (private_status) {
1583 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1587 if (! message->frozen)
1588 _notmuch_message_sync (message);
1590 return NOTMUCH_STATUS_SUCCESS;
1594 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1596 notmuch_private_status_t private_status;
1597 notmuch_status_t status;
1599 status = _notmuch_database_ensure_writable (message->notmuch);
1604 return NOTMUCH_STATUS_NULL_POINTER;
1606 if (strlen (tag) > NOTMUCH_TAG_MAX)
1607 return NOTMUCH_STATUS_TAG_TOO_LONG;
1609 private_status = _notmuch_message_remove_term (message, "tag", tag);
1610 if (private_status) {
1611 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1615 if (! message->frozen)
1616 _notmuch_message_sync (message);
1618 return NOTMUCH_STATUS_SUCCESS;
1621 /* Is the given filename within a maildir directory?
1623 * Specifically, is the final directory component of 'filename' either
1624 * "cur" or "new". If so, return a pointer to that final directory
1625 * component within 'filename'. If not, return NULL.
1627 * A non-NULL return value is guaranteed to be a valid string pointer
1628 * pointing to the characters "new/" or "cur/", (but not
1632 _filename_is_in_maildir (const char *filename)
1634 const char *slash, *dir = NULL;
1636 /* Find the last '/' separating directory from filename. */
1637 slash = strrchr (filename, '/');
1641 /* Jump back 4 characters to where the previous '/' will be if the
1642 * directory is named "cur" or "new". */
1643 if (slash - filename < 4)
1653 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1654 STRNCMP_LITERAL (dir, "new/") == 0) {
1662 _ensure_maildir_flags (notmuch_message_t *message, bool force)
1665 notmuch_filenames_t *filenames;
1666 const char *filename, *dir;
1667 char *combined_flags = talloc_strdup (message, "");
1668 int seen_maildir_info = 0;
1670 if (message->maildir_flags) {
1672 talloc_free (message->maildir_flags);
1673 message->maildir_flags = NULL;
1677 for (filenames = notmuch_message_get_filenames (message);
1678 notmuch_filenames_valid (filenames);
1679 notmuch_filenames_move_to_next (filenames)) {
1680 filename = notmuch_filenames_get (filenames);
1681 dir = _filename_is_in_maildir (filename);
1686 flags = strstr (filename, ":2,");
1688 seen_maildir_info = 1;
1690 combined_flags = talloc_strdup_append (combined_flags, flags);
1691 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1692 /* Messages are delivered to new/ with no "info" part, but
1693 * they effectively have default maildir flags. According
1694 * to the spec, we should ignore the info part for
1695 * messages in new/, but some MUAs (mutt) can set maildir
1696 * flags on messages in new/, so we're liberal in what we
1698 seen_maildir_info = 1;
1701 if (seen_maildir_info)
1702 message->maildir_flags = combined_flags;
1706 notmuch_message_has_maildir_flag (notmuch_message_t *message, char flag)
1708 _ensure_maildir_flags (message, false);
1709 return message->maildir_flags && (strchr (message->maildir_flags, flag) != NULL);
1713 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1715 notmuch_status_t status;
1718 _ensure_maildir_flags (message, true);
1719 /* If none of the filenames have any maildir info field (not even
1720 * an empty info with no flags set) then there's no information to
1721 * go on, so do nothing. */
1722 if (! message->maildir_flags)
1723 return NOTMUCH_STATUS_SUCCESS;
1725 status = notmuch_message_freeze (message);
1729 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1730 if ((strchr (message->maildir_flags, flag2tag[i].flag) != NULL)
1732 flag2tag[i].inverse) {
1733 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1735 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1740 status = notmuch_message_thaw (message);
1745 /* From the set of tags on 'message' and the flag2tag table, compute a
1746 * set of maildir-flag actions to be taken, (flags that should be
1747 * either set or cleared).
1749 * The result is returned as two talloced strings: to_set, and to_clear
1752 _get_maildir_flag_actions (notmuch_message_t *message,
1754 char **to_clear_ret)
1756 char *to_set, *to_clear;
1757 notmuch_tags_t *tags;
1761 to_set = talloc_strdup (message, "");
1762 to_clear = talloc_strdup (message, "");
1764 /* First, find flags for all set tags. */
1765 for (tags = notmuch_message_get_tags (message);
1766 notmuch_tags_valid (tags);
1767 notmuch_tags_move_to_next (tags)) {
1768 tag = notmuch_tags_get (tags);
1770 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1771 if (strcmp (tag, flag2tag[i].tag) == 0) {
1772 if (flag2tag[i].inverse)
1773 to_clear = talloc_asprintf_append (to_clear,
1777 to_set = talloc_asprintf_append (to_set,
1784 /* Then, find the flags for all tags not present. */
1785 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1786 if (flag2tag[i].inverse) {
1787 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1788 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1790 if (strchr (to_set, flag2tag[i].flag) == NULL)
1791 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1795 *to_set_ret = to_set;
1796 *to_clear_ret = to_clear;
1799 /* Given 'filename' and a set of maildir flags to set and to clear,
1800 * compute the new maildir filename.
1802 * If the existing filename is in the directory "new", the new
1803 * filename will be in the directory "cur", except for the case when
1804 * no flags are changed and the existing filename does not contain
1805 * maildir info (starting with ",2:").
1807 * After a sequence of ":2," in the filename, any subsequent
1808 * single-character flags will be added or removed according to the
1809 * characters in flags_to_set and flags_to_clear. Any existing flags
1810 * not mentioned in either string will remain. The final list of flags
1811 * will be in ASCII order.
1813 * If the original flags seem invalid, (repeated characters or
1814 * non-ASCII ordering of flags), this function will return NULL
1815 * (meaning that renaming would not be safe and should not occur).
1818 _new_maildir_filename (void *ctx,
1819 const char *filename,
1820 const char *flags_to_set,
1821 const char *flags_to_clear)
1823 const char *info, *flags;
1824 unsigned int flag, last_flag;
1825 char *filename_new, *dir;
1827 int flags_in_map = 0;
1828 bool flags_changed = false;
1832 memset (flag_map, 0, sizeof (flag_map));
1834 info = strstr (filename, ":2,");
1837 info = filename + strlen (filename);
1839 /* Loop through existing flags in filename. */
1840 for (flags = info + 3, last_flag = 0;
1842 last_flag = flag, flags++) {
1845 /* Original flags not in ASCII order. Abort. */
1846 if (flag < last_flag)
1849 /* Non-ASCII flag. Abort. */
1850 if (flag > sizeof (flag_map) - 1)
1853 /* Repeated flag value. Abort. */
1862 /* Then set and clear our flags from tags. */
1863 for (flags = flags_to_set; *flags; flags++) {
1865 if (flag_map[flag] == 0) {
1868 flags_changed = true;
1872 for (flags = flags_to_clear; *flags; flags++) {
1874 if (flag_map[flag]) {
1877 flags_changed = true;
1881 /* Messages in new/ without maildir info can be kept in new/ if no
1882 * flags have changed. */
1883 dir = (char *) _filename_is_in_maildir (filename);
1884 if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && ! *info && ! flags_changed)
1885 return talloc_strdup (ctx, filename);
1887 filename_new = (char *) talloc_size (ctx,
1889 strlen (":2,") + flags_in_map + 1);
1890 if (unlikely (filename_new == NULL))
1893 strncpy (filename_new, filename, info - filename);
1894 filename_new[info - filename] = '\0';
1896 strcat (filename_new, ":2,");
1898 s = filename_new + strlen (filename_new);
1899 for (i = 0; i < sizeof (flag_map); i++) {
1907 /* If message is in new/ move it under cur/. */
1908 dir = (char *) _filename_is_in_maildir (filename_new);
1909 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1910 memcpy (dir, "cur/", 4);
1912 return filename_new;
1916 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1918 notmuch_filenames_t *filenames;
1919 const char *filename;
1921 char *to_set, *to_clear;
1922 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1924 _get_maildir_flag_actions (message, &to_set, &to_clear);
1926 for (filenames = notmuch_message_get_filenames (message);
1927 notmuch_filenames_valid (filenames);
1928 notmuch_filenames_move_to_next (filenames)) {
1929 filename = notmuch_filenames_get (filenames);
1931 if (! _filename_is_in_maildir (filename))
1934 filename_new = _new_maildir_filename (message, filename,
1936 if (filename_new == NULL)
1939 if (strcmp (filename, filename_new)) {
1941 notmuch_status_t new_status;
1943 err = rename (filename, filename_new);
1947 new_status = _notmuch_message_remove_filename (message,
1949 /* Hold on to only the first error. */
1950 if (! status && new_status
1951 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1952 status = new_status;
1956 new_status = _notmuch_message_add_filename (message,
1958 /* Hold on to only the first error. */
1959 if (! status && new_status) {
1960 status = new_status;
1964 _notmuch_message_sync (message);
1967 talloc_free (filename_new);
1970 talloc_free (to_set);
1971 talloc_free (to_clear);
1977 notmuch_message_remove_all_tags (notmuch_message_t *message)
1979 notmuch_private_status_t private_status;
1980 notmuch_status_t status;
1981 notmuch_tags_t *tags;
1984 status = _notmuch_database_ensure_writable (message->notmuch);
1988 for (tags = notmuch_message_get_tags (message);
1989 notmuch_tags_valid (tags);
1990 notmuch_tags_move_to_next (tags)) {
1991 tag = notmuch_tags_get (tags);
1993 private_status = _notmuch_message_remove_term (message, "tag", tag);
1994 if (private_status) {
1995 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
2000 if (! message->frozen)
2001 _notmuch_message_sync (message);
2004 return NOTMUCH_STATUS_SUCCESS;
2008 notmuch_message_freeze (notmuch_message_t *message)
2010 notmuch_status_t status;
2012 status = _notmuch_database_ensure_writable (message->notmuch);
2018 return NOTMUCH_STATUS_SUCCESS;
2022 notmuch_message_thaw (notmuch_message_t *message)
2024 notmuch_status_t status;
2026 status = _notmuch_database_ensure_writable (message->notmuch);
2030 if (message->frozen > 0) {
2032 if (message->frozen == 0)
2033 _notmuch_message_sync (message);
2034 return NOTMUCH_STATUS_SUCCESS;
2036 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
2041 notmuch_message_destroy (notmuch_message_t *message)
2043 talloc_free (message);
2046 notmuch_database_t *
2047 notmuch_message_get_database (const notmuch_message_t *message)
2049 return message->notmuch;
2053 _notmuch_message_ensure_property_map (notmuch_message_t *message)
2055 notmuch_string_node_t *node;
2057 if (message->property_map)
2060 _notmuch_message_ensure_metadata (message, message->property_term_list);
2062 message->property_map = _notmuch_string_map_create (message);
2064 for (node = message->property_term_list->head; node; node = node->next) {
2068 value = strchr (node->string, '=');
2070 INTERNAL_ERROR ("malformed property term");
2076 _notmuch_string_map_append (message->property_map, key, value);
2080 talloc_free (message->property_term_list);
2081 message->property_term_list = NULL;
2084 notmuch_string_map_t *
2085 _notmuch_message_property_map (notmuch_message_t *message)
2087 _notmuch_message_ensure_property_map (message);
2089 return message->property_map;
2093 _notmuch_message_frozen (notmuch_message_t *message)
2095 return message->frozen;
2099 notmuch_message_reindex (notmuch_message_t *message,
2100 notmuch_indexopts_t *indexopts)
2102 notmuch_database_t *notmuch = NULL;
2103 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2104 notmuch_private_status_t private_status;
2105 notmuch_filenames_t *orig_filenames = NULL;
2106 const char *orig_thread_id = NULL;
2107 notmuch_message_file_t *message_file = NULL;
2111 if (message == NULL)
2112 return NOTMUCH_STATUS_NULL_POINTER;
2114 /* Save in case we need to delete message */
2115 orig_thread_id = notmuch_message_get_thread_id (message);
2116 if (! orig_thread_id) {
2117 /* XXX TODO: make up new error return? */
2118 INTERNAL_ERROR ("message without thread-id");
2121 /* strdup it because the metadata may be invalidated */
2122 orig_thread_id = talloc_strdup (message, orig_thread_id);
2124 notmuch = notmuch_message_get_database (message);
2126 ret = _notmuch_database_ensure_writable (notmuch);
2130 orig_filenames = notmuch_message_get_filenames (message);
2132 private_status = _notmuch_message_remove_indexed_terms (message);
2133 if (private_status) {
2134 ret = COERCE_STATUS (private_status, "error removing terms");
2138 ret = notmuch_message_remove_all_properties_with_prefix (message, "index.");
2140 goto DONE; /* XXX TODO: distinguish from other error returns above? */
2141 if (indexopts && notmuch_indexopts_get_decrypt_policy (indexopts) == NOTMUCH_DECRYPT_FALSE) {
2142 ret = notmuch_message_remove_all_properties (message, "session-key");
2147 /* re-add the filenames with the associated indexopts */
2148 for (; notmuch_filenames_valid (orig_filenames);
2149 notmuch_filenames_move_to_next (orig_filenames)) {
2152 const char *from, *to, *subject;
2153 char *message_id = NULL;
2154 const char *thread_id = NULL;
2156 const char *filename = notmuch_filenames_get (orig_filenames);
2158 message_file = _notmuch_message_file_open (notmuch, filename);
2159 if (message_file == NULL)
2162 ret = _notmuch_message_file_get_headers (message_file,
2163 &from, &subject, &to, &date,
2168 /* XXX TODO: deal with changing message id? */
2170 _notmuch_message_add_filename (message, filename);
2172 ret = _notmuch_database_link_message_to_parents (notmuch, message,
2178 if (thread_id == NULL)
2179 thread_id = orig_thread_id;
2181 _notmuch_message_add_term (message, "thread", thread_id);
2182 /* Take header values only from first filename */
2184 _notmuch_message_set_header_values (message, date, from, subject);
2186 ret = _notmuch_message_index_file (message, indexopts, message_file);
2188 if (ret == NOTMUCH_STATUS_FILE_ERROR)
2194 _notmuch_message_file_close (message_file);
2195 message_file = NULL;
2198 /* put back thread id to help cleanup */
2199 _notmuch_message_add_term (message, "thread", orig_thread_id);
2200 ret = _notmuch_message_delete (message);
2202 _notmuch_message_sync (message);
2207 _notmuch_message_file_close (message_file);
2209 /* XXX TODO destroy orig_filenames? */