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;
39 /* "128 bits of thread-id ought to be enough for anybody" */
40 #define NOTMUCH_THREAD_ID_BITS 128
41 #define NOTMUCH_THREAD_ID_DIGITS (NOTMUCH_THREAD_ID_BITS / 4)
42 typedef struct _thread_id {
43 char str[NOTMUCH_THREAD_ID_DIGITS + 1];
46 /* We end up having to call the destructor explicitly because we had
47 * to use "placement new" in order to initialize C++ objects within a
48 * block that we allocated with talloc. So C++ is making talloc
49 * slightly less simple to use, (we wouldn't need
50 * talloc_set_destructor at all otherwise).
53 _notmuch_message_destructor (notmuch_message_t *message)
55 message->doc.~Document ();
60 /* Create a new notmuch_message_t object for an existing document in
63 * Here, 'talloc owner' is an optional talloc context to which the new
64 * message will belong. This allows for the caller to not bother
65 * calling notmuch_message_destroy on the message, and no that all
66 * memory will be reclaimed with 'talloc_owner' is free. The caller
67 * still can call notmuch_message_destroy when finished with the
70 * The 'talloc_owner' argument can also be NULL, in which case the
71 * caller *is* responsible for calling notmuch_message_destroy.
73 * If no document exists in the database with document ID of 'doc_id'
74 * then this function returns NULL and optionally sets *status to
75 * NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND.
77 * This function can also fail to due lack of available memory,
78 * returning NULL and optionally setting *status to
79 * NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY.
81 * The caller can pass NULL for status if uninterested in
82 * distinguishing these two cases.
85 _notmuch_message_create (const void *talloc_owner,
86 notmuch_database_t *notmuch,
88 notmuch_private_status_t *status)
90 notmuch_message_t *message;
93 *status = NOTMUCH_PRIVATE_STATUS_SUCCESS;
95 message = talloc (talloc_owner, notmuch_message_t);
96 if (unlikely (message == NULL)) {
98 *status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
102 message->notmuch = notmuch;
103 message->doc_id = doc_id;
107 /* Each of these will be lazily created as needed. */
108 message->message_id = NULL;
109 message->thread_id = NULL;
110 message->filename = NULL;
111 message->message_file = NULL;
113 /* This is C++'s creepy "placement new", which is really just an
114 * ugly way to call a constructor for a pre-allocated object. So
115 * it's really not an error to not be checking for OUT_OF_MEMORY
116 * here, since this "new" isn't actually allocating memory. This
117 * is language-design comedy of the wrong kind. */
119 new (&message->doc) Xapian::Document;
121 talloc_set_destructor (message, _notmuch_message_destructor);
124 message->doc = notmuch->xapian_db->get_document (doc_id);
125 } catch (const Xapian::DocNotFoundError &error) {
126 talloc_free (message);
128 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
135 /* Create a new notmuch_message_t object for a specific message ID,
136 * (which may or may not already exist in the databas).
138 * Here, 'talloc owner' is an optional talloc context to which the new
139 * message will belong. This allows for the caller to not bother
140 * calling notmuch_message_destroy on the message, and no that all
141 * memory will be reclaimed with 'talloc_owner' is free. The caller
142 * still can call notmuch_message_destroy when finished with the
143 * message if desired.
145 * The 'talloc_owner' argument can also be NULL, in which case the
146 * caller *is* responsible for calling notmuch_message_destroy.
148 * If there is already a document with message ID 'message_id' in the
149 * database, then the returned message can be used to query/modify the
150 * document. Otherwise, a new document will be inserted into the
151 * database before this function returns, (and *status will be set
152 * to NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND).
154 * If an error occurs, this function will return NULL and *status
155 * will be set as appropriate. (The status pointer argument must
159 _notmuch_message_create_for_message_id (const void *talloc_owner,
160 notmuch_database_t *notmuch,
161 const char *message_id,
162 notmuch_private_status_t *status_ret)
164 notmuch_message_t *message;
165 Xapian::Document doc;
169 *status_ret = NOTMUCH_PRIVATE_STATUS_SUCCESS;
171 message = notmuch_database_find_message (notmuch, message_id);
173 return talloc_steal (talloc_owner, message);
175 term = talloc_asprintf (NULL, "%s%s",
176 _find_prefix ("id"), message_id);
178 *status_ret = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
186 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
188 doc_id = notmuch->xapian_db->add_document (doc);
189 } catch (const Xapian::Error &error) {
190 *status_ret = NOTMUCH_PRIVATE_STATUS_XAPIAN_EXCEPTION;
194 message = _notmuch_message_create (talloc_owner, notmuch,
197 /* We want to inform the caller that we had to create a new
199 if (*status_ret == NOTMUCH_PRIVATE_STATUS_SUCCESS)
200 *status_ret = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
206 notmuch_message_get_message_id (notmuch_message_t *message)
208 Xapian::TermIterator i;
210 if (message->message_id)
211 return message->message_id;
213 i = message->doc.termlist_begin ();
214 i.skip_to (_find_prefix ("id"));
216 if (i == message->doc.termlist_end ())
217 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
220 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
222 #if DEBUG_DATABASE_SANITY
225 if (i != message->doc.termlist_end () &&
226 strncmp ((*i).c_str (), _find_prefix ("id"),
227 strlen (_find_prefix ("id"))) == 0)
229 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
234 return message->message_id;
238 _notmuch_message_ensure_message_file (notmuch_message_t *message)
240 const char *filename;
242 if (message->message_file)
245 filename = notmuch_message_get_filename (message);
246 if (unlikely (filename == NULL))
249 message->message_file = _notmuch_message_file_open_ctx (message, filename);
253 notmuch_message_get_header (notmuch_message_t *message, const char *header)
255 _notmuch_message_ensure_message_file (message);
256 if (message->message_file == NULL)
259 return notmuch_message_file_get_header (message->message_file, header);
263 notmuch_message_get_thread_id (notmuch_message_t *message)
265 Xapian::TermIterator i;
267 if (message->thread_id)
268 return message->thread_id;
270 i = message->doc.termlist_begin ();
271 i.skip_to (_find_prefix ("thread"));
273 if (i == message->doc.termlist_end ())
274 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
277 message->thread_id = talloc_strdup (message, (*i).c_str () + 1);
279 #if DEBUG_DATABASE_SANITY
282 if (i != message->doc.termlist_end () &&
283 strncmp ((*i).c_str (), _find_prefix ("thread"),
284 strlen (_find_prefix ("thread"))) == 0)
286 INTERNAL_ERROR ("Message %s has duplicate thread IDs: %s and %s\n",
287 notmuch_message_get_message_id (message),
293 return message->thread_id;
296 /* Set the filename for 'message' to 'filename'.
298 * XXX: We should still figure out if we think it's important to store
299 * multiple filenames for email messages with identical message IDs.
301 * This change will not be reflected in the database until the next
302 * call to _notmuch_message_set_sync. */
304 _notmuch_message_set_filename (notmuch_message_t *message,
305 const char *filename)
309 unsigned int db_path_len;
311 if (message->filename) {
312 talloc_free (message->filename);
313 message->filename = NULL;
316 if (filename == NULL)
317 INTERNAL_ERROR ("Message filename cannot be NULL.");
321 db_path = notmuch_database_get_path (message->notmuch);
322 db_path_len = strlen (db_path);
324 if (*s == '/' && strncmp (s, db_path, db_path_len) == 0
325 && strlen (s) > db_path_len)
327 s += db_path_len + 1;
330 message->doc.set_data (s);
334 notmuch_message_get_filename (notmuch_message_t *message)
336 std::string filename_str;
339 if (message->filename)
340 return message->filename;
342 filename_str = message->doc.get_data ();
343 db_path = notmuch_database_get_path (message->notmuch);
345 if (filename_str[0] != '/')
346 message->filename = talloc_asprintf (message, "%s/%s", db_path,
347 filename_str.c_str ());
349 message->filename = talloc_strdup (message, filename_str.c_str ());
351 return message->filename;
355 notmuch_message_get_date (notmuch_message_t *message)
360 value = message->doc.get_value (NOTMUCH_VALUE_TIMESTAMP);
361 } catch (Xapian::Error &error) {
362 INTERNAL_ERROR ("Failed to read timestamp value from document.");
366 return Xapian::sortable_unserialise (value);
370 notmuch_message_get_tags (notmuch_message_t *message)
372 const char *prefix = _find_prefix ("tag");
373 Xapian::TermIterator i, end;
374 notmuch_tags_t *tags;
377 /* Currently this iteration is written with the assumption that
378 * "tag" has a single-character prefix. */
379 assert (strlen (prefix) == 1);
381 tags = _notmuch_tags_create (message);
382 if (unlikely (tags == NULL))
385 i = message->doc.termlist_begin ();
386 end = message->doc.termlist_end ();
393 if (tag.empty () || tag[0] != *prefix)
396 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
401 _notmuch_tags_prepare_iterator (tags);
407 _notmuch_message_set_date (notmuch_message_t *message,
412 /* GMime really doesn't want to see a NULL date, so protect its
417 time_value = g_mime_utils_header_decode_date (date, NULL);
419 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
420 Xapian::sortable_serialise (time_value));
424 thread_id_generate (thread_id_t *thread_id)
426 static int seeded = 0;
433 dev_random = fopen ("/dev/random", "r");
434 if (dev_random == NULL) {
437 fread ((void *) &value, sizeof (value), 1, dev_random);
445 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
447 sprintf (s, "%08x", value);
453 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
455 /* If not part of any existing thread, generate a new thread_id. */
456 thread_id_t thread_id;
458 thread_id_generate (&thread_id);
459 _notmuch_message_add_term (message, "thread", thread_id.str);
462 /* Synchronize changes made to message->doc out into the database. */
464 _notmuch_message_sync (notmuch_message_t *message)
466 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
468 db->replace_document (message->doc_id, message->doc);
471 /* Add a name:value term to 'message', (the actual term will be
472 * encoded by prefixing the value with a short prefix). See
473 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
474 * names to prefix values.
476 * This change will not be reflected in the database until the next
477 * call to _notmuch_message_set_sync. */
478 notmuch_private_status_t
479 _notmuch_message_add_term (notmuch_message_t *message,
480 const char *prefix_name,
487 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
489 term = talloc_asprintf (message, "%s%s",
490 _find_prefix (prefix_name), value);
492 if (strlen (term) > NOTMUCH_TERM_MAX)
493 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
495 message->doc.add_term (term);
499 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
502 /* Parse 'text' and add a term to 'message' for each parsed word. Each
503 * term will be added both prefixed (if prefix_name is not NULL) and
504 * also unprefixed). */
505 notmuch_private_status_t
506 _notmuch_message_gen_terms (notmuch_message_t *message,
507 const char *prefix_name,
510 Xapian::TermGenerator *term_gen = message->notmuch->term_gen;
513 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
515 term_gen->set_document (message->doc);
518 const char *prefix = _find_prefix (prefix_name);
520 term_gen->index_text (text, 1, prefix);
523 term_gen->index_text (text);
525 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
528 /* Remove a name:value term from 'message', (the actual term will be
529 * encoded by prefixing the value with a short prefix). See
530 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
531 * names to prefix values.
533 * This change will not be reflected in the database until the next
534 * call to _notmuch_message_set_sync. */
535 notmuch_private_status_t
536 _notmuch_message_remove_term (notmuch_message_t *message,
537 const char *prefix_name,
543 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
545 term = talloc_asprintf (message, "%s%s",
546 _find_prefix (prefix_name), value);
548 if (strlen (term) > NOTMUCH_TERM_MAX)
549 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
552 message->doc.remove_term (term);
553 } catch (const Xapian::InvalidArgumentError) {
554 /* We'll let the philosopher's try to wrestle with the
555 * question of whether failing to remove that which was not
556 * there in the first place is failure. For us, we'll silently
557 * consider it all good. */
562 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
566 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
568 notmuch_private_status_t status;
571 return NOTMUCH_STATUS_NULL_POINTER;
573 if (strlen (tag) > NOTMUCH_TAG_MAX)
574 return NOTMUCH_STATUS_TAG_TOO_LONG;
576 status = _notmuch_message_add_term (message, "tag", tag);
578 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
582 if (! message->frozen)
583 _notmuch_message_sync (message);
585 return NOTMUCH_STATUS_SUCCESS;
589 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
591 notmuch_private_status_t status;
594 return NOTMUCH_STATUS_NULL_POINTER;
596 if (strlen (tag) > NOTMUCH_TAG_MAX)
597 return NOTMUCH_STATUS_TAG_TOO_LONG;
599 status = _notmuch_message_remove_term (message, "tag", tag);
601 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
605 if (! message->frozen)
606 _notmuch_message_sync (message);
608 return NOTMUCH_STATUS_SUCCESS;
612 notmuch_message_remove_all_tags (notmuch_message_t *message)
614 notmuch_private_status_t status;
615 notmuch_tags_t *tags;
618 for (tags = notmuch_message_get_tags (message);
619 notmuch_tags_has_more (tags);
620 notmuch_tags_advance (tags))
622 tag = notmuch_tags_get (tags);
624 status = _notmuch_message_remove_term (message, "tag", tag);
626 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
631 if (! message->frozen)
632 _notmuch_message_sync (message);
636 notmuch_message_freeze (notmuch_message_t *message)
642 notmuch_message_thaw (notmuch_message_t *message)
644 if (message->frozen > 0) {
646 if (message->frozen == 0)
647 _notmuch_message_sync (message);
648 return NOTMUCH_STATUS_SUCCESS;
650 return NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW;
655 notmuch_message_destroy (notmuch_message_t *message)
657 talloc_free (message);