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;
34 struct _notmuch_tags {
35 Xapian::TermIterator iterator;
36 Xapian::TermIterator iterator_end;
39 struct _notmuch_thread_ids {
44 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
46 /* These prefix values are specifically chosen to be compatible
47 * with sup, (http://sup.rubyforge.org), written by
48 * William Morgan <wmorgan-sup@masanjin.net>, and released
49 * under the GNU GPL v2.
57 prefix_t NORMAL_PREFIX[] = {
60 { "from_name", "FN" },
66 prefix_t BOOLEAN_PREFIX[] = {
68 { "from_email", "FE" },
75 { "attachment_extension", "O" },
82 _find_prefix (const char *name)
86 for (i = 0; i < ARRAY_SIZE (NORMAL_PREFIX); i++)
87 if (strcmp (name, NORMAL_PREFIX[i].name) == 0)
88 return NORMAL_PREFIX[i].prefix;
90 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX); i++)
91 if (strcmp (name, BOOLEAN_PREFIX[i].name) == 0)
92 return BOOLEAN_PREFIX[i].prefix;
97 /* We end up having to call the destructor explicitly because we had
98 * to use "placement new" in order to initialize C++ objects within a
99 * block that we allocated with talloc. So C++ is making talloc
100 * slightly less simple to use, (we wouldn't need
101 * talloc_set_destructor at all otherwise).
104 _notmuch_message_destructor (notmuch_message_t *message)
106 message->doc.~Document ();
111 /* Create a new notmuch_message_t object for an existing document in
114 * Here, 'talloc owner' is an optional talloc context to which the new
115 * message will belong. This allows for the caller to not bother
116 * calling notmuch_message_destroy on the message, and no that all
117 * memory will be reclaimed with 'talloc_owner' is free. The caller
118 * still can call notmuch_message_destroy when finished with the
119 * message if desired.
121 * The 'talloc_owner' argument can also be NULL, in which case the
122 * caller *is* responsible for calling notmuch_message_destroy.
124 * If no document exists in the database with document ID of 'doc_id'
125 * then this function returns NULL.
128 _notmuch_message_create (const void *talloc_owner,
129 notmuch_database_t *notmuch,
132 notmuch_message_t *message;
134 message = talloc (talloc_owner, notmuch_message_t);
135 if (unlikely (message == NULL))
138 message->notmuch = notmuch;
139 message->doc_id = doc_id;
140 message->message_id = NULL; /* lazily created */
141 message->filename = NULL; /* lazily created */
142 new (&message->doc) Xapian::Document;
144 talloc_set_destructor (message, _notmuch_message_destructor);
147 message->doc = notmuch->xapian_db->get_document (doc_id);
148 } catch (const Xapian::DocNotFoundError &error) {
149 talloc_free (message);
157 notmuch_message_get_message_id (notmuch_message_t *message)
159 Xapian::TermIterator i;
161 if (message->message_id)
162 return message->message_id;
164 i = message->doc.termlist_begin ();
165 i.skip_to (_find_prefix ("msgid"));
167 /* XXX: This should really be an internal error, but we'll need to
168 * fix the add_message side of things first. */
169 if (i == message->doc.termlist_end ())
172 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
173 return message->message_id;
176 /* Set the filename for 'message' to 'filename'.
178 * XXX: We should still figure out what we want to do for multiple
179 * files with identical message IDs. We will probably want to store a
180 * list of filenames here, (so that this will be "add_filename"
181 * instead of "set_filename"). Which would make this very similar to
184 * This change will not be reflected in the database until the next
185 * call to _notmuch_message_set_sync. */
187 _notmuch_message_set_filename (notmuch_message_t *message,
188 const char *filename)
190 if (message->filename)
191 talloc_free (message->filename);
192 message->doc.set_data (filename);
196 notmuch_message_get_filename (notmuch_message_t *message)
198 std::string filename_str;
200 if (message->filename)
201 return message->filename;
203 filename_str = message->doc.get_data ();
204 message->filename = talloc_strdup (message, filename_str.c_str ());
206 return message->filename;
209 /* We end up having to call the destructors explicitly because we had
210 * to use "placement new" in order to initialize C++ objects within a
211 * block that we allocated with talloc. So C++ is making talloc
212 * slightly less simple to use, (we wouldn't need
213 * talloc_set_destructor at all otherwise).
216 _notmuch_tags_destructor (notmuch_tags_t *tags)
218 tags->iterator.~TermIterator ();
219 tags->iterator_end.~TermIterator ();
225 notmuch_message_get_tags (notmuch_message_t *message)
227 notmuch_tags_t *tags;
229 tags = talloc (message, notmuch_tags_t);
230 if (unlikely (tags == NULL))
233 new (&tags->iterator) Xapian::TermIterator;
234 new (&tags->iterator_end) Xapian::TermIterator;
236 talloc_set_destructor (tags, _notmuch_tags_destructor);
238 tags->iterator = message->doc.termlist_begin ();
239 tags->iterator.skip_to (_find_prefix ("tag"));
240 tags->iterator_end = message->doc.termlist_end ();
245 notmuch_thread_ids_t *
246 notmuch_message_get_thread_ids (notmuch_message_t *message)
248 notmuch_thread_ids_t *thread_ids;
251 thread_ids = talloc (message, notmuch_thread_ids_t);
252 if (unlikely (thread_ids == NULL))
255 id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
256 thread_ids->next = talloc_strdup (message, id_str.c_str ());
258 /* Initialize thread_ids->current and terminate first ID. */
259 notmuch_thread_ids_advance (thread_ids);
265 _notmuch_message_set_date (notmuch_message_t *message,
270 time_value = notmuch_parse_date (date, NULL);
272 message->doc.add_value (NOTMUCH_VALUE_DATE,
273 Xapian::sortable_serialise (time_value));
277 _notmuch_message_add_thread_id (notmuch_message_t *message,
278 const char *thread_id)
282 _notmuch_message_add_term (message, "thread", thread_id);
284 id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
286 if (id_str.empty ()) {
287 message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
291 /* Think about using a hash here if there's any performance
293 pos = id_str.find (thread_id);
294 if (pos == std::string::npos) {
296 id_str.append (thread_id);
297 message->doc.add_value (NOTMUCH_VALUE_THREAD, id_str);
303 thread_id_generate (thread_id_t *thread_id)
305 static int seeded = 0;
312 dev_random = fopen ("/dev/random", "r");
313 if (dev_random == NULL) {
316 fread ((void *) &value, sizeof (value), 1, dev_random);
324 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
326 sprintf (s, "%08x", value);
332 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
334 /* If not part of any existing thread, generate a new thread_id. */
335 thread_id_t thread_id;
337 thread_id_generate (&thread_id);
338 _notmuch_message_add_term (message, "thread", thread_id.str);
339 message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str);
342 /* Synchronize changes made to message->doc out into the database. */
344 _notmuch_message_sync (notmuch_message_t *message)
346 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
348 db->replace_document (message->doc_id, message->doc);
351 /* Add a name:value term to 'message', (the actual term will be
352 * encoded by prefixing the value with a short prefix). See
353 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
354 * names to prefix values.
356 * This change will not be reflected in the database until the next
357 * call to _notmuch_message_set_sync. */
358 notmuch_private_status_t
359 _notmuch_message_add_term (notmuch_message_t *message,
360 const char *prefix_name,
367 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
369 term = talloc_asprintf (message, "%s%s",
370 _find_prefix (prefix_name), value);
372 if (strlen (term) > NOTMUCH_TERM_MAX)
373 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
375 message->doc.add_term (term);
379 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
382 /* Remove a name:value term from 'message', (the actual term will be
383 * encoded by prefixing the value with a short prefix). See
384 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
385 * names to prefix values.
387 * This change will not be reflected in the database until the next
388 * call to _notmuch_message_set_sync. */
389 notmuch_private_status_t
390 _notmuch_message_remove_term (notmuch_message_t *message,
391 const char *prefix_name,
397 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
399 term = talloc_asprintf (message, "%s%s",
400 _find_prefix (prefix_name), value);
402 if (strlen (term) > NOTMUCH_TERM_MAX)
403 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
405 message->doc.remove_term (term);
409 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
413 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
415 notmuch_private_status_t status;
418 return NOTMUCH_STATUS_NULL_POINTER;
420 if (strlen (tag) > NOTMUCH_TAG_MAX)
421 return NOTMUCH_STATUS_TAG_TOO_LONG;
423 status = _notmuch_message_add_term (message, "tag", tag);
425 fprintf (stderr, "Internal error: _notmuch_message_add_term return unexpected value: %d\n",
430 _notmuch_message_sync (message);
432 return NOTMUCH_STATUS_SUCCESS;
436 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
438 notmuch_private_status_t status;
441 return NOTMUCH_STATUS_NULL_POINTER;
443 if (strlen (tag) > NOTMUCH_TAG_MAX)
444 return NOTMUCH_STATUS_TAG_TOO_LONG;
446 status = _notmuch_message_remove_term (message, "tag", tag);
448 fprintf (stderr, "Internal error: _notmuch_message_remove_term return unexpected value: %d\n",
453 _notmuch_message_sync (message);
455 return NOTMUCH_STATUS_SUCCESS;
459 notmuch_message_destroy (notmuch_message_t *message)
461 talloc_free (message);
465 notmuch_tags_has_more (notmuch_tags_t *tags)
469 if (tags->iterator == tags->iterator_end)
473 if (s.size () && s[0] == 'L')
480 notmuch_tags_get (notmuch_tags_t *tags)
482 return talloc_strdup (tags, (*tags->iterator).c_str () + 1);
486 notmuch_tags_advance (notmuch_tags_t *tags)
492 notmuch_tags_destroy (notmuch_tags_t *tags)
498 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids)
500 if (thread_ids->current == NULL || *thread_ids->current == '\0')
507 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids)
509 return thread_ids->current;
513 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids)
515 thread_ids->current = strsep (&thread_ids->next, ",");
519 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids)
521 talloc_free (thread_ids);