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>
30 struct _notmuch_message {
31 notmuch_database_t *notmuch;
38 notmuch_message_file_t *message_file;
39 notmuch_message_list_t *replies;
44 /* "128 bits of thread-id ought to be enough for anybody" */
45 #define NOTMUCH_THREAD_ID_BITS 128
46 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
47 typedef struct _thread_id {
48 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
51 /* We end up having to call the destructor explicitly because we had
52 * to use "placement new" in order to initialize C++ objects within a
53 * block that we allocated with talloc. So C++ is making talloc
54 * slightly less simple to use, (we wouldn't need
55 * talloc_set_destructor at all otherwise).
58 _notmuch_message_destructor (notmuch_message_t *message)
60 message->doc.~Document ();
65 /* Create a new notmuch_message_t object for an existing document in
68 * Here, 'talloc owner' is an optional talloc context to which the new
69 * message will belong. This allows for the caller to not bother
70 * calling notmuch_message_destroy on the message, and no that all
71 * memory will be reclaimed with 'talloc_owner' is free. The caller
72 * still can call notmuch_message_destroy when finished with the
75 * The 'talloc_owner' argument can also be NULL, in which case the
76 * caller *is* responsible for calling notmuch_message_destroy.
78 * If no document exists in the database with document ID of 'doc_id'
79 * then this function returns NULL and optionally sets *status to
80 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
82 * This function can also fail to due lack of available memory,
83 * returning NULL and optionally setting *status to
84 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
86 * The caller can pass NULL for status if uninterested in
87 * distinguishing these two cases.
90 _notmuch_message_create (const void *talloc_owner,
91 notmuch_database_t *notmuch,
93 notmuch_private_status_t *status)
95 notmuch_message_t *message;
98 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
100 message = talloc (talloc_owner, notmuch_message_t);
101 if (unlikely (message == NULL)) {
103 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
107 message->notmuch = notmuch;
108 message->doc_id = doc_id;
112 /* Each of these will be lazily created as needed. */
113 message->message_id = NULL;
114 message->thread_id = NULL;
115 message->in_reply_to = NULL;
116 message->filename = NULL;
117 message->message_file = NULL;
119 message->replies = _notmuch_message_list_create (message);
120 if (unlikely (message->replies == NULL)) {
122 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
126 /* This is C++'s creepy "placement new", which is really just an
127 * ugly way to call a constructor for a pre-allocated object. So
128 * it's really not an error to not be checking for OUT_OF_MEMORY
129 * here, since this "new" isn't actually allocating memory. This
130 * is language-design comedy of the wrong kind. */
132 new (&message->doc) Xapian::Document;
134 talloc_set_destructor (message, _notmuch_message_destructor);
137 message->doc = notmuch->xapian_db->get_document (doc_id);
138 } catch (const Xapian::DocNotFoundError &error) {
139 talloc_free (message);
141 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
148 /* Create a new notmuch_message_t object for a specific message ID,
149 * (which may or may not already exist in the database).
151 * The 'notmuch' database will be the talloc owner of the returned
154 * If there is already a document with message ID 'message_id' in the
155 * database, then the returned message can be used to query/modify the
156 * document. Otherwise, a new document will be inserted into the
157 * database before this function returns, (and *status will be set
158 * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
160 * If an error occurs, this function will return NULL and *status
161 * will be set as appropriate. (The status pointer argument must
165 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
166 const char *message_id,
167 notmuch_private_status_t *status_ret)
169 notmuch_message_t *message;
170 Xapian::Document doc;
171 Xapian::WritableDatabase *db;
175 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
176 *status_ret = NOTMUCH_PRIVATE_STATUS_READONLY_DATABASE;
180 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
182 message = notmuch_database_find_message (notmuch, message_id);
184 return talloc_steal (notmuch, message);
186 term = talloc_asprintf (NULL, "%s%s",
187 _find_prefix ("id"), message_id);
189 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
193 db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
198 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
200 doc_id = db->add_document (doc);
201 } catch (const Xapian::Error &error) {
202 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
206 message = _notmuch_message_create (notmuch, notmuch,
209 /* We want to inform the caller that we had to create a new
211 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
212 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
218 notmuch_message_get_message_id (notmuch_message_t *message)
220 Xapian::TermIterator i;
222 if (message->message_id)
223 return message->message_id;
225 i = message->doc.termlist_begin ();
226 i.skip_to (_find_prefix ("id"));
228 if (i == message->doc.termlist_end ())
229 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
232 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
234 #if DEBUG_DATABASE_SANITY
237 if (i != message->doc.termlist_end () &&
238 strncmp ((*i).c_str (), _find_prefix ("id"),
239 strlen (_find_prefix ("id"))) == 0)
241 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
246 return message->message_id;
250 _notmuch_message_ensure_message_file (notmuch_message_t *message)
252 const char *filename;
254 if (message->message_file)
257 filename = notmuch_message_get_filename (message);
258 if (unlikely (filename == NULL))
261 message->message_file = _notmuch_message_file_open_ctx (message, filename);
265 notmuch_message_get_header (notmuch_message_t *message, const char *header)
267 _notmuch_message_ensure_message_file (message);
268 if (message->message_file == NULL)
271 return notmuch_message_file_get_header (message->message_file, header);
274 /* Return the message ID from the In-Reply-To header of 'message'.
276 * Returns an empty string ("") if 'message' has no In-Reply-To
279 * Returns NULL if any error occurs.
282 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
284 const char *prefix = _find_prefix ("replyto");
285 int prefix_len = strlen (prefix);
286 Xapian::TermIterator i;
287 std::string in_reply_to;
289 if (message->in_reply_to)
290 return message->in_reply_to;
292 i = message->doc.termlist_begin ();
295 if (i != message->doc.termlist_end ())
298 /* It's perfectly valid for a message to have no In-Reply-To
299 * header. For these cases, we return an empty string. */
300 if (i == message->doc.termlist_end () ||
301 strncmp (in_reply_to.c_str (), prefix, prefix_len))
303 message->in_reply_to = talloc_strdup (message, "");
304 return message->in_reply_to;
307 message->in_reply_to = talloc_strdup (message,
308 in_reply_to.c_str () + prefix_len);
310 #if DEBUG_DATABASE_SANITY
315 if (i != message->doc.termlist_end () &&
316 strncmp ((*i).c_str (), prefix, prefix_len))
318 INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n"
319 notmuch_message_get_message_id (message),
320 message->in_reply_to,
321 (*i).c_str () + prefix_len);
325 return message->in_reply_to;
329 notmuch_message_get_thread_id (notmuch_message_t *message)
331 const char *prefix = _find_prefix ("thread");
332 Xapian::TermIterator i;
335 /* This code is written with the assumption that "thread" has a
336 * single-character prefix. */
337 assert (strlen (prefix) == 1);
339 if (message->thread_id)
340 return message->thread_id;
342 i = message->doc.termlist_begin ();
345 if (i != message->doc.termlist_end ())
348 if (i == message->doc.termlist_end () || id[0] != *prefix)
349 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
352 message->thread_id = talloc_strdup (message, id.c_str () + 1);
354 #if DEBUG_DATABASE_SANITY
358 if (i != message->doc.termlist_end () && id[0] == *prefix)
360 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
361 notmuch_message_get_message_id (message),
367 return message->thread_id;
371 _notmuch_message_add_reply (notmuch_message_t *message,
372 notmuch_message_node_t *reply)
374 _notmuch_message_list_append (message->replies, reply);
378 notmuch_message_get_replies (notmuch_message_t *message)
380 return _notmuch_messages_create (message->replies);
383 /* Set the filename for 'message' to 'filename'.
385 * XXX: We should still figure out if we think it's important to store
386 * multiple filenames for email messages with identical message IDs.
388 * This change will not be reflected in the database until the next
389 * call to _notmuch_message_set_sync. */
391 _notmuch_message_set_filename (notmuch_message_t *message,
392 const char *filename)
396 unsigned int db_path_len;
398 if (message->filename) {
399 talloc_free (message->filename);
400 message->filename = NULL;
403 if (filename == NULL)
404 INTERNAL_ERROR ("Message filename cannot be NULL.");
408 db_path = notmuch_database_get_path (message->notmuch);
409 db_path_len = strlen (db_path);
411 if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
412 && strlen (s) > db_path_len)
414 s += db_path_len + 1;
417 message->doc.set_data (s);
421 notmuch_message_get_filename (notmuch_message_t *message)
423 std::string filename_str;
426 if (message->filename)
427 return message->filename;
429 filename_str = message->doc.get_data ();
430 db_path = notmuch_database_get_path (message->notmuch);
432 if (filename_str[0] != '/')
433 message->filename = talloc_asprintf (message, "%s/%s", db_path,
434 filename_str.c_str ());
436 message->filename = talloc_strdup (message, filename_str.c_str ());
438 return message->filename;
442 notmuch_message_get_date (notmuch_message_t *message)
447 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
448 } catch (Xapian::Error &error) {
449 INTERNAL_ERROR ("Failed to read timestamp value from document.");
453 return Xapian::sortable_unserialise (value);
457 notmuch_message_get_tags (notmuch_message_t *message)
459 const char *prefix = _find_prefix ("tag");
460 Xapian::TermIterator i, end;
461 notmuch_tags_t *tags;
464 /* Currently this iteration is written with the assumption that
465 * "tag" has a single-character prefix. */
466 assert (strlen (prefix) == 1);
468 tags = _notmuch_tags_create (message);
469 if (unlikely (tags == NULL))
472 i = message->doc.termlist_begin ();
473 end = message->doc.termlist_end ();
480 if (tag.empty () || tag[0] != *prefix)
483 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
488 _notmuch_tags_prepare_iterator (tags);
494 _notmuch_message_set_date (notmuch_message_t *message,
499 /* GMime really doesn't want to see a NULL date, so protect its
501 if (date == NULL || *date == '\0')
504 time_value = g_mime_utils_header_decode_date (date, NULL);
506 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
507 Xapian::sortable_serialise (time_value));
511 thread_id_generate (thread_id_t *thread_id)
513 static int seeded = 0;
520 dev_random = fopen ("/dev/random", "r");
521 if (dev_random == NULL) {
524 fread ((void *) &value, sizeof (value), 1, dev_random);
532 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
534 sprintf (s, "%08x", value);
540 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
542 /* If not part of any existing thread, generate a new thread_id. */
543 thread_id_t thread_id;
545 thread_id_generate (&thread_id);
546 _notmuch_message_add_term (message, "thread", thread_id.str);
549 /* Synchronize changes made to message->doc out into the database. */
551 _notmuch_message_sync (notmuch_message_t *message)
553 Xapian::WritableDatabase *db;
555 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
558 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
559 db->replace_document (message->doc_id, message->doc);
562 /* Ensure that 'message' is not holding any file object open. Future
563 * calls to various functions will still automatically open the
564 * message file as needed.
567 _notmuch_message_close (notmuch_message_t *message)
569 if (message->message_file) {
570 notmuch_message_file_close (message->message_file);
571 message->message_file = NULL;
575 /* Add a name:value term to 'message', (the actual term will be
576 * encoded by prefixing the value with a short prefix). See
577 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
578 * names to prefix values.
580 * This change will not be reflected in the database until the next
581 * call to _notmuch_message_set_sync. */
582 notmuch_private_status_t
583 _notmuch_message_add_term (notmuch_message_t *message,
584 const char *prefix_name,
591 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
593 term = talloc_asprintf (message, "%s%s",
594 _find_prefix (prefix_name), value);
596 if (strlen (term) > NOTMUCH_TERM_MAX)
597 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
599 message->doc.add_term (term);
603 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
606 /* Parse 'text' and add a term to 'message' for each parsed word. Each
607 * term will be added both prefixed (if prefix_name is not NULL) and
608 * also unprefixed). */
609 notmuch_private_status_t
610 _notmuch_message_gen_terms (notmuch_message_t *message,
611 const char *prefix_name,
614 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
617 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
619 term_gen->set_document (message->doc);
622 const char *prefix = _find_prefix (prefix_name);
624 term_gen->index_text (text, 1, prefix);
627 term_gen->index_text (text);
629 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
632 /* Remove a name:value term from 'message', (the actual term will be
633 * encoded by prefixing the value with a short prefix). See
634 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
635 * names to prefix values.
637 * This change will not be reflected in the database until the next
638 * call to _notmuch_message_set_sync. */
639 notmuch_private_status_t
640 _notmuch_message_remove_term (notmuch_message_t *message,
641 const char *prefix_name,
647 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
649 term = talloc_asprintf (message, "%s%s",
650 _find_prefix (prefix_name), value);
652 if (strlen (term) > NOTMUCH_TERM_MAX)
653 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
656 message->doc.remove_term (term);
657 } catch (const Xapian::InvalidArgumentError) {
658 /* We'll let the philosopher's try to wrestle with the
659 * question of whether failing to remove that which was not
660 * there in the first place is failure. For us, we'll silently
661 * consider it all good. */
666 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
670 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
672 notmuch_private_status_t status;
675 return NOTMUCH_STATUS_NULL_POINTER;
677 if (strlen (tag) > NOTMUCH_TAG_MAX)
678 return NOTMUCH_STATUS_TAG_TOO_LONG;
680 status = _notmuch_message_add_term (message, "tag", tag);
682 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
686 if (! message->frozen)
687 _notmuch_message_sync (message);
689 return NOTMUCH_STATUS_SUCCESS;
693 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
695 notmuch_private_status_t status;
698 return NOTMUCH_STATUS_NULL_POINTER;
700 if (strlen (tag) > NOTMUCH_TAG_MAX)
701 return NOTMUCH_STATUS_TAG_TOO_LONG;
703 status = _notmuch_message_remove_term (message, "tag", tag);
705 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
709 if (! message->frozen)
710 _notmuch_message_sync (message);
712 return NOTMUCH_STATUS_SUCCESS;
716 notmuch_message_remove_all_tags (notmuch_message_t *message)
718 notmuch_private_status_t status;
719 notmuch_tags_t *tags;
722 for (tags = notmuch_message_get_tags (message);
723 notmuch_tags_has_more (tags);
724 notmuch_tags_advance (tags))
726 tag = notmuch_tags_get (tags);
728 status = _notmuch_message_remove_term (message, "tag", tag);
730 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
735 if (! message->frozen)
736 _notmuch_message_sync (message);
740 notmuch_message_freeze (notmuch_message_t *message)
746 notmuch_message_thaw (notmuch_message_t *message)
748 if (message->frozen > 0) {
750 if (message->frozen == 0)
751 _notmuch_message_sync (message);
752 return NOTMUCH_STATUS_SUCCESS;
754 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
759 notmuch_message_destroy (notmuch_message_t *message)
761 talloc_free (message);