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 */
31 #include <gmime/gmime.h> /* g_mime_init */
35 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
42 #define NOTMUCH_DATABASE_VERSION 1
44 #define STRINGIFY(s) _SUB_STRINGIFY(s)
45 #define _SUB_STRINGIFY(s) #s
47 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
49 * We currently have two different types of documents (mail and
50 * directory) and also some metadata.
54 * A mail document is associated with a particular email message file
55 * on disk. It is indexed with the following prefixed terms which the
56 * database uses to construct threads, etc.:
58 * Single terms of given prefix:
62 * id: Unique ID of mail. This is from the Message-ID header
63 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
64 * If it's present and too long, then we use
65 * "notmuch-sha1-<sha1_sum_of_message_id>".
66 * If this header is not present, we use
67 * "notmuch-sha1-<sha1_sum_of_entire_file>".
69 * thread: The ID of the thread to which the mail belongs
71 * replyto: The ID from the In-Reply-To header of the mail (if any).
73 * Multiple terms of given prefix:
75 * reference: All message IDs from In-Reply-To and References
76 * headers in the message.
78 * tag: Any tags associated with this message by the user.
80 * file-direntry: A colon-separated pair of values
81 * (INTEGER:STRING), where INTEGER is the
82 * document ID of a directory document, and
83 * STRING is the name of a file within that
84 * directory for this mail message.
86 * A mail document also has four values:
88 * TIMESTAMP: The time_t value corresponding to the message's
91 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
93 * FROM: The value of the "From" header
95 * SUBJECT: The value of the "Subject" header
97 * In addition, terms from the content of the message are added with
98 * "from", "to", "attachment", and "subject" prefixes for use by the
99 * user in searching. Similarly, terms from the path of the mail
100 * message are added with a "folder" prefix. But the database doesn't
101 * really care itself about any of these.
103 * The data portion of a mail document is empty.
107 * A directory document is used by a client of the notmuch library to
108 * maintain data necessary to allow for efficient polling of mail
111 * All directory documents contain one term:
113 * directory: The directory path (relative to the database path)
114 * Or the SHA1 sum of the directory path (if the
115 * path itself is too long to fit in a Xapian
118 * And all directory documents for directories other than top-level
119 * directories also contain the following term:
121 * directory-direntry: A colon-separated pair of values
122 * (INTEGER:STRING), where INTEGER is the
123 * document ID of the parent directory
124 * document, and STRING is the name of this
125 * directory within that parent.
127 * All directory documents have a single value:
129 * TIMESTAMP: The mtime of the directory (at last scan)
131 * The data portion of a directory document contains the path of the
132 * directory (relative to the database path).
136 * Xapian allows us to store arbitrary name-value pairs as
137 * "metadata". We currently use the following metadata names with the
140 * version The database schema version, (which is distinct
141 * from both the notmuch package version (see
142 * notmuch --version) and the libnotmuch library
143 * version. The version is stored as an base-10
144 * ASCII integer. The initial database version
145 * was 1, (though a schema existed before that
146 * were no "version" database value existed at
147 * all). Successive versions are allocated as
148 * changes are made to the database (such as by
149 * indexing new fields).
151 * last_thread_id The last thread ID generated. This is stored
152 * as a 16-byte hexadecimal ASCII representation
153 * of a 64-bit unsigned integer. The first ID
154 * generated is 1 and the value will be
155 * incremented for each thread ID.
157 * thread_id_* A pre-allocated thread ID for a particular
158 * message. This is actually an arbitrarily large
159 * family of metadata name. Any particular name is
160 * formed by concatenating "thread_id_" with a message
161 * ID (or the SHA1 sum of a message ID if it is very
162 * long---see description of 'id' in the mail
163 * document). The value stored is a thread ID.
165 * These thread ID metadata values are stored
166 * whenever a message references a parent message
167 * that does not yet exist in the database. A
168 * thread ID will be allocated and stored, and if
169 * the message is later added, the stored thread
170 * ID will be used (and the metadata value will
173 * Even before a message is added, it's
174 * pre-allocated thread ID is useful so that all
175 * descendant messages that reference this common
176 * parent can be recognized as belonging to the
180 /* With these prefix values we follow the conventions published here:
182 * http://xapian.org/docs/omega/termprefixes.html
184 * as much as makes sense. Note that I took some liberty in matching
185 * the reserved prefix values to notmuch concepts, (for example, 'G'
186 * is documented as "newsGroup (or similar entity - e.g. a web forum
187 * name)", for which I think the thread is the closest analogue in
188 * notmuch. This in spite of the fact that we will eventually be
189 * storing mailing-list messages where 'G' for "mailing list name"
190 * might be even a closer analogue. I'm treating the single-character
191 * prefixes preferentially for core notmuch concepts (which will be
192 * nearly universal to all mail messages).
195 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
197 { "reference", "XREFERENCE" },
198 { "replyto", "XREPLYTO" },
199 { "directory", "XDIRECTORY" },
200 { "file-direntry", "XFDIRENTRY" },
201 { "directory-direntry", "XDDIRENTRY" },
204 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
211 static prefix_t PROBABILISTIC_PREFIX[]= {
214 { "attachment", "XATTACHMENT" },
215 { "subject", "XSUBJECT"},
216 { "folder", "XFOLDER"}
220 _find_prefix (const char *name)
224 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
225 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
226 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
229 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
230 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
231 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
234 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
235 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
236 return PROBABILISTIC_PREFIX[i].prefix;
239 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
245 notmuch_status_to_string (notmuch_status_t status)
248 case NOTMUCH_STATUS_SUCCESS:
249 return "No error occurred";
250 case NOTMUCH_STATUS_OUT_OF_MEMORY:
251 return "Out of memory";
252 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
253 return "Attempt to write to a read-only database";
254 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
255 return "A Xapian exception occurred";
256 case NOTMUCH_STATUS_FILE_ERROR:
257 return "Something went wrong trying to read or write a file";
258 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
259 return "File is not an email";
260 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
261 return "Message ID is identical to a message in database";
262 case NOTMUCH_STATUS_NULL_POINTER:
263 return "Erroneous NULL pointer";
264 case NOTMUCH_STATUS_TAG_TOO_LONG:
265 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
266 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
267 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
268 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
269 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
271 case NOTMUCH_STATUS_LAST_STATUS:
272 return "Unknown error status value";
277 find_doc_ids_for_term (notmuch_database_t *notmuch,
279 Xapian::PostingIterator *begin,
280 Xapian::PostingIterator *end)
282 *begin = notmuch->xapian_db->postlist_begin (term);
284 *end = notmuch->xapian_db->postlist_end (term);
288 find_doc_ids (notmuch_database_t *notmuch,
289 const char *prefix_name,
291 Xapian::PostingIterator *begin,
292 Xapian::PostingIterator *end)
296 term = talloc_asprintf (notmuch, "%s%s",
297 _find_prefix (prefix_name), value);
299 find_doc_ids_for_term (notmuch, term, begin, end);
304 notmuch_private_status_t
305 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
306 const char *prefix_name,
308 unsigned int *doc_id)
310 Xapian::PostingIterator i, end;
312 find_doc_ids (notmuch, prefix_name, value, &i, &end);
316 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
321 #if DEBUG_DATABASE_SANITY
325 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
329 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
332 static Xapian::Document
333 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
335 return notmuch->xapian_db->get_document (doc_id);
338 /* Generate a compressed version of 'message_id' of the form:
340 * notmuch-sha1-<sha1_sum_of_message_id>
343 _message_id_compressed (void *ctx, const char *message_id)
345 char *sha1, *compressed;
347 sha1 = notmuch_sha1_of_string (message_id);
349 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
356 notmuch_database_find_message (notmuch_database_t *notmuch,
357 const char *message_id,
358 notmuch_message_t **message_ret)
360 notmuch_private_status_t status;
363 if (message_ret == NULL)
364 return NOTMUCH_STATUS_NULL_POINTER;
366 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
367 message_id = _message_id_compressed (notmuch, message_id);
370 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
371 message_id, &doc_id);
373 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
376 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
378 if (*message_ret == NULL)
379 return NOTMUCH_STATUS_OUT_OF_MEMORY;
382 return NOTMUCH_STATUS_SUCCESS;
383 } catch (const Xapian::Error &error) {
384 fprintf (stderr, "A Xapian exception occurred finding message: %s.\n",
385 error.get_msg().c_str());
386 notmuch->exception_reported = TRUE;
388 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
392 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
393 * a (potentially nested) parenthesized sequence with '\' used to
394 * escape any character (including parentheses).
396 * If the sequence to be skipped continues to the end of the string,
397 * then 'str' will be left pointing at the final terminating '\0'
401 skip_space_and_comments (const char **str)
406 while (*s && (isspace (*s) || *s == '(')) {
407 while (*s && isspace (*s))
412 while (*s && nesting) {
415 } else if (*s == ')') {
417 } else if (*s == '\\') {
429 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
430 * comments, and the '<' and '>' delimiters.
432 * If not NULL, then *next will be made to point to the first character
433 * not parsed, (possibly pointing to the final '\0' terminator.
435 * Returns a newly talloc'ed string belonging to 'ctx'.
437 * Returns NULL if there is any error parsing the message-id. */
439 _parse_message_id (void *ctx, const char *message_id, const char **next)
444 if (message_id == NULL || *message_id == '\0')
449 skip_space_and_comments (&s);
451 /* Skip any unstructured text as well. */
452 while (*s && *s != '<')
463 skip_space_and_comments (&s);
466 while (*end && *end != '>')
475 if (end > s && *end == '>')
480 result = talloc_strndup (ctx, s, end - s + 1);
482 /* Finally, collapse any whitespace that is within the message-id
488 for (r = result, len = strlen (r); *r; r++, len--)
489 if (*r == ' ' || *r == '\t')
490 memmove (r, r+1, len);
496 /* Parse a References header value, putting a (talloc'ed under 'ctx')
497 * copy of each referenced message-id into 'hash'.
499 * We explicitly avoid including any reference identical to
500 * 'message_id' in the result (to avoid mass confusion when a single
501 * message references itself cyclically---and yes, mail messages are
502 * not infrequent in the wild that do this---don't ask me why).
505 parse_references (void *ctx,
506 const char *message_id,
512 if (refs == NULL || *refs == '\0')
516 ref = _parse_message_id (ctx, refs, &refs);
518 if (ref && strcmp (ref, message_id))
519 g_hash_table_insert (hash, ref, NULL);
524 notmuch_database_create (const char *path)
526 notmuch_database_t *notmuch = NULL;
527 char *notmuch_path = NULL;
532 fprintf (stderr, "Error: Cannot create a database for a NULL path.\n");
536 err = stat (path, &st);
538 fprintf (stderr, "Error: Cannot create database at %s: %s.\n",
539 path, strerror (errno));
543 if (! S_ISDIR (st.st_mode)) {
544 fprintf (stderr, "Error: Cannot create database at %s: Not a directory.\n",
549 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
551 err = mkdir (notmuch_path, 0755);
554 fprintf (stderr, "Error: Cannot create directory %s: %s.\n",
555 notmuch_path, strerror (errno));
559 notmuch = notmuch_database_open (path,
560 NOTMUCH_DATABASE_MODE_READ_WRITE);
561 notmuch_database_upgrade (notmuch, NULL, NULL);
565 talloc_free (notmuch_path);
571 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
573 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
574 fprintf (stderr, "Cannot write to a read-only database.\n");
575 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
578 return NOTMUCH_STATUS_SUCCESS;
582 notmuch_database_open (const char *path,
583 notmuch_database_mode_t mode)
585 void *local = talloc_new (NULL);
586 notmuch_database_t *notmuch = NULL;
587 char *notmuch_path, *xapian_path;
590 unsigned int i, version;
591 static int initialized = 0;
593 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
594 fprintf (stderr, "Out of memory\n");
598 err = stat (notmuch_path, &st);
600 fprintf (stderr, "Error opening database at %s: %s\n",
601 notmuch_path, strerror (errno));
605 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
606 fprintf (stderr, "Out of memory\n");
610 /* Initialize the GLib type system and threads */
613 /* Initialize gmime */
619 notmuch = talloc_zero (NULL, notmuch_database_t);
620 notmuch->exception_reported = FALSE;
621 notmuch->path = talloc_strdup (notmuch, path);
623 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
624 notmuch->path[strlen (notmuch->path) - 1] = '\0';
626 notmuch->needs_upgrade = FALSE;
627 notmuch->mode = mode;
628 notmuch->atomic_nesting = 0;
630 string last_thread_id;
632 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
633 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
634 Xapian::DB_CREATE_OR_OPEN);
635 version = notmuch_database_get_version (notmuch);
637 if (version > NOTMUCH_DATABASE_VERSION) {
639 "Error: Notmuch database at %s\n"
640 " has a newer database format version (%u) than supported by this\n"
641 " version of notmuch (%u). Refusing to open this database in\n"
642 " read-write mode.\n",
643 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
644 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
645 notmuch_database_close (notmuch);
650 if (version < NOTMUCH_DATABASE_VERSION)
651 notmuch->needs_upgrade = TRUE;
653 notmuch->xapian_db = new Xapian::Database (xapian_path);
654 version = notmuch_database_get_version (notmuch);
655 if (version > NOTMUCH_DATABASE_VERSION)
658 "Warning: Notmuch database at %s\n"
659 " has a newer database format version (%u) than supported by this\n"
660 " version of notmuch (%u). Some operations may behave incorrectly,\n"
661 " (but the database will not be harmed since it is being opened\n"
662 " in read-only mode).\n",
663 notmuch_path, version, NOTMUCH_DATABASE_VERSION);
667 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
668 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
669 if (last_thread_id.empty ()) {
670 notmuch->last_thread_id = 0;
675 str = last_thread_id.c_str ();
676 notmuch->last_thread_id = strtoull (str, &end, 16);
678 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
681 notmuch->query_parser = new Xapian::QueryParser;
682 notmuch->term_gen = new Xapian::TermGenerator;
683 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
684 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
686 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
687 notmuch->query_parser->set_database (*notmuch->xapian_db);
688 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
689 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
690 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
692 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
693 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
694 notmuch->query_parser->add_boolean_prefix (prefix->name,
698 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
699 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
700 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
702 } catch (const Xapian::Error &error) {
703 fprintf (stderr, "A Xapian exception occurred opening database: %s\n",
704 error.get_msg().c_str());
705 notmuch_database_close (notmuch);
716 notmuch_database_close (notmuch_database_t *notmuch)
719 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE)
720 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->flush ();
721 } catch (const Xapian::Error &error) {
722 if (! notmuch->exception_reported) {
723 fprintf (stderr, "Error: A Xapian exception occurred flushing database: %s\n",
724 error.get_msg().c_str());
728 delete notmuch->term_gen;
729 delete notmuch->query_parser;
730 delete notmuch->xapian_db;
731 delete notmuch->value_range_processor;
732 talloc_free (notmuch);
736 notmuch_database_get_path (notmuch_database_t *notmuch)
738 return notmuch->path;
742 notmuch_database_get_version (notmuch_database_t *notmuch)
744 unsigned int version;
745 string version_string;
749 version_string = notmuch->xapian_db->get_metadata ("version");
750 if (version_string.empty ())
753 str = version_string.c_str ();
754 if (str == NULL || *str == '\0')
757 version = strtoul (str, &end, 10);
759 INTERNAL_ERROR ("Malformed database version: %s", str);
765 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
767 return notmuch->needs_upgrade;
770 static volatile sig_atomic_t do_progress_notify = 0;
773 handle_sigalrm (unused (int signal))
775 do_progress_notify = 1;
778 /* Upgrade the current database.
780 * After opening a database in read-write mode, the client should
781 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
782 * if so, upgrade with this function before making any modifications.
784 * The optional progress_notify callback can be used by the caller to
785 * provide progress indication to the user. If non-NULL it will be
786 * called periodically with 'count' as the number of messages upgraded
787 * so far and 'total' the overall number of messages that will be
791 notmuch_database_upgrade (notmuch_database_t *notmuch,
792 void (*progress_notify) (void *closure,
796 Xapian::WritableDatabase *db;
797 struct sigaction action;
798 struct itimerval timerval;
799 notmuch_bool_t timer_is_active = FALSE;
800 unsigned int version;
801 notmuch_status_t status;
802 unsigned int count = 0, total = 0;
804 status = _notmuch_database_ensure_writable (notmuch);
808 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
810 version = notmuch_database_get_version (notmuch);
812 if (version >= NOTMUCH_DATABASE_VERSION)
813 return NOTMUCH_STATUS_SUCCESS;
815 if (progress_notify) {
816 /* Setup our handler for SIGALRM */
817 memset (&action, 0, sizeof (struct sigaction));
818 action.sa_handler = handle_sigalrm;
819 sigemptyset (&action.sa_mask);
820 action.sa_flags = SA_RESTART;
821 sigaction (SIGALRM, &action, NULL);
823 /* Then start a timer to send SIGALRM once per second. */
824 timerval.it_interval.tv_sec = 1;
825 timerval.it_interval.tv_usec = 0;
826 timerval.it_value.tv_sec = 1;
827 timerval.it_value.tv_usec = 0;
828 setitimer (ITIMER_REAL, &timerval, NULL);
830 timer_is_active = TRUE;
833 /* Before version 1, each message document had its filename in the
834 * data field. Copy that into the new format by calling
835 * notmuch_message_add_filename.
838 notmuch_query_t *query = notmuch_query_create (notmuch, "");
839 notmuch_messages_t *messages;
840 notmuch_message_t *message;
842 Xapian::TermIterator t, t_end;
844 total = notmuch_query_count_messages (query);
846 for (messages = notmuch_query_search_messages (query);
847 notmuch_messages_valid (messages);
848 notmuch_messages_move_to_next (messages))
850 if (do_progress_notify) {
851 progress_notify (closure, (double) count / total);
852 do_progress_notify = 0;
855 message = notmuch_messages_get (messages);
857 filename = _notmuch_message_talloc_copy_data (message);
858 if (filename && *filename != '\0') {
859 _notmuch_message_add_filename (message, filename);
860 _notmuch_message_sync (message);
862 talloc_free (filename);
864 notmuch_message_destroy (message);
869 notmuch_query_destroy (query);
871 /* Also, before version 1 we stored directory timestamps in
872 * XTIMESTAMP documents instead of the current XDIRECTORY
873 * documents. So copy those as well. */
875 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
877 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
881 Xapian::PostingIterator p, p_end;
882 std::string term = *t;
884 p_end = notmuch->xapian_db->postlist_end (term);
886 for (p = notmuch->xapian_db->postlist_begin (term);
890 Xapian::Document document;
892 notmuch_directory_t *directory;
894 if (do_progress_notify) {
895 progress_notify (closure, (double) count / total);
896 do_progress_notify = 0;
899 document = find_document_for_doc_id (notmuch, *p);
900 mtime = Xapian::sortable_unserialise (
901 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
903 directory = notmuch_database_get_directory (notmuch,
905 notmuch_directory_set_mtime (directory, mtime);
906 notmuch_directory_destroy (directory);
911 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
914 /* Now that the upgrade is complete we can remove the old data
915 * and documents that are no longer needed. */
917 notmuch_query_t *query = notmuch_query_create (notmuch, "");
918 notmuch_messages_t *messages;
919 notmuch_message_t *message;
922 for (messages = notmuch_query_search_messages (query);
923 notmuch_messages_valid (messages);
924 notmuch_messages_move_to_next (messages))
926 if (do_progress_notify) {
927 progress_notify (closure, (double) count / total);
928 do_progress_notify = 0;
931 message = notmuch_messages_get (messages);
933 filename = _notmuch_message_talloc_copy_data (message);
934 if (filename && *filename != '\0') {
935 _notmuch_message_clear_data (message);
936 _notmuch_message_sync (message);
938 talloc_free (filename);
940 notmuch_message_destroy (message);
943 notmuch_query_destroy (query);
947 Xapian::TermIterator t, t_end;
949 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
951 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
955 Xapian::PostingIterator p, p_end;
956 std::string term = *t;
958 p_end = notmuch->xapian_db->postlist_end (term);
960 for (p = notmuch->xapian_db->postlist_begin (term);
964 if (do_progress_notify) {
965 progress_notify (closure, (double) count / total);
966 do_progress_notify = 0;
969 db->delete_document (*p);
974 if (timer_is_active) {
975 /* Now stop the timer. */
976 timerval.it_interval.tv_sec = 0;
977 timerval.it_interval.tv_usec = 0;
978 timerval.it_value.tv_sec = 0;
979 timerval.it_value.tv_usec = 0;
980 setitimer (ITIMER_REAL, &timerval, NULL);
982 /* And disable the signal handler. */
983 action.sa_handler = SIG_IGN;
984 sigaction (SIGALRM, &action, NULL);
987 return NOTMUCH_STATUS_SUCCESS;
991 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
993 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
994 notmuch->atomic_nesting > 0)
998 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
999 } catch (const Xapian::Error &error) {
1000 fprintf (stderr, "A Xapian exception occurred beginning transaction: %s.\n",
1001 error.get_msg().c_str());
1002 notmuch->exception_reported = TRUE;
1003 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1007 notmuch->atomic_nesting++;
1008 return NOTMUCH_STATUS_SUCCESS;
1012 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1014 Xapian::WritableDatabase *db;
1016 if (notmuch->atomic_nesting == 0)
1017 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1019 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1020 notmuch->atomic_nesting > 1)
1023 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1025 db->commit_transaction ();
1027 /* This is a hack for testing. Xapian never flushes on a
1028 * non-flushed commit, even if the flush threshold is 1.
1029 * However, we rely on flushing to test atomicity. */
1030 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1031 if (thresh && atoi (thresh) == 1)
1033 } catch (const Xapian::Error &error) {
1034 fprintf (stderr, "A Xapian exception occurred committing transaction: %s.\n",
1035 error.get_msg().c_str());
1036 notmuch->exception_reported = TRUE;
1037 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1041 notmuch->atomic_nesting--;
1042 return NOTMUCH_STATUS_SUCCESS;
1045 /* We allow the user to use arbitrarily long paths for directories. But
1046 * we have a term-length limit. So if we exceed that, we'll use the
1047 * SHA-1 of the path for the database term.
1049 * Note: This function may return the original value of 'path'. If it
1050 * does not, then the caller is responsible to free() the returned
1054 _notmuch_database_get_directory_db_path (const char *path)
1056 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1058 if (term_len > NOTMUCH_TERM_MAX)
1059 return notmuch_sha1_of_string (path);
1064 /* Given a path, split it into two parts: the directory part is all
1065 * components except for the last, and the basename is that last
1066 * component. Getting the return-value for either part is optional
1067 * (the caller can pass NULL).
1069 * The original 'path' can represent either a regular file or a
1070 * directory---the splitting will be carried out in the same way in
1071 * either case. Trailing slashes on 'path' will be ignored, and any
1072 * cases of multiple '/' characters appearing in series will be
1073 * treated as a single '/'.
1075 * Allocation (if any) will have 'ctx' as the talloc owner. But
1076 * pointers will be returned within the original path string whenever
1079 * Note: If 'path' is non-empty and contains no non-trailing slash,
1080 * (that is, consists of a filename with no parent directory), then
1081 * the directory returned will be an empty string. However, if 'path'
1082 * is an empty string, then both directory and basename will be
1086 _notmuch_database_split_path (void *ctx,
1088 const char **directory,
1089 const char **basename)
1093 if (path == NULL || *path == '\0') {
1098 return NOTMUCH_STATUS_SUCCESS;
1101 /* Find the last slash (not counting a trailing slash), if any. */
1103 slash = path + strlen (path) - 1;
1105 /* First, skip trailing slashes. */
1106 while (slash != path) {
1113 /* Then, find a slash. */
1114 while (slash != path) {
1124 /* Finally, skip multiple slashes. */
1125 while (slash != path) {
1132 if (slash == path) {
1134 *directory = talloc_strdup (ctx, "");
1139 *directory = talloc_strndup (ctx, path, slash - path + 1);
1142 return NOTMUCH_STATUS_SUCCESS;
1146 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1148 unsigned int *directory_id)
1150 notmuch_directory_t *directory;
1151 notmuch_status_t status;
1155 return NOTMUCH_STATUS_SUCCESS;
1158 directory = _notmuch_directory_create (notmuch, path, &status);
1164 *directory_id = _notmuch_directory_get_document_id (directory);
1166 notmuch_directory_destroy (directory);
1168 return NOTMUCH_STATUS_SUCCESS;
1172 _notmuch_database_get_directory_path (void *ctx,
1173 notmuch_database_t *notmuch,
1174 unsigned int doc_id)
1176 Xapian::Document document;
1178 document = find_document_for_doc_id (notmuch, doc_id);
1180 return talloc_strdup (ctx, document.get_data ().c_str ());
1183 /* Given a legal 'filename' for the database, (either relative to
1184 * database path or absolute with initial components identical to
1185 * database path), return a new string (with 'ctx' as the talloc
1186 * owner) suitable for use as a direntry term value.
1188 * The necessary directory documents will be created in the database
1192 _notmuch_database_filename_to_direntry (void *ctx,
1193 notmuch_database_t *notmuch,
1194 const char *filename,
1197 const char *relative, *directory, *basename;
1198 Xapian::docid directory_id;
1199 notmuch_status_t status;
1201 relative = _notmuch_database_relative_path (notmuch, filename);
1203 status = _notmuch_database_split_path (ctx, relative,
1204 &directory, &basename);
1208 status = _notmuch_database_find_directory_id (notmuch, directory,
1213 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1215 return NOTMUCH_STATUS_SUCCESS;
1218 /* Given a legal 'path' for the database, return the relative path.
1220 * The return value will be a pointer to the original path contents,
1221 * and will be either the original string (if 'path' was relative) or
1222 * a portion of the string (if path was absolute and begins with the
1226 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1229 const char *db_path, *relative;
1230 unsigned int db_path_len;
1232 db_path = notmuch_database_get_path (notmuch);
1233 db_path_len = strlen (db_path);
1237 if (*relative == '/') {
1238 while (*relative == '/' && *(relative+1) == '/')
1241 if (strncmp (relative, db_path, db_path_len) == 0)
1243 relative += db_path_len;
1244 while (*relative == '/')
1252 notmuch_directory_t *
1253 notmuch_database_get_directory (notmuch_database_t *notmuch,
1256 notmuch_status_t status;
1259 return _notmuch_directory_create (notmuch, path, &status);
1260 } catch (const Xapian::Error &error) {
1261 fprintf (stderr, "A Xapian exception occurred getting directory: %s.\n",
1262 error.get_msg().c_str());
1263 notmuch->exception_reported = TRUE;
1268 /* Allocate a document ID that satisfies the following criteria:
1270 * 1. The ID does not exist for any document in the Xapian database
1272 * 2. The ID was not previously returned from this function
1274 * 3. The ID is the smallest integer satisfying (1) and (2)
1276 * This function will trigger an internal error if these constraints
1277 * cannot all be satisfied, (that is, the pool of available document
1278 * IDs has been exhausted).
1281 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1283 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1285 notmuch->last_doc_id++;
1287 if (notmuch->last_doc_id == 0)
1288 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1290 return notmuch->last_doc_id;
1294 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1296 /* 16 bytes (+ terminator) for hexadecimal representation of
1297 * a 64-bit integer. */
1298 static char thread_id[17];
1299 Xapian::WritableDatabase *db;
1301 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1303 notmuch->last_thread_id++;
1305 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1307 db->set_metadata ("last_thread_id", thread_id);
1313 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1315 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1316 message_id = _message_id_compressed (ctx, message_id);
1318 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1322 /* Find the thread ID to which the message with 'message_id' belongs.
1324 * Note: 'thread_id_ret' must not be NULL!
1325 * On success '*thread_id_ret' is set to a newly talloced string belonging to
1328 * Note: If there is no message in the database with the given
1329 * 'message_id' then a new thread_id will be allocated for this
1330 * message and stored in the database metadata, (where this same
1331 * thread ID can be looked up if the message is added to the database
1334 static notmuch_status_t
1335 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1337 const char *message_id,
1338 const char **thread_id_ret)
1340 notmuch_status_t status;
1341 notmuch_message_t *message;
1342 string thread_id_string;
1344 Xapian::WritableDatabase *db;
1346 status = notmuch_database_find_message (notmuch, message_id, &message);
1352 *thread_id_ret = talloc_steal (ctx,
1353 notmuch_message_get_thread_id (message));
1355 notmuch_message_destroy (message);
1357 return NOTMUCH_STATUS_SUCCESS;
1360 /* Message has not been seen yet.
1362 * We may have seen a reference to it already, in which case, we
1363 * can return the thread ID stored in the metadata. Otherwise, we
1364 * generate a new thread ID and store it there.
1366 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1367 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
1368 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
1370 if (thread_id_string.empty()) {
1371 *thread_id_ret = talloc_strdup (ctx,
1372 _notmuch_database_generate_thread_id (notmuch));
1373 db->set_metadata (metadata_key, *thread_id_ret);
1375 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
1378 talloc_free (metadata_key);
1380 return NOTMUCH_STATUS_SUCCESS;
1383 static notmuch_status_t
1384 _merge_threads (notmuch_database_t *notmuch,
1385 const char *winner_thread_id,
1386 const char *loser_thread_id)
1388 Xapian::PostingIterator loser, loser_end;
1389 notmuch_message_t *message = NULL;
1390 notmuch_private_status_t private_status;
1391 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1393 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
1395 for ( ; loser != loser_end; loser++) {
1396 message = _notmuch_message_create (notmuch, notmuch,
1397 *loser, &private_status);
1398 if (message == NULL) {
1399 ret = COERCE_STATUS (private_status,
1400 "Cannot find document for doc_id from query");
1404 _notmuch_message_remove_term (message, "thread", loser_thread_id);
1405 _notmuch_message_add_term (message, "thread", winner_thread_id);
1406 _notmuch_message_sync (message);
1408 notmuch_message_destroy (message);
1414 notmuch_message_destroy (message);
1420 _my_talloc_free_for_g_hash (void *ptr)
1425 static notmuch_status_t
1426 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
1427 notmuch_message_t *message,
1428 notmuch_message_file_t *message_file,
1429 const char **thread_id)
1431 GHashTable *parents = NULL;
1432 const char *refs, *in_reply_to, *in_reply_to_message_id;
1433 GList *l, *keys = NULL;
1434 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1436 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
1437 _my_talloc_free_for_g_hash, NULL);
1439 refs = notmuch_message_file_get_header (message_file, "references");
1440 parse_references (message, notmuch_message_get_message_id (message),
1443 in_reply_to = notmuch_message_file_get_header (message_file, "in-reply-to");
1444 parse_references (message, notmuch_message_get_message_id (message),
1445 parents, in_reply_to);
1447 /* Carefully avoid adding any self-referential in-reply-to term. */
1448 in_reply_to_message_id = _parse_message_id (message, in_reply_to, NULL);
1449 if (in_reply_to_message_id &&
1450 strcmp (in_reply_to_message_id,
1451 notmuch_message_get_message_id (message)))
1453 _notmuch_message_add_term (message, "replyto",
1454 _parse_message_id (message, in_reply_to, NULL));
1457 keys = g_hash_table_get_keys (parents);
1458 for (l = keys; l; l = l->next) {
1459 char *parent_message_id;
1460 const char *parent_thread_id = NULL;
1462 parent_message_id = (char *) l->data;
1464 _notmuch_message_add_term (message, "reference",
1467 ret = _resolve_message_id_to_thread_id (notmuch,
1474 if (*thread_id == NULL) {
1475 *thread_id = talloc_strdup (message, parent_thread_id);
1476 _notmuch_message_add_term (message, "thread", *thread_id);
1477 } else if (strcmp (*thread_id, parent_thread_id)) {
1478 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
1488 g_hash_table_unref (parents);
1493 static notmuch_status_t
1494 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
1495 notmuch_message_t *message,
1496 const char **thread_id)
1498 const char *message_id = notmuch_message_get_message_id (message);
1499 Xapian::PostingIterator child, children_end;
1500 notmuch_message_t *child_message = NULL;
1501 const char *child_thread_id;
1502 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1503 notmuch_private_status_t private_status;
1505 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
1507 for ( ; child != children_end; child++) {
1509 child_message = _notmuch_message_create (message, notmuch,
1510 *child, &private_status);
1511 if (child_message == NULL) {
1512 ret = COERCE_STATUS (private_status,
1513 "Cannot find document for doc_id from query");
1517 child_thread_id = notmuch_message_get_thread_id (child_message);
1518 if (*thread_id == NULL) {
1519 *thread_id = talloc_strdup (message, child_thread_id);
1520 _notmuch_message_add_term (message, "thread", *thread_id);
1521 } else if (strcmp (*thread_id, child_thread_id)) {
1522 _notmuch_message_remove_term (child_message, "reference",
1524 _notmuch_message_sync (child_message);
1525 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
1530 notmuch_message_destroy (child_message);
1531 child_message = NULL;
1536 notmuch_message_destroy (child_message);
1541 /* Given a (mostly empty) 'message' and its corresponding
1542 * 'message_file' link it to existing threads in the database.
1544 * The first check is in the metadata of the database to see if we
1545 * have pre-allocated a thread_id in advance for this message, (which
1546 * would have happened if a message was previously added that
1547 * referenced this one).
1549 * Second, we look at 'message_file' and its link-relevant headers
1550 * (References and In-Reply-To) for message IDs.
1552 * Finally, we look in the database for existing message that
1553 * reference 'message'.
1555 * In all cases, we assign to the current message the first thread_id
1556 * found (through either parent or child). We will also merge any
1557 * existing, distinct threads where this message belongs to both,
1558 * (which is not uncommon when messages are processed out of order).
1560 * Finally, if no thread ID has been found through parent or child, we
1561 * call _notmuch_message_generate_thread_id to generate a new thread
1562 * ID. This should only happen for new, top-level messages, (no
1563 * References or In-Reply-To header in this message, and no previously
1564 * added message refers to this message).
1566 static notmuch_status_t
1567 _notmuch_database_link_message (notmuch_database_t *notmuch,
1568 notmuch_message_t *message,
1569 notmuch_message_file_t *message_file)
1571 notmuch_status_t status;
1572 const char *message_id, *thread_id = NULL;
1576 message_id = notmuch_message_get_message_id (message);
1577 metadata_key = _get_metadata_thread_id_key (message, message_id);
1579 /* Check if we have already seen related messages to this one.
1580 * If we have then use the thread_id that we stored at that time.
1582 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
1583 if (! stored_id.empty()) {
1584 Xapian::WritableDatabase *db;
1586 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1588 /* Clear the metadata for this message ID. We don't need it
1590 db->set_metadata (metadata_key, "");
1591 thread_id = stored_id.c_str();
1593 _notmuch_message_add_term (message, "thread", thread_id);
1595 talloc_free (metadata_key);
1597 status = _notmuch_database_link_message_to_parents (notmuch, message,
1603 status = _notmuch_database_link_message_to_children (notmuch, message,
1608 /* If not part of any existing thread, generate a new thread ID. */
1609 if (thread_id == NULL) {
1610 thread_id = _notmuch_database_generate_thread_id (notmuch);
1612 _notmuch_message_add_term (message, "thread", thread_id);
1615 return NOTMUCH_STATUS_SUCCESS;
1619 notmuch_database_add_message (notmuch_database_t *notmuch,
1620 const char *filename,
1621 notmuch_message_t **message_ret)
1623 notmuch_message_file_t *message_file;
1624 notmuch_message_t *message = NULL;
1625 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
1626 notmuch_private_status_t private_status;
1628 const char *date, *header;
1629 const char *from, *to, *subject;
1630 char *message_id = NULL;
1633 *message_ret = NULL;
1635 ret = _notmuch_database_ensure_writable (notmuch);
1639 message_file = notmuch_message_file_open (filename);
1640 if (message_file == NULL)
1641 return NOTMUCH_STATUS_FILE_ERROR;
1643 /* Adding a message may change many documents. Do this all
1645 ret = notmuch_database_begin_atomic (notmuch);
1649 notmuch_message_file_restrict_headers (message_file,
1660 /* Before we do any real work, (especially before doing a
1661 * potential SHA-1 computation on the entire file's contents),
1662 * let's make sure that what we're looking at looks like an
1663 * actual email message.
1665 from = notmuch_message_file_get_header (message_file, "from");
1666 subject = notmuch_message_file_get_header (message_file, "subject");
1667 to = notmuch_message_file_get_header (message_file, "to");
1669 if ((from == NULL || *from == '\0') &&
1670 (subject == NULL || *subject == '\0') &&
1671 (to == NULL || *to == '\0'))
1673 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
1677 /* Now that we're sure it's mail, the first order of business
1678 * is to find a message ID (or else create one ourselves). */
1680 header = notmuch_message_file_get_header (message_file, "message-id");
1681 if (header && *header != '\0') {
1682 message_id = _parse_message_id (message_file, header, NULL);
1684 /* So the header value isn't RFC-compliant, but it's
1685 * better than no message-id at all. */
1686 if (message_id == NULL)
1687 message_id = talloc_strdup (message_file, header);
1689 /* If a message ID is too long, substitute its sha1 instead. */
1690 if (message_id && strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX) {
1691 char *compressed = _message_id_compressed (message_file,
1693 talloc_free (message_id);
1694 message_id = compressed;
1698 if (message_id == NULL ) {
1699 /* No message-id at all, let's generate one by taking a
1700 * hash over the file's contents. */
1701 char *sha1 = notmuch_sha1_of_file (filename);
1703 /* If that failed too, something is really wrong. Give up. */
1705 ret = NOTMUCH_STATUS_FILE_ERROR;
1709 message_id = talloc_asprintf (message_file,
1710 "notmuch-sha1-%s", sha1);
1714 /* Now that we have a message ID, we get a message object,
1715 * (which may or may not reference an existing document in the
1718 message = _notmuch_message_create_for_message_id (notmuch,
1722 talloc_free (message_id);
1724 if (message == NULL) {
1725 ret = COERCE_STATUS (private_status,
1726 "Unexpected status value from _notmuch_message_create_for_message_id");
1730 _notmuch_message_add_filename (message, filename);
1732 /* Is this a newly created message object? */
1733 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1734 _notmuch_message_add_term (message, "type", "mail");
1736 ret = _notmuch_database_link_message (notmuch, message,
1741 date = notmuch_message_file_get_header (message_file, "date");
1742 _notmuch_message_set_header_values (message, date, from, subject);
1744 _notmuch_message_index_file (message, filename);
1746 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
1749 _notmuch_message_sync (message);
1750 } catch (const Xapian::Error &error) {
1751 fprintf (stderr, "A Xapian exception occurred adding message: %s.\n",
1752 error.get_msg().c_str());
1753 notmuch->exception_reported = TRUE;
1754 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1760 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1761 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
1762 *message_ret = message;
1764 notmuch_message_destroy (message);
1768 notmuch_message_file_close (message_file);
1770 ret2 = notmuch_database_end_atomic (notmuch);
1771 if ((ret == NOTMUCH_STATUS_SUCCESS ||
1772 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
1773 ret2 != NOTMUCH_STATUS_SUCCESS)
1780 notmuch_database_remove_message (notmuch_database_t *notmuch,
1781 const char *filename)
1783 notmuch_status_t status;
1784 notmuch_message_t *message;
1786 status = notmuch_database_find_message_by_filename (notmuch, filename,
1789 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1790 status = _notmuch_message_remove_filename (message, filename);
1791 if (status == NOTMUCH_STATUS_SUCCESS)
1792 _notmuch_message_delete (message);
1793 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1794 _notmuch_message_sync (message);
1796 notmuch_message_destroy (message);
1803 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1804 const char *filename,
1805 notmuch_message_t **message_ret)
1808 const char *prefix = _find_prefix ("file-direntry");
1809 char *direntry, *term;
1810 Xapian::PostingIterator i, end;
1811 notmuch_status_t status;
1813 if (message_ret == NULL)
1814 return NOTMUCH_STATUS_NULL_POINTER;
1816 local = talloc_new (notmuch);
1819 status = _notmuch_database_filename_to_direntry (local, notmuch,
1820 filename, &direntry);
1824 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1826 find_doc_ids_for_term (notmuch, term, &i, &end);
1829 notmuch_private_status_t private_status;
1831 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1833 if (*message_ret == NULL)
1834 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1836 } catch (const Xapian::Error &error) {
1837 fprintf (stderr, "Error: A Xapian exception occurred finding message by filename: %s\n",
1838 error.get_msg().c_str());
1839 notmuch->exception_reported = TRUE;
1840 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1844 talloc_free (local);
1846 if (status && *message_ret) {
1847 notmuch_message_destroy (*message_ret);
1848 *message_ret = NULL;
1853 notmuch_string_list_t *
1854 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1855 Xapian::TermIterator &end,
1858 int prefix_len = strlen (prefix);
1859 notmuch_string_list_t *list;
1861 list = _notmuch_string_list_create (ctx);
1862 if (unlikely (list == NULL))
1865 for (i.skip_to (prefix); i != end; i++) {
1866 /* Terminate loop at first term without desired prefix. */
1867 if (strncmp ((*i).c_str (), prefix, prefix_len))
1870 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1877 notmuch_database_get_all_tags (notmuch_database_t *db)
1879 Xapian::TermIterator i, end;
1880 notmuch_string_list_t *tags;
1883 i = db->xapian_db->allterms_begin();
1884 end = db->xapian_db->allterms_end();
1885 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1886 _find_prefix ("tag"));
1887 _notmuch_string_list_sort (tags);
1888 return _notmuch_tags_create (db, tags);
1889 } catch (const Xapian::Error &error) {
1890 fprintf (stderr, "A Xapian exception occurred getting tags: %s.\n",
1891 error.get_msg().c_str());
1892 db->exception_reported = TRUE;