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;
45 /* "128 bits of thread-id ought to be enough for anybody" */
46 #define NOTMUCH_THREAD_ID_BITS 128
47 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
48 typedef struct _thread_id {
49 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
52 /* We end up having to call the destructor explicitly because we had
53 * to use "placement new" in order to initialize C++ objects within a
54 * block that we allocated with talloc. So C++ is making talloc
55 * slightly less simple to use, (we wouldn't need
56 * talloc_set_destructor at all otherwise).
59 _notmuch_message_destructor (notmuch_message_t *message)
61 message->doc.~Document ();
66 /* Create a new notmuch_message_t object for an existing document in
69 * Here, 'talloc owner' is an optional talloc context to which the new
70 * message will belong. This allows for the caller to not bother
71 * calling notmuch_message_destroy on the message, and no that all
72 * memory will be reclaimed with 'talloc_owner' is free. The caller
73 * still can call notmuch_message_destroy when finished with the
76 * The 'talloc_owner' argument can also be NULL, in which case the
77 * caller *is* responsible for calling notmuch_message_destroy.
79 * If no document exists in the database with document ID of 'doc_id'
80 * then this function returns NULL and optionally sets *status to
81 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
83 * This function can also fail to due lack of available memory,
84 * returning NULL and optionally setting *status to
85 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
87 * The caller can pass NULL for status if uninterested in
88 * distinguishing these two cases.
91 _notmuch_message_create (const void *talloc_owner,
92 notmuch_database_t *notmuch,
94 notmuch_private_status_t *status)
96 notmuch_message_t *message;
99 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
101 message = talloc (talloc_owner, notmuch_message_t);
102 if (unlikely (message == NULL)) {
104 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
108 message->notmuch = notmuch;
109 message->doc_id = doc_id;
114 /* Each of these will be lazily created as needed. */
115 message->message_id = NULL;
116 message->thread_id = NULL;
117 message->in_reply_to = NULL;
118 message->filename = NULL;
119 message->message_file = NULL;
121 message->replies = _notmuch_message_list_create (message);
122 if (unlikely (message->replies == NULL)) {
124 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
128 /* This is C++'s creepy "placement new", which is really just an
129 * ugly way to call a constructor for a pre-allocated object. So
130 * it's really not an error to not be checking for OUT_OF_MEMORY
131 * here, since this "new" isn't actually allocating memory. This
132 * is language-design comedy of the wrong kind. */
134 new (&message->doc) Xapian::Document;
136 talloc_set_destructor (message, _notmuch_message_destructor);
139 message->doc = notmuch->xapian_db->get_document (doc_id);
140 } catch (const Xapian::DocNotFoundError &error) {
141 talloc_free (message);
143 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
150 /* Create a new notmuch_message_t object for a specific message ID,
151 * (which may or may not already exist in the database).
153 * The 'notmuch' database will be the talloc owner of the returned
156 * If there is already a document with message ID 'message_id' in the
157 * database, then the returned message can be used to query/modify the
158 * document. Otherwise, a new document will be inserted into the
159 * database before this function returns, (and *status will be set
160 * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
162 * If an error occurs, this function will return NULL and *status
163 * will be set as appropriate. (The status pointer argument must
167 _notmuch_message_create_for_message_id (notmuch_database_t *notmuch,
168 const char *message_id,
169 notmuch_private_status_t *status_ret)
171 notmuch_message_t *message;
172 Xapian::Document doc;
173 Xapian::WritableDatabase *db;
177 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
178 *status_ret = NOTMUCH_PRIVATE_STATUS_READONLY_DATABASE;
182 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
184 message = notmuch_database_find_message (notmuch, message_id);
186 return talloc_steal (notmuch, message);
188 term = talloc_asprintf (NULL, "%s%s",
189 _find_prefix ("id"), message_id);
191 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
195 db = static_cast<Xapian::WritableDatabase *> (notmuch->xapian_db);
200 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
202 doc_id = db->add_document (doc);
203 } catch (const Xapian::Error &error) {
204 fprintf (stderr, "A Xapian exception occurred creating message: %s\n",
205 error.get_msg().c_str());
206 notmuch->exception_reported = TRUE;
207 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
211 message = _notmuch_message_create (notmuch, notmuch,
214 /* We want to inform the caller that we had to create a new
216 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
217 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
223 notmuch_message_get_message_id (notmuch_message_t *message)
225 Xapian::TermIterator i;
227 if (message->message_id)
228 return message->message_id;
230 i = message->doc.termlist_begin ();
231 i.skip_to (_find_prefix ("id"));
233 if (i == message->doc.termlist_end ())
234 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
237 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
239 #if DEBUG_DATABASE_SANITY
242 if (i != message->doc.termlist_end () &&
243 strncmp ((*i).c_str (), _find_prefix ("id"),
244 strlen (_find_prefix ("id"))) == 0)
246 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
251 return message->message_id;
255 _notmuch_message_ensure_message_file (notmuch_message_t *message)
257 const char *filename;
259 if (message->message_file)
262 filename = notmuch_message_get_filename (message);
263 if (unlikely (filename == NULL))
266 message->message_file = _notmuch_message_file_open_ctx (message, filename);
270 notmuch_message_get_header (notmuch_message_t *message, const char *header)
272 _notmuch_message_ensure_message_file (message);
273 if (message->message_file == NULL)
276 return notmuch_message_file_get_header (message->message_file, header);
279 /* Return the message ID from the In-Reply-To header of 'message'.
281 * Returns an empty string ("") if 'message' has no In-Reply-To
284 * Returns NULL if any error occurs.
287 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
289 const char *prefix = _find_prefix ("replyto");
290 int prefix_len = strlen (prefix);
291 Xapian::TermIterator i;
292 std::string in_reply_to;
294 if (message->in_reply_to)
295 return message->in_reply_to;
297 i = message->doc.termlist_begin ();
300 if (i != message->doc.termlist_end ())
303 /* It's perfectly valid for a message to have no In-Reply-To
304 * header. For these cases, we return an empty string. */
305 if (i == message->doc.termlist_end () ||
306 strncmp (in_reply_to.c_str (), prefix, prefix_len))
308 message->in_reply_to = talloc_strdup (message, "");
309 return message->in_reply_to;
312 message->in_reply_to = talloc_strdup (message,
313 in_reply_to.c_str () + prefix_len);
315 #if DEBUG_DATABASE_SANITY
320 if (i != message->doc.termlist_end () &&
321 strncmp ((*i).c_str (), prefix, prefix_len) == 0)
323 INTERNAL_ERROR ("Message %s has duplicate In-Reply-To IDs: %s and %s\n",
324 notmuch_message_get_message_id (message),
325 message->in_reply_to,
326 (*i).c_str () + prefix_len);
330 return message->in_reply_to;
334 notmuch_message_get_thread_id (notmuch_message_t *message)
336 const char *prefix = _find_prefix ("thread");
337 Xapian::TermIterator i;
340 /* This code is written with the assumption that "thread" has a
341 * single-character prefix. */
342 assert (strlen (prefix) == 1);
344 if (message->thread_id)
345 return message->thread_id;
347 i = message->doc.termlist_begin ();
350 if (i != message->doc.termlist_end ())
353 if (i == message->doc.termlist_end () || id[0] != *prefix)
354 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
357 message->thread_id = talloc_strdup (message, id.c_str () + 1);
359 #if DEBUG_DATABASE_SANITY
363 if (i != message->doc.termlist_end () && id[0] == *prefix)
365 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
366 notmuch_message_get_message_id (message),
372 return message->thread_id;
376 _notmuch_message_add_reply (notmuch_message_t *message,
377 notmuch_message_node_t *reply)
379 _notmuch_message_list_append (message->replies, reply);
383 notmuch_message_get_replies (notmuch_message_t *message)
385 return _notmuch_messages_create (message->replies);
388 /* Add an additional 'filename' for 'message'.
390 * This change will not be reflected in the database until the next
391 * call to _notmuch_message_set_sync. */
393 _notmuch_message_add_filename (notmuch_message_t *message,
394 const char *filename)
396 notmuch_status_t status;
397 void *local = talloc_new (message);
400 if (message->filename) {
401 talloc_free (message->filename);
402 message->filename = NULL;
405 if (filename == NULL)
406 INTERNAL_ERROR ("Message filename cannot be NULL.");
408 status = _notmuch_database_filename_to_direntry (local,
410 filename, &direntry);
414 _notmuch_message_add_term (message, "file-direntry", direntry);
418 return NOTMUCH_STATUS_SUCCESS;
422 notmuch_message_get_filename (notmuch_message_t *message)
424 const char *prefix = _find_prefix ("file-direntry");
425 int prefix_len = strlen (prefix);
426 Xapian::TermIterator i;
427 char *direntry, *colon;
428 const char *db_path, *directory, *basename;
429 unsigned int directory_id;
430 void *local = talloc_new (message);
432 if (message->filename)
433 return message->filename;
435 i = message->doc.termlist_begin ();
438 if (i != message->doc.termlist_end ())
439 direntry = talloc_strdup (local, (*i).c_str ());
441 if (i == message->doc.termlist_end () ||
442 strncmp (direntry, prefix, prefix_len))
444 INTERNAL_ERROR ("message with no filename");
447 direntry += prefix_len;
449 directory_id = strtol (direntry, &colon, 10);
451 if (colon == NULL || *colon != ':')
452 INTERNAL_ERROR ("malformed direntry");
454 basename = colon + 1;
458 db_path = notmuch_database_get_path (message->notmuch);
460 directory = _notmuch_database_get_directory_path (local,
464 if (strlen (directory))
465 message->filename = talloc_asprintf (message, "%s/%s/%s",
466 db_path, directory, basename);
468 message->filename = talloc_asprintf (message, "%s/%s",
470 talloc_free ((void *) directory);
474 return message->filename;
478 notmuch_message_get_flag (notmuch_message_t *message,
479 notmuch_message_flag_t flag)
481 return message->flags & (1 << flag);
485 notmuch_message_set_flag (notmuch_message_t *message,
486 notmuch_message_flag_t flag, notmuch_bool_t enable)
489 message->flags |= (1 << flag);
491 message->flags &= ~(1 << flag);
495 notmuch_message_get_date (notmuch_message_t *message)
500 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
501 } catch (Xapian::Error &error) {
502 INTERNAL_ERROR ("Failed to read timestamp value from document.");
506 return Xapian::sortable_unserialise (value);
510 notmuch_message_get_tags (notmuch_message_t *message)
512 Xapian::TermIterator i, end;
513 i = message->doc.termlist_begin();
514 end = message->doc.termlist_end();
515 return _notmuch_convert_tags(message, i, end);
519 _notmuch_message_set_date (notmuch_message_t *message,
524 /* GMime really doesn't want to see a NULL date, so protect its
526 if (date == NULL || *date == '\0')
529 time_value = g_mime_utils_header_decode_date (date, NULL);
531 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
532 Xapian::sortable_serialise (time_value));
536 thread_id_generate (thread_id_t *thread_id)
538 static int seeded = 0;
545 dev_random = fopen ("/dev/random", "r");
546 if (dev_random == NULL) {
549 fread ((void *) &value, sizeof (value), 1, dev_random);
557 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
559 sprintf (s, "%08x", value);
565 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
567 /* If not part of any existing thread, generate a new thread_id. */
568 thread_id_t thread_id;
570 thread_id_generate (&thread_id);
571 _notmuch_message_add_term (message, "thread", thread_id.str);
574 /* Synchronize changes made to message->doc out into the database. */
576 _notmuch_message_sync (notmuch_message_t *message)
578 Xapian::WritableDatabase *db;
580 if (message->notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY)
583 db = static_cast <Xapian::WritableDatabase *> (message->notmuch->xapian_db);
584 db->replace_document (message->doc_id, message->doc);
587 /* Ensure that 'message' is not holding any file object open. Future
588 * calls to various functions will still automatically open the
589 * message file as needed.
592 _notmuch_message_close (notmuch_message_t *message)
594 if (message->message_file) {
595 notmuch_message_file_close (message->message_file);
596 message->message_file = NULL;
600 /* Add a name:value term to 'message', (the actual term will be
601 * encoded by prefixing the value with a short prefix). See
602 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
603 * names to prefix values.
605 * This change will not be reflected in the database until the next
606 * call to _notmuch_message_set_sync. */
607 notmuch_private_status_t
608 _notmuch_message_add_term (notmuch_message_t *message,
609 const char *prefix_name,
616 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
618 term = talloc_asprintf (message, "%s%s",
619 _find_prefix (prefix_name), value);
621 if (strlen (term) > NOTMUCH_TERM_MAX)
622 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
624 message->doc.add_term (term);
628 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
631 /* Parse 'text' and add a term to 'message' for each parsed word. Each
632 * term will be added both prefixed (if prefix_name is not NULL) and
633 * also unprefixed). */
634 notmuch_private_status_t
635 _notmuch_message_gen_terms (notmuch_message_t *message,
636 const char *prefix_name,
639 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
642 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
644 term_gen->set_document (message->doc);
647 const char *prefix = _find_prefix (prefix_name);
649 term_gen->index_text (text, 1, prefix);
652 term_gen->index_text (text);
654 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
657 /* Remove a name:value term from 'message', (the actual term will be
658 * encoded by prefixing the value with a short prefix). See
659 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
660 * names to prefix values.
662 * This change will not be reflected in the database until the next
663 * call to _notmuch_message_set_sync. */
664 notmuch_private_status_t
665 _notmuch_message_remove_term (notmuch_message_t *message,
666 const char *prefix_name,
672 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
674 term = talloc_asprintf (message, "%s%s",
675 _find_prefix (prefix_name), value);
677 if (strlen (term) > NOTMUCH_TERM_MAX)
678 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
681 message->doc.remove_term (term);
682 } catch (const Xapian::InvalidArgumentError) {
683 /* We'll let the philosopher's try to wrestle with the
684 * question of whether failing to remove that which was not
685 * there in the first place is failure. For us, we'll silently
686 * consider it all good. */
691 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
695 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
697 notmuch_private_status_t status;
700 return NOTMUCH_STATUS_NULL_POINTER;
702 if (strlen (tag) > NOTMUCH_TAG_MAX)
703 return NOTMUCH_STATUS_TAG_TOO_LONG;
705 status = _notmuch_message_add_term (message, "tag", tag);
707 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
711 if (! message->frozen)
712 _notmuch_message_sync (message);
714 return NOTMUCH_STATUS_SUCCESS;
718 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
720 notmuch_private_status_t status;
723 return NOTMUCH_STATUS_NULL_POINTER;
725 if (strlen (tag) > NOTMUCH_TAG_MAX)
726 return NOTMUCH_STATUS_TAG_TOO_LONG;
728 status = _notmuch_message_remove_term (message, "tag", tag);
730 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
734 if (! message->frozen)
735 _notmuch_message_sync (message);
737 return NOTMUCH_STATUS_SUCCESS;
741 notmuch_message_remove_all_tags (notmuch_message_t *message)
743 notmuch_private_status_t status;
744 notmuch_tags_t *tags;
747 for (tags = notmuch_message_get_tags (message);
748 notmuch_tags_has_more (tags);
749 notmuch_tags_advance (tags))
751 tag = notmuch_tags_get (tags);
753 status = _notmuch_message_remove_term (message, "tag", tag);
755 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
760 if (! message->frozen)
761 _notmuch_message_sync (message);
765 notmuch_message_freeze (notmuch_message_t *message)
771 notmuch_message_thaw (notmuch_message_t *message)
773 if (message->frozen > 0) {
775 if (message->frozen == 0)
776 _notmuch_message_sync (message);
777 return NOTMUCH_STATUS_SUCCESS;
779 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
784 notmuch_message_destroy (notmuch_message_t *message)
786 talloc_free (message);