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 struct _notmuch_message {
27 notmuch_database_t *notmuch;
33 notmuch_message_file_t *message_file;
37 /* "128 bits of thread-id ought to be enough for anybody" */
38 #define NOTMUCH_THREAD_ID_BITS 128
39 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
40 typedef struct _thread_id {
41 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
44 /* We end up having to call the destructor explicitly because we had
45 * to use "placement new" in order to initialize C++ objects within a
46 * block that we allocated with talloc. So C++ is making talloc
47 * slightly less simple to use, (we wouldn't need
48 * talloc_set_destructor at all otherwise).
51 _notmuch_message_destructor (notmuch_message_t *message)
53 message->doc.~Document ();
58 /* Create a new notmuch_message_t object for an existing document in
61 * Here, 'talloc owner' is an optional talloc context to which the new
62 * message will belong. This allows for the caller to not bother
63 * calling notmuch_message_destroy on the message, and no that all
64 * memory will be reclaimed with 'talloc_owner' is free. The caller
65 * still can call notmuch_message_destroy when finished with the
68 * The 'talloc_owner' argument can also be NULL, in which case the
69 * caller *is* responsible for calling notmuch_message_destroy.
71 * If no document exists in the database with document ID of 'doc_id'
72 * then this function returns NULL and optionally sets *status to
73 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
75 * This function can also fail to due lack of available memory,
76 * returning NULL and optionally setting *status to
77 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
79 * The caller can pass NULL for status if uninterested in
80 * distinguishing these two cases.
83 _notmuch_message_create (const void *talloc_owner,
84 notmuch_database_t *notmuch,
86 notmuch_private_status_t *status)
88 notmuch_message_t *message;
91 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
93 message = talloc (talloc_owner, notmuch_message_t);
94 if (unlikely (message == NULL)) {
96 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
100 message->notmuch = notmuch;
101 message->doc_id = doc_id;
105 /* Each of these will be lazily created as needed. */
106 message->message_id = NULL;
107 message->thread_id = NULL;
108 message->filename = NULL;
109 message->message_file = NULL;
111 /* This is C++'s creepy "placement new", which is really just an
112 * ugly way to call a constructor for a pre-allocated object. So
113 * it's really not an error to not be checking for OUT_OF_MEMORY
114 * here, since this "new" isn't actually allocating memory. This
115 * is language-design comedy of the wrong kind. */
117 new (&message->doc) Xapian::Document;
119 talloc_set_destructor (message, _notmuch_message_destructor);
122 message->doc = notmuch->xapian_db->get_document (doc_id);
123 } catch (const Xapian::DocNotFoundError &error) {
124 talloc_free (message);
126 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
133 /* Create a new notmuch_message_t object for a specific message ID,
134 * (which may or may not already exist in the databas).
136 * Here, 'talloc owner' is an optional talloc context to which the new
137 * message will belong. This allows for the caller to not bother
138 * calling notmuch_message_destroy on the message, and no that all
139 * memory will be reclaimed with 'talloc_owner' is free. The caller
140 * still can call notmuch_message_destroy when finished with the
141 * message if desired.
143 * The 'talloc_owner' argument can also be NULL, in which case the
144 * caller *is* responsible for calling notmuch_message_destroy.
146 * If there is already a document with message ID 'message_id' in the
147 * database, then the returned message can be used to query/modify the
148 * document. Otherwise, a new document will be inserted into the
149 * database before this function returns, (and *status will be set
150 * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
152 * If an error occurs, this function will return NULL and *status
153 * will be set as appropriate. (The status pointer argument must
157 _notmuch_message_create_for_message_id (const void *talloc_owner,
158 notmuch_database_t *notmuch,
159 const char *message_id,
160 notmuch_private_status_t *status_ret)
162 notmuch_message_t *message;
163 Xapian::Document doc;
167 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
169 message = notmuch_database_find_message (notmuch, message_id);
171 return talloc_steal (talloc_owner, message);
173 term = talloc_asprintf (NULL, "%s%s",
174 _find_prefix ("id"), message_id);
176 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
184 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
186 doc_id = notmuch->xapian_db->add_document (doc);
187 } catch (const Xapian::Error &error) {
188 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
192 message = _notmuch_message_create (talloc_owner, notmuch,
195 /* We want to inform the caller that we had to create a new
197 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
198 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
204 notmuch_message_get_message_id (notmuch_message_t *message)
206 Xapian::TermIterator i;
208 if (message->message_id)
209 return message->message_id;
211 i = message->doc.termlist_begin ();
212 i.skip_to (_find_prefix ("id"));
214 if (i == message->doc.termlist_end ())
215 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
218 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
220 #if DEBUG_DATABASE_SANITY
223 if (i != message->doc.termlist_end () &&
224 strncmp ((*i).c_str (), _find_prefix ("id"),
225 strlen (_find_prefix ("id"))) == 0)
227 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
232 return message->message_id;
236 _notmuch_message_ensure_message_file (notmuch_message_t *message)
238 const char *filename;
240 if (message->message_file)
243 filename = notmuch_message_get_filename (message);
244 if (unlikely (filename == NULL))
247 message->message_file = _notmuch_message_file_open_ctx (message, filename);
251 notmuch_message_get_header (notmuch_message_t *message, const char *header)
253 _notmuch_message_ensure_message_file (message);
254 if (message->message_file == NULL)
257 return notmuch_message_file_get_header (message->message_file, header);
261 notmuch_message_get_all_headers (notmuch_message_t *message)
263 _notmuch_message_ensure_message_file (message);
264 if (message->message_file == NULL)
267 return notmuch_message_file_get_all_headers (message->message_file);
271 notmuch_message_get_header_size (notmuch_message_t *message)
273 _notmuch_message_ensure_message_file (message);
274 if (message->message_file == NULL)
277 return notmuch_message_file_get_header_size (message->message_file);
282 notmuch_message_get_thread_id (notmuch_message_t *message)
284 Xapian::TermIterator i;
286 if (message->thread_id)
287 return message->thread_id;
289 i = message->doc.termlist_begin ();
290 i.skip_to (_find_prefix ("thread"));
292 if (i == message->doc.termlist_end ())
293 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
296 message->thread_id = talloc_strdup (message, (*i).c_str () + 1);
298 #if DEBUG_DATABASE_SANITY
301 if (i != message->doc.termlist_end () &&
302 strncmp ((*i).c_str (), _find_prefix ("thread"),
303 strlen (_find_prefix ("thread"))) == 0)
305 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
306 notmuch_message_get_message_id (message),
312 return message->thread_id;
315 /* Set the filename for 'message' to 'filename'.
317 * XXX: We should still figure out if we think it's important to store
318 * multiple filenames for email messages with identical message IDs.
320 * This change will not be reflected in the database until the next
321 * call to _notmuch_message_set_sync. */
323 _notmuch_message_set_filename (notmuch_message_t *message,
324 const char *filename)
328 unsigned int db_path_len;
330 if (message->filename) {
331 talloc_free (message->filename);
332 message->filename = NULL;
335 if (filename == NULL)
336 INTERNAL_ERROR ("Message filename cannot be NULL.");
340 db_path = notmuch_database_get_path (message->notmuch);
341 db_path_len = strlen (db_path);
343 if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
344 && strlen (s) > db_path_len)
346 s += db_path_len + 1;
349 message->doc.set_data (s);
353 notmuch_message_get_filename (notmuch_message_t *message)
355 std::string filename_str;
358 if (message->filename)
359 return message->filename;
361 filename_str = message->doc.get_data ();
362 db_path = notmuch_database_get_path (message->notmuch);
364 if (filename_str[0] != '/')
365 message->filename = talloc_asprintf (message, "%s/%s", db_path,
366 filename_str.c_str ());
368 message->filename = talloc_strdup (message, filename_str.c_str ());
370 return message->filename;
374 notmuch_message_get_date (notmuch_message_t *message)
379 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
380 } catch (Xapian::Error &error) {
381 INTERNAL_ERROR ("Failed to read timestamp value from document.");
385 return Xapian::sortable_unserialise (value);
389 notmuch_message_get_tags (notmuch_message_t *message)
391 const char *prefix = _find_prefix ("tag");
392 Xapian::TermIterator i, end;
393 notmuch_tags_t *tags;
396 /* Currently this iteration is written with the assumption that
397 * "tag" has a single-character prefix. */
398 assert (strlen (prefix) == 1);
400 tags = _notmuch_tags_create (message);
401 if (unlikely (tags == NULL))
404 i = message->doc.termlist_begin ();
405 end = message->doc.termlist_end ();
412 if (tag.empty () || tag[0] != *prefix)
415 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
420 _notmuch_tags_prepare_iterator (tags);
426 _notmuch_message_set_date (notmuch_message_t *message,
431 time_value = notmuch_parse_date (date, NULL);
433 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
434 Xapian::sortable_serialise (time_value));
438 thread_id_generate (thread_id_t *thread_id)
440 static int seeded = 0;
447 dev_random = fopen ("/dev/random", "r");
448 if (dev_random == NULL) {
451 fread ((void *) &value, sizeof (value), 1, dev_random);
459 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
461 sprintf (s, "%08x", value);
467 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
469 /* If not part of any existing thread, generate a new thread_id. */
470 thread_id_t thread_id;
472 thread_id_generate (&thread_id);
473 _notmuch_message_add_term (message, "thread", thread_id.str);
476 /* Synchronize changes made to message->doc out into the database. */
478 _notmuch_message_sync (notmuch_message_t *message)
480 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
482 db->replace_document (message->doc_id, message->doc);
485 /* Add a name:value term to 'message', (the actual term will be
486 * encoded by prefixing the value with a short prefix). See
487 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
488 * names to prefix values.
490 * This change will not be reflected in the database until the next
491 * call to _notmuch_message_set_sync. */
492 notmuch_private_status_t
493 _notmuch_message_add_term (notmuch_message_t *message,
494 const char *prefix_name,
501 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
503 term = talloc_asprintf (message, "%s%s",
504 _find_prefix (prefix_name), value);
506 if (strlen (term) > NOTMUCH_TERM_MAX)
507 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
509 message->doc.add_term (term);
513 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
516 /* Parse 'text' and add a term to 'message' for each parsed word. Each
517 * term will be added both prefixed (if prefix_name is not NULL) and
518 * also unprefixed). */
519 notmuch_private_status_t
520 _notmuch_message_gen_terms (notmuch_message_t *message,
521 const char *prefix_name,
524 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
527 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
529 term_gen->set_document (message->doc);
532 const char *prefix = _find_prefix (prefix_name);
534 term_gen->index_text (text, 1, prefix);
537 term_gen->index_text (text);
539 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
542 /* Remove a name:value term from 'message', (the actual term will be
543 * encoded by prefixing the value with a short prefix). See
544 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
545 * names to prefix values.
547 * This change will not be reflected in the database until the next
548 * call to _notmuch_message_set_sync. */
549 notmuch_private_status_t
550 _notmuch_message_remove_term (notmuch_message_t *message,
551 const char *prefix_name,
557 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
559 term = talloc_asprintf (message, "%s%s",
560 _find_prefix (prefix_name), value);
562 if (strlen (term) > NOTMUCH_TERM_MAX)
563 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
566 message->doc.remove_term (term);
567 } catch (const Xapian::InvalidArgumentError) {
568 /* We'll let the philosopher's try to wrestle with the
569 * question of whether failing to remove that which was not
570 * there in the first place is failure. For us, we'll silently
571 * consider it all good. */
576 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
580 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
582 notmuch_private_status_t status;
585 return NOTMUCH_STATUS_NULL_POINTER;
587 if (strlen (tag) > NOTMUCH_TAG_MAX)
588 return NOTMUCH_STATUS_TAG_TOO_LONG;
590 status = _notmuch_message_add_term (message, "tag", tag);
592 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
596 if (! message->frozen)
597 _notmuch_message_sync (message);
599 return NOTMUCH_STATUS_SUCCESS;
603 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
605 notmuch_private_status_t status;
608 return NOTMUCH_STATUS_NULL_POINTER;
610 if (strlen (tag) > NOTMUCH_TAG_MAX)
611 return NOTMUCH_STATUS_TAG_TOO_LONG;
613 status = _notmuch_message_remove_term (message, "tag", tag);
615 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
619 if (! message->frozen)
620 _notmuch_message_sync (message);
622 return NOTMUCH_STATUS_SUCCESS;
626 notmuch_message_remove_all_tags (notmuch_message_t *message)
628 notmuch_private_status_t status;
629 notmuch_tags_t *tags;
632 for (tags = notmuch_message_get_tags (message);
633 notmuch_tags_has_more (tags);
634 notmuch_tags_advance (tags))
636 tag = notmuch_tags_get (tags);
638 status = _notmuch_message_remove_term (message, "tag", tag);
640 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
645 if (! message->frozen)
646 _notmuch_message_sync (message);
650 notmuch_message_freeze (notmuch_message_t *message)
656 notmuch_message_thaw (notmuch_message_t *message)
658 if (message->frozen > 0) {
660 if (message->frozen == 0)
661 _notmuch_message_sync (message);
662 return NOTMUCH_STATUS_SUCCESS;
664 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
669 notmuch_message_destroy (notmuch_message_t *message)
671 talloc_free (message);