1 /* message.cc - Results of message-based searches from a notmuch database
3 * Copyright © 2009 Carl Worth
5 * This program is free software: you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation, either version 3 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this program. If not, see http://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "notmuch-private.h"
22 #include "database-private.h"
26 #include <gmime/gmime.h>
28 struct visible _notmuch_message {
29 notmuch_database_t *notmuch;
35 notmuch_string_list_t *tag_list;
36 notmuch_string_list_t *filename_term_list;
37 notmuch_string_list_t *filename_list;
39 notmuch_message_file_t *message_file;
40 notmuch_message_list_t *replies;
44 Xapian::termcount termpos;
47 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
49 struct maildir_flag_tag {
55 /* ASCII ordered table of Maildir flags and associated tags */
56 static struct maildir_flag_tag flag2tag[] = {
57 { 'D', "draft", false},
58 { 'F', "flagged", false},
59 { 'P', "passed", false},
60 { 'R', "replied", false},
61 { 'S', "unread", true }
64 /* We end up having to call the destructor explicitly because we had
65 * to use "placement new" in order to initialize C++ objects within a
66 * block that we allocated with talloc. So C++ is making talloc
67 * slightly less simple to use, (we wouldn't need
68 * talloc_set_destructor at all otherwise).
71 _notmuch_message_destructor (notmuch_message_t *message)
73 message->doc.~Document ();
78 static notmuch_message_t *
79 _notmuch_message_create_for_document (const void *talloc_owner,
80 notmuch_database_t *notmuch,
83 notmuch_private_status_t *status)
85 notmuch_message_t *message;
88 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
90 message = talloc (talloc_owner, notmuch_message_t);
91 if (unlikely (message == NULL)) {
93 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
97 message->notmuch = notmuch;
98 message->doc_id = doc_id;
103 /* Each of these will be lazily created as needed. */
104 message->message_id = NULL;
105 message->thread_id = NULL;
106 message->in_reply_to = NULL;
107 message->tag_list = NULL;
108 message->filename_term_list = NULL;
109 message->filename_list = NULL;
110 message->message_file = NULL;
111 message->author = NULL;
113 message->replies = _notmuch_message_list_create (message);
114 if (unlikely (message->replies == NULL)) {
116 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
120 /* This is C++'s creepy "placement new", which is really just an
121 * ugly way to call a constructor for a pre-allocated object. So
122 * it's really not an error to not be checking for OUT_OF_MEMORY
123 * here, since this "new" isn't actually allocating memory. This
124 * is language-design comedy of the wrong kind. */
126 new (&message->doc) Xapian::Document;
128 talloc_set_destructor (message, _notmuch_message_destructor);
131 message->termpos = 0;
136 /* Create a new notmuch_message_t object for an existing document in
139 * Here, 'talloc owner' is an optional talloc context to which the new
140 * message will belong. This allows for the caller to not bother
141 * calling notmuch_message_destroy on the message, and know that all
142 * memory will be reclaimed when 'talloc_owner' is freed. The caller
143 * still can call notmuch_message_destroy when finished with the
144 * message if desired.
146 * The 'talloc_owner' argument can also be NULL, in which case the
147 * caller *is* responsible for calling notmuch_message_destroy.
149 * If no document exists in the database with document ID of 'doc_id'
150 * then this function returns NULL and optionally sets *status to
151 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
153 * This function can also fail to due lack of available memory,
154 * returning NULL and optionally setting *status to
155 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
157 * The caller can pass NULL for status if uninterested in
158 * distinguishing these two cases.
161 _notmuch_message_create (const void *talloc_owner,
162 notmuch_database_t *notmuch,
164 notmuch_private_status_t *status)
166 Xapian::Document doc;
169 doc = notmuch->xapian_db->get_document (doc_id);
170 } catch (const Xapian::DocNotFoundError &error) {
172 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
176 return _notmuch_message_create_for_document (talloc_owner, notmuch,
177 doc_id, doc, status);
180 /* Create a new notmuch_message_t object for a specific message ID,
181 * (which may or may not already exist in the database).
183 * The 'notmuch' database will be the talloc owner of the returned
186 * This function returns a valid notmuch_message_t whether or not
187 * there is already a document in the database with the given message
188 * ID. These two cases can be distinguished by the value of *status:
191 * NOTMUCH_PRIVATE_STATUS_SUCCESS:
193 * There is already a document with message ID 'message_id' in the
194 * database. The returned message can be used to query/modify the
196 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND:
198 * No document with 'message_id' exists in the database. The
199 * returned message contains a newly created document (not yet
200 * added to the database) and a document ID that is known not to
201 * exist in the database. The caller can modify the message, and a
202 * call to _notmuch_message_sync will add * the document to the
205 * If an error occurs, this function will return NULL and *status
206 * will be set as appropriate. (The status pointer argument must
210 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
211 const char *message_id,
212 notmuch_private_status_t *status_ret)
214 notmuch_message_t *message;
215 Xapian::Document doc;
219 *status_ret = (notmuch_private_status_t) notmuch_database_find_message (notmuch,
223 return talloc_steal (notmuch, message);
224 else if (*status_ret)
227 term = talloc_asprintf (NULL, "%s%s",
228 _find_prefix ("id"), message_id);
230 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
234 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
235 INTERNAL_ERROR ("Failure to ensure database is writable.");
238 doc.add_term (term, 0);
241 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
243 doc_id = _notmuch_database_generate_doc_id (notmuch);
244 } catch (const Xapian::Error &error) {
245 fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
246 error.get_msg().c_str());
247 notmuch->exception_reported = TRUE;
248 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
252 message = _notmuch_message_create_for_document (notmuch, notmuch,
253 doc_id, doc, status_ret);
255 /* We want to inform the caller that we had to create a new
257 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
258 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
264 _notmuch_message_get_term (notmuch_message_t *message,
265 Xapian::TermIterator &i, Xapian::TermIterator &end,
268 int prefix_len = strlen (prefix);
269 const char *term = NULL;
275 term = (*i).c_str ();
277 if (!term || strncmp (term, prefix, prefix_len))
280 value = talloc_strdup (message, term + prefix_len);
282 #if DEBUG_DATABASE_SANITY
285 if (i != end && strncmp ((*i).c_str (), prefix, prefix_len) == 0) {
286 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate %s terms: %s and %s\n",
287 message->doc_id, prefix, value,
288 (*i).c_str () + prefix_len);
296 _notmuch_message_ensure_metadata (notmuch_message_t *message)
298 Xapian::TermIterator i, end;
299 const char *thread_prefix = _find_prefix ("thread"),
300 *tag_prefix = _find_prefix ("tag"),
301 *id_prefix = _find_prefix ("id"),
302 *filename_prefix = _find_prefix ("file-direntry"),
303 *replyto_prefix = _find_prefix ("replyto");
305 /* We do this all in a single pass because Xapian decompresses the
306 * term list every time you iterate over it. Thus, while this is
307 * slightly more costly than looking up individual fields if only
308 * one field of the message object is actually used, it's a huge
309 * win as more fields are used. */
311 i = message->doc.termlist_begin ();
312 end = message->doc.termlist_end ();
315 if (!message->thread_id)
317 _notmuch_message_get_term (message, i, end, thread_prefix);
320 assert (strcmp (thread_prefix, tag_prefix) < 0);
321 if (!message->tag_list) {
323 _notmuch_database_get_terms_with_prefix (message, i, end,
325 _notmuch_string_list_sort (message->tag_list);
329 assert (strcmp (tag_prefix, id_prefix) < 0);
330 if (!message->message_id)
331 message->message_id =
332 _notmuch_message_get_term (message, i, end, id_prefix);
334 /* Get filename list. Here we get only the terms. We lazily
335 * expand them to full file names when needed in
336 * _notmuch_message_ensure_filename_list. */
337 assert (strcmp (id_prefix, filename_prefix) < 0);
338 if (!message->filename_term_list && !message->filename_list)
339 message->filename_term_list =
340 _notmuch_database_get_terms_with_prefix (message, i, end,
344 assert (strcmp (filename_prefix, replyto_prefix) < 0);
345 if (!message->in_reply_to)
346 message->in_reply_to =
347 _notmuch_message_get_term (message, i, end, replyto_prefix);
348 /* It's perfectly valid for a message to have no In-Reply-To
349 * header. For these cases, we return an empty string. */
350 if (!message->in_reply_to)
351 message->in_reply_to = talloc_strdup (message, "");
355 _notmuch_message_invalidate_metadata (notmuch_message_t *message,
356 const char *prefix_name)
358 if (strcmp ("thread", prefix_name) == 0) {
359 talloc_free (message->thread_id);
360 message->thread_id = NULL;
363 if (strcmp ("tag", prefix_name) == 0) {
364 talloc_unlink (message, message->tag_list);
365 message->tag_list = NULL;
368 if (strcmp ("file-direntry", prefix_name) == 0) {
369 talloc_free (message->filename_term_list);
370 talloc_free (message->filename_list);
371 message->filename_term_list = message->filename_list = NULL;
374 if (strcmp ("replyto", prefix_name) == 0) {
375 talloc_free (message->in_reply_to);
376 message->in_reply_to = NULL;
381 _notmuch_message_get_doc_id (notmuch_message_t *message)
383 return message->doc_id;
387 notmuch_message_get_message_id (notmuch_message_t *message)
389 if (!message->message_id)
390 _notmuch_message_ensure_metadata (message);
391 if (!message->message_id)
392 INTERNAL_ERROR ("Message with document ID of %u has no message ID.\n",
394 return message->message_id;
398 _notmuch_message_ensure_message_file (notmuch_message_t *message)
400 const char *filename;
402 if (message->message_file)
405 filename = notmuch_message_get_filename (message);
406 if (unlikely (filename == NULL))
409 message->message_file = _notmuch_message_file_open_ctx (message, filename);
413 notmuch_message_get_header (notmuch_message_t *message, const char *header)
415 _notmuch_message_ensure_message_file (message);
416 if (message->message_file == NULL)
419 return notmuch_message_file_get_header (message->message_file, header);
422 /* Return the message ID from the In-Reply-To header of 'message'.
424 * Returns an empty string ("") if 'message' has no In-Reply-To
427 * Returns NULL if any error occurs.
430 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
432 if (!message->in_reply_to)
433 _notmuch_message_ensure_metadata (message);
434 return message->in_reply_to;
438 notmuch_message_get_thread_id (notmuch_message_t *message)
440 if (!message->thread_id)
441 _notmuch_message_ensure_metadata (message);
442 if (!message->thread_id)
443 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
445 return message->thread_id;
449 _notmuch_message_add_reply (notmuch_message_t *message,
450 notmuch_message_node_t *reply)
452 _notmuch_message_list_append (message->replies, reply);
456 notmuch_message_get_replies (notmuch_message_t *message)
458 return _notmuch_messages_create (message->replies);
461 /* Add an additional 'filename' for 'message'.
463 * This change will not be reflected in the database until the next
464 * call to _notmuch_message_sync. */
466 _notmuch_message_add_filename (notmuch_message_t *message,
467 const char *filename)
469 const char *relative, *directory;
470 notmuch_status_t status;
471 void *local = talloc_new (message);
474 if (filename == NULL)
475 INTERNAL_ERROR ("Message filename cannot be NULL.");
477 relative = _notmuch_database_relative_path (message->notmuch, filename);
479 status = _notmuch_database_split_path (local, relative, &directory, NULL);
483 status = _notmuch_database_filename_to_direntry (local,
485 filename, &direntry);
489 /* New file-direntry allows navigating to this message with
490 * notmuch_directory_get_child_files() . */
491 _notmuch_message_add_term (message, "file-direntry", direntry);
493 /* New terms allow user to search with folder: specification. */
494 _notmuch_message_gen_terms (message, "folder", directory);
498 return NOTMUCH_STATUS_SUCCESS;
501 /* Remove a particular 'filename' from 'message'.
503 * This change will not be reflected in the database until the next
504 * call to _notmuch_message_sync.
506 * If this message still has other filenames, returns
507 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
509 * Note: This function does not remove a document from the database,
510 * even if the specified filename is the only filename for this
511 * message. For that functionality, see
512 * _notmuch_database_remove_message. */
514 _notmuch_message_remove_filename (notmuch_message_t *message,
515 const char *filename)
517 const char *direntry_prefix = _find_prefix ("file-direntry");
518 int direntry_prefix_len = strlen (direntry_prefix);
519 const char *folder_prefix = _find_prefix ("folder");
520 int folder_prefix_len = strlen (folder_prefix);
521 void *local = talloc_new (message);
522 char *zfolder_prefix = talloc_asprintf(local, "Z%s", folder_prefix);
523 int zfolder_prefix_len = strlen (zfolder_prefix);
525 notmuch_private_status_t private_status;
526 notmuch_status_t status;
527 Xapian::TermIterator i, last;
529 status = _notmuch_database_filename_to_direntry (local, message->notmuch,
530 filename, &direntry);
534 /* Unlink this file from its parent directory. */
535 private_status = _notmuch_message_remove_term (message,
536 "file-direntry", direntry);
537 status = COERCE_STATUS (private_status,
538 "Unexpected error from _notmuch_message_remove_term");
542 /* Re-synchronize "folder:" terms for this message. This requires:
543 * 1. removing all "folder:" terms
544 * 2. removing all "folder:" stemmed terms
545 * 3. adding back terms for all remaining filenames of the message. */
547 /* 1. removing all "folder:" terms */
549 i = message->doc.termlist_begin ();
550 i.skip_to (folder_prefix);
552 /* Terminate loop when no terms remain with desired prefix. */
553 if (i == message->doc.termlist_end () ||
554 strncmp ((*i).c_str (), folder_prefix, folder_prefix_len))
560 message->doc.remove_term ((*i));
561 } catch (const Xapian::InvalidArgumentError) {
562 /* Ignore failure to remove non-existent term. */
566 /* 2. removing all "folder:" stemmed terms */
568 i = message->doc.termlist_begin ();
569 i.skip_to (zfolder_prefix);
571 /* Terminate loop when no terms remain with desired prefix. */
572 if (i == message->doc.termlist_end () ||
573 strncmp ((*i).c_str (), zfolder_prefix, zfolder_prefix_len))
579 message->doc.remove_term ((*i));
580 } catch (const Xapian::InvalidArgumentError) {
581 /* Ignore failure to remove non-existent term. */
585 /* 3. adding back terms for all remaining filenames of the message. */
586 i = message->doc.termlist_begin ();
587 i.skip_to (direntry_prefix);
589 for (; i != message->doc.termlist_end (); i++) {
590 unsigned int directory_id;
591 const char *direntry, *directory;
594 /* Terminate loop at first term without desired prefix. */
595 if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
598 /* Indicate that there are filenames remaining. */
599 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
601 direntry = (*i).c_str ();
602 direntry += direntry_prefix_len;
604 directory_id = strtol (direntry, &colon, 10);
606 if (colon == NULL || *colon != ':')
607 INTERNAL_ERROR ("malformed direntry");
609 directory = _notmuch_database_get_directory_path (local,
612 if (strlen (directory))
613 _notmuch_message_gen_terms (message, "folder", directory);
622 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
624 return talloc_strdup (message, message->doc.get_data ().c_str ());
628 _notmuch_message_clear_data (notmuch_message_t *message)
630 message->doc.set_data ("");
634 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
636 notmuch_string_node_t *node;
638 if (message->filename_list)
641 if (!message->filename_term_list)
642 _notmuch_message_ensure_metadata (message);
644 message->filename_list = _notmuch_string_list_create (message);
645 node = message->filename_term_list->head;
648 /* A message document created by an old version of notmuch
649 * (prior to rename support) will have the filename in the
650 * data of the document rather than as a file-direntry term.
652 * It would be nice to do the upgrade of the document directly
653 * here, but the database is likely open in read-only mode. */
656 data = message->doc.get_data ().c_str ();
659 INTERNAL_ERROR ("message with no filename");
661 _notmuch_string_list_append (message->filename_list, data);
666 for (; node; node = node->next) {
667 void *local = talloc_new (message);
668 const char *db_path, *directory, *basename, *filename;
669 char *colon, *direntry = NULL;
670 unsigned int directory_id;
672 direntry = node->string;
674 directory_id = strtol (direntry, &colon, 10);
676 if (colon == NULL || *colon != ':')
677 INTERNAL_ERROR ("malformed direntry");
679 basename = colon + 1;
683 db_path = notmuch_database_get_path (message->notmuch);
685 directory = _notmuch_database_get_directory_path (local,
689 if (strlen (directory))
690 filename = talloc_asprintf (message, "%s/%s/%s",
691 db_path, directory, basename);
693 filename = talloc_asprintf (message, "%s/%s",
696 _notmuch_string_list_append (message->filename_list, filename);
701 talloc_free (message->filename_term_list);
702 message->filename_term_list = NULL;
706 notmuch_message_get_filename (notmuch_message_t *message)
708 _notmuch_message_ensure_filename_list (message);
710 if (message->filename_list == NULL)
713 if (message->filename_list->head == NULL ||
714 message->filename_list->head->string == NULL)
716 INTERNAL_ERROR ("message with no filename");
719 return message->filename_list->head->string;
722 notmuch_filenames_t *
723 notmuch_message_get_filenames (notmuch_message_t *message)
725 _notmuch_message_ensure_filename_list (message);
727 return _notmuch_filenames_create (message, message->filename_list);
731 notmuch_message_get_flag (notmuch_message_t *message,
732 notmuch_message_flag_t flag)
734 return message->flags & (1 << flag);
738 notmuch_message_set_flag (notmuch_message_t *message,
739 notmuch_message_flag_t flag, notmuch_bool_t enable)
742 message->flags |= (1 << flag);
744 message->flags &= ~(1 << flag);
748 notmuch_message_get_date (notmuch_message_t *message)
753 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
754 } catch (Xapian::Error &error) {
755 INTERNAL_ERROR ("Failed to read timestamp value from document.");
759 return Xapian::sortable_unserialise (value);
763 notmuch_message_get_tags (notmuch_message_t *message)
765 notmuch_tags_t *tags;
767 if (!message->tag_list)
768 _notmuch_message_ensure_metadata (message);
770 tags = _notmuch_tags_create (message, message->tag_list);
771 /* _notmuch_tags_create steals the reference to the tag_list, but
772 * in this case it's still used by the message, so we add an
773 * *additional* talloc reference to the list. As a result, it's
774 * possible to modify the message tags (which talloc_unlink's the
775 * current list from the message) while still iterating because
776 * the iterator will keep the current list alive. */
777 talloc_reference (message, message->tag_list);
782 notmuch_message_get_author (notmuch_message_t *message)
784 return message->author;
788 notmuch_message_set_author (notmuch_message_t *message,
792 talloc_free(message->author);
793 message->author = talloc_strdup(message, author);
798 _notmuch_message_set_date (notmuch_message_t *message,
803 /* GMime really doesn't want to see a NULL date, so protect its
805 if (date == NULL || *date == '\0')
808 time_value = g_mime_utils_header_decode_date (date, NULL);
810 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
811 Xapian::sortable_serialise (time_value));
814 /* Synchronize changes made to message->doc out into the database. */
816 _notmuch_message_sync (notmuch_message_t *message)
818 Xapian::WritableDatabase *db;
820 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
823 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
824 db->replace_document (message->doc_id, message->doc);
827 /* Delete a message document from the database. */
829 _notmuch_message_delete (notmuch_message_t *message)
831 notmuch_status_t status;
832 Xapian::WritableDatabase *db;
834 status = _notmuch_database_ensure_writable (message->notmuch);
838 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
839 db->delete_document (message->doc_id);
840 return NOTMUCH_STATUS_SUCCESS;
843 /* Ensure that 'message' is not holding any file object open. Future
844 * calls to various functions will still automatically open the
845 * message file as needed.
848 _notmuch_message_close (notmuch_message_t *message)
850 if (message->message_file) {
851 notmuch_message_file_close (message->message_file);
852 message->message_file = NULL;
856 /* Add a name:value term to 'message', (the actual term will be
857 * encoded by prefixing the value with a short prefix). See
858 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
859 * names to prefix values.
861 * This change will not be reflected in the database until the next
862 * call to _notmuch_message_sync. */
863 notmuch_private_status_t
864 _notmuch_message_add_term (notmuch_message_t *message,
865 const char *prefix_name,
872 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
874 term = talloc_asprintf (message, "%s%s",
875 _find_prefix (prefix_name), value);
877 if (strlen (term) > NOTMUCH_TERM_MAX)
878 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
880 message->doc.add_term (term, 0);
884 _notmuch_message_invalidate_metadata (message, prefix_name);
886 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
889 /* Parse 'text' and add a term to 'message' for each parsed word. Each
890 * term will be added both prefixed (if prefix_name is not NULL) and
891 * also non-prefixed). */
892 notmuch_private_status_t
893 _notmuch_message_gen_terms (notmuch_message_t *message,
894 const char *prefix_name,
897 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
900 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
902 term_gen->set_document (message->doc);
903 term_gen->set_termpos (message->termpos);
906 const char *prefix = _find_prefix (prefix_name);
908 term_gen->index_text (text, 1, prefix);
909 message->termpos = term_gen->get_termpos ();
912 term_gen->index_text (text);
914 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
917 /* Remove a name:value term from 'message', (the actual term will be
918 * encoded by prefixing the value with a short prefix). See
919 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
920 * names to prefix values.
922 * This change will not be reflected in the database until the next
923 * call to _notmuch_message_sync. */
924 notmuch_private_status_t
925 _notmuch_message_remove_term (notmuch_message_t *message,
926 const char *prefix_name,
932 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
934 term = talloc_asprintf (message, "%s%s",
935 _find_prefix (prefix_name), value);
937 if (strlen (term) > NOTMUCH_TERM_MAX)
938 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
941 message->doc.remove_term (term);
942 } catch (const Xapian::InvalidArgumentError) {
943 /* We'll let the philosopher's try to wrestle with the
944 * question of whether failing to remove that which was not
945 * there in the first place is failure. For us, we'll silently
946 * consider it all good. */
951 _notmuch_message_invalidate_metadata (message, prefix_name);
953 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
957 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
959 notmuch_private_status_t private_status;
960 notmuch_status_t status;
962 status = _notmuch_database_ensure_writable (message->notmuch);
967 return NOTMUCH_STATUS_NULL_POINTER;
969 if (strlen (tag) > NOTMUCH_TAG_MAX)
970 return NOTMUCH_STATUS_TAG_TOO_LONG;
972 private_status = _notmuch_message_add_term (message, "tag", tag);
973 if (private_status) {
974 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
978 if (! message->frozen)
979 _notmuch_message_sync (message);
981 return NOTMUCH_STATUS_SUCCESS;
985 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
987 notmuch_private_status_t private_status;
988 notmuch_status_t status;
990 status = _notmuch_database_ensure_writable (message->notmuch);
995 return NOTMUCH_STATUS_NULL_POINTER;
997 if (strlen (tag) > NOTMUCH_TAG_MAX)
998 return NOTMUCH_STATUS_TAG_TOO_LONG;
1000 private_status = _notmuch_message_remove_term (message, "tag", tag);
1001 if (private_status) {
1002 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1006 if (! message->frozen)
1007 _notmuch_message_sync (message);
1009 return NOTMUCH_STATUS_SUCCESS;
1013 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1016 notmuch_status_t status;
1017 notmuch_filenames_t *filenames;
1018 const char *filename;
1019 char *combined_flags = talloc_strdup (message, "");
1021 int seen_maildir_info = 0;
1023 for (filenames = notmuch_message_get_filenames (message);
1024 notmuch_filenames_valid (filenames);
1025 notmuch_filenames_move_to_next (filenames))
1027 filename = notmuch_filenames_get (filenames);
1029 flags = strstr (filename, ":2,");
1033 seen_maildir_info = 1;
1036 combined_flags = talloc_strdup_append (combined_flags, flags);
1039 /* If none of the filenames have any maildir info field (not even
1040 * an empty info with no flags set) then there's no information to
1041 * go on, so do nothing. */
1042 if (! seen_maildir_info)
1043 return NOTMUCH_STATUS_SUCCESS;
1045 status = notmuch_message_freeze (message);
1049 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1050 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1052 flag2tag[i].inverse)
1054 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1056 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1061 status = notmuch_message_thaw (message);
1063 talloc_free (combined_flags);
1068 /* Is the given filename within a maildir directory?
1070 * Specifically, is the final directory component of 'filename' either
1071 * "cur" or "new". If so, return a pointer to that final directory
1072 * component within 'filename'. If not, return NULL.
1074 * A non-NULL return value is guaranteed to be a valid string pointer
1075 * pointing to the characters "new/" or "cur/", (but not
1079 _filename_is_in_maildir (const char *filename)
1081 const char *slash, *dir = NULL;
1083 /* Find the last '/' separating directory from filename. */
1084 slash = strrchr (filename, '/');
1088 /* Jump back 4 characters to where the previous '/' will be if the
1089 * directory is named "cur" or "new". */
1090 if (slash - filename < 4)
1100 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1101 STRNCMP_LITERAL (dir, "new/") == 0)
1109 /* From the set of tags on 'message' and the flag2tag table, compute a
1110 * set of maildir-flag actions to be taken, (flags that should be
1111 * either set or cleared).
1113 * The result is returned as two talloced strings: to_set, and to_clear
1116 _get_maildir_flag_actions (notmuch_message_t *message,
1118 char **to_clear_ret)
1120 char *to_set, *to_clear;
1121 notmuch_tags_t *tags;
1125 to_set = talloc_strdup (message, "");
1126 to_clear = talloc_strdup (message, "");
1128 /* First, find flags for all set tags. */
1129 for (tags = notmuch_message_get_tags (message);
1130 notmuch_tags_valid (tags);
1131 notmuch_tags_move_to_next (tags))
1133 tag = notmuch_tags_get (tags);
1135 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1136 if (strcmp (tag, flag2tag[i].tag) == 0) {
1137 if (flag2tag[i].inverse)
1138 to_clear = talloc_asprintf_append (to_clear,
1142 to_set = talloc_asprintf_append (to_set,
1149 /* Then, find the flags for all tags not present. */
1150 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1151 if (flag2tag[i].inverse) {
1152 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1153 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1155 if (strchr (to_set, flag2tag[i].flag) == NULL)
1156 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1160 *to_set_ret = to_set;
1161 *to_clear_ret = to_clear;
1164 /* Given 'filename' and a set of maildir flags to set and to clear,
1165 * compute the new maildir filename.
1167 * If the existing filename is in the directory "new", the new
1168 * filename will be in the directory "cur".
1170 * After a sequence of ":2," in the filename, any subsequent
1171 * single-character flags will be added or removed according to the
1172 * characters in flags_to_set and flags_to_clear. Any existing flags
1173 * not mentioned in either string will remain. The final list of flags
1174 * will be in ASCII order.
1176 * If the original flags seem invalid, (repeated characters or
1177 * non-ASCII ordering of flags), this function will return NULL
1178 * (meaning that renaming would not be safe and should not occur).
1181 _new_maildir_filename (void *ctx,
1182 const char *filename,
1183 const char *flags_to_set,
1184 const char *flags_to_clear)
1186 const char *info, *flags;
1187 unsigned int flag, last_flag;
1188 char *filename_new, *dir;
1190 int flags_in_map = 0;
1194 memset (flag_map, 0, sizeof (flag_map));
1196 info = strstr (filename, ":2,");
1199 info = filename + strlen(filename);
1203 /* Loop through existing flags in filename. */
1204 for (flags = info + 3, last_flag = 0;
1206 last_flag = flag, flags++)
1210 /* Original flags not in ASCII order. Abort. */
1211 if (flag < last_flag)
1214 /* Non-ASCII flag. Abort. */
1215 if (flag > sizeof(flag_map) - 1)
1218 /* Repeated flag value. Abort. */
1227 /* Then set and clear our flags from tags. */
1228 for (flags = flags_to_set; *flags; flags++) {
1230 if (flag_map[flag] == 0) {
1236 for (flags = flags_to_clear; *flags; flags++) {
1238 if (flag_map[flag]) {
1244 filename_new = (char *) talloc_size (ctx,
1246 strlen (":2,") + flags_in_map + 1);
1247 if (unlikely (filename_new == NULL))
1250 strncpy (filename_new, filename, info - filename);
1251 filename_new[info - filename] = '\0';
1253 strcat (filename_new, ":2,");
1255 s = filename_new + strlen (filename_new);
1256 for (i = 0; i < sizeof (flag_map); i++)
1265 /* If message is in new/ move it under cur/. */
1266 dir = (char *) _filename_is_in_maildir (filename_new);
1267 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1268 memcpy (dir, "cur/", 4);
1270 return filename_new;
1274 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1276 notmuch_filenames_t *filenames;
1277 const char *filename;
1279 char *to_set, *to_clear;
1280 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1282 _get_maildir_flag_actions (message, &to_set, &to_clear);
1284 for (filenames = notmuch_message_get_filenames (message);
1285 notmuch_filenames_valid (filenames);
1286 notmuch_filenames_move_to_next (filenames))
1288 filename = notmuch_filenames_get (filenames);
1290 if (! _filename_is_in_maildir (filename))
1293 filename_new = _new_maildir_filename (message, filename,
1295 if (filename_new == NULL)
1298 if (strcmp (filename, filename_new)) {
1300 notmuch_status_t new_status;
1302 err = rename (filename, filename_new);
1306 new_status = _notmuch_message_remove_filename (message,
1308 /* Hold on to only the first error. */
1309 if (! status && new_status
1310 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1311 status = new_status;
1315 new_status = _notmuch_message_add_filename (message,
1317 /* Hold on to only the first error. */
1318 if (! status && new_status) {
1319 status = new_status;
1323 _notmuch_message_sync (message);
1326 talloc_free (filename_new);
1329 talloc_free (to_set);
1330 talloc_free (to_clear);
1332 return NOTMUCH_STATUS_SUCCESS;
1336 notmuch_message_remove_all_tags (notmuch_message_t *message)
1338 notmuch_private_status_t private_status;
1339 notmuch_status_t status;
1340 notmuch_tags_t *tags;
1343 status = _notmuch_database_ensure_writable (message->notmuch);
1347 for (tags = notmuch_message_get_tags (message);
1348 notmuch_tags_valid (tags);
1349 notmuch_tags_move_to_next (tags))
1351 tag = notmuch_tags_get (tags);
1353 private_status = _notmuch_message_remove_term (message, "tag", tag);
1354 if (private_status) {
1355 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1360 if (! message->frozen)
1361 _notmuch_message_sync (message);
1364 return NOTMUCH_STATUS_SUCCESS;
1368 notmuch_message_freeze (notmuch_message_t *message)
1370 notmuch_status_t status;
1372 status = _notmuch_database_ensure_writable (message->notmuch);
1378 return NOTMUCH_STATUS_SUCCESS;
1382 notmuch_message_thaw (notmuch_message_t *message)
1384 notmuch_status_t status;
1386 status = _notmuch_database_ensure_writable (message->notmuch);
1390 if (message->frozen > 0) {
1392 if (message->frozen == 0)
1393 _notmuch_message_sync (message);
1394 return NOTMUCH_STATUS_SUCCESS;
1396 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1401 notmuch_message_destroy (notmuch_message_t *message)
1403 talloc_free (message);