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 */
29 #include <glib-object.h> /* g_type_init */
33 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
40 #define NOTMUCH_DATABASE_VERSION 1
42 #define STRINGIFY(s) _SUB_STRINGIFY(s)
43 #define _SUB_STRINGIFY(s) #s
45 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
47 * We currently have two different types of documents (mail and
48 * directory) and also some metadata.
52 * A mail document is associated with a particular email message file
53 * on disk. It is indexed with the following prefixed terms which the
54 * database uses to construct threads, etc.:
56 * Single terms of given prefix:
60 * id: Unique ID of mail. This is from the Message-ID header
61 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
62 * If it's present and too long, then we use
63 * "notmuch-sha1-<sha1_sum_of_message_id>".
64 * If this header is not present, we use
65 * "notmuch-sha1-<sha1_sum_of_entire_file>".
67 * thread: The ID of the thread to which the mail belongs
69 * replyto: The ID from the In-Reply-To header of the mail (if any).
71 * Multiple terms of given prefix:
73 * reference: All message IDs from In-Reply-To and References
74 * headers in the message.
76 * tag: Any tags associated with this message by the user.
78 * file-direntry: A colon-separated pair of values
79 * (INTEGER:STRING), where INTEGER is the
80 * document ID of a directory document, and
81 * STRING is the name of a file within that
82 * directory for this mail message.
84 * A mail document also has two values:
86 * TIMESTAMP: The time_t value corresponding to the message's
89 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
91 * In addition, terms from the content of the message are added with
92 * "from", "to", "attachment", and "subject" prefixes for use by the
93 * user in searching. Similarly, terms from the path of the mail
94 * message are added with a "folder" prefix. But the database doesn't
95 * really care itself about any of these.
97 * The data portion of a mail document is empty.
101 * A directory document is used by a client of the notmuch library to
102 * maintain data necessary to allow for efficient polling of mail
105 * All directory documents contain one term:
107 * directory: The directory path (relative to the database path)
108 * Or the SHA1 sum of the directory path (if the
109 * path itself is too long to fit in a Xapian
112 * And all directory documents for directories other than top-level
113 * directories also contain the following term:
115 * directory-direntry: A colon-separated pair of values
116 * (INTEGER:STRING), where INTEGER is the
117 * document ID of the parent directory
118 * document, and STRING is the name of this
119 * directory within that parent.
121 * All directory documents have a single value:
123 * TIMESTAMP: The mtime of the directory (at last scan)
125 * The data portion of a directory document contains the path of the
126 * directory (relative to the database path).
130 * Xapian allows us to store arbitrary name-value pairs as
131 * "metadata". We currently use the following metadata names with the
134 * version The database schema version, (which is distinct
135 * from both the notmuch package version (see
136 * notmuch --version) and the libnotmuch library
137 * version. The version is stored as an base-10
138 * ASCII integer. The initial database version
139 * was 1, (though a schema existed before that
140 * were no "version" database value existed at
141 * all). Successive versions are allocated as
142 * changes are made to the database (such as by
143 * indexing new fields).
145 * last_thread_id The last thread ID generated. This is stored
146 * as a 16-byte hexadecimal ASCII representation
147 * of a 64-bit unsigned integer. The first ID
148 * generated is 1 and the value will be
149 * incremented for each thread ID.
151 * thread_id_* A pre-allocated thread ID for a particular
152 * message. This is actually an arbitrarily large
153 * family of metadata name. Any particular name is
154 * formed by concatenating "thread_id_" with a message
155 * ID (or the SHA1 sum of a message ID if it is very
156 * long---see description of 'id' in the mail
157 * document). The value stored is a thread ID.
159 * These thread ID metadata values are stored
160 * whenever a message references a parent message
161 * that does not yet exist in the database. A
162 * thread ID will be allocated and stored, and if
163 * the message is later added, the stored thread
164 * ID will be used (and the metadata value will
167 * Even before a message is added, it's
168 * pre-allocated thread ID is useful so that all
169 * descendant messages that reference this common
170 * parent can be recognized as belonging to the
174 /* With these prefix values we follow the conventions published here:
176 * http://xapian.org/docs/omega/termprefixes.html
178 * as much as makes sense. Note that I took some liberty in matching
179 * the reserved prefix values to notmuch concepts, (for example, 'G'
180 * is documented as "newsGroup (or similar entity - e.g. a web forum
181 * name)", for which I think the thread is the closest analogue in
182 * notmuch. This in spite of the fact that we will eventually be
183 * storing mailing-list messages where 'G' for "mailing list name"
184 * might be even a closer analogue. I'm treating the single-character
185 * prefixes preferentially for core notmuch concepts (which will be
186 * nearly universal to all mail messages).
189 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
191 { "reference", "XREFERENCE" },
192 { "replyto", "XREPLYTO" },
193 { "directory", "XDIRECTORY" },
194 { "file-direntry", "XFDIRENTRY" },
195 { "directory-direntry", "XDDIRENTRY" },
198 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
205 static prefix_t PROBABILISTIC_PREFIX[]= {
208 { "attachment", "XATTACHMENT" },
209 { "subject", "XSUBJECT"},
210 { "folder", "XFOLDER"}
214 _find_prefix (const char *name)
218 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
219 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
220 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
223 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
224 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
225 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
228 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
229 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
230 return PROBABILISTIC_PREFIX[i].prefix;
233 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
239 notmuch_status_to_string (notmuch_status_t status)
242 case NOTMUCH_STATUS_SUCCESS:
243 return "No error occurred";
244 case NOTMUCH_STATUS_OUT_OF_MEMORY:
245 return "Out of memory";
246 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
247 return "Attempt to write to a read-only database";
248 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
249 return "A Xapian exception occurred";
250 case NOTMUCH_STATUS_FILE_ERROR:
251 return "Something went wrong trying to read or write a file";
252 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
253 return "File is not an email";
254 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
255 return "Message ID is identical to a message in database";
256 case NOTMUCH_STATUS_NULL_POINTER:
257 return "Erroneous NULL pointer";
258 case NOTMUCH_STATUS_TAG_TOO_LONG:
259 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
260 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
261 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
262 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
263 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
265 case NOTMUCH_STATUS_LAST_STATUS:
266 return "Unknown error status value";
271 find_doc_ids_for_term (notmuch_database_t *notmuch,
273 Xapian::PostingIterator *begin,
274 Xapian::PostingIterator *end)
276 *begin = notmuch->xapian_db->postlist_begin (term);
278 *end = notmuch->xapian_db->postlist_end (term);
282 find_doc_ids (notmuch_database_t *notmuch,
283 const char *prefix_name,
285 Xapian::PostingIterator *begin,
286 Xapian::PostingIterator *end)
290 term = talloc_asprintf (notmuch, "%s%s",
291 _find_prefix (prefix_name), value);
293 find_doc_ids_for_term (notmuch, term, begin, end);
298 notmuch_private_status_t
299 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
300 const char *prefix_name,
302 unsigned int *doc_id)
304 Xapian::PostingIterator i, end;
306 find_doc_ids (notmuch, prefix_name, value, &i, &end);
310 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
315 #if DEBUG_DATABASE_SANITY
319 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
323 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
326 static Xapian::Document
327 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
329 return notmuch->xapian_db->get_document (doc_id);
332 /* Generate a compressed version of 'message_id' of the form:
334 * notmuch-sha1-<sha1_sum_of_message_id>
337 _message_id_compressed (void *ctx, const char *message_id)
339 char *sha1, *compressed;
341 sha1 = notmuch_sha1_of_string (message_id);
343 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
350 notmuch_database_find_message (notmuch_database_t *notmuch,
351 const char *message_id,
352 notmuch_message_t **message_ret)
354 notmuch_private_status_t status;
357 if (message_ret == NULL)
358 return NOTMUCH_STATUS_NULL_POINTER;
360 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
361 message_id = _message_id_compressed (notmuch, message_id);
364 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
365 message_id, &doc_id);
367 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
370 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
372 if (*message_ret == NULL)
373 return NOTMUCH_STATUS_OUT_OF_MEMORY;
376 return NOTMUCH_STATUS_SUCCESS;
377 } catch (const Xapian::Error &error) {
378 fprintf (stderr, "A Xapian exception occurred finding message: %s.\n",
379 error.get_msg().c_str());
380 notmuch->exception_reported = TRUE;
382 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
386 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
387 * a (potentially nested) parenthesized sequence with '\' used to
388 * escape any character (including parentheses).
390 * If the sequence to be skipped continues to the end of the string,
391 * then 'str' will be left pointing at the final terminating '\0'
395 skip_space_and_comments (const char **str)
400 while (*s && (isspace (*s) || *s == '(')) {
401 while (*s && isspace (*s))
406 while (*s && nesting) {
409 } else if (*s == ')') {
411 } else if (*s == '\\') {
423 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
424 * comments, and the '<' and '>' delimiters.
426 * If not NULL, then *next will be made to point to the first character
427 * not parsed, (possibly pointing to the final '\0' terminator.
429 * Returns a newly talloc'ed string belonging to 'ctx'.
431 * Returns NULL if there is any error parsing the message-id. */
433 _parse_message_id (void *ctx, const char *message_id, const char **next)
438 if (message_id == NULL || *message_id == '\0')
443 skip_space_and_comments (&s);
445 /* Skip any unstructured text as well. */
446 while (*s && *s != '<')
457 skip_space_and_comments (&s);
460 while (*end && *end != '>')
469 if (end > s && *end == '>')
474 result = talloc_strndup (ctx, s, end - s + 1);
476 /* Finally, collapse any whitespace that is within the message-id
482 for (r = result, len = strlen (r); *r; r++, len--)
483 if (*r == ' ' || *r == '\t')
484 memmove (r, r+1, len);
490 /* Parse a References header value, putting a (talloc'ed under 'ctx')
491 * copy of each referenced message-id into 'hash'.
493 * We explicitly avoid including any reference identical to
494 * 'message_id' in the result (to avoid mass confusion when a single
495 * message references itself cyclically---and yes, mail messages are
496 * not infrequent in the wild that do this---don't ask me why).
499 parse_references (void *ctx,
500 const char *message_id,
506 if (refs == NULL || *refs == '\0')
510 ref = _parse_message_id (ctx, refs, &refs);
512 if (ref && strcmp (ref, message_id))
513 g_hash_table_insert (hash, ref, NULL);
518 notmuch_database_create (const char *path)
520 notmuch_database_t *notmuch = NULL;
521 char *notmuch_path = NULL;
526 fprintf (stderr, "Error: Cannot create a database for a NULL path.\n");
530 err = stat (path, &st);
532 fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
533 path, strerror (errno));
537 if (! S_ISDIR (st.st_mode)) {
538 fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
543 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
545 err = mkdir (notmuch_path, 0755);
548 fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
549 notmuch_path, strerror (errno));
553 notmuch = notmuch_database_open (path,
554 NOTMUCH_DATABASE_MODE_READ_WRITE);
555 notmuch_database_upgrade (notmuch, NULL, NULL);
559 talloc_free (notmuch_path);
565 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
567 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
568 fprintf (stderr, "Cannot write to a read-only database.\n");
569 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
572 return NOTMUCH_STATUS_SUCCESS;
576 notmuch_database_open (const char *path,
577 notmuch_database_mode_t mode)
579 notmuch_database_t *notmuch = NULL;
580 char *notmuch_path = NULL, *xapian_path = NULL;
583 unsigned int i, version;
585 if (asprintf (¬much_path, "%s/%s", path, ".notmuch") == -1) {
587 fprintf (stderr, "Out of memory\n");
591 err = stat (notmuch_path, &st);
593 fprintf (stderr, "Error opening database at %s: %s\n",
594 notmuch_path, strerror (errno));
598 if (asprintf (&xapian_path, "%s/%s", notmuch_path, "xapian") == -1) {
600 fprintf (stderr, "Out of memory\n");
604 /* Initialize the GLib type system and threads */
607 notmuch = talloc (NULL, notmuch_database_t);
608 notmuch->exception_reported = FALSE;
609 notmuch->path = talloc_strdup (notmuch, path);
611 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
612 notmuch->path[strlen (notmuch->path) - 1] = '\0';
614 notmuch->needs_upgrade = FALSE;
615 notmuch->mode = mode;
616 notmuch->atomic_nesting = 0;
618 string last_thread_id;
620 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
621 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
622 Xapian::DB_CREATE_OR_OPEN);
623 version = notmuch_database_get_version (notmuch);
625 if (version > NOTMUCH_DATABASE_VERSION) {
627 "Error: Notmuch database at %s\n"
628 " has a newer database format version (%u) than supported by this\n"
629 " version of notmuch (%u). Refusing to open this database in\n"
630 " read-write mode.\n",
631 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
632 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
633 notmuch_database_close (notmuch);
638 if (version < NOTMUCH_DATABASE_VERSION)
639 notmuch->needs_upgrade = TRUE;
641 notmuch->xapian_db = new Xapian::Database (xapian_path);
642 version = notmuch_database_get_version (notmuch);
643 if (version > NOTMUCH_DATABASE_VERSION)
646 "Warning: Notmuch database at %s\n"
647 " has a newer database format version (%u) than supported by this\n"
648 " version of notmuch (%u). Some operations may behave incorrectly,\n"
649 " (but the database will not be harmed since it is being opened\n"
650 " in read-only mode).\n",
651 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
655 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
656 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
657 if (last_thread_id.empty ()) {
658 notmuch->last_thread_id = 0;
663 str = last_thread_id.c_str ();
664 notmuch->last_thread_id = strtoull (str, &end, 16);
666 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
669 notmuch->query_parser = new Xapian::QueryParser;
670 notmuch->term_gen = new Xapian::TermGenerator;
671 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
672 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
674 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
675 notmuch->query_parser->set_database (*notmuch->xapian_db);
676 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
677 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
678 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
680 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
681 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
682 notmuch->query_parser->add_boolean_prefix (prefix->name,
686 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
687 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
688 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
690 } catch (const Xapian::Error &error) {
691 fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
692 error.get_msg().c_str());
706 notmuch_database_close (notmuch_database_t *notmuch)
709 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
710 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
711 } catch (const Xapian::Error &error) {
712 if (! notmuch->exception_reported) {
713 fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
714 error.get_msg().c_str());
718 delete notmuch->term_gen;
719 delete notmuch->query_parser;
720 delete notmuch->xapian_db;
721 delete notmuch->value_range_processor;
722 talloc_free (notmuch);
726 notmuch_database_get_path (notmuch_database_t *notmuch)
728 return notmuch->path;
732 notmuch_database_get_version (notmuch_database_t *notmuch)
734 unsigned int version;
735 string version_string;
739 version_string = notmuch->xapian_db->get_metadata ("version");
740 if (version_string.empty ())
743 str = version_string.c_str ();
744 if (str == NULL || *str == '\0')
747 version = strtoul (str, &end, 10);
749 INTERNAL_ERROR ("Malformed database version: %s", str);
755 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
757 return notmuch->needs_upgrade;
760 static volatile sig_atomic_t do_progress_notify = 0;
763 handle_sigalrm (unused (int signal))
765 do_progress_notify = 1;
768 /* Upgrade the current database.
770 * After opening a database in read-write mode, the client should
771 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
772 * if so, upgrade with this function before making any modifications.
774 * The optional progress_notify callback can be used by the caller to
775 * provide progress indication to the user. If non-NULL it will be
776 * called periodically with 'count' as the number of messages upgraded
777 * so far and 'total' the overall number of messages that will be
781 notmuch_database_upgrade (notmuch_database_t *notmuch,
782 void (*progress_notify) (void *closure,
786 Xapian::WritableDatabase *db;
787 struct sigaction action;
788 struct itimerval timerval;
789 notmuch_bool_t timer_is_active = FALSE;
790 unsigned int version;
791 notmuch_status_t status;
792 unsigned int count = 0, total = 0;
794 status = _notmuch_database_ensure_writable (notmuch);
798 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
800 version = notmuch_database_get_version (notmuch);
802 if (version >= NOTMUCH_DATABASE_VERSION)
803 return NOTMUCH_STATUS_SUCCESS;
805 if (progress_notify) {
806 /* Setup our handler for SIGALRM */
807 memset (&action, 0, sizeof (struct sigaction));
808 action.sa_handler = handle_sigalrm;
809 sigemptyset (&action.sa_mask);
810 action.sa_flags = SA_RESTART;
811 sigaction (SIGALRM, &action, NULL);
813 /* Then start a timer to send SIGALRM once per second. */
814 timerval.it_interval.tv_sec = 1;
815 timerval.it_interval.tv_usec = 0;
816 timerval.it_value.tv_sec = 1;
817 timerval.it_value.tv_usec = 0;
818 setitimer (ITIMER_REAL, &timerval, NULL);
820 timer_is_active = TRUE;
823 /* Before version 1, each message document had its filename in the
824 * data field. Copy that into the new format by calling
825 * notmuch_message_add_filename.
828 notmuch_query_t *query = notmuch_query_create (notmuch, "");
829 notmuch_messages_t *messages;
830 notmuch_message_t *message;
832 Xapian::TermIterator t, t_end;
834 total = notmuch_query_count_messages (query);
836 for (messages = notmuch_query_search_messages (query);
837 notmuch_messages_valid (messages);
838 notmuch_messages_move_to_next (messages))
840 if (do_progress_notify) {
841 progress_notify (closure, (double) count / total);
842 do_progress_notify = 0;
845 message = notmuch_messages_get (messages);
847 filename = _notmuch_message_talloc_copy_data (message);
848 if (filename && *filename != '\0') {
849 _notmuch_message_add_filename (message, filename);
850 _notmuch_message_sync (message);
852 talloc_free (filename);
854 notmuch_message_destroy (message);
859 notmuch_query_destroy (query);
861 /* Also, before version 1 we stored directory timestamps in
862 * XTIMESTAMP documents instead of the current XDIRECTORY
863 * documents. So copy those as well. */
865 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
867 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
871 Xapian::PostingIterator p, p_end;
872 std::string term = *t;
874 p_end = notmuch->xapian_db->postlist_end (term);
876 for (p = notmuch->xapian_db->postlist_begin (term);
880 Xapian::Document document;
882 notmuch_directory_t *directory;
884 if (do_progress_notify) {
885 progress_notify (closure, (double) count / total);
886 do_progress_notify = 0;
889 document = find_document_for_doc_id (notmuch, *p);
890 mtime = Xapian::sortable_unserialise (
891 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
893 directory = notmuch_database_get_directory (notmuch,
895 notmuch_directory_set_mtime (directory, mtime);
896 notmuch_directory_destroy (directory);
901 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
904 /* Now that the upgrade is complete we can remove the old data
905 * and documents that are no longer needed. */
907 notmuch_query_t *query = notmuch_query_create (notmuch, "");
908 notmuch_messages_t *messages;
909 notmuch_message_t *message;
912 for (messages = notmuch_query_search_messages (query);
913 notmuch_messages_valid (messages);
914 notmuch_messages_move_to_next (messages))
916 if (do_progress_notify) {
917 progress_notify (closure, (double) count / total);
918 do_progress_notify = 0;
921 message = notmuch_messages_get (messages);
923 filename = _notmuch_message_talloc_copy_data (message);
924 if (filename && *filename != '\0') {
925 _notmuch_message_clear_data (message);
926 _notmuch_message_sync (message);
928 talloc_free (filename);
930 notmuch_message_destroy (message);
933 notmuch_query_destroy (query);
937 Xapian::TermIterator t, t_end;
939 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
941 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
945 Xapian::PostingIterator p, p_end;
946 std::string term = *t;
948 p_end = notmuch->xapian_db->postlist_end (term);
950 for (p = notmuch->xapian_db->postlist_begin (term);
954 if (do_progress_notify) {
955 progress_notify (closure, (double) count / total);
956 do_progress_notify = 0;
959 db->delete_document (*p);
964 if (timer_is_active) {
965 /* Now stop the timer. */
966 timerval.it_interval.tv_sec = 0;
967 timerval.it_interval.tv_usec = 0;
968 timerval.it_value.tv_sec = 0;
969 timerval.it_value.tv_usec = 0;
970 setitimer (ITIMER_REAL, &timerval, NULL);
972 /* And disable the signal handler. */
973 action.sa_handler = SIG_IGN;
974 sigaction (SIGALRM, &action, NULL);
977 return NOTMUCH_STATUS_SUCCESS;
981 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
983 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
984 notmuch->atomic_nesting > 0)
988 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
989 } catch (const Xapian::Error &error) {
990 fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
991 error.get_msg().c_str());
992 notmuch->exception_reported = TRUE;
993 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
997 notmuch->atomic_nesting++;
998 return NOTMUCH_STATUS_SUCCESS;
1002 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1004 Xapian::WritableDatabase *db;
1006 if (notmuch->atomic_nesting == 0)
1007 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1009 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1010 notmuch->atomic_nesting > 1)
1013 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1015 db->commit_transaction ();
1017 /* This is a hack for testing. Xapian never flushes on a
1018 * non-flushed commit, even if the flush threshold is 1.
1019 * However, we rely on flushing to test atomicity. */
1020 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1021 if (thresh && atoi (thresh) == 1)
1023 } catch (const Xapian::Error &error) {
1024 fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1025 error.get_msg().c_str());
1026 notmuch->exception_reported = TRUE;
1027 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1031 notmuch->atomic_nesting--;
1032 return NOTMUCH_STATUS_SUCCESS;
1035 /* We allow the user to use arbitrarily long paths for directories. But
1036 * we have a term-length limit. So if we exceed that, we'll use the
1037 * SHA-1 of the path for the database term.
1039 * Note: This function may return the original value of 'path'. If it
1040 * does not, then the caller is responsible to free() the returned
1044 _notmuch_database_get_directory_db_path (const char *path)
1046 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1048 if (term_len > NOTMUCH_TERM_MAX)
1049 return notmuch_sha1_of_string (path);
1054 /* Given a path, split it into two parts: the directory part is all
1055 * components except for the last, and the basename is that last
1056 * component. Getting the return-value for either part is optional
1057 * (the caller can pass NULL).
1059 * The original 'path' can represent either a regular file or a
1060 * directory---the splitting will be carried out in the same way in
1061 * either case. Trailing slashes on 'path' will be ignored, and any
1062 * cases of multiple '/' characters appearing in series will be
1063 * treated as a single '/'.
1065 * Allocation (if any) will have 'ctx' as the talloc owner. But
1066 * pointers will be returned within the original path string whenever
1069 * Note: If 'path' is non-empty and contains no non-trailing slash,
1070 * (that is, consists of a filename with no parent directory), then
1071 * the directory returned will be an empty string. However, if 'path'
1072 * is an empty string, then both directory and basename will be
1076 _notmuch_database_split_path (void *ctx,
1078 const char **directory,
1079 const char **basename)
1083 if (path == NULL || *path == '\0') {
1088 return NOTMUCH_STATUS_SUCCESS;
1091 /* Find the last slash (not counting a trailing slash), if any. */
1093 slash = path + strlen (path) - 1;
1095 /* First, skip trailing slashes. */
1096 while (slash != path) {
1103 /* Then, find a slash. */
1104 while (slash != path) {
1114 /* Finally, skip multiple slashes. */
1115 while (slash != path) {
1122 if (slash == path) {
1124 *directory = talloc_strdup (ctx, "");
1129 *directory = talloc_strndup (ctx, path, slash - path + 1);
1132 return NOTMUCH_STATUS_SUCCESS;
1136 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1138 unsigned int *directory_id)
1140 notmuch_directory_t *directory;
1141 notmuch_status_t status;
1145 return NOTMUCH_STATUS_SUCCESS;
1148 directory = _notmuch_directory_create (notmuch, path, &status);
1154 *directory_id = _notmuch_directory_get_document_id (directory);
1156 notmuch_directory_destroy (directory);
1158 return NOTMUCH_STATUS_SUCCESS;
1162 _notmuch_database_get_directory_path (void *ctx,
1163 notmuch_database_t *notmuch,
1164 unsigned int doc_id)
1166 Xapian::Document document;
1168 document = find_document_for_doc_id (notmuch, doc_id);
1170 return talloc_strdup (ctx, document.get_data ().c_str ());
1173 /* Given a legal 'filename' for the database, (either relative to
1174 * database path or absolute with initial components identical to
1175 * database path), return a new string (with 'ctx' as the talloc
1176 * owner) suitable for use as a direntry term value.
1178 * The necessary directory documents will be created in the database
1182 _notmuch_database_filename_to_direntry (void *ctx,
1183 notmuch_database_t *notmuch,
1184 const char *filename,
1187 const char *relative, *directory, *basename;
1188 Xapian::docid directory_id;
1189 notmuch_status_t status;
1191 relative = _notmuch_database_relative_path (notmuch, filename);
1193 status = _notmuch_database_split_path (ctx, relative,
1194 &directory, &basename);
1198 status = _notmuch_database_find_directory_id (notmuch, directory,
1203 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1205 return NOTMUCH_STATUS_SUCCESS;
1208 /* Given a legal 'path' for the database, return the relative path.
1210 * The return value will be a pointer to the original path contents,
1211 * and will be either the original string (if 'path' was relative) or
1212 * a portion of the string (if path was absolute and begins with the
1216 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1219 const char *db_path, *relative;
1220 unsigned int db_path_len;
1222 db_path = notmuch_database_get_path (notmuch);
1223 db_path_len = strlen (db_path);
1227 if (*relative == '/') {
1228 while (*relative == '/' && *(relative+1) == '/')
1231 if (strncmp (relative, db_path, db_path_len) == 0)
1233 relative += db_path_len;
1234 while (*relative == '/')
1242 notmuch_directory_t *
1243 notmuch_database_get_directory (notmuch_database_t *notmuch,
1246 notmuch_status_t status;
1249 return _notmuch_directory_create (notmuch, path, &status);
1250 } catch (const Xapian::Error &error) {
1251 fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1252 error.get_msg().c_str());
1253 notmuch->exception_reported = TRUE;
1258 /* Allocate a document ID that satisfies the following criteria:
1260 * 1. The ID does not exist for any document in the Xapian database
1262 * 2. The ID was not previously returned from this function
1264 * 3. The ID is the smallest integer satisfying (1) and (2)
1266 * This function will trigger an internal error if these constraints
1267 * cannot all be satisfied, (that is, the pool of available document
1268 * IDs has been exhausted).
1271 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1273 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1275 notmuch->last_doc_id++;
1277 if (notmuch->last_doc_id == 0)
1278 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1280 return notmuch->last_doc_id;
1284 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1286 /* 16 bytes (+ terminator) for hexadecimal representation of
1287 * a 64-bit integer. */
1288 static char thread_id[17];
1289 Xapian::WritableDatabase *db;
1291 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1293 notmuch->last_thread_id++;
1295 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1297 db->set_metadata ("last_thread_id", thread_id);
1303 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1305 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1306 message_id = _message_id_compressed (ctx, message_id);
1308 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1312 /* Find the thread ID to which the message with 'message_id' belongs.
1314 * Note: 'thread_id_ret' must not be NULL!
1315 * On success '*thread_id_ret' is set to a newly talloced string belonging to
1318 * Note: If there is no message in the database with the given
1319 * 'message_id' then a new thread_id will be allocated for this
1320 * message and stored in the database metadata, (where this same
1321 * thread ID can be looked up if the message is added to the database
1324 static notmuch_status_t
1325 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1327 const char *message_id,
1328 const char **thread_id_ret)
1330 notmuch_status_t status;
1331 notmuch_message_t *message;
1332 string thread_id_string;
1334 Xapian::WritableDatabase *db;
1336 status = notmuch_database_find_message (notmuch, message_id, &message);
1342 *thread_id_ret = talloc_steal (ctx,
1343 notmuch_message_get_thread_id (message));
1345 notmuch_message_destroy (message);
1347 return NOTMUCH_STATUS_SUCCESS;
1350 /* Message has not been seen yet.
1352 * We may have seen a reference to it already, in which case, we
1353 * can return the thread ID stored in the metadata. Otherwise, we
1354 * generate a new thread ID and store it there.
1356 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1357 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1358 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1360 if (thread_id_string.empty()) {
1361 *thread_id_ret = talloc_strdup (ctx,
1362 _notmuch_database_generate_thread_id (notmuch));
1363 db->set_metadata (metadata_key, *thread_id_ret);
1365 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1368 talloc_free (metadata_key);
1370 return NOTMUCH_STATUS_SUCCESS;
1373 static notmuch_status_t
1374 _merge_threads (notmuch_database_t *notmuch,
1375 const char *winner_thread_id,
1376 const char *loser_thread_id)
1378 Xapian::PostingIterator loser, loser_end;
1379 notmuch_message_t *message = NULL;
1380 notmuch_private_status_t private_status;
1381 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1383 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1385 for ( ; loser != loser_end; loser++) {
1386 message = _notmuch_message_create (notmuch, notmuch,
1387 *loser, &private_status);
1388 if (message == NULL) {
1389 ret = COERCE_STATUS (private_status,
1390 "Cannot find document for doc_id from query");
1394 _notmuch_message_remove_term (message, "thread", loser_thread_id);
1395 _notmuch_message_add_term (message, "thread", winner_thread_id);
1396 _notmuch_message_sync (message);
1398 notmuch_message_destroy (message);
1404 notmuch_message_destroy (message);
1410 _my_talloc_free_for_g_hash (void *ptr)
1415 static notmuch_status_t
1416 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1417 notmuch_message_t *message,
1418 notmuch_message_file_t *message_file,
1419 const char **thread_id)
1421 GHashTable *parents = NULL;
1422 const char *refs, *in_reply_to, *in_reply_to_message_id;
1423 GList *l, *keys = NULL;
1424 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1426 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1427 _my_talloc_free_for_g_hash, NULL);
1429 refs = notmuch_message_file_get_header (message_file, "references");
1430 parse_references (message, notmuch_message_get_message_id (message),
1433 in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1434 parse_references (message, notmuch_message_get_message_id (message),
1435 parents, in_reply_to);
1437 /* Carefully avoid adding any self-referential in-reply-to term. */
1438 in_reply_to_message_id = _parse_message_id (message, in_reply_to, NULL);
1439 if (in_reply_to_message_id &&
1440 strcmp (in_reply_to_message_id,
1441 notmuch_message_get_message_id (message)))
1443 _notmuch_message_add_term (message, "replyto",
1444 _parse_message_id (message, in_reply_to, NULL));
1447 keys = g_hash_table_get_keys (parents);
1448 for (l = keys; l; l = l->next) {
1449 char *parent_message_id;
1450 const char *parent_thread_id;
1452 parent_message_id = (char *) l->data;
1454 _notmuch_message_add_term (message, "reference",
1457 ret = _resolve_message_id_to_thread_id (notmuch,
1464 if (*thread_id == NULL) {
1465 *thread_id = talloc_strdup (message, parent_thread_id);
1466 _notmuch_message_add_term (message, "thread", *thread_id);
1467 } else if (strcmp (*thread_id, parent_thread_id)) {
1468 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1478 g_hash_table_unref (parents);
1483 static notmuch_status_t
1484 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1485 notmuch_message_t *message,
1486 const char **thread_id)
1488 const char *message_id = notmuch_message_get_message_id (message);
1489 Xapian::PostingIterator child, children_end;
1490 notmuch_message_t *child_message = NULL;
1491 const char *child_thread_id;
1492 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1493 notmuch_private_status_t private_status;
1495 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1497 for ( ; child != children_end; child++) {
1499 child_message = _notmuch_message_create (message, notmuch,
1500 *child, &private_status);
1501 if (child_message == NULL) {
1502 ret = COERCE_STATUS (private_status,
1503 "Cannot find document for doc_id from query");
1507 child_thread_id = notmuch_message_get_thread_id (child_message);
1508 if (*thread_id == NULL) {
1509 *thread_id = talloc_strdup (message, child_thread_id);
1510 _notmuch_message_add_term (message, "thread", *thread_id);
1511 } else if (strcmp (*thread_id, child_thread_id)) {
1512 _notmuch_message_remove_term (child_message, "reference",
1514 _notmuch_message_sync (child_message);
1515 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1520 notmuch_message_destroy (child_message);
1521 child_message = NULL;
1526 notmuch_message_destroy (child_message);
1531 /* Given a (mostly empty) 'message' and its corresponding
1532 * 'message_file' link it to existing threads in the database.
1534 * The first check is in the metadata of the database to see if we
1535 * have pre-allocated a thread_id in advance for this message, (which
1536 * would have happened if a message was previously added that
1537 * referenced this one).
1539 * Second, we look at 'message_file' and its link-relevant headers
1540 * (References and In-Reply-To) for message IDs.
1542 * Finally, we look in the database for existing message that
1543 * reference 'message'.
1545 * In all cases, we assign to the current message the first thread_id
1546 * found (through either parent or child). We will also merge any
1547 * existing, distinct threads where this message belongs to both,
1548 * (which is not uncommon when messages are processed out of order).
1550 * Finally, if no thread ID has been found through parent or child, we
1551 * call _notmuch_message_generate_thread_id to generate a new thread
1552 * ID. This should only happen for new, top-level messages, (no
1553 * References or In-Reply-To header in this message, and no previously
1554 * added message refers to this message).
1556 static notmuch_status_t
1557 _notmuch_database_link_message (notmuch_database_t *notmuch,
1558 notmuch_message_t *message,
1559 notmuch_message_file_t *message_file)
1561 notmuch_status_t status;
1562 const char *message_id, *thread_id = NULL;
1566 message_id = notmuch_message_get_message_id (message);
1567 metadata_key = _get_metadata_thread_id_key (message, message_id);
1569 /* Check if we have already seen related messages to this one.
1570 * If we have then use the thread_id that we stored at that time.
1572 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1573 if (! stored_id.empty()) {
1574 Xapian::WritableDatabase *db;
1576 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1578 /* Clear the metadata for this message ID. We don't need it
1580 db->set_metadata (metadata_key, "");
1581 thread_id = stored_id.c_str();
1583 _notmuch_message_add_term (message, "thread", thread_id);
1585 talloc_free (metadata_key);
1587 status = _notmuch_database_link_message_to_parents (notmuch, message,
1593 status = _notmuch_database_link_message_to_children (notmuch, message,
1598 /* If not part of any existing thread, generate a new thread ID. */
1599 if (thread_id == NULL) {
1600 thread_id = _notmuch_database_generate_thread_id (notmuch);
1602 _notmuch_message_add_term (message, "thread", thread_id);
1605 return NOTMUCH_STATUS_SUCCESS;
1609 notmuch_database_add_message (notmuch_database_t *notmuch,
1610 const char *filename,
1611 notmuch_message_t **message_ret)
1613 notmuch_message_file_t *message_file;
1614 notmuch_message_t *message = NULL;
1615 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1616 notmuch_private_status_t private_status;
1618 const char *date, *header;
1619 const char *from, *to, *subject;
1620 char *message_id = NULL;
1623 *message_ret = NULL;
1625 ret = _notmuch_database_ensure_writable (notmuch);
1629 message_file = notmuch_message_file_open (filename);
1630 if (message_file == NULL)
1631 return NOTMUCH_STATUS_FILE_ERROR;
1633 /* Adding a message may change many documents. Do this all
1635 ret = notmuch_database_begin_atomic (notmuch);
1639 notmuch_message_file_restrict_headers (message_file,
1650 /* Before we do any real work, (especially before doing a
1651 * potential SHA-1 computation on the entire file's contents),
1652 * let's make sure that what we're looking at looks like an
1653 * actual email message.
1655 from = notmuch_message_file_get_header (message_file, "from");
1656 subject = notmuch_message_file_get_header (message_file, "subject");
1657 to = notmuch_message_file_get_header (message_file, "to");
1659 if ((from == NULL || *from == '\0') &&
1660 (subject == NULL || *subject == '\0') &&
1661 (to == NULL || *to == '\0'))
1663 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1667 /* Now that we're sure it's mail, the first order of business
1668 * is to find a message ID (or else create one ourselves). */
1670 header = notmuch_message_file_get_header (message_file, "message-id");
1671 if (header && *header != '\0') {
1672 message_id = _parse_message_id (message_file, header, NULL);
1674 /* So the header value isn't RFC-compliant, but it's
1675 * better than no message-id at all. */
1676 if (message_id == NULL)
1677 message_id = talloc_strdup (message_file, header);
1679 /* If a message ID is too long, substitute its sha1 instead. */
1680 if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1681 char *compressed = _message_id_compressed (message_file,
1683 talloc_free (message_id);
1684 message_id = compressed;
1688 if (message_id == NULL ) {
1689 /* No message-id at all, let's generate one by taking a
1690 * hash over the file's contents. */
1691 char *sha1 = notmuch_sha1_of_file (filename);
1693 /* If that failed too, something is really wrong. Give up. */
1695 ret = NOTMUCH_STATUS_FILE_ERROR;
1699 message_id = talloc_asprintf (message_file,
1700 "notmuch-sha1-%s", sha1);
1704 /* Now that we have a message ID, we get a message object,
1705 * (which may or may not reference an existing document in the
1708 message = _notmuch_message_create_for_message_id (notmuch,
1712 talloc_free (message_id);
1714 if (message == NULL) {
1715 ret = COERCE_STATUS (private_status,
1716 "Unexpected status value from _notmuch_message_create_for_message_id");
1720 _notmuch_message_add_filename (message, filename);
1722 /* Is this a newly created message object? */
1723 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1724 _notmuch_message_add_term (message, "type", "mail");
1726 ret = _notmuch_database_link_message (notmuch, message,
1731 date = notmuch_message_file_get_header (message_file, "date");
1732 _notmuch_message_set_header_values (message, date, from, subject);
1734 _notmuch_message_index_file (message, filename);
1736 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1739 _notmuch_message_sync (message);
1740 } catch (const Xapian::Error &error) {
1741 fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
1742 error.get_msg().c_str());
1743 notmuch->exception_reported = TRUE;
1744 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1750 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1751 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
1752 *message_ret = message;
1754 notmuch_message_destroy (message);
1758 notmuch_message_file_close (message_file);
1760 ret2 = notmuch_database_end_atomic (notmuch);
1761 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1762 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
1763 ret2 != NOTMUCH_STATUS_SUCCESS)
1770 notmuch_database_remove_message (notmuch_database_t *notmuch,
1771 const char *filename)
1773 notmuch_status_t status;
1774 notmuch_message_t *message;
1776 status = notmuch_database_find_message_by_filename (notmuch, filename,
1779 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1780 status = _notmuch_message_remove_filename (message, filename);
1781 if (status == NOTMUCH_STATUS_SUCCESS)
1782 _notmuch_message_delete (message);
1783 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1784 _notmuch_message_sync (message);
1786 notmuch_message_destroy (message);
1793 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1794 const char *filename,
1795 notmuch_message_t **message_ret)
1798 const char *prefix = _find_prefix ("file-direntry");
1799 char *direntry, *term;
1800 Xapian::PostingIterator i, end;
1801 notmuch_status_t status;
1803 if (message_ret == NULL)
1804 return NOTMUCH_STATUS_NULL_POINTER;
1806 local = talloc_new (notmuch);
1809 status = _notmuch_database_filename_to_direntry (local, notmuch,
1810 filename, &direntry);
1814 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1816 find_doc_ids_for_term (notmuch, term, &i, &end);
1819 notmuch_private_status_t private_status;
1821 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1823 if (*message_ret == NULL)
1824 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1826 } catch (const Xapian::Error &error) {
1827 fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
1828 error.get_msg().c_str());
1829 notmuch->exception_reported = TRUE;
1830 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1834 talloc_free (local);
1836 if (status && *message_ret) {
1837 notmuch_message_destroy (*message_ret);
1838 *message_ret = NULL;
1843 notmuch_string_list_t *
1844 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1845 Xapian::TermIterator &end,
1848 int prefix_len = strlen (prefix);
1849 notmuch_string_list_t *list;
1851 list = _notmuch_string_list_create (ctx);
1852 if (unlikely (list == NULL))
1855 for (i.skip_to (prefix); i != end; i++) {
1856 /* Terminate loop at first term without desired prefix. */
1857 if (strncmp ((*i).c_str (), prefix, prefix_len))
1860 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1867 notmuch_database_get_all_tags (notmuch_database_t *db)
1869 Xapian::TermIterator i, end;
1870 notmuch_string_list_t *tags;
1873 i = db->xapian_db->allterms_begin();
1874 end = db->xapian_db->allterms_end();
1875 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1876 _find_prefix ("tag"));
1877 _notmuch_string_list_sort (tags);
1878 return _notmuch_tags_create (db, tags);
1879 } catch (const Xapian::Error &error) {
1880 fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
1881 error.get_msg().c_str());
1882 db->exception_reported = TRUE;