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 databas).
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;
174 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
176 message = notmuch_database_find_message (notmuch, message_id);
178 return talloc_steal (notmuch, message);
180 term = talloc_asprintf (NULL, "%s%s",
181 _find_prefix ("id"), message_id);
183 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
191 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
193 doc_id = notmuch->xapian_db->add_document (doc);
194 } catch (const Xapian::Error &error) {
195 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
199 message = _notmuch_message_create (notmuch, notmuch,
202 /* We want to inform the caller that we had to create a new
204 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
205 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
211 notmuch_message_get_message_id (notmuch_message_t *message)
213 Xapian::TermIterator i;
215 if (message->message_id)
216 return message->message_id;
218 i = message->doc.termlist_begin ();
219 i.skip_to (_find_prefix ("id"));
221 if (i == message->doc.termlist_end ())
222 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
225 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
227 #if DEBUG_DATABASE_SANITY
230 if (i != message->doc.termlist_end () &&
231 strncmp ((*i).c_str (), _find_prefix ("id"),
232 strlen (_find_prefix ("id"))) == 0)
234 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
239 return message->message_id;
243 _notmuch_message_ensure_message_file (notmuch_message_t *message)
245 const char *filename;
247 if (message->message_file)
250 filename = notmuch_message_get_filename (message);
251 if (unlikely (filename == NULL))
254 message->message_file = _notmuch_message_file_open_ctx (message, filename);
258 notmuch_message_get_header (notmuch_message_t *message, const char *header)
260 _notmuch_message_ensure_message_file (message);
261 if (message->message_file == NULL)
264 return notmuch_message_file_get_header (message->message_file, header);
267 /* Return the message ID from the In-Reply-To header of 'message'.
269 * Returns an empty string ("") if 'message' has no In-Reply-To
272 * Returns NULL if any error occurs.
275 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
277 const char *prefix = _find_prefix ("replyto");
278 int prefix_len = strlen (prefix);
279 Xapian::TermIterator i;
280 std::string in_reply_to;
282 if (message->in_reply_to)
283 return message->in_reply_to;
285 i = message->doc.termlist_begin ();
290 /* It's perfectly valid for a message to have no In-Reply-To
291 * header. For these cases, we return an empty string. */
292 if (i == message->doc.termlist_end () ||
293 strncmp (in_reply_to.c_str (), prefix, prefix_len))
295 message->in_reply_to = talloc_strdup (message, "");
296 return message->in_reply_to;
299 message->in_reply_to = talloc_strdup (message,
300 in_reply_to.c_str () + prefix_len);
302 #if DEBUG_DATABASE_SANITY
307 if (i != message->doc.termlist_end () &&
308 strncmp ((*i).c_str (), prefix, prefix_len))
310 INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n"
311 notmuch_message_get_message_id (message),
312 message->in_reply_to,
313 (*i).c_str () + prefix_len);
317 return message->in_reply_to;
321 notmuch_message_get_thread_id (notmuch_message_t *message)
323 const char *prefix = _find_prefix ("thread");
324 Xapian::TermIterator i;
327 /* This code is written with the assumption that "thread" has a
328 * single-character prefix. */
329 assert (strlen (prefix) == 1);
331 if (message->thread_id)
332 return message->thread_id;
334 i = message->doc.termlist_begin ();
340 if (i == message->doc.termlist_end () || id[0] != *prefix)
341 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
344 message->thread_id = talloc_strdup (message, id.c_str () + 1);
346 #if DEBUG_DATABASE_SANITY
350 if (i != message->doc.termlist_end () && id[0] == *prefix)
352 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
353 notmuch_message_get_message_id (message),
359 return message->thread_id;
363 _notmuch_message_add_reply (notmuch_message_t *message,
364 notmuch_message_node_t *reply)
366 _notmuch_message_list_append (message->replies, reply);
370 notmuch_message_get_replies (notmuch_message_t *message)
372 return _notmuch_messages_create (message->replies);
375 /* Set the filename for 'message' to 'filename'.
377 * XXX: We should still figure out if we think it's important to store
378 * multiple filenames for email messages with identical message IDs.
380 * This change will not be reflected in the database until the next
381 * call to _notmuch_message_set_sync. */
383 _notmuch_message_set_filename (notmuch_message_t *message,
384 const char *filename)
388 unsigned int db_path_len;
390 if (message->filename) {
391 talloc_free (message->filename);
392 message->filename = NULL;
395 if (filename == NULL)
396 INTERNAL_ERROR ("Message filename cannot be NULL.");
400 db_path = notmuch_database_get_path (message->notmuch);
401 db_path_len = strlen (db_path);
403 if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
404 && strlen (s) > db_path_len)
406 s += db_path_len + 1;
409 message->doc.set_data (s);
413 notmuch_message_get_filename (notmuch_message_t *message)
415 std::string filename_str;
418 if (message->filename)
419 return message->filename;
421 filename_str = message->doc.get_data ();
422 db_path = notmuch_database_get_path (message->notmuch);
424 if (filename_str[0] != '/')
425 message->filename = talloc_asprintf (message, "%s/%s", db_path,
426 filename_str.c_str ());
428 message->filename = talloc_strdup (message, filename_str.c_str ());
430 return message->filename;
434 notmuch_message_get_date (notmuch_message_t *message)
439 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
440 } catch (Xapian::Error &error) {
441 INTERNAL_ERROR ("Failed to read timestamp value from document.");
445 return Xapian::sortable_unserialise (value);
449 notmuch_message_get_tags (notmuch_message_t *message)
451 const char *prefix = _find_prefix ("tag");
452 Xapian::TermIterator i, end;
453 notmuch_tags_t *tags;
456 /* Currently this iteration is written with the assumption that
457 * "tag" has a single-character prefix. */
458 assert (strlen (prefix) == 1);
460 tags = _notmuch_tags_create (message);
461 if (unlikely (tags == NULL))
464 i = message->doc.termlist_begin ();
465 end = message->doc.termlist_end ();
472 if (tag.empty () || tag[0] != *prefix)
475 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
480 _notmuch_tags_prepare_iterator (tags);
486 _notmuch_message_set_date (notmuch_message_t *message,
491 /* GMime really doesn't want to see a NULL date, so protect its
496 time_value = g_mime_utils_header_decode_date (date, NULL);
498 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
499 Xapian::sortable_serialise (time_value));
503 thread_id_generate (thread_id_t *thread_id)
505 static int seeded = 0;
512 dev_random = fopen ("/dev/random", "r");
513 if (dev_random == NULL) {
516 fread ((void *) &value, sizeof (value), 1, dev_random);
524 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
526 sprintf (s, "%08x", value);
532 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
534 /* If not part of any existing thread, generate a new thread_id. */
535 thread_id_t thread_id;
537 thread_id_generate (&thread_id);
538 _notmuch_message_add_term (message, "thread", thread_id.str);
541 /* Synchronize changes made to message->doc out into the database. */
543 _notmuch_message_sync (notmuch_message_t *message)
545 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
547 db->replace_document (message->doc_id, message->doc);
550 /* Ensure that 'message' is not holding any file object open. Future
551 * calls to various functions will still automatically open the
552 * message file as needed.
555 _notmuch_message_close (notmuch_message_t *message)
557 if (message->message_file) {
558 notmuch_message_file_close (message->message_file);
559 message->message_file = NULL;
563 /* Add a name:value term to 'message', (the actual term will be
564 * encoded by prefixing the value with a short prefix). See
565 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
566 * names to prefix values.
568 * This change will not be reflected in the database until the next
569 * call to _notmuch_message_set_sync. */
570 notmuch_private_status_t
571 _notmuch_message_add_term (notmuch_message_t *message,
572 const char *prefix_name,
579 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
581 term = talloc_asprintf (message, "%s%s",
582 _find_prefix (prefix_name), value);
584 if (strlen (term) > NOTMUCH_TERM_MAX)
585 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
587 message->doc.add_term (term);
591 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
594 /* Parse 'text' and add a term to 'message' for each parsed word. Each
595 * term will be added both prefixed (if prefix_name is not NULL) and
596 * also unprefixed). */
597 notmuch_private_status_t
598 _notmuch_message_gen_terms (notmuch_message_t *message,
599 const char *prefix_name,
602 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
605 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
607 term_gen->set_document (message->doc);
610 const char *prefix = _find_prefix (prefix_name);
612 term_gen->index_text (text, 1, prefix);
615 term_gen->index_text (text);
617 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
620 /* Remove a name:value term from 'message', (the actual term will be
621 * encoded by prefixing the value with a short prefix). See
622 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
623 * names to prefix values.
625 * This change will not be reflected in the database until the next
626 * call to _notmuch_message_set_sync. */
627 notmuch_private_status_t
628 _notmuch_message_remove_term (notmuch_message_t *message,
629 const char *prefix_name,
635 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
637 term = talloc_asprintf (message, "%s%s",
638 _find_prefix (prefix_name), value);
640 if (strlen (term) > NOTMUCH_TERM_MAX)
641 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
644 message->doc.remove_term (term);
645 } catch (const Xapian::InvalidArgumentError) {
646 /* We'll let the philosopher's try to wrestle with the
647 * question of whether failing to remove that which was not
648 * there in the first place is failure. For us, we'll silently
649 * consider it all good. */
654 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
658 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
660 notmuch_private_status_t status;
663 return NOTMUCH_STATUS_NULL_POINTER;
665 if (strlen (tag) > NOTMUCH_TAG_MAX)
666 return NOTMUCH_STATUS_TAG_TOO_LONG;
668 status = _notmuch_message_add_term (message, "tag", tag);
670 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
674 if (! message->frozen)
675 _notmuch_message_sync (message);
677 return NOTMUCH_STATUS_SUCCESS;
681 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
683 notmuch_private_status_t status;
686 return NOTMUCH_STATUS_NULL_POINTER;
688 if (strlen (tag) > NOTMUCH_TAG_MAX)
689 return NOTMUCH_STATUS_TAG_TOO_LONG;
691 status = _notmuch_message_remove_term (message, "tag", tag);
693 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
697 if (! message->frozen)
698 _notmuch_message_sync (message);
700 return NOTMUCH_STATUS_SUCCESS;
704 notmuch_message_remove_all_tags (notmuch_message_t *message)
706 notmuch_private_status_t status;
707 notmuch_tags_t *tags;
710 for (tags = notmuch_message_get_tags (message);
711 notmuch_tags_has_more (tags);
712 notmuch_tags_advance (tags))
714 tag = notmuch_tags_get (tags);
716 status = _notmuch_message_remove_term (message, "tag", tag);
718 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
723 if (! message->frozen)
724 _notmuch_message_sync (message);
728 notmuch_message_freeze (notmuch_message_t *message)
734 notmuch_message_thaw (notmuch_message_t *message)
736 if (message->frozen > 0) {
738 if (message->frozen == 0)
739 _notmuch_message_sync (message);
740 return NOTMUCH_STATUS_SUCCESS;
742 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
747 notmuch_message_destroy (notmuch_message_t *message)
749 talloc_free (message);