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);
156 /* Create a new notmuch_message_t object for a specific message ID,
157 * (which may or may not already exist in the databas).
159 * Here, 'talloc owner' is an optional talloc context to which the new
160 * message will belong. This allows for the caller to not bother
161 * calling notmuch_message_destroy on the message, and no that all
162 * memory will be reclaimed with 'talloc_owner' is free. The caller
163 * still can call notmuch_message_destroy when finished with the
164 * message if desired.
166 * The 'talloc_owner' argument can also be NULL, in which case the
167 * caller *is* responsible for calling notmuch_message_destroy.
169 * If there is already a document with message ID 'message_id' in the
170 * database, then the returned message can be used to query/modify the
171 * document. Otherwise, a new document will be inserted into the
172 * database before this function returns;
175 _notmuch_message_create_for_message_id (const void *talloc_owner,
176 notmuch_database_t *notmuch,
177 const char *message_id)
179 notmuch_message_t *message;
180 Xapian::Document doc;
184 message = notmuch_database_find_message (notmuch, message_id);
186 return talloc_steal (talloc_owner, message);
188 term = talloc_asprintf (NULL, "%s%s",
189 _find_prefix ("msgid"), message_id);
193 doc.add_value (NOTMUCH_VALUE_MESSAGE_ID, message_id);
195 doc_id = notmuch->xapian_db->add_document (doc);
197 return _notmuch_message_create (talloc_owner, notmuch, doc_id);
201 notmuch_message_get_message_id (notmuch_message_t *message)
203 Xapian::TermIterator i;
205 if (message->message_id)
206 return message->message_id;
208 i = message->doc.termlist_begin ();
209 i.skip_to (_find_prefix ("msgid"));
211 /* XXX: This should really be an internal error, but we'll need to
212 * fix the add_message side of things first. */
213 if (i == message->doc.termlist_end ())
216 message->message_id = talloc_strdup (message, (*i).c_str () + 1);
217 return message->message_id;
220 /* Set the filename for 'message' to 'filename'.
222 * XXX: We should still figure out what we want to do for multiple
223 * files with identical message IDs. We will probably want to store a
224 * list of filenames here, (so that this will be "add_filename"
225 * instead of "set_filename"). Which would make this very similar to
228 * This change will not be reflected in the database until the next
229 * call to _notmuch_message_set_sync. */
231 _notmuch_message_set_filename (notmuch_message_t *message,
232 const char *filename)
234 if (message->filename)
235 talloc_free (message->filename);
236 message->doc.set_data (filename);
240 notmuch_message_get_filename (notmuch_message_t *message)
242 std::string filename_str;
244 if (message->filename)
245 return message->filename;
247 filename_str = message->doc.get_data ();
248 message->filename = talloc_strdup (message, filename_str.c_str ());
250 return message->filename;
253 /* We end up having to call the destructors explicitly because we had
254 * to use "placement new" in order to initialize C++ objects within a
255 * block that we allocated with talloc. So C++ is making talloc
256 * slightly less simple to use, (we wouldn't need
257 * talloc_set_destructor at all otherwise).
260 _notmuch_tags_destructor (notmuch_tags_t *tags)
262 tags->iterator.~TermIterator ();
263 tags->iterator_end.~TermIterator ();
269 notmuch_message_get_tags (notmuch_message_t *message)
271 notmuch_tags_t *tags;
273 tags = talloc (message, notmuch_tags_t);
274 if (unlikely (tags == NULL))
277 new (&tags->iterator) Xapian::TermIterator;
278 new (&tags->iterator_end) Xapian::TermIterator;
280 talloc_set_destructor (tags, _notmuch_tags_destructor);
282 tags->iterator = message->doc.termlist_begin ();
283 tags->iterator.skip_to (_find_prefix ("tag"));
284 tags->iterator_end = message->doc.termlist_end ();
289 notmuch_thread_ids_t *
290 notmuch_message_get_thread_ids (notmuch_message_t *message)
292 notmuch_thread_ids_t *thread_ids;
295 thread_ids = talloc (message, notmuch_thread_ids_t);
296 if (unlikely (thread_ids == NULL))
299 id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
300 thread_ids->next = talloc_strdup (message, id_str.c_str ());
302 /* Initialize thread_ids->current and terminate first ID. */
303 notmuch_thread_ids_advance (thread_ids);
309 _notmuch_message_set_date (notmuch_message_t *message,
314 time_value = notmuch_parse_date (date, NULL);
316 message->doc.add_value (NOTMUCH_VALUE_DATE,
317 Xapian::sortable_serialise (time_value));
321 _notmuch_message_add_thread_id (notmuch_message_t *message,
322 const char *thread_id)
326 _notmuch_message_add_term (message, "thread", thread_id);
328 id_str = message->doc.get_value (NOTMUCH_VALUE_THREAD);
330 if (id_str.empty ()) {
331 message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id);
335 /* Think about using a hash here if there's any performance
337 pos = id_str.find (thread_id);
338 if (pos == std::string::npos) {
340 id_str.append (thread_id);
341 message->doc.add_value (NOTMUCH_VALUE_THREAD, id_str);
347 thread_id_generate (thread_id_t *thread_id)
349 static int seeded = 0;
356 dev_random = fopen ("/dev/random", "r");
357 if (dev_random == NULL) {
360 fread ((void *) &value, sizeof (value), 1, dev_random);
368 for (i = 0; i < NOTMUCH_THREAD_ID_DIGITS; i += 8) {
370 sprintf (s, "%08x", value);
376 _notmuch_message_ensure_thread_id (notmuch_message_t *message)
378 /* If not part of any existing thread, generate a new thread_id. */
379 thread_id_t thread_id;
381 thread_id_generate (&thread_id);
382 _notmuch_message_add_term (message, "thread", thread_id.str);
383 message->doc.add_value (NOTMUCH_VALUE_THREAD, thread_id.str);
386 /* Synchronize changes made to message->doc out into the database. */
388 _notmuch_message_sync (notmuch_message_t *message)
390 Xapian::WritableDatabase *db = message->notmuch->xapian_db;
392 db->replace_document (message->doc_id, message->doc);
395 /* Add a name:value term to 'message', (the actual term will be
396 * encoded by prefixing the value with a short prefix). See
397 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
398 * names to prefix values.
400 * This change will not be reflected in the database until the next
401 * call to _notmuch_message_set_sync. */
402 notmuch_private_status_t
403 _notmuch_message_add_term (notmuch_message_t *message,
404 const char *prefix_name,
411 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
413 term = talloc_asprintf (message, "%s%s",
414 _find_prefix (prefix_name), value);
416 if (strlen (term) > NOTMUCH_TERM_MAX)
417 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
419 message->doc.add_term (term);
423 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
426 /* Remove a name:value term from 'message', (the actual term will be
427 * encoded by prefixing the value with a short prefix). See
428 * NORMAL_PREFIX and BOOLEAN_PREFIX arrays for the mapping of term
429 * names to prefix values.
431 * This change will not be reflected in the database until the next
432 * call to _notmuch_message_set_sync. */
433 notmuch_private_status_t
434 _notmuch_message_remove_term (notmuch_message_t *message,
435 const char *prefix_name,
441 return NOTMUCH_PRIVATE_STATUS_NULL_POINTER;
443 term = talloc_asprintf (message, "%s%s",
444 _find_prefix (prefix_name), value);
446 if (strlen (term) > NOTMUCH_TERM_MAX)
447 return NOTMUCH_PRIVATE_STATUS_TERM_TOO_LONG;
449 message->doc.remove_term (term);
453 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
457 notmuch_message_add_tag (notmuch_message_t *message, const char *tag)
459 notmuch_private_status_t status;
462 return NOTMUCH_STATUS_NULL_POINTER;
464 if (strlen (tag) > NOTMUCH_TAG_MAX)
465 return NOTMUCH_STATUS_TAG_TOO_LONG;
467 status = _notmuch_message_add_term (message, "tag", tag);
469 fprintf (stderr, "Internal error: _notmuch_message_add_term return unexpected value: %d\n",
474 _notmuch_message_sync (message);
476 return NOTMUCH_STATUS_SUCCESS;
480 notmuch_message_remove_tag (notmuch_message_t *message, const char *tag)
482 notmuch_private_status_t status;
485 return NOTMUCH_STATUS_NULL_POINTER;
487 if (strlen (tag) > NOTMUCH_TAG_MAX)
488 return NOTMUCH_STATUS_TAG_TOO_LONG;
490 status = _notmuch_message_remove_term (message, "tag", tag);
492 fprintf (stderr, "Internal error: _notmuch_message_remove_term return unexpected value: %d\n",
497 _notmuch_message_sync (message);
499 return NOTMUCH_STATUS_SUCCESS;
503 notmuch_message_destroy (notmuch_message_t *message)
505 talloc_free (message);
509 notmuch_tags_has_more (notmuch_tags_t *tags)
513 if (tags->iterator == tags->iterator_end)
517 if (s.size () && s[0] == 'L')
524 notmuch_tags_get (notmuch_tags_t *tags)
526 return talloc_strdup (tags, (*tags->iterator).c_str () + 1);
530 notmuch_tags_advance (notmuch_tags_t *tags)
536 notmuch_tags_destroy (notmuch_tags_t *tags)
542 notmuch_thread_ids_has_more (notmuch_thread_ids_t *thread_ids)
544 if (thread_ids->current == NULL || *thread_ids->current == '\0')
551 notmuch_thread_ids_get (notmuch_thread_ids_t *thread_ids)
553 return thread_ids->current;
557 notmuch_thread_ids_advance (notmuch_thread_ids_t *thread_ids)
559 thread_ids->current = strsep (&thread_ids->next, ",");
563 notmuch_thread_ids_destroy (notmuch_thread_ids_t *thread_ids)
565 talloc_free (thread_ids);