1 /* database.cc - The database interfaces of the notmuch mail library
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 "database-private.h"
28 #include <glib.h> /* g_free, GPtrArray, GHashTable */
32 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
39 #define NOTMUCH_DATABASE_VERSION 1
41 #define STRINGIFY(s) _SUB_STRINGIFY(s)
42 #define _SUB_STRINGIFY(s) #s
44 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
46 * We currently have two different types of documents (mail and
47 * directory) and also some metadata.
51 * A mail document is associated with a particular email message file
52 * on disk. It is indexed with the following prefixed terms which the
53 * database uses to construct threads, etc.:
55 * Single terms of given prefix:
59 * id: Unique ID of mail. This is from the Message-ID header
60 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
61 * If it's present and too long, then we use
62 * "notmuch-sha1-<sha1_sum_of_message_id>".
63 * If this header is not present, we use
64 * "notmuch-sha1-<sha1_sum_of_entire_file>".
66 * thread: The ID of the thread to which the mail belongs
68 * replyto: The ID from the In-Reply-To header of the mail (if any).
70 * Multiple terms of given prefix:
72 * reference: All message IDs from In-Reply-To and References
73 * headers in the message.
75 * tag: Any tags associated with this message by the user.
77 * file-direntry: A colon-separated pair of values
78 * (INTEGER:STRING), where INTEGER is the
79 * document ID of a directory document, and
80 * STRING is the name of a file within that
81 * directory for this mail message.
83 * A mail document also has two values:
85 * TIMESTAMP: The time_t value corresponding to the message's
88 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
90 * In addition, terms from the content of the message are added with
91 * "from", "to", "attachment", and "subject" prefixes for use by the
92 * user in searching. Similarly, terms from the path of the mail
93 * message are added with a "folder" prefix. But the database doesn't
94 * really care itself about any of these.
96 * The data portion of a mail document is empty.
100 * A directory document is used by a client of the notmuch library to
101 * maintain data necessary to allow for efficient polling of mail
104 * All directory documents contain one term:
106 * directory: The directory path (relative to the database path)
107 * Or the SHA1 sum of the directory path (if the
108 * path itself is too long to fit in a Xapian
111 * And all directory documents for directories other than top-level
112 * directories also contain the following term:
114 * directory-direntry: A colon-separated pair of values
115 * (INTEGER:STRING), where INTEGER is the
116 * document ID of the parent directory
117 * document, and STRING is the name of this
118 * directory within that parent.
120 * All directory documents have a single value:
122 * TIMESTAMP: The mtime of the directory (at last scan)
124 * The data portion of a directory document contains the path of the
125 * directory (relative to the database path).
129 * Xapian allows us to store arbitrary name-value pairs as
130 * "metadata". We currently use the following metadata names with the
133 * version The database schema version, (which is distinct
134 * from both the notmuch package version (see
135 * notmuch --version) and the libnotmuch library
136 * version. The version is stored as an base-10
137 * ASCII integer. The initial database version
138 * was 1, (though a schema existed before that
139 * were no "version" database value existed at
140 * all). Successive versions are allocated as
141 * changes are made to the database (such as by
142 * indexing new fields).
144 * last_thread_id The last thread ID generated. This is stored
145 * as a 16-byte hexadecimal ASCII representation
146 * of a 64-bit unsigned integer. The first ID
147 * generated is 1 and the value will be
148 * incremented for each thread ID.
150 * thread_id_* A pre-allocated thread ID for a particular
151 * message. This is actually an arbitrarily large
152 * family of metadata name. Any particular name is
153 * formed by concatenating "thread_id_" with a message
154 * ID (or the SHA1 sum of a message ID if it is very
155 * long---see description of 'id' in the mail
156 * document). The value stored is a thread ID.
158 * These thread ID metadata values are stored
159 * whenever a message references a parent message
160 * that does not yet exist in the database. A
161 * thread ID will be allocated and stored, and if
162 * the message is later added, the stored thread
163 * ID will be used (and the metadata value will
166 * Even before a message is added, it's
167 * pre-allocated thread ID is useful so that all
168 * descendant messages that reference this common
169 * parent can be recognized as belonging to the
173 /* With these prefix values we follow the conventions published here:
175 * http://xapian.org/docs/omega/termprefixes.html
177 * as much as makes sense. Note that I took some liberty in matching
178 * the reserved prefix values to notmuch concepts, (for example, 'G'
179 * is documented as "newsGroup (or similar entity - e.g. a web forum
180 * name)", for which I think the thread is the closest analogue in
181 * notmuch. This in spite of the fact that we will eventually be
182 * storing mailing-list messages where 'G' for "mailing list name"
183 * might be even a closer analogue. I'm treating the single-character
184 * prefixes preferentially for core notmuch concepts (which will be
185 * nearly universal to all mail messages).
188 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
190 { "reference", "XREFERENCE" },
191 { "replyto", "XREPLYTO" },
192 { "directory", "XDIRECTORY" },
193 { "file-direntry", "XFDIRENTRY" },
194 { "directory-direntry", "XDDIRENTRY" },
197 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
204 static prefix_t PROBABILISTIC_PREFIX[]= {
207 { "attachment", "XATTACHMENT" },
208 { "subject", "XSUBJECT"},
209 { "folder", "XFOLDER"}
213 _find_prefix (const char *name)
217 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
218 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
219 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
222 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
223 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
224 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
227 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
228 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
229 return PROBABILISTIC_PREFIX[i].prefix;
232 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
238 notmuch_status_to_string (notmuch_status_t status)
241 case NOTMUCH_STATUS_SUCCESS:
242 return "No error occurred";
243 case NOTMUCH_STATUS_OUT_OF_MEMORY:
244 return "Out of memory";
245 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
246 return "Attempt to write to a read-only database";
247 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
248 return "A Xapian exception occurred";
249 case NOTMUCH_STATUS_FILE_ERROR:
250 return "Something went wrong trying to read or write a file";
251 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
252 return "File is not an email";
253 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
254 return "Message ID is identical to a message in database";
255 case NOTMUCH_STATUS_NULL_POINTER:
256 return "Erroneous NULL pointer";
257 case NOTMUCH_STATUS_TAG_TOO_LONG:
258 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
259 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
260 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
261 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
262 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
264 case NOTMUCH_STATUS_LAST_STATUS:
265 return "Unknown error status value";
270 find_doc_ids_for_term (notmuch_database_t *notmuch,
272 Xapian::PostingIterator *begin,
273 Xapian::PostingIterator *end)
275 *begin = notmuch->xapian_db->postlist_begin (term);
277 *end = notmuch->xapian_db->postlist_end (term);
281 find_doc_ids (notmuch_database_t *notmuch,
282 const char *prefix_name,
284 Xapian::PostingIterator *begin,
285 Xapian::PostingIterator *end)
289 term = talloc_asprintf (notmuch, "%s%s",
290 _find_prefix (prefix_name), value);
292 find_doc_ids_for_term (notmuch, term, begin, end);
297 notmuch_private_status_t
298 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
299 const char *prefix_name,
301 unsigned int *doc_id)
303 Xapian::PostingIterator i, end;
305 find_doc_ids (notmuch, prefix_name, value, &i, &end);
309 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
314 #if DEBUG_DATABASE_SANITY
318 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
322 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
325 static Xapian::Document
326 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
328 return notmuch->xapian_db->get_document (doc_id);
331 /* Generate a compressed version of 'message_id' of the form:
333 * notmuch-sha1-<sha1_sum_of_message_id>
336 _message_id_compressed (void *ctx, const char *message_id)
338 char *sha1, *compressed;
340 sha1 = notmuch_sha1_of_string (message_id);
342 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
349 notmuch_database_find_message (notmuch_database_t *notmuch,
350 const char *message_id,
351 notmuch_message_t **message_ret)
353 notmuch_private_status_t status;
356 if (message_ret == NULL)
357 return NOTMUCH_STATUS_NULL_POINTER;
359 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
360 message_id = _message_id_compressed (notmuch, message_id);
363 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
364 message_id, &doc_id);
366 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
369 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
371 if (*message_ret == NULL)
372 return NOTMUCH_STATUS_OUT_OF_MEMORY;
375 return NOTMUCH_STATUS_SUCCESS;
376 } catch (const Xapian::Error &error) {
377 fprintf (stderr, "A Xapian exception occurred finding message: %s.\n",
378 error.get_msg().c_str());
379 notmuch->exception_reported = TRUE;
381 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
385 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
386 * a (potentially nested) parenthesized sequence with '\' used to
387 * escape any character (including parentheses).
389 * If the sequence to be skipped continues to the end of the string,
390 * then 'str' will be left pointing at the final terminating '\0'
394 skip_space_and_comments (const char **str)
399 while (*s && (isspace (*s) || *s == '(')) {
400 while (*s && isspace (*s))
405 while (*s && nesting) {
408 } else if (*s == ')') {
410 } else if (*s == '\\') {
422 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
423 * comments, and the '<' and '>' delimiters.
425 * If not NULL, then *next will be made to point to the first character
426 * not parsed, (possibly pointing to the final '\0' terminator.
428 * Returns a newly talloc'ed string belonging to 'ctx'.
430 * Returns NULL if there is any error parsing the message-id. */
432 _parse_message_id (void *ctx, const char *message_id, const char **next)
437 if (message_id == NULL || *message_id == '\0')
442 skip_space_and_comments (&s);
444 /* Skip any unstructured text as well. */
445 while (*s && *s != '<')
456 skip_space_and_comments (&s);
459 while (*end && *end != '>')
468 if (end > s && *end == '>')
473 result = talloc_strndup (ctx, s, end - s + 1);
475 /* Finally, collapse any whitespace that is within the message-id
481 for (r = result, len = strlen (r); *r; r++, len--)
482 if (*r == ' ' || *r == '\t')
483 memmove (r, r+1, len);
489 /* Parse a References header value, putting a (talloc'ed under 'ctx')
490 * copy of each referenced message-id into 'hash'.
492 * We explicitly avoid including any reference identical to
493 * 'message_id' in the result (to avoid mass confusion when a single
494 * message references itself cyclically---and yes, mail messages are
495 * not infrequent in the wild that do this---don't ask me why).
498 parse_references (void *ctx,
499 const char *message_id,
505 if (refs == NULL || *refs == '\0')
509 ref = _parse_message_id (ctx, refs, &refs);
511 if (ref && strcmp (ref, message_id))
512 g_hash_table_insert (hash, ref, NULL);
517 notmuch_database_create (const char *path)
519 notmuch_database_t *notmuch = NULL;
520 char *notmuch_path = NULL;
525 fprintf (stderr, "Error: Cannot create a database for a NULL path.\n");
529 err = stat (path, &st);
531 fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
532 path, strerror (errno));
536 if (! S_ISDIR (st.st_mode)) {
537 fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
542 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
544 err = mkdir (notmuch_path, 0755);
547 fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
548 notmuch_path, strerror (errno));
552 notmuch = notmuch_database_open (path,
553 NOTMUCH_DATABASE_MODE_READ_WRITE);
554 notmuch_database_upgrade (notmuch, NULL, NULL);
558 talloc_free (notmuch_path);
564 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
566 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
567 fprintf (stderr, "Cannot write to a read-only database.\n");
568 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
571 return NOTMUCH_STATUS_SUCCESS;
575 notmuch_database_open (const char *path,
576 notmuch_database_mode_t mode)
578 notmuch_database_t *notmuch = NULL;
579 char *notmuch_path = NULL, *xapian_path = NULL;
582 unsigned int i, version;
584 if (asprintf (¬much_path, "%s/%s", path, ".notmuch") == -1) {
586 fprintf (stderr, "Out of memory\n");
590 err = stat (notmuch_path, &st);
592 fprintf (stderr, "Error opening database at %s: %s\n",
593 notmuch_path, strerror (errno));
597 if (asprintf (&xapian_path, "%s/%s", notmuch_path, "xapian") == -1) {
599 fprintf (stderr, "Out of memory\n");
603 notmuch = talloc (NULL, notmuch_database_t);
604 notmuch->exception_reported = FALSE;
605 notmuch->path = talloc_strdup (notmuch, path);
607 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
608 notmuch->path[strlen (notmuch->path) - 1] = '\0';
610 notmuch->needs_upgrade = FALSE;
611 notmuch->mode = mode;
612 notmuch->atomic_nesting = 0;
614 string last_thread_id;
616 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
617 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
618 Xapian::DB_CREATE_OR_OPEN);
619 version = notmuch_database_get_version (notmuch);
621 if (version > NOTMUCH_DATABASE_VERSION) {
623 "Error: Notmuch database at %s\n"
624 " has a newer database format version (%u) than supported by this\n"
625 " version of notmuch (%u). Refusing to open this database in\n"
626 " read-write mode.\n",
627 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
628 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
629 notmuch_database_close (notmuch);
634 if (version < NOTMUCH_DATABASE_VERSION)
635 notmuch->needs_upgrade = TRUE;
637 notmuch->xapian_db = new Xapian::Database (xapian_path);
638 version = notmuch_database_get_version (notmuch);
639 if (version > NOTMUCH_DATABASE_VERSION)
642 "Warning: Notmuch database at %s\n"
643 " has a newer database format version (%u) than supported by this\n"
644 " version of notmuch (%u). Some operations may behave incorrectly,\n"
645 " (but the database will not be harmed since it is being opened\n"
646 " in read-only mode).\n",
647 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
651 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
652 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
653 if (last_thread_id.empty ()) {
654 notmuch->last_thread_id = 0;
659 str = last_thread_id.c_str ();
660 notmuch->last_thread_id = strtoull (str, &end, 16);
662 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
665 notmuch->query_parser = new Xapian::QueryParser;
666 notmuch->term_gen = new Xapian::TermGenerator;
667 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
668 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
670 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
671 notmuch->query_parser->set_database (*notmuch->xapian_db);
672 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
673 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
674 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
676 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
677 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
678 notmuch->query_parser->add_boolean_prefix (prefix->name,
682 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
683 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
684 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
686 } catch (const Xapian::Error &error) {
687 fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
688 error.get_msg().c_str());
702 notmuch_database_close (notmuch_database_t *notmuch)
705 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
706 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
707 } catch (const Xapian::Error &error) {
708 if (! notmuch->exception_reported) {
709 fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
710 error.get_msg().c_str());
714 delete notmuch->term_gen;
715 delete notmuch->query_parser;
716 delete notmuch->xapian_db;
717 delete notmuch->value_range_processor;
718 talloc_free (notmuch);
722 notmuch_database_get_path (notmuch_database_t *notmuch)
724 return notmuch->path;
728 notmuch_database_get_version (notmuch_database_t *notmuch)
730 unsigned int version;
731 string version_string;
735 version_string = notmuch->xapian_db->get_metadata ("version");
736 if (version_string.empty ())
739 str = version_string.c_str ();
740 if (str == NULL || *str == '\0')
743 version = strtoul (str, &end, 10);
745 INTERNAL_ERROR ("Malformed database version: %s", str);
751 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
753 return notmuch->needs_upgrade;
756 static volatile sig_atomic_t do_progress_notify = 0;
759 handle_sigalrm (unused (int signal))
761 do_progress_notify = 1;
764 /* Upgrade the current database.
766 * After opening a database in read-write mode, the client should
767 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
768 * if so, upgrade with this function before making any modifications.
770 * The optional progress_notify callback can be used by the caller to
771 * provide progress indication to the user. If non-NULL it will be
772 * called periodically with 'count' as the number of messages upgraded
773 * so far and 'total' the overall number of messages that will be
777 notmuch_database_upgrade (notmuch_database_t *notmuch,
778 void (*progress_notify) (void *closure,
782 Xapian::WritableDatabase *db;
783 struct sigaction action;
784 struct itimerval timerval;
785 notmuch_bool_t timer_is_active = FALSE;
786 unsigned int version;
787 notmuch_status_t status;
788 unsigned int count = 0, total = 0;
790 status = _notmuch_database_ensure_writable (notmuch);
794 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
796 version = notmuch_database_get_version (notmuch);
798 if (version >= NOTMUCH_DATABASE_VERSION)
799 return NOTMUCH_STATUS_SUCCESS;
801 if (progress_notify) {
802 /* Setup our handler for SIGALRM */
803 memset (&action, 0, sizeof (struct sigaction));
804 action.sa_handler = handle_sigalrm;
805 sigemptyset (&action.sa_mask);
806 action.sa_flags = SA_RESTART;
807 sigaction (SIGALRM, &action, NULL);
809 /* Then start a timer to send SIGALRM once per second. */
810 timerval.it_interval.tv_sec = 1;
811 timerval.it_interval.tv_usec = 0;
812 timerval.it_value.tv_sec = 1;
813 timerval.it_value.tv_usec = 0;
814 setitimer (ITIMER_REAL, &timerval, NULL);
816 timer_is_active = TRUE;
819 /* Before version 1, each message document had its filename in the
820 * data field. Copy that into the new format by calling
821 * notmuch_message_add_filename.
824 notmuch_query_t *query = notmuch_query_create (notmuch, "");
825 notmuch_messages_t *messages;
826 notmuch_message_t *message;
828 Xapian::TermIterator t, t_end;
830 total = notmuch_query_count_messages (query);
832 for (messages = notmuch_query_search_messages (query);
833 notmuch_messages_valid (messages);
834 notmuch_messages_move_to_next (messages))
836 if (do_progress_notify) {
837 progress_notify (closure, (double) count / total);
838 do_progress_notify = 0;
841 message = notmuch_messages_get (messages);
843 filename = _notmuch_message_talloc_copy_data (message);
844 if (filename && *filename != '\0') {
845 _notmuch_message_add_filename (message, filename);
846 _notmuch_message_sync (message);
848 talloc_free (filename);
850 notmuch_message_destroy (message);
855 notmuch_query_destroy (query);
857 /* Also, before version 1 we stored directory timestamps in
858 * XTIMESTAMP documents instead of the current XDIRECTORY
859 * documents. So copy those as well. */
861 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
863 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
867 Xapian::PostingIterator p, p_end;
868 std::string term = *t;
870 p_end = notmuch->xapian_db->postlist_end (term);
872 for (p = notmuch->xapian_db->postlist_begin (term);
876 Xapian::Document document;
878 notmuch_directory_t *directory;
880 if (do_progress_notify) {
881 progress_notify (closure, (double) count / total);
882 do_progress_notify = 0;
885 document = find_document_for_doc_id (notmuch, *p);
886 mtime = Xapian::sortable_unserialise (
887 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
889 directory = notmuch_database_get_directory (notmuch,
891 notmuch_directory_set_mtime (directory, mtime);
892 notmuch_directory_destroy (directory);
897 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
900 /* Now that the upgrade is complete we can remove the old data
901 * and documents that are no longer needed. */
903 notmuch_query_t *query = notmuch_query_create (notmuch, "");
904 notmuch_messages_t *messages;
905 notmuch_message_t *message;
908 for (messages = notmuch_query_search_messages (query);
909 notmuch_messages_valid (messages);
910 notmuch_messages_move_to_next (messages))
912 if (do_progress_notify) {
913 progress_notify (closure, (double) count / total);
914 do_progress_notify = 0;
917 message = notmuch_messages_get (messages);
919 filename = _notmuch_message_talloc_copy_data (message);
920 if (filename && *filename != '\0') {
921 _notmuch_message_clear_data (message);
922 _notmuch_message_sync (message);
924 talloc_free (filename);
926 notmuch_message_destroy (message);
929 notmuch_query_destroy (query);
933 Xapian::TermIterator t, t_end;
935 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
937 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
941 Xapian::PostingIterator p, p_end;
942 std::string term = *t;
944 p_end = notmuch->xapian_db->postlist_end (term);
946 for (p = notmuch->xapian_db->postlist_begin (term);
950 if (do_progress_notify) {
951 progress_notify (closure, (double) count / total);
952 do_progress_notify = 0;
955 db->delete_document (*p);
960 if (timer_is_active) {
961 /* Now stop the timer. */
962 timerval.it_interval.tv_sec = 0;
963 timerval.it_interval.tv_usec = 0;
964 timerval.it_value.tv_sec = 0;
965 timerval.it_value.tv_usec = 0;
966 setitimer (ITIMER_REAL, &timerval, NULL);
968 /* And disable the signal handler. */
969 action.sa_handler = SIG_IGN;
970 sigaction (SIGALRM, &action, NULL);
973 return NOTMUCH_STATUS_SUCCESS;
977 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
979 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
980 notmuch->atomic_nesting > 0)
984 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
985 } catch (const Xapian::Error &error) {
986 fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
987 error.get_msg().c_str());
988 notmuch->exception_reported = TRUE;
989 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
993 notmuch->atomic_nesting++;
994 return NOTMUCH_STATUS_SUCCESS;
998 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1000 Xapian::WritableDatabase *db;
1002 if (notmuch->atomic_nesting == 0)
1003 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1005 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1006 notmuch->atomic_nesting > 1)
1009 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1011 db->commit_transaction ();
1013 /* This is a hack for testing. Xapian never flushes on a
1014 * non-flushed commit, even if the flush threshold is 1.
1015 * However, we rely on flushing to test atomicity. */
1016 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1017 if (thresh && atoi (thresh) == 1)
1019 } catch (const Xapian::Error &error) {
1020 fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1021 error.get_msg().c_str());
1022 notmuch->exception_reported = TRUE;
1023 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1027 notmuch->atomic_nesting--;
1028 return NOTMUCH_STATUS_SUCCESS;
1031 /* We allow the user to use arbitrarily long paths for directories. But
1032 * we have a term-length limit. So if we exceed that, we'll use the
1033 * SHA-1 of the path for the database term.
1035 * Note: This function may return the original value of 'path'. If it
1036 * does not, then the caller is responsible to free() the returned
1040 _notmuch_database_get_directory_db_path (const char *path)
1042 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1044 if (term_len > NOTMUCH_TERM_MAX)
1045 return notmuch_sha1_of_string (path);
1050 /* Given a path, split it into two parts: the directory part is all
1051 * components except for the last, and the basename is that last
1052 * component. Getting the return-value for either part is optional
1053 * (the caller can pass NULL).
1055 * The original 'path' can represent either a regular file or a
1056 * directory---the splitting will be carried out in the same way in
1057 * either case. Trailing slashes on 'path' will be ignored, and any
1058 * cases of multiple '/' characters appearing in series will be
1059 * treated as a single '/'.
1061 * Allocation (if any) will have 'ctx' as the talloc owner. But
1062 * pointers will be returned within the original path string whenever
1065 * Note: If 'path' is non-empty and contains no non-trailing slash,
1066 * (that is, consists of a filename with no parent directory), then
1067 * the directory returned will be an empty string. However, if 'path'
1068 * is an empty string, then both directory and basename will be
1072 _notmuch_database_split_path (void *ctx,
1074 const char **directory,
1075 const char **basename)
1079 if (path == NULL || *path == '\0') {
1084 return NOTMUCH_STATUS_SUCCESS;
1087 /* Find the last slash (not counting a trailing slash), if any. */
1089 slash = path + strlen (path) - 1;
1091 /* First, skip trailing slashes. */
1092 while (slash != path) {
1099 /* Then, find a slash. */
1100 while (slash != path) {
1110 /* Finally, skip multiple slashes. */
1111 while (slash != path) {
1118 if (slash == path) {
1120 *directory = talloc_strdup (ctx, "");
1125 *directory = talloc_strndup (ctx, path, slash - path + 1);
1128 return NOTMUCH_STATUS_SUCCESS;
1132 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1134 unsigned int *directory_id)
1136 notmuch_directory_t *directory;
1137 notmuch_status_t status;
1141 return NOTMUCH_STATUS_SUCCESS;
1144 directory = _notmuch_directory_create (notmuch, path, &status);
1150 *directory_id = _notmuch_directory_get_document_id (directory);
1152 notmuch_directory_destroy (directory);
1154 return NOTMUCH_STATUS_SUCCESS;
1158 _notmuch_database_get_directory_path (void *ctx,
1159 notmuch_database_t *notmuch,
1160 unsigned int doc_id)
1162 Xapian::Document document;
1164 document = find_document_for_doc_id (notmuch, doc_id);
1166 return talloc_strdup (ctx, document.get_data ().c_str ());
1169 /* Given a legal 'filename' for the database, (either relative to
1170 * database path or absolute with initial components identical to
1171 * database path), return a new string (with 'ctx' as the talloc
1172 * owner) suitable for use as a direntry term value.
1174 * The necessary directory documents will be created in the database
1178 _notmuch_database_filename_to_direntry (void *ctx,
1179 notmuch_database_t *notmuch,
1180 const char *filename,
1183 const char *relative, *directory, *basename;
1184 Xapian::docid directory_id;
1185 notmuch_status_t status;
1187 relative = _notmuch_database_relative_path (notmuch, filename);
1189 status = _notmuch_database_split_path (ctx, relative,
1190 &directory, &basename);
1194 status = _notmuch_database_find_directory_id (notmuch, directory,
1199 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1201 return NOTMUCH_STATUS_SUCCESS;
1204 /* Given a legal 'path' for the database, return the relative path.
1206 * The return value will be a pointer to the original path contents,
1207 * and will be either the original string (if 'path' was relative) or
1208 * a portion of the string (if path was absolute and begins with the
1212 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1215 const char *db_path, *relative;
1216 unsigned int db_path_len;
1218 db_path = notmuch_database_get_path (notmuch);
1219 db_path_len = strlen (db_path);
1223 if (*relative == '/') {
1224 while (*relative == '/' && *(relative+1) == '/')
1227 if (strncmp (relative, db_path, db_path_len) == 0)
1229 relative += db_path_len;
1230 while (*relative == '/')
1238 notmuch_directory_t *
1239 notmuch_database_get_directory (notmuch_database_t *notmuch,
1242 notmuch_status_t status;
1245 return _notmuch_directory_create (notmuch, path, &status);
1246 } catch (const Xapian::Error &error) {
1247 fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1248 error.get_msg().c_str());
1249 notmuch->exception_reported = TRUE;
1254 /* Allocate a document ID that satisfies the following criteria:
1256 * 1. The ID does not exist for any document in the Xapian database
1258 * 2. The ID was not previously returned from this function
1260 * 3. The ID is the smallest integer satisfying (1) and (2)
1262 * This function will trigger an internal error if these constraints
1263 * cannot all be satisfied, (that is, the pool of available document
1264 * IDs has been exhausted).
1267 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1269 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1271 notmuch->last_doc_id++;
1273 if (notmuch->last_doc_id == 0)
1274 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1276 return notmuch->last_doc_id;
1280 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1282 /* 16 bytes (+ terminator) for hexadecimal representation of
1283 * a 64-bit integer. */
1284 static char thread_id[17];
1285 Xapian::WritableDatabase *db;
1287 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1289 notmuch->last_thread_id++;
1291 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1293 db->set_metadata ("last_thread_id", thread_id);
1299 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1301 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1302 message_id = _message_id_compressed (ctx, message_id);
1304 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1308 /* Find the thread ID to which the message with 'message_id' belongs.
1310 * Note: 'thread_id_ret' must not be NULL!
1311 * On success '*thread_id_ret' is set to a newly talloced string belonging to
1314 * Note: If there is no message in the database with the given
1315 * 'message_id' then a new thread_id will be allocated for this
1316 * message and stored in the database metadata, (where this same
1317 * thread ID can be looked up if the message is added to the database
1320 static notmuch_status_t
1321 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1323 const char *message_id,
1324 const char **thread_id_ret)
1326 notmuch_status_t status;
1327 notmuch_message_t *message;
1328 string thread_id_string;
1330 Xapian::WritableDatabase *db;
1332 status = notmuch_database_find_message (notmuch, message_id, &message);
1338 *thread_id_ret = talloc_steal (ctx,
1339 notmuch_message_get_thread_id (message));
1341 notmuch_message_destroy (message);
1343 return NOTMUCH_STATUS_SUCCESS;
1346 /* Message has not been seen yet.
1348 * We may have seen a reference to it already, in which case, we
1349 * can return the thread ID stored in the metadata. Otherwise, we
1350 * generate a new thread ID and store it there.
1352 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1353 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1354 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1356 if (thread_id_string.empty()) {
1357 *thread_id_ret = talloc_strdup (ctx,
1358 _notmuch_database_generate_thread_id (notmuch));
1359 db->set_metadata (metadata_key, *thread_id_ret);
1361 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1364 talloc_free (metadata_key);
1366 return NOTMUCH_STATUS_SUCCESS;
1369 static notmuch_status_t
1370 _merge_threads (notmuch_database_t *notmuch,
1371 const char *winner_thread_id,
1372 const char *loser_thread_id)
1374 Xapian::PostingIterator loser, loser_end;
1375 notmuch_message_t *message = NULL;
1376 notmuch_private_status_t private_status;
1377 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1379 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1381 for ( ; loser != loser_end; loser++) {
1382 message = _notmuch_message_create (notmuch, notmuch,
1383 *loser, &private_status);
1384 if (message == NULL) {
1385 ret = COERCE_STATUS (private_status,
1386 "Cannot find document for doc_id from query");
1390 _notmuch_message_remove_term (message, "thread", loser_thread_id);
1391 _notmuch_message_add_term (message, "thread", winner_thread_id);
1392 _notmuch_message_sync (message);
1394 notmuch_message_destroy (message);
1400 notmuch_message_destroy (message);
1406 _my_talloc_free_for_g_hash (void *ptr)
1411 static notmuch_status_t
1412 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1413 notmuch_message_t *message,
1414 notmuch_message_file_t *message_file,
1415 const char **thread_id)
1417 GHashTable *parents = NULL;
1418 const char *refs, *in_reply_to, *in_reply_to_message_id;
1419 GList *l, *keys = NULL;
1420 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1422 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1423 _my_talloc_free_for_g_hash, NULL);
1425 refs = notmuch_message_file_get_header (message_file, "references");
1426 parse_references (message, notmuch_message_get_message_id (message),
1429 in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1430 parse_references (message, notmuch_message_get_message_id (message),
1431 parents, in_reply_to);
1433 /* Carefully avoid adding any self-referential in-reply-to term. */
1434 in_reply_to_message_id = _parse_message_id (message, in_reply_to, NULL);
1435 if (in_reply_to_message_id &&
1436 strcmp (in_reply_to_message_id,
1437 notmuch_message_get_message_id (message)))
1439 _notmuch_message_add_term (message, "replyto",
1440 _parse_message_id (message, in_reply_to, NULL));
1443 keys = g_hash_table_get_keys (parents);
1444 for (l = keys; l; l = l->next) {
1445 char *parent_message_id;
1446 const char *parent_thread_id;
1448 parent_message_id = (char *) l->data;
1450 _notmuch_message_add_term (message, "reference",
1453 ret = _resolve_message_id_to_thread_id (notmuch,
1460 if (*thread_id == NULL) {
1461 *thread_id = talloc_strdup (message, parent_thread_id);
1462 _notmuch_message_add_term (message, "thread", *thread_id);
1463 } else if (strcmp (*thread_id, parent_thread_id)) {
1464 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1474 g_hash_table_unref (parents);
1479 static notmuch_status_t
1480 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1481 notmuch_message_t *message,
1482 const char **thread_id)
1484 const char *message_id = notmuch_message_get_message_id (message);
1485 Xapian::PostingIterator child, children_end;
1486 notmuch_message_t *child_message = NULL;
1487 const char *child_thread_id;
1488 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1489 notmuch_private_status_t private_status;
1491 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1493 for ( ; child != children_end; child++) {
1495 child_message = _notmuch_message_create (message, notmuch,
1496 *child, &private_status);
1497 if (child_message == NULL) {
1498 ret = COERCE_STATUS (private_status,
1499 "Cannot find document for doc_id from query");
1503 child_thread_id = notmuch_message_get_thread_id (child_message);
1504 if (*thread_id == NULL) {
1505 *thread_id = talloc_strdup (message, child_thread_id);
1506 _notmuch_message_add_term (message, "thread", *thread_id);
1507 } else if (strcmp (*thread_id, child_thread_id)) {
1508 _notmuch_message_remove_term (child_message, "reference",
1510 _notmuch_message_sync (child_message);
1511 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1516 notmuch_message_destroy (child_message);
1517 child_message = NULL;
1522 notmuch_message_destroy (child_message);
1527 /* Given a (mostly empty) 'message' and its corresponding
1528 * 'message_file' link it to existing threads in the database.
1530 * The first check is in the metadata of the database to see if we
1531 * have pre-allocated a thread_id in advance for this message, (which
1532 * would have happened if a message was previously added that
1533 * referenced this one).
1535 * Second, we look at 'message_file' and its link-relevant headers
1536 * (References and In-Reply-To) for message IDs.
1538 * Finally, we look in the database for existing message that
1539 * reference 'message'.
1541 * In all cases, we assign to the current message the first thread_id
1542 * found (through either parent or child). We will also merge any
1543 * existing, distinct threads where this message belongs to both,
1544 * (which is not uncommon when messages are processed out of order).
1546 * Finally, if no thread ID has been found through parent or child, we
1547 * call _notmuch_message_generate_thread_id to generate a new thread
1548 * ID. This should only happen for new, top-level messages, (no
1549 * References or In-Reply-To header in this message, and no previously
1550 * added message refers to this message).
1552 static notmuch_status_t
1553 _notmuch_database_link_message (notmuch_database_t *notmuch,
1554 notmuch_message_t *message,
1555 notmuch_message_file_t *message_file)
1557 notmuch_status_t status;
1558 const char *message_id, *thread_id = NULL;
1562 message_id = notmuch_message_get_message_id (message);
1563 metadata_key = _get_metadata_thread_id_key (message, message_id);
1565 /* Check if we have already seen related messages to this one.
1566 * If we have then use the thread_id that we stored at that time.
1568 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1569 if (! stored_id.empty()) {
1570 Xapian::WritableDatabase *db;
1572 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1574 /* Clear the metadata for this message ID. We don't need it
1576 db->set_metadata (metadata_key, "");
1577 thread_id = stored_id.c_str();
1579 _notmuch_message_add_term (message, "thread", thread_id);
1581 talloc_free (metadata_key);
1583 status = _notmuch_database_link_message_to_parents (notmuch, message,
1589 status = _notmuch_database_link_message_to_children (notmuch, message,
1594 /* If not part of any existing thread, generate a new thread ID. */
1595 if (thread_id == NULL) {
1596 thread_id = _notmuch_database_generate_thread_id (notmuch);
1598 _notmuch_message_add_term (message, "thread", thread_id);
1601 return NOTMUCH_STATUS_SUCCESS;
1605 notmuch_database_add_message (notmuch_database_t *notmuch,
1606 const char *filename,
1607 notmuch_message_t **message_ret)
1609 notmuch_message_file_t *message_file;
1610 notmuch_message_t *message = NULL;
1611 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1612 notmuch_private_status_t private_status;
1614 const char *date, *header;
1615 const char *from, *to, *subject;
1616 char *message_id = NULL;
1619 *message_ret = NULL;
1621 ret = _notmuch_database_ensure_writable (notmuch);
1625 message_file = notmuch_message_file_open (filename);
1626 if (message_file == NULL)
1627 return NOTMUCH_STATUS_FILE_ERROR;
1629 /* Adding a message may change many documents. Do this all
1631 ret = notmuch_database_begin_atomic (notmuch);
1635 notmuch_message_file_restrict_headers (message_file,
1646 /* Before we do any real work, (especially before doing a
1647 * potential SHA-1 computation on the entire file's contents),
1648 * let's make sure that what we're looking at looks like an
1649 * actual email message.
1651 from = notmuch_message_file_get_header (message_file, "from");
1652 subject = notmuch_message_file_get_header (message_file, "subject");
1653 to = notmuch_message_file_get_header (message_file, "to");
1655 if ((from == NULL || *from == '\0') &&
1656 (subject == NULL || *subject == '\0') &&
1657 (to == NULL || *to == '\0'))
1659 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1663 /* Now that we're sure it's mail, the first order of business
1664 * is to find a message ID (or else create one ourselves). */
1666 header = notmuch_message_file_get_header (message_file, "message-id");
1667 if (header && *header != '\0') {
1668 message_id = _parse_message_id (message_file, header, NULL);
1670 /* So the header value isn't RFC-compliant, but it's
1671 * better than no message-id at all. */
1672 if (message_id == NULL)
1673 message_id = talloc_strdup (message_file, header);
1675 /* If a message ID is too long, substitute its sha1 instead. */
1676 if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1677 char *compressed = _message_id_compressed (message_file,
1679 talloc_free (message_id);
1680 message_id = compressed;
1684 if (message_id == NULL ) {
1685 /* No message-id at all, let's generate one by taking a
1686 * hash over the file's contents. */
1687 char *sha1 = notmuch_sha1_of_file (filename);
1689 /* If that failed too, something is really wrong. Give up. */
1691 ret = NOTMUCH_STATUS_FILE_ERROR;
1695 message_id = talloc_asprintf (message_file,
1696 "notmuch-sha1-%s", sha1);
1700 /* Now that we have a message ID, we get a message object,
1701 * (which may or may not reference an existing document in the
1704 message = _notmuch_message_create_for_message_id (notmuch,
1708 talloc_free (message_id);
1710 if (message == NULL) {
1711 ret = COERCE_STATUS (private_status,
1712 "Unexpected status value from _notmuch_message_create_for_message_id");
1716 _notmuch_message_add_filename (message, filename);
1718 /* Is this a newly created message object? */
1719 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1720 _notmuch_message_add_term (message, "type", "mail");
1722 ret = _notmuch_database_link_message (notmuch, message,
1727 date = notmuch_message_file_get_header (message_file, "date");
1728 _notmuch_message_set_header_values (message, date, from, subject);
1730 _notmuch_message_index_file (message, filename);
1732 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1735 _notmuch_message_sync (message);
1736 } catch (const Xapian::Error &error) {
1737 fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
1738 error.get_msg().c_str());
1739 notmuch->exception_reported = TRUE;
1740 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1746 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1747 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
1748 *message_ret = message;
1750 notmuch_message_destroy (message);
1754 notmuch_message_file_close (message_file);
1756 ret2 = notmuch_database_end_atomic (notmuch);
1757 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1758 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
1759 ret2 != NOTMUCH_STATUS_SUCCESS)
1766 notmuch_database_remove_message (notmuch_database_t *notmuch,
1767 const char *filename)
1769 notmuch_status_t status;
1770 notmuch_message_t *message;
1772 status = notmuch_database_find_message_by_filename (notmuch, filename,
1775 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1776 status = _notmuch_message_remove_filename (message, filename);
1777 if (status == NOTMUCH_STATUS_SUCCESS)
1778 _notmuch_message_delete (message);
1779 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1780 _notmuch_message_sync (message);
1782 notmuch_message_destroy (message);
1789 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1790 const char *filename,
1791 notmuch_message_t **message_ret)
1794 const char *prefix = _find_prefix ("file-direntry");
1795 char *direntry, *term;
1796 Xapian::PostingIterator i, end;
1797 notmuch_status_t status;
1799 if (message_ret == NULL)
1800 return NOTMUCH_STATUS_NULL_POINTER;
1802 local = talloc_new (notmuch);
1805 status = _notmuch_database_filename_to_direntry (local, notmuch,
1806 filename, &direntry);
1810 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1812 find_doc_ids_for_term (notmuch, term, &i, &end);
1815 notmuch_private_status_t private_status;
1817 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1819 if (*message_ret == NULL)
1820 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1822 } catch (const Xapian::Error &error) {
1823 fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
1824 error.get_msg().c_str());
1825 notmuch->exception_reported = TRUE;
1826 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1830 talloc_free (local);
1832 if (status && *message_ret) {
1833 notmuch_message_destroy (*message_ret);
1834 *message_ret = NULL;
1839 notmuch_string_list_t *
1840 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1841 Xapian::TermIterator &end,
1844 int prefix_len = strlen (prefix);
1845 notmuch_string_list_t *list;
1847 list = _notmuch_string_list_create (ctx);
1848 if (unlikely (list == NULL))
1851 for (i.skip_to (prefix); i != end; i++) {
1852 /* Terminate loop at first term without desired prefix. */
1853 if (strncmp ((*i).c_str (), prefix, prefix_len))
1856 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1863 notmuch_database_get_all_tags (notmuch_database_t *db)
1865 Xapian::TermIterator i, end;
1866 notmuch_string_list_t *tags;
1869 i = db->xapian_db->allterms_begin();
1870 end = db->xapian_db->allterms_end();
1871 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1872 _find_prefix ("tag"));
1873 _notmuch_string_list_sort (tags);
1874 return _notmuch_tags_create (db, tags);
1875 } catch (const Xapian::Error &error) {
1876 fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
1877 error.get_msg().c_str());
1878 db->exception_reported = TRUE;