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;
32 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;
103 /* Each of these will be lazily created as needed. */
104 message->message_id = NULL;
105 message->thread_id = NULL;
106 message->filename = NULL;
107 message->message_file = NULL;
109 /* This is C++'s creepy "placement new", which is really just an
110 * ugly way to call a constructor for a pre-allocated object. So
111 * it's really not an error to not be checking for OUT_OF_MEMORY
112 * here, since this "new" isn't actually allocating memory. This
113 * is language-design comedy of the wrong kind. */
115 new (&message->doc) Xapian::Document;
117 talloc_set_destructor (message, _notmuch_message_destructor);
120 message->doc = notmuch->xapian_db->get_document (doc_id);
121 } catch (const Xapian::DocNotFoundError &error) {
122 talloc_free (message);
124 *status = NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
131 /* Create a new notmuch_message_t object for a specific message ID,
132 * (which may or may not already exist in the databas).
134 * Here, 'talloc owner' is an optional talloc context to which the new
135 * message will belong. This allows for the caller to not bother
136 * calling notmuch_message_destroy on the message, and no that all
137 * memory will be reclaimed with 'talloc_owner' is free. The caller
138 * still can call notmuch_message_destroy when finished with the
139 * message if desired.
141 * The 'talloc_owner' argument can also be NULL, in which case the
142 * caller *is* responsible for calling notmuch_message_destroy.
144 * If there is already a document with message ID 'message_id' in the
145 * database, then the returned message can be used to query/modify the
146 * document. Otherwise, a new document will be inserted into the
147 * database before this function returns.
149 * If an error occurs, this function will return NULL and *status
150 * will be set as appropriate. (The status pointer argument must
154 _notmuch_message_create_for_message_id (const void *talloc_owner,
155 notmuch_database_t *notmuch,
156 const char *message_id,
157 notmuch_status_t *status)
159 notmuch_private_status_t private_status;
160 notmuch_message_t *message;
161 Xapian::Document doc;
165 *status = NOTMUCH_STATUS_SUCCESS;
167 message = notmuch_database_find_message (notmuch, message_id);
169 return talloc_steal (talloc_owner, message);
171 term = talloc_asprintf (NULL, "%s%s",
172 _find_prefix ("id"), message_id);
174 *status = NOTMUCH_STATUS_OUT_OF_MEMORY;
182 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
184 doc_id = notmuch->xapian_db->add_document (doc);
185 } catch (const Xapian::Error &error) {
186 *status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
190 message = _notmuch_message_create (talloc_owner, notmuch,
191 doc_id, &private_status);
193 *status = COERCE_STATUS (private_status,
194 "Failed to find dcocument after inserting it.");
200 notmuch_message_get_message_id (notmuch_message_t *message)
202 Xapian::TermIterator i;
204 if (message->message_id)
205 return message->message_id;
207 i = message->doc.termlist_begin ();
208 i.skip_to (_find_prefix ("id"));
210 if (i == message->doc.termlist_end ())
211 INTERNAL_ERROR ("Message with document ID of %d has no message ID.\n",
214 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
216 #if DEBUG_DATABASE_SANITY
219 if (i != message->doc.termlist_end () &&
220 strncmp ((*i).c_str (), _find_prefix ("id"),
221 strlen (_find_prefix ("id"))) == 0)
223 INTERNAL_ERROR ("Mail (doc_id: %d) has duplicate message IDs",
228 return message->message_id;
232 _notmuch_message_get_subject (notmuch_message_t *message)
234 if (! message->message_file) {
235 notmuch_message_file_t *message_file;
236 const char *filename;
238 filename = notmuch_message_get_filename (message);
239 if (unlikely (filename == NULL))
242 message_file = _notmuch_message_file_open_ctx (message, filename);
243 if (unlikely (message_file == NULL))
246 message->message_file = message_file;
249 return notmuch_message_file_get_header (message->message_file,
254 notmuch_message_get_thread_id (notmuch_message_t *message)
256 Xapian::TermIterator i;
258 if (message->thread_id)
259 return message->thread_id;
261 i = message->doc.termlist_begin ();
262 i.skip_to (_find_prefix ("thread"));
264 if (i == message->doc.termlist_end ())
265 INTERNAL_ERROR ("Message with document ID of %d has no thread ID.\n",
268 message->thread_id = talloc_strdup (message, (*i).c_str () + 1);
270 #if DEBUG_DATABASE_SANITY
273 if (i != message->doc.termlist_end () &&
274 strncmp ((*i).c_str (), _find_prefix ("thread"),
275 strlen (_find_prefix ("thread"))) == 0)
277 INTERNAL_ERROR ("Message with document ID of %d has duplicate thread IDs.\n",
282 return message->thread_id;
285 /* Set the filename for 'message' to 'filename'.
287 * XXX: We should still figure out if we think it's important to store
288 * multiple filenames for email messages with identical message IDs.
290 * This change will not be reflected in the database until the next
291 * call to _notmuch_message_set_sync. */
293 _notmuch_message_set_filename (notmuch_message_t *message,
294 const char *filename)
296 if (message->filename)
297 talloc_free (message->filename);
298 message->doc.set_data (filename);
302 notmuch_message_get_filename (notmuch_message_t *message)
304 std::string filename_str;
306 if (message->filename)
307 return message->filename;
309 filename_str = message->doc.get_data ();
310 message->filename = talloc_strdup (message, filename_str.c_str ());
312 return message->filename;
316 notmuch_message_get_tags (notmuch_message_t *message)
318 const char *prefix = _find_prefix ("tag");
319 Xapian::TermIterator i, end;
320 notmuch_tags_t *tags;
323 /* Currently this iteration is written with the assumption that
324 * "tag" has a single-character prefix. */
325 assert (strlen (prefix) == 1);
327 tags = _notmuch_tags_create (message);
328 if (unlikely (tags == NULL))
331 i = message->doc.termlist_begin ();
332 end = message->doc.termlist_end ();
339 if (tag.empty () || tag[0] != *prefix)
342 _notmuch_tags_add_tag (tags, tag.c_str () + 1);
347 _notmuch_tags_prepare_iterator (tags);
353 _notmuch_message_set_date (notmuch_message_t *message,
358 time_value = notmuch_parse_date (date, NULL);
360 message->doc.add_value (NOTMUCH_VALUE_TIMESTAMP,
361 Xapian::sortable_serialise (time_value));
365 thread_id_generate (thread_id_t *thread_id)
367 static int seeded = 0;
374 dev_random = fopen ("/dev/random", "r");
375 if (dev_random == NULL) {
378 fread ((void *) &value, sizeof (value), 1, dev_random);
386 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
388 sprintf (s, "%08x", value);
394 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
396 /* If not part of any existing thread, generate a new thread_id. */
397 thread_id_t thread_id;
399 thread_id_generate (&thread_id);
400 _notmuch_message_add_term (message, "thread", thread_id.str);
403 /* Synchronize changes made to message->doc out into the database. */
405 _notmuch_message_sync (notmuch_message_t *message)
407 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
409 db->replace_document (message->doc_id, message->doc);
412 /* Add a name:value term to 'message', (the actual term will be
413 * encoded by prefixing the value with a short prefix). See
414 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
415 * names to prefix values.
417 * This change will not be reflected in the database until the next
418 * call to _notmuch_message_set_sync. */
419 notmuch_private_status_t
420 _notmuch_message_add_term (notmuch_message_t *message,
421 const char *prefix_name,
428 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
430 term = talloc_asprintf (message, "%s%s",
431 _find_prefix (prefix_name), value);
433 if (strlen (term) > NOTMUCH_TERM_MAX)
434 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
436 message->doc.add_term (term);
440 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
443 /* Remove a name:value term from 'message', (the actual term will be
444 * encoded by prefixing the value with a short prefix). See
445 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
446 * names to prefix values.
448 * This change will not be reflected in the database until the next
449 * call to _notmuch_message_set_sync. */
450 notmuch_private_status_t
451 _notmuch_message_remove_term (notmuch_message_t *message,
452 const char *prefix_name,
458 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
460 term = talloc_asprintf (message, "%s%s",
461 _find_prefix (prefix_name), value);
463 if (strlen (term) > NOTMUCH_TERM_MAX)
464 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
466 message->doc.remove_term (term);
470 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
474 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
476 notmuch_private_status_t status;
479 return NOTMUCH_STATUS_NULL_POINTER;
481 if (strlen (tag) > NOTMUCH_TAG_MAX)
482 return NOTMUCH_STATUS_TAG_TOO_LONG;
484 status = _notmuch_message_add_term (message, "tag", tag);
486 INTERNAL_ERROR ("_notmuch_message_add_term return unexpected value: %d\n",
490 _notmuch_message_sync (message);
492 return NOTMUCH_STATUS_SUCCESS;
496 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
498 notmuch_private_status_t status;
501 return NOTMUCH_STATUS_NULL_POINTER;
503 if (strlen (tag) > NOTMUCH_TAG_MAX)
504 return NOTMUCH_STATUS_TAG_TOO_LONG;
506 status = _notmuch_message_remove_term (message, "tag", tag);
508 INTERNAL_ERROR ("_notmuch_message_remove_term return unexpected value: %d\n",
512 _notmuch_message_sync (message);
514 return NOTMUCH_STATUS_SUCCESS;
518 notmuch_message_destroy (notmuch_message_t *message)
520 talloc_free (message);