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"
24 #include <gmime/gmime.h>
28 struct _notmuch_message {
29 notmuch_database_t *notmuch;
35 notmuch_message_file_t *message_file;
36 notmuch_message_list_t *replies;
41 /* "128 bits of thread-id ought to be enough for anybody" */
42 #define NOTMUCH_THREAD_ID_BITS 128
43 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
44 typedef struct _thread_id {
45 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
48 /* We end up having to call the destructor explicitly because we had
49 * to use "placement new" in order to initialize C++ objects within a
50 * block that we allocated with talloc. So C++ is making talloc
51 * slightly less simple to use, (we wouldn't need
52 * talloc_set_destructor at all otherwise).
55 _notmuch_message_destructor (notmuch_message_t *message)
57 message->doc.~Document ();
62 /* Create a new notmuch_message_t object for an existing document in
65 * Here, 'talloc owner' is an optional talloc context to which the new
66 * message will belong. This allows for the caller to not bother
67 * calling notmuch_message_destroy on the message, and no that all
68 * memory will be reclaimed with 'talloc_owner' is free. The caller
69 * still can call notmuch_message_destroy when finished with the
72 * The 'talloc_owner' argument can also be NULL, in which case the
73 * caller *is* responsible for calling notmuch_message_destroy.
75 * If no document exists in the database with document ID of 'doc_id'
76 * then this function returns NULL and optionally sets *status to
77 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
79 * This function can also fail to due lack of available memory,
80 * returning NULL and optionally setting *status to
81 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
83 * The caller can pass NULL for status if uninterested in
84 * distinguishing these two cases.
87 _notmuch_message_create (const void *talloc_owner,
88 notmuch_database_t *notmuch,
90 notmuch_private_status_t *status)
92 notmuch_message_t *message;
95 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
97 message = talloc (talloc_owner, notmuch_message_t);
98 if (unlikely (message == NULL)) {
100 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
104 message->notmuch = notmuch;
105 message->doc_id = doc_id;
109 /* Each of these will be lazily created as needed. */
110 message->message_id = NULL;
111 message->thread_id = NULL;
112 message->filename = NULL;
113 message->message_file = NULL;
115 message->replies = _notmuch_message_list_create (message);
116 if (unlikely (message->replies == NULL)) {
118 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
122 /* This is C++'s creepy "placement new", which is really just an
123 * ugly way to call a constructor for a pre-allocated object. So
124 * it's really not an error to not be checking for OUT_OF_MEMORY
125 * here, since this "new" isn't actually allocating memory. This
126 * is language-design comedy of the wrong kind. */
128 new (&message->doc) Xapian::Document;
130 talloc_set_destructor (message, _notmuch_message_destructor);
133 message->doc = notmuch->xapian_db->get_document (doc_id);
134 } catch (const Xapian::DocNotFoundError &error) {
135 talloc_free (message);
137 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
144 /* Create a new notmuch_message_t object for a specific message ID,
145 * (which may or may not already exist in the databas).
147 * Here, 'talloc owner' is an optional talloc context to which the new
148 * message will belong. This allows for the caller to not bother
149 * calling notmuch_message_destroy on the message, and no that all
150 * memory will be reclaimed with 'talloc_owner' is free. The caller
151 * still can call notmuch_message_destroy when finished with the
152 * message if desired.
154 * The 'talloc_owner' argument can also be NULL, in which case the
155 * caller *is* responsible for calling notmuch_message_destroy.
157 * If there is already a document with message ID 'message_id' in the
158 * database, then the returned message can be used to query/modify the
159 * document. Otherwise, a new document will be inserted into the
160 * database before this function returns, (and *status will be set
161 * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
163 * If an error occurs, this function will return NULL and *status
164 * will be set as appropriate. (The status pointer argument must
168 _notmuch_message_create_for_message_id (const void *talloc_owner,
169 notmuch_database_t *notmuch,
170 const char *message_id,
171 notmuch_private_status_t *status_ret)
173 notmuch_message_t *message;
174 Xapian::Document doc;
178 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
180 message = notmuch_database_find_message (notmuch, message_id);
182 return talloc_steal (talloc_owner, message);
184 term = talloc_asprintf (NULL, "%s%s",
185 _find_prefix ("id"), message_id);
187 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
195 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
197 doc_id = notmuch->xapian_db->add_document (doc);
198 } catch (const Xapian::Error &error) {
199 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
203 message = _notmuch_message_create (talloc_owner, notmuch,
206 /* We want to inform the caller that we had to create a new
208 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
209 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
215 notmuch_message_get_message_id (notmuch_message_t *message)
217 Xapian::TermIterator i;
219 if (message->message_id)
220 return message->message_id;
222 i = message->doc.termlist_begin ();
223 i.skip_to (_find_prefix ("id"));
225 if (i == message->doc.termlist_end ())
226 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
229 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
231 #if DEBUG_DATABASE_SANITY
234 if (i != message->doc.termlist_end () &&
235 strncmp ((*i).c_str (), _find_prefix ("id"),
236 strlen (_find_prefix ("id"))) == 0)
238 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
243 return message->message_id;
247 _notmuch_message_ensure_message_file (notmuch_message_t *message)
249 const char *filename;
251 if (message->message_file)
254 filename = notmuch_message_get_filename (message);
255 if (unlikely (filename == NULL))
258 message->message_file = _notmuch_message_file_open_ctx (message, filename);
262 notmuch_message_get_header (notmuch_message_t *message, const char *header)
264 _notmuch_message_ensure_message_file (message);
265 if (message->message_file == NULL)
268 return notmuch_message_file_get_header (message->message_file, header);
271 /* XXX: We probably want to store the In-Reply-To header in the
272 * database (separate from the References message IDs) so that we can
273 * fetch it out again without having to go load the message file. */
275 _notmuch_message_get_in_reply_to (notmuch_message_t *message)
277 return _parse_message_id (message,
278 notmuch_message_get_header (message,
284 notmuch_message_get_thread_id (notmuch_message_t *message)
286 Xapian::TermIterator i;
288 if (message->thread_id)
289 return message->thread_id;
291 i = message->doc.termlist_begin ();
292 i.skip_to (_find_prefix ("thread"));
294 if (i == message->doc.termlist_end ())
295 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
298 message->thread_id = talloc_strdup (message, (*i).c_str () + 1);
300 #if DEBUG_DATABASE_SANITY
303 if (i != message->doc.termlist_end () &&
304 strncmp ((*i).c_str (), _find_prefix ("thread"),
305 strlen (_find_prefix ("thread"))) == 0)
307 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
308 notmuch_message_get_message_id (message),
314 return message->thread_id;
318 _notmuch_message_add_reply (notmuch_message_t *message,
319 notmuch_message_node_t *reply)
321 _notmuch_message_list_append (message->replies, reply);
325 notmuch_message_get_replies (notmuch_message_t *message)
327 return _notmuch_messages_create (message->replies);
330 /* Set the filename for 'message' to 'filename'.
332 * XXX: We should still figure out if we think it's important to store
333 * multiple filenames for email messages with identical message IDs.
335 * This change will not be reflected in the database until the next
336 * call to _notmuch_message_set_sync. */
338 _notmuch_message_set_filename (notmuch_message_t *message,
339 const char *filename)
343 unsigned int db_path_len;
345 if (message->filename) {
346 talloc_free (message->filename);
347 message->filename = NULL;
350 if (filename == NULL)
351 INTERNAL_ERROR ("Message filename cannot be NULL.");
355 db_path = notmuch_database_get_path (message->notmuch);
356 db_path_len = strlen (db_path);
358 if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
359 && strlen (s) > db_path_len)
361 s += db_path_len + 1;
364 message->doc.set_data (s);
368 notmuch_message_get_filename (notmuch_message_t *message)
370 std::string filename_str;
373 if (message->filename)
374 return message->filename;
376 filename_str = message->doc.get_data ();
377 db_path = notmuch_database_get_path (message->notmuch);
379 if (filename_str[0] != '/')
380 message->filename = talloc_asprintf (message, "%s/%s", db_path,
381 filename_str.c_str ());
383 message->filename = talloc_strdup (message, filename_str.c_str ());
385 return message->filename;
389 notmuch_message_get_date (notmuch_message_t *message)
394 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
395 } catch (Xapian::Error &error) {
396 INTERNAL_ERROR ("Failed to read timestamp value from document.");
400 return Xapian::sortable_unserialise (value);
404 notmuch_message_get_tags (notmuch_message_t *message)
406 const char *prefix = _find_prefix ("tag");
407 Xapian::TermIterator i, end;
408 notmuch_tags_t *tags;
411 /* Currently this iteration is written with the assumption that
412 * "tag" has a single-character prefix. */
413 assert (strlen (prefix) == 1);
415 tags = _notmuch_tags_create (message);
416 if (unlikely (tags == NULL))
419 i = message->doc.termlist_begin ();
420 end = message->doc.termlist_end ();
427 if (tag.empty () || tag[0] != *prefix)
430 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
435 _notmuch_tags_prepare_iterator (tags);
441 _notmuch_message_set_date (notmuch_message_t *message,
446 /* GMime really doesn't want to see a NULL date, so protect its
451 time_value = g_mime_utils_header_decode_date (date, NULL);
453 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
454 Xapian::sortable_serialise (time_value));
458 thread_id_generate (thread_id_t *thread_id)
460 static int seeded = 0;
467 dev_random = fopen ("/dev/random", "r");
468 if (dev_random == NULL) {
471 fread ((void *) &value, sizeof (value), 1, dev_random);
479 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
481 sprintf (s, "%08x", value);
487 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
489 /* If not part of any existing thread, generate a new thread_id. */
490 thread_id_t thread_id;
492 thread_id_generate (&thread_id);
493 _notmuch_message_add_term (message, "thread", thread_id.str);
496 /* Synchronize changes made to message->doc out into the database. */
498 _notmuch_message_sync (notmuch_message_t *message)
500 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
502 db->replace_document (message->doc_id, message->doc);
505 /* Add a name:value term to 'message', (the actual term will be
506 * encoded by prefixing the value with a short prefix). See
507 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
508 * names to prefix values.
510 * This change will not be reflected in the database until the next
511 * call to _notmuch_message_set_sync. */
512 notmuch_private_status_t
513 _notmuch_message_add_term (notmuch_message_t *message,
514 const char *prefix_name,
521 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
523 term = talloc_asprintf (message, "%s%s",
524 _find_prefix (prefix_name), value);
526 if (strlen (term) > NOTMUCH_TERM_MAX)
527 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
529 message->doc.add_term (term);
533 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
536 /* Parse 'text' and add a term to 'message' for each parsed word. Each
537 * term will be added both prefixed (if prefix_name is not NULL) and
538 * also unprefixed). */
539 notmuch_private_status_t
540 _notmuch_message_gen_terms (notmuch_message_t *message,
541 const char *prefix_name,
544 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
547 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
549 term_gen->set_document (message->doc);
552 const char *prefix = _find_prefix (prefix_name);
554 term_gen->index_text (text, 1, prefix);
557 term_gen->index_text (text);
559 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
562 /* Remove a name:value term from 'message', (the actual term will be
563 * encoded by prefixing the value with a short prefix). See
564 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
565 * names to prefix values.
567 * This change will not be reflected in the database until the next
568 * call to _notmuch_message_set_sync. */
569 notmuch_private_status_t
570 _notmuch_message_remove_term (notmuch_message_t *message,
571 const char *prefix_name,
577 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
579 term = talloc_asprintf (message, "%s%s",
580 _find_prefix (prefix_name), value);
582 if (strlen (term) > NOTMUCH_TERM_MAX)
583 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
586 message->doc.remove_term (term);
587 } catch (const Xapian::InvalidArgumentError) {
588 /* We'll let the philosopher's try to wrestle with the
589 * question of whether failing to remove that which was not
590 * there in the first place is failure. For us, we'll silently
591 * consider it all good. */
596 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
600 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
602 notmuch_private_status_t status;
605 return NOTMUCH_STATUS_NULL_POINTER;
607 if (strlen (tag) > NOTMUCH_TAG_MAX)
608 return NOTMUCH_STATUS_TAG_TOO_LONG;
610 status = _notmuch_message_add_term (message, "tag", tag);
612 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
616 if (! message->frozen)
617 _notmuch_message_sync (message);
619 return NOTMUCH_STATUS_SUCCESS;
623 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
625 notmuch_private_status_t status;
628 return NOTMUCH_STATUS_NULL_POINTER;
630 if (strlen (tag) > NOTMUCH_TAG_MAX)
631 return NOTMUCH_STATUS_TAG_TOO_LONG;
633 status = _notmuch_message_remove_term (message, "tag", tag);
635 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
639 if (! message->frozen)
640 _notmuch_message_sync (message);
642 return NOTMUCH_STATUS_SUCCESS;
646 notmuch_message_remove_all_tags (notmuch_message_t *message)
648 notmuch_private_status_t status;
649 notmuch_tags_t *tags;
652 for (tags = notmuch_message_get_tags (message);
653 notmuch_tags_has_more (tags);
654 notmuch_tags_advance (tags))
656 tag = notmuch_tags_get (tags);
658 status = _notmuch_message_remove_term (message, "tag", tag);
660 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
665 if (! message->frozen)
666 _notmuch_message_sync (message);
670 notmuch_message_freeze (notmuch_message_t *message)
676 notmuch_message_thaw (notmuch_message_t *message)
678 if (message->frozen > 0) {
680 if (message->frozen == 0)
681 _notmuch_message_sync (message);
682 return NOTMUCH_STATUS_SUCCESS;
684 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
689 notmuch_message_destroy (notmuch_message_t *message)
691 talloc_free (message);