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 /* Return true if p points at "new" or "cur". */
508 static bool is_maildir (const char *p)
510 return strcmp (p, "cur") == 0 || strcmp (p, "new") == 0;
513 /* Add "folder:" term for directory. */
514 static notmuch_status_t
515 _notmuch_message_add_folder_terms (notmuch_message_t *message,
516 const char *directory)
520 folder = talloc_strdup (NULL, directory);
522 return NOTMUCH_STATUS_OUT_OF_MEMORY;
525 * If the message file is in a leaf directory named "new" or
526 * "cur", presume maildir and index the parent directory. Thus a
527 * "folder:" prefix search matches messages in the specified
528 * maildir folder, i.e. in the specified directory and its "new"
529 * and "cur" subdirectories.
531 * Note that this means the "folder:" prefix can't be used for
532 * distinguishing between message files in "new" or "cur". The
533 * "path:" prefix needs to be used for that.
535 * Note the deliberate difference to _filename_is_in_maildir(). We
536 * don't want to index different things depending on the existence
537 * or non-existence of all maildir sibling directories "new",
538 * "cur", and "tmp". Doing so would be surprising, and difficult
539 * for the user to fix in case all subdirectories were not in
540 * place during indexing.
542 last = strrchr (folder, '/');
544 if (is_maildir (last + 1))
546 } else if (is_maildir (folder)) {
550 _notmuch_message_add_term (message, "folder", folder);
552 talloc_free (folder);
554 return NOTMUCH_STATUS_SUCCESS;
557 #define RECURSIVE_SUFFIX "/**"
559 /* Add "path:" terms for directory. */
560 static notmuch_status_t
561 _notmuch_message_add_path_terms (notmuch_message_t *message,
562 const char *directory)
564 /* Add exact "path:" term. */
565 _notmuch_message_add_term (message, "path", directory);
567 if (strlen (directory)) {
570 path = talloc_asprintf (NULL, "%s%s", directory, RECURSIVE_SUFFIX);
572 return NOTMUCH_STATUS_OUT_OF_MEMORY;
574 /* Add recursive "path:" terms for directory and all parents. */
575 for (p = path + strlen (path) - 1; p > path; p--) {
577 strcpy (p, RECURSIVE_SUFFIX);
578 _notmuch_message_add_term (message, "path", path);
585 /* Recursive all-matching path:** for consistency. */
586 _notmuch_message_add_term (message, "path", "**");
588 return NOTMUCH_STATUS_SUCCESS;
591 /* Add directory based terms for all filenames of the message. */
592 static notmuch_status_t
593 _notmuch_message_add_directory_terms (void *ctx, notmuch_message_t *message)
595 const char *direntry_prefix = _find_prefix ("file-direntry");
596 int direntry_prefix_len = strlen (direntry_prefix);
597 Xapian::TermIterator i = message->doc.termlist_begin ();
598 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
600 for (i.skip_to (direntry_prefix); i != message->doc.termlist_end (); i++) {
601 unsigned int directory_id;
602 const char *direntry, *directory;
605 /* Terminate loop at first term without desired prefix. */
606 if (strncmp ((*i).c_str (), direntry_prefix, direntry_prefix_len))
609 /* Indicate that there are filenames remaining. */
610 status = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
612 direntry = (*i).c_str ();
613 direntry += direntry_prefix_len;
615 directory_id = strtol (direntry, &colon, 10);
617 if (colon == NULL || *colon != ':')
618 INTERNAL_ERROR ("malformed direntry");
620 directory = _notmuch_database_get_directory_path (ctx,
624 _notmuch_message_add_folder_terms (message, directory);
625 _notmuch_message_add_path_terms (message, directory);
631 /* Add an additional 'filename' for 'message'.
633 * This change will not be reflected in the database until the next
634 * call to _notmuch_message_sync. */
636 _notmuch_message_add_filename (notmuch_message_t *message,
637 const char *filename)
639 const char *relative, *directory;
640 notmuch_status_t status;
641 void *local = talloc_new (message);
644 if (filename == NULL)
645 INTERNAL_ERROR ("Message filename cannot be NULL.");
647 relative = _notmuch_database_relative_path (message->notmuch, filename);
649 status = _notmuch_database_split_path (local, relative, &directory, NULL);
653 status = _notmuch_database_filename_to_direntry (
654 local, message->notmuch, filename, NOTMUCH_FIND_CREATE, &direntry);
658 /* New file-direntry allows navigating to this message with
659 * notmuch_directory_get_child_files() . */
660 _notmuch_message_add_term (message, "file-direntry", direntry);
662 _notmuch_message_add_folder_terms (message, directory);
663 _notmuch_message_add_path_terms (message, directory);
667 return NOTMUCH_STATUS_SUCCESS;
670 /* Remove a particular 'filename' from 'message'.
672 * This change will not be reflected in the database until the next
673 * call to _notmuch_message_sync.
675 * If this message still has other filenames, returns
676 * NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID.
678 * Note: This function does not remove a document from the database,
679 * even if the specified filename is the only filename for this
680 * message. For that functionality, see
681 * _notmuch_database_remove_message. */
683 _notmuch_message_remove_filename (notmuch_message_t *message,
684 const char *filename)
686 void *local = talloc_new (message);
688 notmuch_private_status_t private_status;
689 notmuch_status_t status;
691 status = _notmuch_database_filename_to_direntry (
692 local, message->notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
693 if (status || !direntry)
696 /* Unlink this file from its parent directory. */
697 private_status = _notmuch_message_remove_term (message,
698 "file-direntry", direntry);
699 status = COERCE_STATUS (private_status,
700 "Unexpected error from _notmuch_message_remove_term");
704 /* Re-synchronize "folder:" and "path:" terms for this message. */
706 /* Remove all "folder:" terms. */
707 _notmuch_message_remove_terms (message, _find_prefix ("folder"));
709 /* Remove all "path:" terms. */
710 _notmuch_message_remove_terms (message, _find_prefix ("path"));
712 /* Add back terms for all remaining filenames of the message. */
713 status = _notmuch_message_add_directory_terms (local, message);
720 /* Upgrade the "folder:" prefix from V1 to V2. */
721 #define FOLDER_PREFIX_V1 "XFOLDER"
722 #define ZFOLDER_PREFIX_V1 "Z" FOLDER_PREFIX_V1
724 _notmuch_message_upgrade_folder (notmuch_message_t *message)
726 /* Remove all old "folder:" terms. */
727 _notmuch_message_remove_terms (message, FOLDER_PREFIX_V1);
729 /* Remove all old "folder:" stemmed terms. */
730 _notmuch_message_remove_terms (message, ZFOLDER_PREFIX_V1);
732 /* Add new boolean "folder:" and "path:" terms. */
733 _notmuch_message_add_directory_terms (message, message);
737 _notmuch_message_talloc_copy_data (notmuch_message_t *message)
739 return talloc_strdup (message, message->doc.get_data ().c_str ());
743 _notmuch_message_clear_data (notmuch_message_t *message)
745 message->doc.set_data ("");
749 _notmuch_message_ensure_filename_list (notmuch_message_t *message)
751 notmuch_string_node_t *node;
753 if (message->filename_list)
756 if (!message->filename_term_list)
757 _notmuch_message_ensure_metadata (message);
759 message->filename_list = _notmuch_string_list_create (message);
760 node = message->filename_term_list->head;
763 /* A message document created by an old version of notmuch
764 * (prior to rename support) will have the filename in the
765 * data of the document rather than as a file-direntry term.
767 * It would be nice to do the upgrade of the document directly
768 * here, but the database is likely open in read-only mode. */
771 data = message->doc.get_data ().c_str ();
774 INTERNAL_ERROR ("message with no filename");
776 _notmuch_string_list_append (message->filename_list, data);
781 for (; node; node = node->next) {
782 void *local = talloc_new (message);
783 const char *db_path, *directory, *basename, *filename;
784 char *colon, *direntry = NULL;
785 unsigned int directory_id;
787 direntry = node->string;
789 directory_id = strtol (direntry, &colon, 10);
791 if (colon == NULL || *colon != ':')
792 INTERNAL_ERROR ("malformed direntry");
794 basename = colon + 1;
798 db_path = notmuch_database_get_path (message->notmuch);
800 directory = _notmuch_database_get_directory_path (local,
804 if (strlen (directory))
805 filename = talloc_asprintf (message, "%s/%s/%s",
806 db_path, directory, basename);
808 filename = talloc_asprintf (message, "%s/%s",
811 _notmuch_string_list_append (message->filename_list, filename);
816 talloc_free (message->filename_term_list);
817 message->filename_term_list = NULL;
821 notmuch_message_get_filename (notmuch_message_t *message)
823 _notmuch_message_ensure_filename_list (message);
825 if (message->filename_list == NULL)
828 if (message->filename_list->head == NULL ||
829 message->filename_list->head->string == NULL)
831 INTERNAL_ERROR ("message with no filename");
834 return message->filename_list->head->string;
837 notmuch_filenames_t *
838 notmuch_message_get_filenames (notmuch_message_t *message)
840 _notmuch_message_ensure_filename_list (message);
842 return _notmuch_filenames_create (message, message->filename_list);
846 notmuch_message_get_flag (notmuch_message_t *message,
847 notmuch_message_flag_t flag)
849 return message->flags & (1 << flag);
853 notmuch_message_set_flag (notmuch_message_t *message,
854 notmuch_message_flag_t flag, notmuch_bool_t enable)
857 message->flags |= (1 << flag);
859 message->flags &= ~(1 << flag);
863 notmuch_message_get_date (notmuch_message_t *message)
868 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
869 } catch (Xapian::Error &error) {
870 fprintf (stderr, "A Xapian exception occurred when reading date: %s\n",
871 error.get_msg().c_str());
872 message->notmuch->exception_reported = TRUE;
876 return Xapian::sortable_unserialise (value);
880 notmuch_message_get_tags (notmuch_message_t *message)
882 notmuch_tags_t *tags;
884 if (!message->tag_list)
885 _notmuch_message_ensure_metadata (message);
887 tags = _notmuch_tags_create (message, message->tag_list);
888 /* _notmuch_tags_create steals the reference to the tag_list, but
889 * in this case it's still used by the message, so we add an
890 * *additional* talloc reference to the list. As a result, it's
891 * possible to modify the message tags (which talloc_unlink's the
892 * current list from the message) while still iterating because
893 * the iterator will keep the current list alive. */
894 if (!talloc_reference (message, message->tag_list))
901 notmuch_message_get_author (notmuch_message_t *message)
903 return message->author;
907 notmuch_message_set_author (notmuch_message_t *message,
911 talloc_free(message->author);
912 message->author = talloc_strdup(message, author);
917 _notmuch_message_set_header_values (notmuch_message_t *message,
924 /* GMime really doesn't want to see a NULL date, so protect its
926 if (date == NULL || *date == '\0')
929 time_value = g_mime_utils_header_decode_date (date, NULL);
931 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
932 Xapian::sortable_serialise (time_value));
933 message->doc.add_value (NOTMUCH_VALUE_FROM, from);
934 message->doc.add_value (NOTMUCH_VALUE_SUBJECT, subject);
937 /* Synchronize changes made to message->doc out into the database. */
939 _notmuch_message_sync (notmuch_message_t *message)
941 Xapian::WritableDatabase *db;
943 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
946 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
947 db->replace_document (message->doc_id, message->doc);
950 /* Delete a message document from the database. */
952 _notmuch_message_delete (notmuch_message_t *message)
954 notmuch_status_t status;
955 Xapian::WritableDatabase *db;
957 status = _notmuch_database_ensure_writable (message->notmuch);
961 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
962 db->delete_document (message->doc_id);
963 return NOTMUCH_STATUS_SUCCESS;
966 /* Ensure that 'message' is not holding any file object open. Future
967 * calls to various functions will still automatically open the
968 * message file as needed.
971 _notmuch_message_close (notmuch_message_t *message)
973 if (message->message_file) {
974 notmuch_message_file_close (message->message_file);
975 message->message_file = NULL;
979 /* Add a name:value term to 'message', (the actual term will be
980 * encoded by prefixing the value with a short prefix). See
981 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
982 * names to prefix values.
984 * This change will not be reflected in the database until the next
985 * call to _notmuch_message_sync. */
986 notmuch_private_status_t
987 _notmuch_message_add_term (notmuch_message_t *message,
988 const char *prefix_name,
995 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
997 term = talloc_asprintf (message, "%s%s",
998 _find_prefix (prefix_name), value);
1000 if (strlen (term) > NOTMUCH_TERM_MAX)
1001 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1003 message->doc.add_term (term, 0);
1007 _notmuch_message_invalidate_metadata (message, prefix_name);
1009 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1012 /* Parse 'text' and add a term to 'message' for each parsed word. Each
1013 * term will be added both prefixed (if prefix_name is not NULL) and
1014 * also non-prefixed). */
1015 notmuch_private_status_t
1016 _notmuch_message_gen_terms (notmuch_message_t *message,
1017 const char *prefix_name,
1020 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
1023 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1025 term_gen->set_document (message->doc);
1026 term_gen->set_termpos (message->termpos);
1029 const char *prefix = _find_prefix (prefix_name);
1031 term_gen->index_text (text, 1, prefix);
1032 message->termpos = term_gen->get_termpos ();
1035 term_gen->index_text (text);
1037 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1040 /* Remove a name:value term from 'message', (the actual term will be
1041 * encoded by prefixing the value with a short prefix). See
1042 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
1043 * names to prefix values.
1045 * This change will not be reflected in the database until the next
1046 * call to _notmuch_message_sync. */
1047 notmuch_private_status_t
1048 _notmuch_message_remove_term (notmuch_message_t *message,
1049 const char *prefix_name,
1055 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
1057 term = talloc_asprintf (message, "%s%s",
1058 _find_prefix (prefix_name), value);
1060 if (strlen (term) > NOTMUCH_TERM_MAX)
1061 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
1064 message->doc.remove_term (term);
1065 } catch (const Xapian::InvalidArgumentError) {
1066 /* We'll let the philosopher's try to wrestle with the
1067 * question of whether failing to remove that which was not
1068 * there in the first place is failure. For us, we'll silently
1069 * consider it all good. */
1074 _notmuch_message_invalidate_metadata (message, prefix_name);
1076 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
1080 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
1082 notmuch_private_status_t private_status;
1083 notmuch_status_t status;
1085 status = _notmuch_database_ensure_writable (message->notmuch);
1090 return NOTMUCH_STATUS_NULL_POINTER;
1092 if (strlen (tag) > NOTMUCH_TAG_MAX)
1093 return NOTMUCH_STATUS_TAG_TOO_LONG;
1095 private_status = _notmuch_message_add_term (message, "tag", tag);
1096 if (private_status) {
1097 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
1101 if (! message->frozen)
1102 _notmuch_message_sync (message);
1104 return NOTMUCH_STATUS_SUCCESS;
1108 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
1110 notmuch_private_status_t private_status;
1111 notmuch_status_t status;
1113 status = _notmuch_database_ensure_writable (message->notmuch);
1118 return NOTMUCH_STATUS_NULL_POINTER;
1120 if (strlen (tag) > NOTMUCH_TAG_MAX)
1121 return NOTMUCH_STATUS_TAG_TOO_LONG;
1123 private_status = _notmuch_message_remove_term (message, "tag", tag);
1124 if (private_status) {
1125 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1129 if (! message->frozen)
1130 _notmuch_message_sync (message);
1132 return NOTMUCH_STATUS_SUCCESS;
1135 /* Is the given filename within a maildir directory?
1137 * Specifically, is the final directory component of 'filename' either
1138 * "cur" or "new". If so, return a pointer to that final directory
1139 * component within 'filename'. If not, return NULL.
1141 * A non-NULL return value is guaranteed to be a valid string pointer
1142 * pointing to the characters "new/" or "cur/", (but not
1146 _filename_is_in_maildir (const char *filename)
1148 const char *slash, *dir = NULL;
1150 /* Find the last '/' separating directory from filename. */
1151 slash = strrchr (filename, '/');
1155 /* Jump back 4 characters to where the previous '/' will be if the
1156 * directory is named "cur" or "new". */
1157 if (slash - filename < 4)
1167 if (STRNCMP_LITERAL (dir, "cur/") == 0 ||
1168 STRNCMP_LITERAL (dir, "new/") == 0)
1177 notmuch_message_maildir_flags_to_tags (notmuch_message_t *message)
1180 notmuch_status_t status;
1181 notmuch_filenames_t *filenames;
1182 const char *filename, *dir;
1183 char *combined_flags = talloc_strdup (message, "");
1185 int seen_maildir_info = 0;
1187 for (filenames = notmuch_message_get_filenames (message);
1188 notmuch_filenames_valid (filenames);
1189 notmuch_filenames_move_to_next (filenames))
1191 filename = notmuch_filenames_get (filenames);
1192 dir = _filename_is_in_maildir (filename);
1197 flags = strstr (filename, ":2,");
1199 seen_maildir_info = 1;
1201 combined_flags = talloc_strdup_append (combined_flags, flags);
1202 } else if (STRNCMP_LITERAL (dir, "new/") == 0) {
1203 /* Messages are delivered to new/ with no "info" part, but
1204 * they effectively have default maildir flags. According
1205 * to the spec, we should ignore the info part for
1206 * messages in new/, but some MUAs (mutt) can set maildir
1207 * flags on messages in new/, so we're liberal in what we
1209 seen_maildir_info = 1;
1213 /* If none of the filenames have any maildir info field (not even
1214 * an empty info with no flags set) then there's no information to
1215 * go on, so do nothing. */
1216 if (! seen_maildir_info)
1217 return NOTMUCH_STATUS_SUCCESS;
1219 status = notmuch_message_freeze (message);
1223 for (i = 0; i < ARRAY_SIZE(flag2tag); i++) {
1224 if ((strchr (combined_flags, flag2tag[i].flag) != NULL)
1226 flag2tag[i].inverse)
1228 status = notmuch_message_add_tag (message, flag2tag[i].tag);
1230 status = notmuch_message_remove_tag (message, flag2tag[i].tag);
1235 status = notmuch_message_thaw (message);
1237 talloc_free (combined_flags);
1242 /* From the set of tags on 'message' and the flag2tag table, compute a
1243 * set of maildir-flag actions to be taken, (flags that should be
1244 * either set or cleared).
1246 * The result is returned as two talloced strings: to_set, and to_clear
1249 _get_maildir_flag_actions (notmuch_message_t *message,
1251 char **to_clear_ret)
1253 char *to_set, *to_clear;
1254 notmuch_tags_t *tags;
1258 to_set = talloc_strdup (message, "");
1259 to_clear = talloc_strdup (message, "");
1261 /* First, find flags for all set tags. */
1262 for (tags = notmuch_message_get_tags (message);
1263 notmuch_tags_valid (tags);
1264 notmuch_tags_move_to_next (tags))
1266 tag = notmuch_tags_get (tags);
1268 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1269 if (strcmp (tag, flag2tag[i].tag) == 0) {
1270 if (flag2tag[i].inverse)
1271 to_clear = talloc_asprintf_append (to_clear,
1275 to_set = talloc_asprintf_append (to_set,
1282 /* Then, find the flags for all tags not present. */
1283 for (i = 0; i < ARRAY_SIZE (flag2tag); i++) {
1284 if (flag2tag[i].inverse) {
1285 if (strchr (to_clear, flag2tag[i].flag) == NULL)
1286 to_set = talloc_asprintf_append (to_set, "%c", flag2tag[i].flag);
1288 if (strchr (to_set, flag2tag[i].flag) == NULL)
1289 to_clear = talloc_asprintf_append (to_clear, "%c", flag2tag[i].flag);
1293 *to_set_ret = to_set;
1294 *to_clear_ret = to_clear;
1297 /* Given 'filename' and a set of maildir flags to set and to clear,
1298 * compute the new maildir filename.
1300 * If the existing filename is in the directory "new", the new
1301 * filename will be in the directory "cur", except for the case when
1302 * no flags are changed and the existing filename does not contain
1303 * maildir info (starting with ",2:").
1305 * After a sequence of ":2," in the filename, any subsequent
1306 * single-character flags will be added or removed according to the
1307 * characters in flags_to_set and flags_to_clear. Any existing flags
1308 * not mentioned in either string will remain. The final list of flags
1309 * will be in ASCII order.
1311 * If the original flags seem invalid, (repeated characters or
1312 * non-ASCII ordering of flags), this function will return NULL
1313 * (meaning that renaming would not be safe and should not occur).
1316 _new_maildir_filename (void *ctx,
1317 const char *filename,
1318 const char *flags_to_set,
1319 const char *flags_to_clear)
1321 const char *info, *flags;
1322 unsigned int flag, last_flag;
1323 char *filename_new, *dir;
1325 int flags_in_map = 0;
1326 notmuch_bool_t flags_changed = FALSE;
1330 memset (flag_map, 0, sizeof (flag_map));
1332 info = strstr (filename, ":2,");
1335 info = filename + strlen(filename);
1337 /* Loop through existing flags in filename. */
1338 for (flags = info + 3, last_flag = 0;
1340 last_flag = flag, flags++)
1344 /* Original flags not in ASCII order. Abort. */
1345 if (flag < last_flag)
1348 /* Non-ASCII flag. Abort. */
1349 if (flag > sizeof(flag_map) - 1)
1352 /* Repeated flag value. Abort. */
1361 /* Then set and clear our flags from tags. */
1362 for (flags = flags_to_set; *flags; flags++) {
1364 if (flag_map[flag] == 0) {
1367 flags_changed = TRUE;
1371 for (flags = flags_to_clear; *flags; flags++) {
1373 if (flag_map[flag]) {
1376 flags_changed = TRUE;
1380 /* Messages in new/ without maildir info can be kept in new/ if no
1381 * flags have changed. */
1382 dir = (char *) _filename_is_in_maildir (filename);
1383 if (dir && STRNCMP_LITERAL (dir, "new/") == 0 && !*info && !flags_changed)
1384 return talloc_strdup (ctx, filename);
1386 filename_new = (char *) talloc_size (ctx,
1388 strlen (":2,") + flags_in_map + 1);
1389 if (unlikely (filename_new == NULL))
1392 strncpy (filename_new, filename, info - filename);
1393 filename_new[info - filename] = '\0';
1395 strcat (filename_new, ":2,");
1397 s = filename_new + strlen (filename_new);
1398 for (i = 0; i < sizeof (flag_map); i++)
1407 /* If message is in new/ move it under cur/. */
1408 dir = (char *) _filename_is_in_maildir (filename_new);
1409 if (dir && STRNCMP_LITERAL (dir, "new/") == 0)
1410 memcpy (dir, "cur/", 4);
1412 return filename_new;
1416 notmuch_message_tags_to_maildir_flags (notmuch_message_t *message)
1418 notmuch_filenames_t *filenames;
1419 const char *filename;
1421 char *to_set, *to_clear;
1422 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1424 _get_maildir_flag_actions (message, &to_set, &to_clear);
1426 for (filenames = notmuch_message_get_filenames (message);
1427 notmuch_filenames_valid (filenames);
1428 notmuch_filenames_move_to_next (filenames))
1430 filename = notmuch_filenames_get (filenames);
1432 if (! _filename_is_in_maildir (filename))
1435 filename_new = _new_maildir_filename (message, filename,
1437 if (filename_new == NULL)
1440 if (strcmp (filename, filename_new)) {
1442 notmuch_status_t new_status;
1444 err = rename (filename, filename_new);
1448 new_status = _notmuch_message_remove_filename (message,
1450 /* Hold on to only the first error. */
1451 if (! status && new_status
1452 && new_status != NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) {
1453 status = new_status;
1457 new_status = _notmuch_message_add_filename (message,
1459 /* Hold on to only the first error. */
1460 if (! status && new_status) {
1461 status = new_status;
1465 _notmuch_message_sync (message);
1468 talloc_free (filename_new);
1471 talloc_free (to_set);
1472 talloc_free (to_clear);
1474 return NOTMUCH_STATUS_SUCCESS;
1478 notmuch_message_remove_all_tags (notmuch_message_t *message)
1480 notmuch_private_status_t private_status;
1481 notmuch_status_t status;
1482 notmuch_tags_t *tags;
1485 status = _notmuch_database_ensure_writable (message->notmuch);
1489 for (tags = notmuch_message_get_tags (message);
1490 notmuch_tags_valid (tags);
1491 notmuch_tags_move_to_next (tags))
1493 tag = notmuch_tags_get (tags);
1495 private_status = _notmuch_message_remove_term (message, "tag", tag);
1496 if (private_status) {
1497 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
1502 if (! message->frozen)
1503 _notmuch_message_sync (message);
1506 return NOTMUCH_STATUS_SUCCESS;
1510 notmuch_message_freeze (notmuch_message_t *message)
1512 notmuch_status_t status;
1514 status = _notmuch_database_ensure_writable (message->notmuch);
1520 return NOTMUCH_STATUS_SUCCESS;
1524 notmuch_message_thaw (notmuch_message_t *message)
1526 notmuch_status_t status;
1528 status = _notmuch_database_ensure_writable (message->notmuch);
1532 if (message->frozen > 0) {
1534 if (message->frozen == 0)
1535 _notmuch_message_sync (message);
1536 return NOTMUCH_STATUS_SUCCESS;
1538 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
1543 notmuch_message_destroy (notmuch_message_t *message)
1545 talloc_free (message);