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)
418 /* Fetch header from the appropriate xapian value field if
420 if (strcasecmp (header, "from") == 0)
421 value = message->doc.get_value (NOTMUCH_VALUE_FROM);
422 else if (strcasecmp (header, "subject") == 0)
423 value = message->doc.get_value (NOTMUCH_VALUE_SUBJECT);
424 else if (strcasecmp (header, "message-id") == 0)
425 value = message->doc.get_value (NOTMUCH_VALUE_MESSAGE_ID);
428 return talloc_strdup (message, value.c_str ());
430 } catch (Xapian::Error &error) {
431 fprintf (stderr, "A Xapian exception occurred when reading header: %s\n",
432 error.get_msg().c_str());
433 message->notmuch->exception_reported = TRUE;
437 /* Otherwise fall back to parsing the file */
438 _notmuch_message_ensure_message_file (message);
439 if (message->message_file == NULL)
442 return notmuch_message_file_get_header (message->message_file, header);
445 /* Return the message ID from the In-Reply-To header of 'message'.
447 * Returns an empty string ("") if 'message' has no In-Reply-To
450 * Returns NULL if any error occurs.
453 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
455 if (!message->in_reply_to)
456 _notmuch_message_ensure_metadata (message);
457 return message->in_reply_to;
461 notmuch_message_get_thread_id (notmuch_message_t *message)
463 if (!message->thread_id)
464 _notmuch_message_ensure_metadata (message);
465 if (!message->thread_id)
466 INTERNAL_ERROR ("Message with document ID of %u has no thread ID.\n",
468 return message->thread_id;
472 _notmuch_message_add_reply (notmuch_message_t *message,
473 notmuch_message_t *reply)
475 _notmuch_message_list_add_message (message->replies, reply);
479 notmuch_message_get_replies (notmuch_message_t *message)
481 return _notmuch_messages_create (message->replies);
485 _notmuch_message_remove_terms (notmuch_message_t *message, const char *prefix)
487 Xapian::TermIterator i;
488 size_t prefix_len = strlen (prefix);
491 i = message->doc.termlist_begin ();
494 /* Terminate loop when no terms remain with desired prefix. */
495 if (i == message->doc.termlist_end () ||
496 strncmp ((*i).c_str (), prefix, prefix_len))
500 message->doc.remove_term ((*i));
501 } catch (const Xapian::InvalidArgumentError) {
502 /* Ignore failure to remove non-existent term. */
507 #define RECURSIVE_SUFFIX "/**"
509 /* Add "path:" terms for directory. */
510 static notmuch_status_t
511 _notmuch_message_add_path_terms (notmuch_message_t *message,
512 const char *directory)
514 /* Add exact "path:" term. */
515 _notmuch_message_add_term (message, "path", directory);
517 if (strlen (directory)) {
520 path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
522 return NOTMUCH_STATUS_OUT_OF_MEMORY;
524 /* Add recursive "path:" terms for directory and all parents. */
525 for (p = path + strlen (path) - 1; p > path; p--) {
527 strcpy (p, RECURSIVE_SUFFIX);
528 _notmuch_message_add_term (message, "path", path);
535 /* Recursive all-matching path:** for consistency. */
536 _notmuch_message_add_term (message, "path", "**");
538 return NOTMUCH_STATUS_SUCCESS;
541 /* Add directory based terms for all filenames of the message. */
542 static notmuch_status_t
543 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
545 const char *direntry_prefix = _find_prefix ("file-direntry");
546 int direntry_prefix_len = strlen (direntry_prefix);
547 Xapian::TermIterator i = message->doc.termlist_begin ();
548 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
550 for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
551 unsigned int directory_id;
552 const char *direntry, *directory;
555 /* Terminate loop at first term without desired prefix. */
556 if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
559 /* Indicate that there are filenames remaining. */
560 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
562 direntry = (*i).c_str ();
563 direntry += direntry_prefix_len;
565 directory_id = strtol (direntry, &colon, 10);
567 if (colon == NULL || *colon != ':')
568 INTERNAL_ERROR ("malformed direntry");
570 directory = _notmuch_database_get_directory_path (ctx,
573 if (strlen (directory))
574 _notmuch_message_gen_terms (message, "folder", directory);
576 _notmuch_message_add_path_terms (message, directory);
582 /* Add an additional 'filename' for 'message'.
584 * This change will not be reflected in the database until the next
585 * call to _notmuch_message_sync. */
587 _notmuch_message_add_filename (notmuch_message_t *message,
588 const char *filename)
590 const char *relative, *directory;
591 notmuch_status_t status;
592 void *local = talloc_new (message);
595 if (filename == NULL)
596 INTERNAL_ERROR ("Message filename cannot be NULL.");
598 relative = _notmuch_database_relative_path (message->notmuch, filename);
600 status = _notmuch_database_split_path (local, relative, &directory, NULL);
604 status = _notmuch_database_filename_to_direntry (
605 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
609 /* New file-direntry allows navigating to this message with
610 * notmuch_directory_get_child_files() . */
611 _notmuch_message_add_term (message, "file-direntry", direntry);
613 /* New terms allow user to search with folder: specification. */
614 _notmuch_message_gen_terms (message, "folder", directory);
616 _notmuch_message_add_path_terms (message, directory);
620 return NOTMUCH_STATUS_SUCCESS;
623 /* Remove a particular 'filename' from 'message'.
625 * This change will not be reflected in the database until the next
626 * call to _notmuch_message_sync.
628 * If this message still has other filenames, returns
629 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
631 * Note: This function does not remove a document from the database,
632 * even if the specified filename is the only filename for this
633 * message. For that functionality, see
634 * _notmuch_database_remove_message. */
636 _notmuch_message_remove_filename (notmuch_message_t *message,
637 const char *filename)
639 void *local = talloc_new (message);
640 const char *folder_prefix = _find_prefix ("folder");
641 char *zfolder_prefix = talloc_asprintf(local, "Z%s", folder_prefix);
643 notmuch_private_status_t private_status;
644 notmuch_status_t status;
646 status = _notmuch_database_filename_to_direntry (
647 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
648 if (status || !direntry)
651 /* Unlink this file from its parent directory. */
652 private_status = _notmuch_message_remove_term (message,
653 "file-direntry", direntry);
654 status = COERCE_STATUS (private_status,
655 "Unexpected error from _notmuch_message_remove_term");
659 /* Re-synchronize "folder:" and "path:" terms for this message. */
661 /* Remove all "folder:" terms. */
662 _notmuch_message_remove_terms (message, folder_prefix);
664 /* Remove all "folder:" stemmed terms. */
665 _notmuch_message_remove_terms (message, zfolder_prefix);
667 /* Remove all "path:" terms. */
668 _notmuch_message_remove_terms (message, _find_prefix ("path"));
670 /* Add back terms for all remaining filenames of the message. */
671 status = _notmuch_message_add_directory_terms (local, message);
679 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
681 return talloc_strdup (message, message->doc.get_data ().c_str ());
685 _notmuch_message_clear_data (notmuch_message_t *message)
687 message->doc.set_data ("");
691 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
693 notmuch_string_node_t *node;
695 if (message->filename_list)
698 if (!message->filename_term_list)
699 _notmuch_message_ensure_metadata (message);
701 message->filename_list = _notmuch_string_list_create (message);
702 node = message->filename_term_list->head;
705 /* A message document created by an old version of notmuch
706 * (prior to rename support) will have the filename in the
707 * data of the document rather than as a file-direntry term.
709 * It would be nice to do the upgrade of the document directly
710 * here, but the database is likely open in read-only mode. */
713 data = message->doc.get_data ().c_str ();
716 INTERNAL_ERROR ("message with no filename");
718 _notmuch_string_list_append (message->filename_list, data);
723 for (; node; node = node->next) {
724 void *local = talloc_new (message);
725 const char *db_path, *directory, *basename, *filename;
726 char *colon, *direntry = NULL;
727 unsigned int directory_id;
729 direntry = node->string;
731 directory_id = strtol (direntry, &colon, 10);
733 if (colon == NULL || *colon != ':')
734 INTERNAL_ERROR ("malformed direntry");
736 basename = colon + 1;
740 db_path = notmuch_database_get_path (message->notmuch);
742 directory = _notmuch_database_get_directory_path (local,
746 if (strlen (directory))
747 filename = talloc_asprintf (message, "%s/%s/%s",
748 db_path, directory, basename);
750 filename = talloc_asprintf (message, "%s/%s",
753 _notmuch_string_list_append (message->filename_list, filename);
758 talloc_free (message->filename_term_list);
759 message->filename_term_list = NULL;
763 notmuch_message_get_filename (notmuch_message_t *message)
765 _notmuch_message_ensure_filename_list (message);
767 if (message->filename_list == NULL)
770 if (message->filename_list->head == NULL ||
771 message->filename_list->head->string == NULL)
773 INTERNAL_ERROR ("message with no filename");
776 return message->filename_list->head->string;
779 notmuch_filenames_t *
780 notmuch_message_get_filenames (notmuch_message_t *message)
782 _notmuch_message_ensure_filename_list (message);
784 return _notmuch_filenames_create (message, message->filename_list);
788 notmuch_message_get_flag (notmuch_message_t *message,
789 notmuch_message_flag_t flag)
791 return message->flags & (1 << flag);
795 notmuch_message_set_flag (notmuch_message_t *message,
796 notmuch_message_flag_t flag, notmuch_bool_t enable)
799 message->flags |= (1 << flag);
801 message->flags &= ~(1 << flag);
805 notmuch_message_get_date (notmuch_message_t *message)
810 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
811 } catch (Xapian::Error &error) {
812 fprintf (stderr, "A Xapian exception occurred when reading date: %s\n",
813 error.get_msg().c_str());
814 message->notmuch->exception_reported = TRUE;
818 return Xapian::sortable_unserialise (value);
822 notmuch_message_get_tags (notmuch_message_t *message)
824 notmuch_tags_t *tags;
826 if (!message->tag_list)
827 _notmuch_message_ensure_metadata (message);
829 tags = _notmuch_tags_create (message, message->tag_list);
830 /* _notmuch_tags_create steals the reference to the tag_list, but
831 * in this case it's still used by the message, so we add an
832 * *additional* talloc reference to the list. As a result, it's
833 * possible to modify the message tags (which talloc_unlink's the
834 * current list from the message) while still iterating because
835 * the iterator will keep the current list alive. */
836 if (!talloc_reference (message, message->tag_list))
843 notmuch_message_get_author (notmuch_message_t *message)
845 return message->author;
849 notmuch_message_set_author (notmuch_message_t *message,
853 talloc_free(message->author);
854 message->author = talloc_strdup(message, author);
859 _notmuch_message_set_header_values (notmuch_message_t *message,
866 /* GMime really doesn't want to see a NULL date, so protect its
868 if (date == NULL || *date == '\0')
871 time_value = g_mime_utils_header_decode_date (date, NULL);
873 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
874 Xapian::sortable_serialise (time_value));
875 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
876 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
879 /* Synchronize changes made to message->doc out into the database. */
881 _notmuch_message_sync (notmuch_message_t *message)
883 Xapian::WritableDatabase *db;
885 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
888 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
889 db->replace_document (message->doc_id, message->doc);
892 /* Delete a message document from the database. */
894 _notmuch_message_delete (notmuch_message_t *message)
896 notmuch_status_t status;
897 Xapian::WritableDatabase *db;
899 status = _notmuch_database_ensure_writable (message->notmuch);
903 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
904 db->delete_document (message->doc_id);
905 return NOTMUCH_STATUS_SUCCESS;
908 /* Ensure that 'message' is not holding any file object open. Future
909 * calls to various functions will still automatically open the
910 * message file as needed.
913 _notmuch_message_close (notmuch_message_t *message)
915 if (message->message_file) {
916 notmuch_message_file_close (message->message_file);
917 message->message_file = NULL;
921 /* Add a name:value term to 'message', (the actual term will be
922 * encoded by prefixing the value with a short prefix). See
923 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
924 * names to prefix values.
926 * This change will not be reflected in the database until the next
927 * call to _notmuch_message_sync. */
928 notmuch_private_status_t
929 _notmuch_message_add_term (notmuch_message_t *message,
930 const char *prefix_name,
937 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
939 term = talloc_asprintf (message, "%s%s",
940 _find_prefix (prefix_name), value);
942 if (strlen (term) > NOTMUCH_TERM_MAX)
943 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
945 message->doc.add_term (term, 0);
949 _notmuch_message_invalidate_metadata (message, prefix_name);
951 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
954 /* Parse 'text' and add a term to 'message' for each parsed word. Each
955 * term will be added both prefixed (if prefix_name is not NULL) and
956 * also non-prefixed). */
957 notmuch_private_status_t
958 _notmuch_message_gen_terms (notmuch_message_t *message,
959 const char *prefix_name,
962 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
965 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
967 term_gen->set_document (message->doc);
968 term_gen->set_termpos (message->termpos);
971 const char *prefix = _find_prefix (prefix_name);
973 term_gen->index_text (text, 1, prefix);
974 message->termpos = term_gen->get_termpos ();
977 term_gen->index_text (text);
979 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
982 /* Remove a name:value term from 'message', (the actual term will be
983 * encoded by prefixing the value with a short prefix). See
984 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
985 * names to prefix values.
987 * This change will not be reflected in the database until the next
988 * call to _notmuch_message_sync. */
989 notmuch_private_status_t
990 _notmuch_message_remove_term (notmuch_message_t *message,
991 const char *prefix_name,
997 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
999 term = talloc_asprintf (message, "%s%s",
1000 _find_prefix (prefix_name), value);
1002 if (strlen (term) > NOTMUCH_TERM_MAX)
1003 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1006 message->doc.remove_term (term);
1007 } catch (const Xapian::InvalidArgumentError) {
1008 /* We'll let the philosopher's try to wrestle with the
1009 * question of whether failing to remove that which was not
1010 * there in the first place is failure. For us, we'll silently
1011 * consider it all good. */
1016 _notmuch_message_invalidate_metadata (message, prefix_name);
1018 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1022 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1024 notmuch_private_status_t private_status;
1025 notmuch_status_t status;
1027 status = _notmuch_database_ensure_writable (message->notmuch);
1032 return NOTMUCH_STATUS_NULL_POINTER;
1034 if (strlen (tag) > NOTMUCH_TAG_MAX)
1035 return NOTMUCH_STATUS_TAG_TOO_LONG;
1037 private_status = _notmuch_message_add_term (message, "tag", tag);
1038 if (private_status) {
1039 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1043 if (! message->frozen)
1044 _notmuch_message_sync (message);
1046 return NOTMUCH_STATUS_SUCCESS;
1050 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1052 notmuch_private_status_t private_status;
1053 notmuch_status_t status;
1055 status = _notmuch_database_ensure_writable (message->notmuch);
1060 return NOTMUCH_STATUS_NULL_POINTER;
1062 if (strlen (tag) > NOTMUCH_TAG_MAX)
1063 return NOTMUCH_STATUS_TAG_TOO_LONG;
1065 private_status = _notmuch_message_remove_term (message, "tag", tag);
1066 if (private_status) {
1067 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1071 if (! message->frozen)
1072 _notmuch_message_sync (message);
1074 return NOTMUCH_STATUS_SUCCESS;
1077 /* Is the given filename within a maildir directory?
1079 * Specifically, is the final directory component of 'filename' either
1080 * "cur" or "new". If so, return a pointer to that final directory
1081 * component within 'filename'. If not, return NULL.
1083 * A non-NULL return value is guaranteed to be a valid string pointer
1084 * pointing to the characters "new/" or "cur/", (but not
1088 _filename_is_in_maildir (const char *filename)
1090 const char *slash, *dir = NULL;
1092 /* Find the last '/' separating directory from filename. */
1093 slash = strrchr (filename, '/');
1097 /* Jump back 4 characters to where the previous '/' will be if the
1098 * directory is named "cur" or "new". */
1099 if (slash - filename < 4)
1109 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1110 STRNCMP_LITERAL (dir, "new/") == 0)
1119 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1122 notmuch_status_t status;
1123 notmuch_filenames_t *filenames;
1124 const char *filename, *dir;
1125 char *combined_flags = talloc_strdup (message, "");
1127 int seen_maildir_info = 0;
1129 for (filenames = notmuch_message_get_filenames (message);
1130 notmuch_filenames_valid (filenames);
1131 notmuch_filenames_move_to_next (filenames))
1133 filename = notmuch_filenames_get (filenames);
1134 dir = _filename_is_in_maildir (filename);
1139 flags = strstr (filename, ":2,");
1141 seen_maildir_info = 1;
1143 combined_flags = talloc_strdup_append (combined_flags, flags);
1144 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1145 /* Messages are delivered to new/ with no "info" part, but
1146 * they effectively have default maildir flags. According
1147 * to the spec, we should ignore the info part for
1148 * messages in new/, but some MUAs (mutt) can set maildir
1149 * flags on messages in new/, so we're liberal in what we
1151 seen_maildir_info = 1;
1155 /* If none of the filenames have any maildir info field (not even
1156 * an empty info with no flags set) then there's no information to
1157 * go on, so do nothing. */
1158 if (! seen_maildir_info)
1159 return NOTMUCH_STATUS_SUCCESS;
1161 status = notmuch_message_freeze (message);
1165 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1166 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1168 flag2tag[i].inverse)
1170 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1172 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1177 status = notmuch_message_thaw (message);
1179 talloc_free (combined_flags);
1184 /* From the set of tags on 'message' and the flag2tag table, compute a
1185 * set of maildir-flag actions to be taken, (flags that should be
1186 * either set or cleared).
1188 * The result is returned as two talloced strings: to_set, and to_clear
1191 _get_maildir_flag_actions (notmuch_message_t *message,
1193 char **to_clear_ret)
1195 char *to_set, *to_clear;
1196 notmuch_tags_t *tags;
1200 to_set = talloc_strdup (message, "");
1201 to_clear = talloc_strdup (message, "");
1203 /* First, find flags for all set tags. */
1204 for (tags = notmuch_message_get_tags (message);
1205 notmuch_tags_valid (tags);
1206 notmuch_tags_move_to_next (tags))
1208 tag = notmuch_tags_get (tags);
1210 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1211 if (strcmp (tag, flag2tag[i].tag) == 0) {
1212 if (flag2tag[i].inverse)
1213 to_clear = talloc_asprintf_append (to_clear,
1217 to_set = talloc_asprintf_append (to_set,
1224 /* Then, find the flags for all tags not present. */
1225 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1226 if (flag2tag[i].inverse) {
1227 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1228 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1230 if (strchr (to_set, flag2tag[i].flag) == NULL)
1231 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1235 *to_set_ret = to_set;
1236 *to_clear_ret = to_clear;
1239 /* Given 'filename' and a set of maildir flags to set and to clear,
1240 * compute the new maildir filename.
1242 * If the existing filename is in the directory "new", the new
1243 * filename will be in the directory "cur", except for the case when
1244 * no flags are changed and the existing filename does not contain
1245 * maildir info (starting with ",2:").
1247 * After a sequence of ":2," in the filename, any subsequent
1248 * single-character flags will be added or removed according to the
1249 * characters in flags_to_set and flags_to_clear. Any existing flags
1250 * not mentioned in either string will remain. The final list of flags
1251 * will be in ASCII order.
1253 * If the original flags seem invalid, (repeated characters or
1254 * non-ASCII ordering of flags), this function will return NULL
1255 * (meaning that renaming would not be safe and should not occur).
1258 _new_maildir_filename (void *ctx,
1259 const char *filename,
1260 const char *flags_to_set,
1261 const char *flags_to_clear)
1263 const char *info, *flags;
1264 unsigned int flag, last_flag;
1265 char *filename_new, *dir;
1267 int flags_in_map = 0;
1268 notmuch_bool_t flags_changed = FALSE;
1272 memset (flag_map, 0, sizeof (flag_map));
1274 info = strstr (filename, ":2,");
1277 info = filename + strlen(filename);
1279 /* Loop through existing flags in filename. */
1280 for (flags = info + 3, last_flag = 0;
1282 last_flag = flag, flags++)
1286 /* Original flags not in ASCII order. Abort. */
1287 if (flag < last_flag)
1290 /* Non-ASCII flag. Abort. */
1291 if (flag > sizeof(flag_map) - 1)
1294 /* Repeated flag value. Abort. */
1303 /* Then set and clear our flags from tags. */
1304 for (flags = flags_to_set; *flags; flags++) {
1306 if (flag_map[flag] == 0) {
1309 flags_changed = TRUE;
1313 for (flags = flags_to_clear; *flags; flags++) {
1315 if (flag_map[flag]) {
1318 flags_changed = TRUE;
1322 /* Messages in new/ without maildir info can be kept in new/ if no
1323 * flags have changed. */
1324 dir = (char *) _filename_is_in_maildir (filename);
1325 if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && !*info && !flags_changed)
1326 return talloc_strdup (ctx, filename);
1328 filename_new = (char *) talloc_size (ctx,
1330 strlen (":2,") + flags_in_map + 1);
1331 if (unlikely (filename_new == NULL))
1334 strncpy (filename_new, filename, info - filename);
1335 filename_new[info - filename] = '\0';
1337 strcat (filename_new, ":2,");
1339 s = filename_new + strlen (filename_new);
1340 for (i = 0; i < sizeof (flag_map); i++)
1349 /* If message is in new/ move it under cur/. */
1350 dir = (char *) _filename_is_in_maildir (filename_new);
1351 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1352 memcpy (dir, "cur/", 4);
1354 return filename_new;
1358 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1360 notmuch_filenames_t *filenames;
1361 const char *filename;
1363 char *to_set, *to_clear;
1364 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1366 _get_maildir_flag_actions (message, &to_set, &to_clear);
1368 for (filenames = notmuch_message_get_filenames (message);
1369 notmuch_filenames_valid (filenames);
1370 notmuch_filenames_move_to_next (filenames))
1372 filename = notmuch_filenames_get (filenames);
1374 if (! _filename_is_in_maildir (filename))
1377 filename_new = _new_maildir_filename (message, filename,
1379 if (filename_new == NULL)
1382 if (strcmp (filename, filename_new)) {
1384 notmuch_status_t new_status;
1386 err = rename (filename, filename_new);
1390 new_status = _notmuch_message_remove_filename (message,
1392 /* Hold on to only the first error. */
1393 if (! status && new_status
1394 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1395 status = new_status;
1399 new_status = _notmuch_message_add_filename (message,
1401 /* Hold on to only the first error. */
1402 if (! status && new_status) {
1403 status = new_status;
1407 _notmuch_message_sync (message);
1410 talloc_free (filename_new);
1413 talloc_free (to_set);
1414 talloc_free (to_clear);
1416 return NOTMUCH_STATUS_SUCCESS;
1420 notmuch_message_remove_all_tags (notmuch_message_t *message)
1422 notmuch_private_status_t private_status;
1423 notmuch_status_t status;
1424 notmuch_tags_t *tags;
1427 status = _notmuch_database_ensure_writable (message->notmuch);
1431 for (tags = notmuch_message_get_tags (message);
1432 notmuch_tags_valid (tags);
1433 notmuch_tags_move_to_next (tags))
1435 tag = notmuch_tags_get (tags);
1437 private_status = _notmuch_message_remove_term (message, "tag", tag);
1438 if (private_status) {
1439 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1444 if (! message->frozen)
1445 _notmuch_message_sync (message);
1448 return NOTMUCH_STATUS_SUCCESS;
1452 notmuch_message_freeze (notmuch_message_t *message)
1454 notmuch_status_t status;
1456 status = _notmuch_database_ensure_writable (message->notmuch);
1462 return NOTMUCH_STATUS_SUCCESS;
1466 notmuch_message_thaw (notmuch_message_t *message)
1468 notmuch_status_t status;
1470 status = _notmuch_database_ensure_writable (message->notmuch);
1474 if (message->frozen > 0) {
1476 if (message->frozen == 0)
1477 _notmuch_message_sync (message);
1478 return NOTMUCH_STATUS_SUCCESS;
1480 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1485 notmuch_message_destroy (notmuch_message_t *message)
1487 talloc_free (message);