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 {
52 notmuch_bool_t inverse;
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);
276 std::string term = *i;
277 if (strncmp (term.c_str(), prefix, prefix_len))
280 value = talloc_strdup (message, term.c_str() + 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)
417 /* Fetch header from the appropriate xapian value field if
419 if (strcasecmp (header, "from") == 0)
420 value = message->doc.get_value (NOTMUCH_VALUE_FROM);
421 else if (strcasecmp (header, "subject") == 0)
422 value = message->doc.get_value (NOTMUCH_VALUE_SUBJECT);
423 else if (strcasecmp (header, "message-id") == 0)
424 value = message->doc.get_value (NOTMUCH_VALUE_MESSAGE_ID);
427 return talloc_strdup (message, value.c_str ());
429 /* Otherwise fall back to parsing the file */
430 _notmuch_message_ensure_message_file (message);
431 if (message->message_file == NULL)
434 return notmuch_message_file_get_header (message->message_file, header);
437 /* Return the message ID from the In-Reply-To header of 'message'.
439 * Returns an empty string ("") if 'message' has no In-Reply-To
442 * Returns NULL if any error occurs.
445 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
447 if (!message->in_reply_to)
448 _notmuch_message_ensure_metadata (message);
449 return message->in_reply_to;
453 notmuch_message_get_thread_id (notmuch_message_t *message)
455 if (!message->thread_id)
456 _notmuch_message_ensure_metadata (message);
457 if (!message->thread_id)
458 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
460 return message->thread_id;
464 _notmuch_message_add_reply (notmuch_message_t *message,
465 notmuch_message_t *reply)
467 _notmuch_message_list_add_message (message->replies, reply);
471 notmuch_message_get_replies (notmuch_message_t *message)
473 return _notmuch_messages_create (message->replies);
476 /* Add an additional 'filename' for 'message'.
478 * This change will not be reflected in the database until the next
479 * call to _notmuch_message_sync. */
481 _notmuch_message_add_filename (notmuch_message_t *message,
482 const char *filename)
484 const char *relative, *directory;
485 notmuch_status_t status;
486 void *local = talloc_new (message);
489 if (filename == NULL)
490 INTERNAL_ERROR ("Message filename cannot be NULL.");
492 relative = _notmuch_database_relative_path (message->notmuch, filename);
494 status = _notmuch_database_split_path (local, relative, &directory, NULL);
498 status = _notmuch_database_filename_to_direntry (
499 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
503 /* New file-direntry allows navigating to this message with
504 * notmuch_directory_get_child_files() . */
505 _notmuch_message_add_term (message, "file-direntry", direntry);
507 /* New terms allow user to search with folder: specification. */
508 _notmuch_message_gen_terms (message, "folder", directory);
512 return NOTMUCH_STATUS_SUCCESS;
515 /* Remove a particular 'filename' from 'message'.
517 * This change will not be reflected in the database until the next
518 * call to _notmuch_message_sync.
520 * If this message still has other filenames, returns
521 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
523 * Note: This function does not remove a document from the database,
524 * even if the specified filename is the only filename for this
525 * message. For that functionality, see
526 * _notmuch_database_remove_message. */
528 _notmuch_message_remove_filename (notmuch_message_t *message,
529 const char *filename)
531 const char *direntry_prefix = _find_prefix ("file-direntry");
532 int direntry_prefix_len = strlen (direntry_prefix);
533 const char *folder_prefix = _find_prefix ("folder");
534 int folder_prefix_len = strlen (folder_prefix);
535 void *local = talloc_new (message);
536 char *zfolder_prefix = talloc_asprintf(local, "Z%s", folder_prefix);
537 int zfolder_prefix_len = strlen (zfolder_prefix);
539 notmuch_private_status_t private_status;
540 notmuch_status_t status;
541 Xapian::TermIterator i, last;
543 status = _notmuch_database_filename_to_direntry (
544 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
545 if (status || !direntry)
548 /* Unlink this file from its parent directory. */
549 private_status = _notmuch_message_remove_term (message,
550 "file-direntry", direntry);
551 status = COERCE_STATUS (private_status,
552 "Unexpected error from _notmuch_message_remove_term");
556 /* Re-synchronize "folder:" terms for this message. This requires:
557 * 1. removing all "folder:" terms
558 * 2. removing all "folder:" stemmed terms
559 * 3. adding back terms for all remaining filenames of the message. */
561 /* 1. removing all "folder:" terms */
563 i = message->doc.termlist_begin ();
564 i.skip_to (folder_prefix);
566 /* Terminate loop when no terms remain with desired prefix. */
567 if (i == message->doc.termlist_end () ||
568 strncmp ((*i).c_str (), folder_prefix, folder_prefix_len))
574 message->doc.remove_term ((*i));
575 } catch (const Xapian::InvalidArgumentError) {
576 /* Ignore failure to remove non-existent term. */
580 /* 2. removing all "folder:" stemmed terms */
582 i = message->doc.termlist_begin ();
583 i.skip_to (zfolder_prefix);
585 /* Terminate loop when no terms remain with desired prefix. */
586 if (i == message->doc.termlist_end () ||
587 strncmp ((*i).c_str (), zfolder_prefix, zfolder_prefix_len))
593 message->doc.remove_term ((*i));
594 } catch (const Xapian::InvalidArgumentError) {
595 /* Ignore failure to remove non-existent term. */
599 /* 3. adding back terms for all remaining filenames of the message. */
600 i = message->doc.termlist_begin ();
601 i.skip_to (direntry_prefix);
603 for (; i != message->doc.termlist_end (); i++) {
604 unsigned int directory_id;
605 const char *direntry, *directory;
608 /* Terminate loop at first term without desired prefix. */
609 if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
612 /* Indicate that there are filenames remaining. */
613 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
615 direntry = (*i).c_str ();
616 direntry += direntry_prefix_len;
618 directory_id = strtol (direntry, &colon, 10);
620 if (colon == NULL || *colon != ':')
621 INTERNAL_ERROR ("malformed direntry");
623 directory = _notmuch_database_get_directory_path (local,
626 if (strlen (directory))
627 _notmuch_message_gen_terms (message, "folder", directory);
636 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
638 return talloc_strdup (message, message->doc.get_data ().c_str ());
642 _notmuch_message_clear_data (notmuch_message_t *message)
644 message->doc.set_data ("");
648 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
650 notmuch_string_node_t *node;
652 if (message->filename_list)
655 if (!message->filename_term_list)
656 _notmuch_message_ensure_metadata (message);
658 message->filename_list = _notmuch_string_list_create (message);
659 node = message->filename_term_list->head;
662 /* A message document created by an old version of notmuch
663 * (prior to rename support) will have the filename in the
664 * data of the document rather than as a file-direntry term.
666 * It would be nice to do the upgrade of the document directly
667 * here, but the database is likely open in read-only mode. */
670 data = message->doc.get_data ().c_str ();
673 INTERNAL_ERROR ("message with no filename");
675 _notmuch_string_list_append (message->filename_list, data);
680 for (; node; node = node->next) {
681 void *local = talloc_new (message);
682 const char *db_path, *directory, *basename, *filename;
683 char *colon, *direntry = NULL;
684 unsigned int directory_id;
686 direntry = node->string;
688 directory_id = strtol (direntry, &colon, 10);
690 if (colon == NULL || *colon != ':')
691 INTERNAL_ERROR ("malformed direntry");
693 basename = colon + 1;
697 db_path = notmuch_database_get_path (message->notmuch);
699 directory = _notmuch_database_get_directory_path (local,
703 if (strlen (directory))
704 filename = talloc_asprintf (message, "%s/%s/%s",
705 db_path, directory, basename);
707 filename = talloc_asprintf (message, "%s/%s",
710 _notmuch_string_list_append (message->filename_list, filename);
715 talloc_free (message->filename_term_list);
716 message->filename_term_list = NULL;
720 notmuch_message_get_filename (notmuch_message_t *message)
722 _notmuch_message_ensure_filename_list (message);
724 if (message->filename_list == NULL)
727 if (message->filename_list->head == NULL ||
728 message->filename_list->head->string == NULL)
730 INTERNAL_ERROR ("message with no filename");
733 return message->filename_list->head->string;
736 notmuch_filenames_t *
737 notmuch_message_get_filenames (notmuch_message_t *message)
739 _notmuch_message_ensure_filename_list (message);
741 return _notmuch_filenames_create (message, message->filename_list);
745 notmuch_message_get_flag (notmuch_message_t *message,
746 notmuch_message_flag_t flag)
748 return message->flags & (1 << flag);
752 notmuch_message_set_flag (notmuch_message_t *message,
753 notmuch_message_flag_t flag, notmuch_bool_t enable)
756 message->flags |= (1 << flag);
758 message->flags &= ~(1 << flag);
762 notmuch_message_get_date (notmuch_message_t *message)
767 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
768 } catch (Xapian::Error &error) {
769 INTERNAL_ERROR ("Failed to read timestamp value from document.");
773 return Xapian::sortable_unserialise (value);
777 notmuch_message_get_tags (notmuch_message_t *message)
779 notmuch_tags_t *tags;
781 if (!message->tag_list)
782 _notmuch_message_ensure_metadata (message);
784 tags = _notmuch_tags_create (message, message->tag_list);
785 /* _notmuch_tags_create steals the reference to the tag_list, but
786 * in this case it's still used by the message, so we add an
787 * *additional* talloc reference to the list. As a result, it's
788 * possible to modify the message tags (which talloc_unlink's the
789 * current list from the message) while still iterating because
790 * the iterator will keep the current list alive. */
791 if (!talloc_reference (message, message->tag_list))
798 notmuch_message_get_author (notmuch_message_t *message)
800 return message->author;
804 notmuch_message_set_author (notmuch_message_t *message,
808 talloc_free(message->author);
809 message->author = talloc_strdup(message, author);
814 _notmuch_message_set_header_values (notmuch_message_t *message,
821 /* GMime really doesn't want to see a NULL date, so protect its
823 if (date == NULL || *date == '\0')
826 time_value = g_mime_utils_header_decode_date (date, NULL);
828 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
829 Xapian::sortable_serialise (time_value));
830 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
831 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
834 /* Synchronize changes made to message->doc out into the database. */
836 _notmuch_message_sync (notmuch_message_t *message)
838 Xapian::WritableDatabase *db;
840 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
843 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
844 db->replace_document (message->doc_id, message->doc);
847 /* Delete a message document from the database. */
849 _notmuch_message_delete (notmuch_message_t *message)
851 notmuch_status_t status;
852 Xapian::WritableDatabase *db;
854 status = _notmuch_database_ensure_writable (message->notmuch);
858 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
859 db->delete_document (message->doc_id);
860 return NOTMUCH_STATUS_SUCCESS;
863 /* Ensure that 'message' is not holding any file object open. Future
864 * calls to various functions will still automatically open the
865 * message file as needed.
868 _notmuch_message_close (notmuch_message_t *message)
870 if (message->message_file) {
871 notmuch_message_file_close (message->message_file);
872 message->message_file = NULL;
876 /* Add a name:value term to 'message', (the actual term will be
877 * encoded by prefixing the value with a short prefix). See
878 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
879 * names to prefix values.
881 * This change will not be reflected in the database until the next
882 * call to _notmuch_message_sync. */
883 notmuch_private_status_t
884 _notmuch_message_add_term (notmuch_message_t *message,
885 const char *prefix_name,
892 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
894 term = talloc_asprintf (message, "%s%s",
895 _find_prefix (prefix_name), value);
897 if (strlen (term) > NOTMUCH_TERM_MAX)
898 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
900 message->doc.add_term (term, 0);
904 _notmuch_message_invalidate_metadata (message, prefix_name);
906 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
909 /* Parse 'text' and add a term to 'message' for each parsed word. Each
910 * term will be added both prefixed (if prefix_name is not NULL) and
911 * also non-prefixed). */
912 notmuch_private_status_t
913 _notmuch_message_gen_terms (notmuch_message_t *message,
914 const char *prefix_name,
917 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
920 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
922 term_gen->set_document (message->doc);
923 term_gen->set_termpos (message->termpos);
926 const char *prefix = _find_prefix (prefix_name);
928 term_gen->index_text (text, 1, prefix);
929 message->termpos = term_gen->get_termpos ();
932 term_gen->index_text (text);
934 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
937 /* Remove a name:value term from 'message', (the actual term will be
938 * encoded by prefixing the value with a short prefix). See
939 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
940 * names to prefix values.
942 * This change will not be reflected in the database until the next
943 * call to _notmuch_message_sync. */
944 notmuch_private_status_t
945 _notmuch_message_remove_term (notmuch_message_t *message,
946 const char *prefix_name,
952 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
954 term = talloc_asprintf (message, "%s%s",
955 _find_prefix (prefix_name), value);
957 if (strlen (term) > NOTMUCH_TERM_MAX)
958 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
961 message->doc.remove_term (term);
962 } catch (const Xapian::InvalidArgumentError) {
963 /* We'll let the philosopher's try to wrestle with the
964 * question of whether failing to remove that which was not
965 * there in the first place is failure. For us, we'll silently
966 * consider it all good. */
971 _notmuch_message_invalidate_metadata (message, prefix_name);
973 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
977 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
979 notmuch_private_status_t private_status;
980 notmuch_status_t status;
982 status = _notmuch_database_ensure_writable (message->notmuch);
987 return NOTMUCH_STATUS_NULL_POINTER;
989 if (strlen (tag) > NOTMUCH_TAG_MAX)
990 return NOTMUCH_STATUS_TAG_TOO_LONG;
992 private_status = _notmuch_message_add_term (message, "tag", tag);
993 if (private_status) {
994 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
998 if (! message->frozen)
999 _notmuch_message_sync (message);
1001 return NOTMUCH_STATUS_SUCCESS;
1005 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1007 notmuch_private_status_t private_status;
1008 notmuch_status_t status;
1010 status = _notmuch_database_ensure_writable (message->notmuch);
1015 return NOTMUCH_STATUS_NULL_POINTER;
1017 if (strlen (tag) > NOTMUCH_TAG_MAX)
1018 return NOTMUCH_STATUS_TAG_TOO_LONG;
1020 private_status = _notmuch_message_remove_term (message, "tag", tag);
1021 if (private_status) {
1022 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1026 if (! message->frozen)
1027 _notmuch_message_sync (message);
1029 return NOTMUCH_STATUS_SUCCESS;
1032 /* Is the given filename within a maildir directory?
1034 * Specifically, is the final directory component of 'filename' either
1035 * "cur" or "new". If so, return a pointer to that final directory
1036 * component within 'filename'. If not, return NULL.
1038 * A non-NULL return value is guaranteed to be a valid string pointer
1039 * pointing to the characters "new/" or "cur/", (but not
1043 _filename_is_in_maildir (const char *filename)
1045 const char *slash, *dir = NULL;
1047 /* Find the last '/' separating directory from filename. */
1048 slash = strrchr (filename, '/');
1052 /* Jump back 4 characters to where the previous '/' will be if the
1053 * directory is named "cur" or "new". */
1054 if (slash - filename < 4)
1064 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1065 STRNCMP_LITERAL (dir, "new/") == 0)
1074 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1077 notmuch_status_t status;
1078 notmuch_filenames_t *filenames;
1079 const char *filename, *dir;
1080 char *combined_flags = talloc_strdup (message, "");
1082 int seen_maildir_info = 0;
1084 for (filenames = notmuch_message_get_filenames (message);
1085 notmuch_filenames_valid (filenames);
1086 notmuch_filenames_move_to_next (filenames))
1088 filename = notmuch_filenames_get (filenames);
1089 dir = _filename_is_in_maildir (filename);
1094 flags = strstr (filename, ":2,");
1096 seen_maildir_info = 1;
1098 combined_flags = talloc_strdup_append (combined_flags, flags);
1099 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1100 /* Messages are delivered to new/ with no "info" part, but
1101 * they effectively have default maildir flags. According
1102 * to the spec, we should ignore the info part for
1103 * messages in new/, but some MUAs (mutt) can set maildir
1104 * flags on messages in new/, so we're liberal in what we
1106 seen_maildir_info = 1;
1110 /* If none of the filenames have any maildir info field (not even
1111 * an empty info with no flags set) then there's no information to
1112 * go on, so do nothing. */
1113 if (! seen_maildir_info)
1114 return NOTMUCH_STATUS_SUCCESS;
1116 status = notmuch_message_freeze (message);
1120 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1121 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1123 flag2tag[i].inverse)
1125 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1127 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1132 status = notmuch_message_thaw (message);
1134 talloc_free (combined_flags);
1139 /* From the set of tags on 'message' and the flag2tag table, compute a
1140 * set of maildir-flag actions to be taken, (flags that should be
1141 * either set or cleared).
1143 * The result is returned as two talloced strings: to_set, and to_clear
1146 _get_maildir_flag_actions (notmuch_message_t *message,
1148 char **to_clear_ret)
1150 char *to_set, *to_clear;
1151 notmuch_tags_t *tags;
1155 to_set = talloc_strdup (message, "");
1156 to_clear = talloc_strdup (message, "");
1158 /* First, find flags for all set tags. */
1159 for (tags = notmuch_message_get_tags (message);
1160 notmuch_tags_valid (tags);
1161 notmuch_tags_move_to_next (tags))
1163 tag = notmuch_tags_get (tags);
1165 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1166 if (strcmp (tag, flag2tag[i].tag) == 0) {
1167 if (flag2tag[i].inverse)
1168 to_clear = talloc_asprintf_append (to_clear,
1172 to_set = talloc_asprintf_append (to_set,
1179 /* Then, find the flags for all tags not present. */
1180 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1181 if (flag2tag[i].inverse) {
1182 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1183 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1185 if (strchr (to_set, flag2tag[i].flag) == NULL)
1186 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1190 *to_set_ret = to_set;
1191 *to_clear_ret = to_clear;
1194 /* Given 'filename' and a set of maildir flags to set and to clear,
1195 * compute the new maildir filename.
1197 * If the existing filename is in the directory "new", the new
1198 * filename will be in the directory "cur".
1200 * After a sequence of ":2," in the filename, any subsequent
1201 * single-character flags will be added or removed according to the
1202 * characters in flags_to_set and flags_to_clear. Any existing flags
1203 * not mentioned in either string will remain. The final list of flags
1204 * will be in ASCII order.
1206 * If the original flags seem invalid, (repeated characters or
1207 * non-ASCII ordering of flags), this function will return NULL
1208 * (meaning that renaming would not be safe and should not occur).
1211 _new_maildir_filename (void *ctx,
1212 const char *filename,
1213 const char *flags_to_set,
1214 const char *flags_to_clear)
1216 const char *info, *flags;
1217 unsigned int flag, last_flag;
1218 char *filename_new, *dir;
1220 int flags_in_map = 0;
1224 memset (flag_map, 0, sizeof (flag_map));
1226 info = strstr (filename, ":2,");
1229 info = filename + strlen(filename);
1231 /* Loop through existing flags in filename. */
1232 for (flags = info + 3, last_flag = 0;
1234 last_flag = flag, flags++)
1238 /* Original flags not in ASCII order. Abort. */
1239 if (flag < last_flag)
1242 /* Non-ASCII flag. Abort. */
1243 if (flag > sizeof(flag_map) - 1)
1246 /* Repeated flag value. Abort. */
1255 /* Then set and clear our flags from tags. */
1256 for (flags = flags_to_set; *flags; flags++) {
1258 if (flag_map[flag] == 0) {
1264 for (flags = flags_to_clear; *flags; flags++) {
1266 if (flag_map[flag]) {
1272 filename_new = (char *) talloc_size (ctx,
1274 strlen (":2,") + flags_in_map + 1);
1275 if (unlikely (filename_new == NULL))
1278 strncpy (filename_new, filename, info - filename);
1279 filename_new[info - filename] = '\0';
1281 strcat (filename_new, ":2,");
1283 s = filename_new + strlen (filename_new);
1284 for (i = 0; i < sizeof (flag_map); i++)
1293 /* If message is in new/ move it under cur/. */
1294 dir = (char *) _filename_is_in_maildir (filename_new);
1295 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1296 memcpy (dir, "cur/", 4);
1298 return filename_new;
1302 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1304 notmuch_filenames_t *filenames;
1305 const char *filename;
1307 char *to_set, *to_clear;
1308 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1310 _get_maildir_flag_actions (message, &to_set, &to_clear);
1312 for (filenames = notmuch_message_get_filenames (message);
1313 notmuch_filenames_valid (filenames);
1314 notmuch_filenames_move_to_next (filenames))
1316 filename = notmuch_filenames_get (filenames);
1318 if (! _filename_is_in_maildir (filename))
1321 filename_new = _new_maildir_filename (message, filename,
1323 if (filename_new == NULL)
1326 if (strcmp (filename, filename_new)) {
1328 notmuch_status_t new_status;
1330 err = rename (filename, filename_new);
1334 new_status = _notmuch_message_remove_filename (message,
1336 /* Hold on to only the first error. */
1337 if (! status && new_status
1338 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1339 status = new_status;
1343 new_status = _notmuch_message_add_filename (message,
1345 /* Hold on to only the first error. */
1346 if (! status && new_status) {
1347 status = new_status;
1351 _notmuch_message_sync (message);
1354 talloc_free (filename_new);
1357 talloc_free (to_set);
1358 talloc_free (to_clear);
1360 return NOTMUCH_STATUS_SUCCESS;
1364 notmuch_message_remove_all_tags (notmuch_message_t *message)
1366 notmuch_private_status_t private_status;
1367 notmuch_status_t status;
1368 notmuch_tags_t *tags;
1371 status = _notmuch_database_ensure_writable (message->notmuch);
1375 for (tags = notmuch_message_get_tags (message);
1376 notmuch_tags_valid (tags);
1377 notmuch_tags_move_to_next (tags))
1379 tag = notmuch_tags_get (tags);
1381 private_status = _notmuch_message_remove_term (message, "tag", tag);
1382 if (private_status) {
1383 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1388 if (! message->frozen)
1389 _notmuch_message_sync (message);
1392 return NOTMUCH_STATUS_SUCCESS;
1396 notmuch_message_freeze (notmuch_message_t *message)
1398 notmuch_status_t status;
1400 status = _notmuch_database_ensure_writable (message->notmuch);
1406 return NOTMUCH_STATUS_SUCCESS;
1410 notmuch_message_thaw (notmuch_message_t *message)
1412 notmuch_status_t status;
1414 status = _notmuch_database_ensure_writable (message->notmuch);
1418 if (message->frozen > 0) {
1420 if (message->frozen == 0)
1421 _notmuch_message_sync (message);
1422 return NOTMUCH_STATUS_SUCCESS;
1424 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1429 notmuch_message_destroy (notmuch_message_t *message)
1431 talloc_free (message);