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"
22 #include "parse-time-vrp.h"
23 #include "string-util.h"
32 #include <glib.h> /* g_free, GPtrArray, GHashTable */
33 #include <glib-object.h> /* g_type_init */
35 #include <gmime/gmime.h> /* g_mime_init */
39 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
46 #define NOTMUCH_DATABASE_VERSION 3
48 #define STRINGIFY(s) _SUB_STRINGIFY(s)
49 #define _SUB_STRINGIFY(s) #s
51 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
53 * We currently have three different types of documents (mail, ghost,
54 * and directory) and also some metadata.
58 * A mail document is associated with a particular email message. It
59 * is stored in one or more files on disk (though only one has its
60 * content indexed) and is uniquely identified by its "id" field
61 * (which is generally the message ID). It is indexed with the
62 * following prefixed terms which the database uses to construct
65 * Single terms of given prefix:
69 * id: Unique ID of mail. This is from the Message-ID header
70 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
71 * If it's present and too long, then we use
72 * "notmuch-sha1-<sha1_sum_of_message_id>".
73 * If this header is not present, we use
74 * "notmuch-sha1-<sha1_sum_of_entire_file>".
76 * thread: The ID of the thread to which the mail belongs
78 * replyto: The ID from the In-Reply-To header of the mail (if any).
80 * Multiple terms of given prefix:
82 * reference: All message IDs from In-Reply-To and References
83 * headers in the message.
85 * tag: Any tags associated with this message by the user.
87 * file-direntry: A colon-separated pair of values
88 * (INTEGER:STRING), where INTEGER is the
89 * document ID of a directory document, and
90 * STRING is the name of a file within that
91 * directory for this mail message.
93 * A mail document also has four values:
95 * TIMESTAMP: The time_t value corresponding to the message's
98 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
100 * FROM: The value of the "From" header
102 * SUBJECT: The value of the "Subject" header
104 * In addition, terms from the content of the message are added with
105 * "from", "to", "attachment", and "subject" prefixes for use by the
106 * user in searching. Similarly, terms from the path of the mail
107 * message are added with "folder" and "path" prefixes. But the
108 * database doesn't really care itself about any of these.
110 * The data portion of a mail document is empty.
112 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
113 * -----------------------------------------------
114 * A ghost mail document is like a mail document, but where we don't
115 * have the message content. These are used to track thread reference
116 * information for messages we haven't received.
118 * A ghost mail document has type: ghost; id and thread fields that
119 * are identical to the mail document fields; and a MESSAGE_ID value.
123 * A directory document is used by a client of the notmuch library to
124 * maintain data necessary to allow for efficient polling of mail
127 * All directory documents contain one term:
129 * directory: The directory path (relative to the database path)
130 * Or the SHA1 sum of the directory path (if the
131 * path itself is too long to fit in a Xapian
134 * And all directory documents for directories other than top-level
135 * directories also contain the following term:
137 * directory-direntry: A colon-separated pair of values
138 * (INTEGER:STRING), where INTEGER is the
139 * document ID of the parent directory
140 * document, and STRING is the name of this
141 * directory within that parent.
143 * All directory documents have a single value:
145 * TIMESTAMP: The mtime of the directory (at last scan)
147 * The data portion of a directory document contains the path of the
148 * directory (relative to the database path).
152 * Xapian allows us to store arbitrary name-value pairs as
153 * "metadata". We currently use the following metadata names with the
156 * version The database schema version, (which is distinct
157 * from both the notmuch package version (see
158 * notmuch --version) and the libnotmuch library
159 * version. The version is stored as an base-10
160 * ASCII integer. The initial database version
161 * was 1, (though a schema existed before that
162 * were no "version" database value existed at
163 * all). Successive versions are allocated as
164 * changes are made to the database (such as by
165 * indexing new fields).
167 * features The set of features supported by this
168 * database. This consists of a set of
169 * '\n'-separated lines, where each is a feature
170 * name, a '\t', and compatibility flags. If the
171 * compatibility flags contain 'w', then the
172 * opener must support this feature to safely
173 * write this database. If the compatibility
174 * flags contain 'r', then the opener must
175 * support this feature to read this database.
176 * Introduced in database version 3.
178 * last_thread_id The last thread ID generated. This is stored
179 * as a 16-byte hexadecimal ASCII representation
180 * of a 64-bit unsigned integer. The first ID
181 * generated is 1 and the value will be
182 * incremented for each thread ID.
187 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
188 * Instead, the database has the following additional database
191 * thread_id_* A pre-allocated thread ID for a particular
192 * message. This is actually an arbitrarily large
193 * family of metadata name. Any particular name is
194 * formed by concatenating "thread_id_" with a message
195 * ID (or the SHA1 sum of a message ID if it is very
196 * long---see description of 'id' in the mail
197 * document). The value stored is a thread ID.
199 * These thread ID metadata values are stored
200 * whenever a message references a parent message
201 * that does not yet exist in the database. A
202 * thread ID will be allocated and stored, and if
203 * the message is later added, the stored thread
204 * ID will be used (and the metadata value will
207 * Even before a message is added, it's
208 * pre-allocated thread ID is useful so that all
209 * descendant messages that reference this common
210 * parent can be recognized as belonging to the
214 /* With these prefix values we follow the conventions published here:
216 * http://xapian.org/docs/omega/termprefixes.html
218 * as much as makes sense. Note that I took some liberty in matching
219 * the reserved prefix values to notmuch concepts, (for example, 'G'
220 * is documented as "newsGroup (or similar entity - e.g. a web forum
221 * name)", for which I think the thread is the closest analogue in
222 * notmuch. This in spite of the fact that we will eventually be
223 * storing mailing-list messages where 'G' for "mailing list name"
224 * might be even a closer analogue. I'm treating the single-character
225 * prefixes preferentially for core notmuch concepts (which will be
226 * nearly universal to all mail messages).
229 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
231 { "reference", "XREFERENCE" },
232 { "replyto", "XREPLYTO" },
233 { "directory", "XDIRECTORY" },
234 { "file-direntry", "XFDIRENTRY" },
235 { "directory-direntry", "XDDIRENTRY" },
238 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
245 * Without the ":", since this is a multi-letter prefix, Xapian
246 * will add a colon itself if the first letter of the path is
247 * upper-case ASCII. Including the ":" forces there to always be a
248 * colon, which keeps our own logic simpler.
250 { "folder", "XFOLDER:" },
253 static prefix_t PROBABILISTIC_PREFIX[]= {
256 { "attachment", "XATTACHMENT" },
257 { "mimetype", "XMIMETYPE"},
258 { "subject", "XSUBJECT"},
262 _find_prefix (const char *name)
266 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
267 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
268 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
271 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
272 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
273 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
276 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
277 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
278 return PROBABILISTIC_PREFIX[i].prefix;
281 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
286 static const struct {
287 /* NOTMUCH_FEATURE_* value. */
288 _notmuch_features value;
289 /* Feature name as it appears in the database. This name should
290 * be appropriate for displaying to the user if an older version
291 * of notmuch doesn't support this feature. */
293 /* Compatibility flags when this feature is declared. */
295 } feature_names[] = {
296 { NOTMUCH_FEATURE_FILE_TERMS,
297 "multiple paths per message", "rw" },
298 { NOTMUCH_FEATURE_DIRECTORY_DOCS,
299 "relative directory paths", "rw" },
300 /* Header values are not required for reading a database because a
301 * reader can just refer to the message file. */
302 { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
303 "from/subject/message-ID in database", "w" },
304 { NOTMUCH_FEATURE_BOOL_FOLDER,
305 "exact folder:/path: search", "rw" },
306 { NOTMUCH_FEATURE_GHOSTS,
307 "mail documents for missing messages", "w"},
308 /* Knowledge of the index mime-types are not required for reading
309 * a database because a reader will just be unable to query
311 { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
312 "indexed MIME types", "w"},
316 notmuch_status_to_string (notmuch_status_t status)
319 case NOTMUCH_STATUS_SUCCESS:
320 return "No error occurred";
321 case NOTMUCH_STATUS_OUT_OF_MEMORY:
322 return "Out of memory";
323 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
324 return "Attempt to write to a read-only database";
325 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
326 return "A Xapian exception occurred";
327 case NOTMUCH_STATUS_FILE_ERROR:
328 return "Something went wrong trying to read or write a file";
329 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
330 return "File is not an email";
331 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
332 return "Message ID is identical to a message in database";
333 case NOTMUCH_STATUS_NULL_POINTER:
334 return "Erroneous NULL pointer";
335 case NOTMUCH_STATUS_TAG_TOO_LONG:
336 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
337 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
338 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
339 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
340 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
341 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
342 return "Unsupported operation";
343 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
344 return "Operation requires a database upgrade";
345 case NOTMUCH_STATUS_PATH_ERROR:
346 return "Path supplied is illegal for this function";
348 case NOTMUCH_STATUS_LAST_STATUS:
349 return "Unknown error status value";
354 _notmuch_database_log (notmuch_database_t *notmuch,
360 va_start (va_args, format);
362 if (notmuch->status_string)
363 talloc_free (notmuch->status_string);
365 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
371 find_doc_ids_for_term (notmuch_database_t *notmuch,
373 Xapian::PostingIterator *begin,
374 Xapian::PostingIterator *end)
376 *begin = notmuch->xapian_db->postlist_begin (term);
378 *end = notmuch->xapian_db->postlist_end (term);
382 find_doc_ids (notmuch_database_t *notmuch,
383 const char *prefix_name,
385 Xapian::PostingIterator *begin,
386 Xapian::PostingIterator *end)
390 term = talloc_asprintf (notmuch, "%s%s",
391 _find_prefix (prefix_name), value);
393 find_doc_ids_for_term (notmuch, term, begin, end);
398 notmuch_private_status_t
399 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
400 const char *prefix_name,
402 unsigned int *doc_id)
404 Xapian::PostingIterator i, end;
406 find_doc_ids (notmuch, prefix_name, value, &i, &end);
410 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
415 #if DEBUG_DATABASE_SANITY
419 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
423 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
426 static Xapian::Document
427 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
429 return notmuch->xapian_db->get_document (doc_id);
432 /* Generate a compressed version of 'message_id' of the form:
434 * notmuch-sha1-<sha1_sum_of_message_id>
437 _notmuch_message_id_compressed (void *ctx, const char *message_id)
439 char *sha1, *compressed;
441 sha1 = _notmuch_sha1_of_string (message_id);
443 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
450 notmuch_database_find_message (notmuch_database_t *notmuch,
451 const char *message_id,
452 notmuch_message_t **message_ret)
454 notmuch_private_status_t status;
457 if (message_ret == NULL)
458 return NOTMUCH_STATUS_NULL_POINTER;
460 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
461 message_id = _notmuch_message_id_compressed (notmuch, message_id);
464 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
465 message_id, &doc_id);
467 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
470 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
472 if (*message_ret == NULL)
473 return NOTMUCH_STATUS_OUT_OF_MEMORY;
476 return NOTMUCH_STATUS_SUCCESS;
477 } catch (const Xapian::Error &error) {
478 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
479 error.get_msg().c_str());
480 notmuch->exception_reported = TRUE;
482 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
486 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
487 * a (potentially nested) parenthesized sequence with '\' used to
488 * escape any character (including parentheses).
490 * If the sequence to be skipped continues to the end of the string,
491 * then 'str' will be left pointing at the final terminating '\0'
495 skip_space_and_comments (const char **str)
500 while (*s && (isspace (*s) || *s == '(')) {
501 while (*s && isspace (*s))
506 while (*s && nesting) {
509 } else if (*s == ')') {
511 } else if (*s == '\\') {
523 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
524 * comments, and the '<' and '>' delimiters.
526 * If not NULL, then *next will be made to point to the first character
527 * not parsed, (possibly pointing to the final '\0' terminator.
529 * Returns a newly talloc'ed string belonging to 'ctx'.
531 * Returns NULL if there is any error parsing the message-id. */
533 _parse_message_id (void *ctx, const char *message_id, const char **next)
538 if (message_id == NULL || *message_id == '\0')
543 skip_space_and_comments (&s);
545 /* Skip any unstructured text as well. */
546 while (*s && *s != '<')
557 skip_space_and_comments (&s);
560 while (*end && *end != '>')
569 if (end > s && *end == '>')
574 result = talloc_strndup (ctx, s, end - s + 1);
576 /* Finally, collapse any whitespace that is within the message-id
582 for (r = result, len = strlen (r); *r; r++, len--)
583 if (*r == ' ' || *r == '\t')
584 memmove (r, r+1, len);
590 /* Parse a References header value, putting a (talloc'ed under 'ctx')
591 * copy of each referenced message-id into 'hash'.
593 * We explicitly avoid including any reference identical to
594 * 'message_id' in the result (to avoid mass confusion when a single
595 * message references itself cyclically---and yes, mail messages are
596 * not infrequent in the wild that do this---don't ask me why).
598 * Return the last reference parsed, if it is not equal to message_id.
601 parse_references (void *ctx,
602 const char *message_id,
606 char *ref, *last_ref = NULL;
608 if (refs == NULL || *refs == '\0')
612 ref = _parse_message_id (ctx, refs, &refs);
614 if (ref && strcmp (ref, message_id)) {
615 g_hash_table_insert (hash, ref, NULL);
620 /* The return value of this function is used to add a parent
621 * reference to the database. We should avoid making a message
622 * its own parent, thus the above check.
628 notmuch_database_create (const char *path, notmuch_database_t **database)
630 char *status_string = NULL;
631 notmuch_status_t status;
633 status = notmuch_database_create_verbose (path, database,
637 fputs (status_string, stderr);
638 free (status_string);
645 notmuch_database_create_verbose (const char *path,
646 notmuch_database_t **database,
647 char **status_string)
649 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
650 notmuch_database_t *notmuch = NULL;
651 char *notmuch_path = NULL;
652 char *message = NULL;
657 message = strdup ("Error: Cannot create a database for a NULL path.\n");
658 status = NOTMUCH_STATUS_NULL_POINTER;
662 if (path[0] != '/') {
663 message = strdup ("Error: Database path must be absolute.\n");
664 status = NOTMUCH_STATUS_PATH_ERROR;
668 err = stat (path, &st);
670 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
671 path, strerror (errno)));
672 status = NOTMUCH_STATUS_FILE_ERROR;
676 if (! S_ISDIR (st.st_mode)) {
677 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
678 "Not a directory.\n",
680 status = NOTMUCH_STATUS_FILE_ERROR;
684 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
686 err = mkdir (notmuch_path, 0755);
689 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
690 notmuch_path, strerror (errno)));
691 status = NOTMUCH_STATUS_FILE_ERROR;
695 status = notmuch_database_open_verbose (path,
696 NOTMUCH_DATABASE_MODE_READ_WRITE,
701 /* Upgrade doesn't add these feature to existing databases, but
702 * new databases have them. */
703 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
704 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
706 status = notmuch_database_upgrade (notmuch, NULL, NULL);
708 notmuch_database_close(notmuch);
714 talloc_free (notmuch_path);
718 *status_string = message;
725 talloc_free (notmuch);
730 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
732 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
733 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
734 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
737 return NOTMUCH_STATUS_SUCCESS;
740 /* Parse a database features string from the given database version.
741 * Returns the feature bit set.
743 * For version < 3, this ignores the features string and returns a
744 * hard-coded set of features.
746 * If there are unrecognized features that are required to open the
747 * database in mode (which should be 'r' or 'w'), return a
748 * comma-separated list of unrecognized but required features in
749 * *incompat_out suitable for presenting to the user. *incompat_out
750 * will be allocated from ctx.
752 static _notmuch_features
753 _parse_features (const void *ctx, const char *features, unsigned int version,
754 char mode, char **incompat_out)
756 _notmuch_features res = static_cast<_notmuch_features>(0);
757 unsigned int namelen, i;
761 /* Prior to database version 3, features were implied by the
764 return NOTMUCH_FEATURES_V0;
765 else if (version == 1)
766 return NOTMUCH_FEATURES_V1;
767 else if (version == 2)
768 return NOTMUCH_FEATURES_V2;
770 /* Parse the features string */
771 while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
772 flags = strchr (features, '\t');
773 if (! flags || flags > features + llen)
775 namelen = flags - features;
777 for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
778 if (strlen (feature_names[i].name) == namelen &&
779 strncmp (feature_names[i].name, features, namelen) == 0) {
780 res |= feature_names[i].value;
785 if (i == ARRAY_SIZE (feature_names) && incompat_out) {
786 /* Unrecognized feature */
787 const char *have = strchr (flags, mode);
788 if (have && have < features + llen) {
789 /* This feature is required to access this database in
790 * 'mode', but we don't understand it. */
792 *incompat_out = talloc_strdup (ctx, "");
793 *incompat_out = talloc_asprintf_append_buffer (
794 *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
804 _print_features (const void *ctx, unsigned int features)
807 char *res = talloc_strdup (ctx, "");
809 for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
810 if (features & feature_names[i].value)
811 res = talloc_asprintf_append_buffer (
812 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
818 notmuch_database_open (const char *path,
819 notmuch_database_mode_t mode,
820 notmuch_database_t **database)
822 char *status_string = NULL;
823 notmuch_status_t status;
825 status = notmuch_database_open_verbose (path, mode, database,
829 fputs (status_string, stderr);
830 free (status_string);
837 notmuch_database_open_verbose (const char *path,
838 notmuch_database_mode_t mode,
839 notmuch_database_t **database,
840 char **status_string)
842 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
843 void *local = talloc_new (NULL);
844 notmuch_database_t *notmuch = NULL;
845 char *notmuch_path, *xapian_path, *incompat_features;
846 char *message = NULL;
849 unsigned int i, version;
850 static int initialized = 0;
853 message = strdup ("Error: Cannot open a database for a NULL path.\n");
854 status = NOTMUCH_STATUS_NULL_POINTER;
858 if (path[0] != '/') {
859 message = strdup ("Error: Database path must be absolute.\n");
860 status = NOTMUCH_STATUS_PATH_ERROR;
864 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
865 message = strdup ("Out of memory\n");
866 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
870 err = stat (notmuch_path, &st);
872 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
873 notmuch_path, strerror (errno)));
874 status = NOTMUCH_STATUS_FILE_ERROR;
878 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
879 message = strdup ("Out of memory\n");
880 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
884 /* Initialize the GLib type system and threads */
885 #if !GLIB_CHECK_VERSION(2, 35, 1)
889 /* Initialize gmime */
891 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
895 notmuch = talloc_zero (NULL, notmuch_database_t);
896 notmuch->exception_reported = FALSE;
897 notmuch->status_string = NULL;
898 notmuch->path = talloc_strdup (notmuch, path);
900 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
901 notmuch->path[strlen (notmuch->path) - 1] = '\0';
903 notmuch->mode = mode;
904 notmuch->atomic_nesting = 0;
906 string last_thread_id;
908 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
909 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
910 Xapian::DB_CREATE_OR_OPEN);
912 notmuch->xapian_db = new Xapian::Database (xapian_path);
915 /* Check version. As of database version 3, we represent
916 * changes in terms of features, so assume a version bump
917 * means a dramatically incompatible change. */
918 version = notmuch_database_get_version (notmuch);
919 if (version > NOTMUCH_DATABASE_VERSION) {
920 IGNORE_RESULT (asprintf (&message,
921 "Error: Notmuch database at %s\n"
922 " has a newer database format version (%u) than supported by this\n"
923 " version of notmuch (%u).\n",
924 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
925 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
926 notmuch_database_destroy (notmuch);
928 status = NOTMUCH_STATUS_FILE_ERROR;
932 /* Check features. */
933 incompat_features = NULL;
934 notmuch->features = _parse_features (
935 local, notmuch->xapian_db->get_metadata ("features").c_str (),
936 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
938 if (incompat_features) {
939 IGNORE_RESULT (asprintf (&message,
940 "Error: Notmuch database at %s\n"
941 " requires features (%s)\n"
942 " not supported by this version of notmuch.\n",
943 notmuch_path, incompat_features));
944 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
945 notmuch_database_destroy (notmuch);
947 status = NOTMUCH_STATUS_FILE_ERROR;
951 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
952 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
953 if (last_thread_id.empty ()) {
954 notmuch->last_thread_id = 0;
959 str = last_thread_id.c_str ();
960 notmuch->last_thread_id = strtoull (str, &end, 16);
962 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
965 notmuch->query_parser = new Xapian::QueryParser;
966 notmuch->term_gen = new Xapian::TermGenerator;
967 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
968 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
969 notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
971 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
972 notmuch->query_parser->set_database (*notmuch->xapian_db);
973 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
974 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
975 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
976 notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
978 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
979 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
980 notmuch->query_parser->add_boolean_prefix (prefix->name,
984 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
985 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
986 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
988 } catch (const Xapian::Error &error) {
989 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
990 error.get_msg().c_str()));
991 notmuch_database_destroy (notmuch);
993 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1001 *status_string = message;
1007 *database = notmuch;
1009 talloc_free (notmuch);
1014 notmuch_database_close (notmuch_database_t *notmuch)
1016 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1018 /* Many Xapian objects (and thus notmuch objects) hold references to
1019 * the database, so merely deleting the database may not suffice to
1020 * close it. Thus, we explicitly close it here. */
1021 if (notmuch->xapian_db != NULL) {
1023 /* If there's an outstanding transaction, it's unclear if
1024 * closing the Xapian database commits everything up to
1025 * that transaction, or may discard committed (but
1026 * unflushed) transactions. To be certain, explicitly
1027 * cancel any outstanding transaction before closing. */
1028 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1029 notmuch->atomic_nesting)
1030 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1031 ->cancel_transaction ();
1033 /* Close the database. This implicitly flushes
1034 * outstanding changes. */
1035 notmuch->xapian_db->close();
1036 } catch (const Xapian::Error &error) {
1037 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1038 if (! notmuch->exception_reported) {
1039 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1040 error.get_msg().c_str());
1045 delete notmuch->term_gen;
1046 notmuch->term_gen = NULL;
1047 delete notmuch->query_parser;
1048 notmuch->query_parser = NULL;
1049 delete notmuch->xapian_db;
1050 notmuch->xapian_db = NULL;
1051 delete notmuch->value_range_processor;
1052 notmuch->value_range_processor = NULL;
1053 delete notmuch->date_range_processor;
1054 notmuch->date_range_processor = NULL;
1059 #if HAVE_XAPIAN_COMPACT
1061 unlink_cb (const char *path,
1062 unused (const struct stat *sb),
1064 unused (struct FTW *ftw))
1066 return remove (path);
1070 rmtree (const char *path)
1072 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1075 class NotmuchCompactor : public Xapian::Compactor
1077 notmuch_compact_status_cb_t status_cb;
1078 void *status_closure;
1081 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1082 status_cb (cb), status_closure (closure) { }
1085 set_status (const std::string &table, const std::string &status)
1089 if (status_cb == NULL)
1092 if (status.length () == 0)
1093 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
1095 msg = talloc_asprintf (NULL, " %s", status.c_str());
1101 status_cb (msg, status_closure);
1106 /* Compacts the given database, optionally saving the original database
1107 * in backup_path. Additionally, a callback function can be provided to
1108 * give the user feedback on the progress of the (likely long-lived)
1109 * compaction process.
1111 * The backup path must point to a directory on the same volume as the
1112 * original database. Passing a NULL backup_path will result in the
1113 * uncompacted database being deleted after compaction has finished.
1114 * Note that the database write lock will be held during the
1115 * compaction process to protect data integrity.
1118 notmuch_database_compact (const char *path,
1119 const char *backup_path,
1120 notmuch_compact_status_cb_t status_cb,
1124 char *notmuch_path, *xapian_path, *compact_xapian_path;
1125 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1126 notmuch_database_t *notmuch = NULL;
1127 struct stat statbuf;
1128 notmuch_bool_t keep_backup;
1129 char *message = NULL;
1131 local = talloc_new (NULL);
1133 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1135 ret = notmuch_database_open_verbose (path,
1136 NOTMUCH_DATABASE_MODE_READ_WRITE,
1140 if (status_cb) status_cb (message, closure);
1144 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1145 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1149 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1150 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1154 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1155 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1159 if (backup_path == NULL) {
1160 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1161 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1164 keep_backup = FALSE;
1170 if (stat (backup_path, &statbuf) != -1) {
1171 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1172 ret = NOTMUCH_STATUS_FILE_ERROR;
1175 if (errno != ENOENT) {
1176 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1178 ret = NOTMUCH_STATUS_FILE_ERROR;
1182 /* Unconditionally attempt to remove old work-in-progress database (if
1183 * any). This is "protected" by database lock. If this fails due to write
1184 * errors (etc), the following code will fail and provide error message.
1186 (void) rmtree (compact_xapian_path);
1189 NotmuchCompactor compactor (status_cb, closure);
1191 compactor.set_renumber (false);
1192 compactor.add_source (xapian_path);
1193 compactor.set_destdir (compact_xapian_path);
1194 compactor.compact ();
1195 } catch (const Xapian::Error &error) {
1196 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg().c_str());
1197 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1201 if (rename (xapian_path, backup_path)) {
1202 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1203 xapian_path, backup_path, strerror (errno));
1204 ret = NOTMUCH_STATUS_FILE_ERROR;
1208 if (rename (compact_xapian_path, xapian_path)) {
1209 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1210 compact_xapian_path, xapian_path, strerror (errno));
1211 ret = NOTMUCH_STATUS_FILE_ERROR;
1215 if (! keep_backup) {
1216 if (rmtree (backup_path)) {
1217 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1218 backup_path, strerror (errno));
1219 ret = NOTMUCH_STATUS_FILE_ERROR;
1226 notmuch_status_t ret2;
1228 const char *str = notmuch_database_status_string (notmuch);
1229 if (status_cb && str)
1230 status_cb (str, closure);
1232 ret2 = notmuch_database_destroy (notmuch);
1234 /* don't clobber previous error status */
1235 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1239 talloc_free (local);
1245 notmuch_database_compact (unused (const char *path),
1246 unused (const char *backup_path),
1247 unused (notmuch_compact_status_cb_t status_cb),
1248 unused (void *closure))
1250 _notmuch_database_log (notmuch, "notmuch was compiled against a xapian version lacking compaction support.\n");
1251 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1256 notmuch_database_destroy (notmuch_database_t *notmuch)
1258 notmuch_status_t status;
1260 status = notmuch_database_close (notmuch);
1261 talloc_free (notmuch);
1267 notmuch_database_get_path (notmuch_database_t *notmuch)
1269 return notmuch->path;
1273 notmuch_database_get_version (notmuch_database_t *notmuch)
1275 unsigned int version;
1276 string version_string;
1280 version_string = notmuch->xapian_db->get_metadata ("version");
1281 if (version_string.empty ())
1284 str = version_string.c_str ();
1285 if (str == NULL || *str == '\0')
1288 version = strtoul (str, &end, 10);
1290 INTERNAL_ERROR ("Malformed database version: %s", str);
1296 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1298 return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1299 ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1300 (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1303 static volatile sig_atomic_t do_progress_notify = 0;
1306 handle_sigalrm (unused (int signal))
1308 do_progress_notify = 1;
1311 /* Upgrade the current database.
1313 * After opening a database in read-write mode, the client should
1314 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1315 * if so, upgrade with this function before making any modifications.
1317 * The optional progress_notify callback can be used by the caller to
1318 * provide progress indication to the user. If non-NULL it will be
1319 * called periodically with 'count' as the number of messages upgraded
1320 * so far and 'total' the overall number of messages that will be
1324 notmuch_database_upgrade (notmuch_database_t *notmuch,
1325 void (*progress_notify) (void *closure,
1329 void *local = talloc_new (NULL);
1330 Xapian::TermIterator t, t_end;
1331 Xapian::WritableDatabase *db;
1332 struct sigaction action;
1333 struct itimerval timerval;
1334 notmuch_bool_t timer_is_active = FALSE;
1335 enum _notmuch_features target_features, new_features;
1336 notmuch_status_t status;
1337 notmuch_private_status_t private_status;
1338 unsigned int count = 0, total = 0;
1340 status = _notmuch_database_ensure_writable (notmuch);
1344 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1346 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1347 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1349 if (! notmuch_database_needs_upgrade (notmuch))
1350 return NOTMUCH_STATUS_SUCCESS;
1352 if (progress_notify) {
1353 /* Set up our handler for SIGALRM */
1354 memset (&action, 0, sizeof (struct sigaction));
1355 action.sa_handler = handle_sigalrm;
1356 sigemptyset (&action.sa_mask);
1357 action.sa_flags = SA_RESTART;
1358 sigaction (SIGALRM, &action, NULL);
1360 /* Then start a timer to send SIGALRM once per second. */
1361 timerval.it_interval.tv_sec = 1;
1362 timerval.it_interval.tv_usec = 0;
1363 timerval.it_value.tv_sec = 1;
1364 timerval.it_value.tv_usec = 0;
1365 setitimer (ITIMER_REAL, &timerval, NULL);
1367 timer_is_active = TRUE;
1370 /* Figure out how much total work we need to do. */
1372 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER)) {
1373 notmuch_query_t *query = notmuch_query_create (notmuch, "");
1374 total += notmuch_query_count_messages (query);
1375 notmuch_query_destroy (query);
1377 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1378 t_end = db->allterms_end ("XTIMESTAMP");
1379 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1382 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1383 /* The ghost message upgrade converts all thread_id_*
1384 * metadata values into ghost message documents. */
1385 t_end = db->metadata_keys_end ("thread_id_");
1386 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1390 /* Perform the upgrade in a transaction. */
1391 db->begin_transaction (true);
1393 /* Set the target features so we write out changes in the desired
1395 notmuch->features = target_features;
1397 /* Perform per-message upgrades. */
1399 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER)) {
1400 notmuch_query_t *query = notmuch_query_create (notmuch, "");
1401 notmuch_messages_t *messages;
1402 notmuch_message_t *message;
1405 for (messages = notmuch_query_search_messages (query);
1406 notmuch_messages_valid (messages);
1407 notmuch_messages_move_to_next (messages))
1409 if (do_progress_notify) {
1410 progress_notify (closure, (double) count / total);
1411 do_progress_notify = 0;
1414 message = notmuch_messages_get (messages);
1416 /* Before version 1, each message document had its
1417 * filename in the data field. Copy that into the new
1418 * format by calling notmuch_message_add_filename.
1420 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1421 filename = _notmuch_message_talloc_copy_data (message);
1422 if (filename && *filename != '\0') {
1423 _notmuch_message_add_filename (message, filename);
1424 _notmuch_message_clear_data (message);
1426 talloc_free (filename);
1429 /* Prior to version 2, the "folder:" prefix was
1430 * probabilistic and stemmed. Change it to the current
1431 * boolean prefix. Add "path:" prefixes while at it.
1433 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1434 _notmuch_message_upgrade_folder (message);
1436 _notmuch_message_sync (message);
1438 notmuch_message_destroy (message);
1443 notmuch_query_destroy (query);
1446 /* Perform per-directory upgrades. */
1448 /* Before version 1 we stored directory timestamps in
1449 * XTIMESTAMP documents instead of the current XDIRECTORY
1450 * documents. So copy those as well. */
1451 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1452 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1454 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1458 Xapian::PostingIterator p, p_end;
1459 std::string term = *t;
1461 p_end = notmuch->xapian_db->postlist_end (term);
1463 for (p = notmuch->xapian_db->postlist_begin (term);
1467 Xapian::Document document;
1469 notmuch_directory_t *directory;
1471 if (do_progress_notify) {
1472 progress_notify (closure, (double) count / total);
1473 do_progress_notify = 0;
1476 document = find_document_for_doc_id (notmuch, *p);
1477 mtime = Xapian::sortable_unserialise (
1478 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1480 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1481 NOTMUCH_FIND_CREATE, &status);
1482 notmuch_directory_set_mtime (directory, mtime);
1483 notmuch_directory_destroy (directory);
1485 db->delete_document (*p);
1492 /* Perform metadata upgrades. */
1494 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1495 * messages were stored as database metadata. Change these to
1498 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1499 notmuch_message_t *message;
1500 std::string message_id, thread_id;
1502 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1503 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1505 if (do_progress_notify) {
1506 progress_notify (closure, (double) count / total);
1507 do_progress_notify = 0;
1510 message_id = (*t).substr (
1511 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1512 thread_id = db->get_metadata (*t);
1514 /* Create ghost message */
1515 message = _notmuch_message_create_for_message_id (
1516 notmuch, message_id.c_str (), &private_status);
1517 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1518 /* Document already exists; ignore the stored thread ID */
1519 } else if (private_status ==
1520 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1521 private_status = _notmuch_message_initialize_ghost (
1522 message, thread_id.c_str ());
1523 if (! private_status)
1524 _notmuch_message_sync (message);
1527 if (private_status) {
1528 _notmuch_database_log (notmuch,
1529 "Upgrade failed while creating ghost messages.\n");
1530 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1534 /* Clear saved metadata thread ID */
1535 db->set_metadata (*t, "");
1541 status = NOTMUCH_STATUS_SUCCESS;
1542 db->set_metadata ("features", _print_features (local, notmuch->features));
1543 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1546 if (status == NOTMUCH_STATUS_SUCCESS)
1547 db->commit_transaction ();
1549 db->cancel_transaction ();
1551 if (timer_is_active) {
1552 /* Now stop the timer. */
1553 timerval.it_interval.tv_sec = 0;
1554 timerval.it_interval.tv_usec = 0;
1555 timerval.it_value.tv_sec = 0;
1556 timerval.it_value.tv_usec = 0;
1557 setitimer (ITIMER_REAL, &timerval, NULL);
1559 /* And disable the signal handler. */
1560 action.sa_handler = SIG_IGN;
1561 sigaction (SIGALRM, &action, NULL);
1564 talloc_free (local);
1569 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1571 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1572 notmuch->atomic_nesting > 0)
1576 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1577 } catch (const Xapian::Error &error) {
1578 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1579 error.get_msg().c_str());
1580 notmuch->exception_reported = TRUE;
1581 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1585 notmuch->atomic_nesting++;
1586 return NOTMUCH_STATUS_SUCCESS;
1590 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1592 Xapian::WritableDatabase *db;
1594 if (notmuch->atomic_nesting == 0)
1595 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1597 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1598 notmuch->atomic_nesting > 1)
1601 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1603 db->commit_transaction ();
1605 /* This is a hack for testing. Xapian never flushes on a
1606 * non-flushed commit, even if the flush threshold is 1.
1607 * However, we rely on flushing to test atomicity. */
1608 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1609 if (thresh && atoi (thresh) == 1)
1611 } catch (const Xapian::Error &error) {
1612 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1613 error.get_msg().c_str());
1614 notmuch->exception_reported = TRUE;
1615 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1619 notmuch->atomic_nesting--;
1620 return NOTMUCH_STATUS_SUCCESS;
1623 /* We allow the user to use arbitrarily long paths for directories. But
1624 * we have a term-length limit. So if we exceed that, we'll use the
1625 * SHA-1 of the path for the database term.
1627 * Note: This function may return the original value of 'path'. If it
1628 * does not, then the caller is responsible to free() the returned
1632 _notmuch_database_get_directory_db_path (const char *path)
1634 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1636 if (term_len > NOTMUCH_TERM_MAX)
1637 return _notmuch_sha1_of_string (path);
1642 /* Given a path, split it into two parts: the directory part is all
1643 * components except for the last, and the basename is that last
1644 * component. Getting the return-value for either part is optional
1645 * (the caller can pass NULL).
1647 * The original 'path' can represent either a regular file or a
1648 * directory---the splitting will be carried out in the same way in
1649 * either case. Trailing slashes on 'path' will be ignored, and any
1650 * cases of multiple '/' characters appearing in series will be
1651 * treated as a single '/'.
1653 * Allocation (if any) will have 'ctx' as the talloc owner. But
1654 * pointers will be returned within the original path string whenever
1657 * Note: If 'path' is non-empty and contains no non-trailing slash,
1658 * (that is, consists of a filename with no parent directory), then
1659 * the directory returned will be an empty string. However, if 'path'
1660 * is an empty string, then both directory and basename will be
1664 _notmuch_database_split_path (void *ctx,
1666 const char **directory,
1667 const char **basename)
1671 if (path == NULL || *path == '\0') {
1676 return NOTMUCH_STATUS_SUCCESS;
1679 /* Find the last slash (not counting a trailing slash), if any. */
1681 slash = path + strlen (path) - 1;
1683 /* First, skip trailing slashes. */
1684 while (slash != path) {
1691 /* Then, find a slash. */
1692 while (slash != path) {
1702 /* Finally, skip multiple slashes. */
1703 while (slash != path) {
1710 if (slash == path) {
1712 *directory = talloc_strdup (ctx, "");
1717 *directory = talloc_strndup (ctx, path, slash - path + 1);
1720 return NOTMUCH_STATUS_SUCCESS;
1723 /* Find the document ID of the specified directory.
1725 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1726 * created if one does not exist for 'path'. Otherwise, if the
1727 * directory document does not exist, this sets *directory_id to
1728 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1731 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1733 notmuch_find_flags_t flags,
1734 unsigned int *directory_id)
1736 notmuch_directory_t *directory;
1737 notmuch_status_t status;
1741 return NOTMUCH_STATUS_SUCCESS;
1744 directory = _notmuch_directory_create (notmuch, path, flags, &status);
1745 if (status || !directory) {
1750 *directory_id = _notmuch_directory_get_document_id (directory);
1752 notmuch_directory_destroy (directory);
1754 return NOTMUCH_STATUS_SUCCESS;
1758 _notmuch_database_get_directory_path (void *ctx,
1759 notmuch_database_t *notmuch,
1760 unsigned int doc_id)
1762 Xapian::Document document;
1764 document = find_document_for_doc_id (notmuch, doc_id);
1766 return talloc_strdup (ctx, document.get_data ().c_str ());
1769 /* Given a legal 'filename' for the database, (either relative to
1770 * database path or absolute with initial components identical to
1771 * database path), return a new string (with 'ctx' as the talloc
1772 * owner) suitable for use as a direntry term value.
1774 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1775 * will be created in the database as needed. Otherwise, if the
1776 * necessary directory documents do not exist, this sets
1777 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1780 _notmuch_database_filename_to_direntry (void *ctx,
1781 notmuch_database_t *notmuch,
1782 const char *filename,
1783 notmuch_find_flags_t flags,
1786 const char *relative, *directory, *basename;
1787 Xapian::docid directory_id;
1788 notmuch_status_t status;
1790 relative = _notmuch_database_relative_path (notmuch, filename);
1792 status = _notmuch_database_split_path (ctx, relative,
1793 &directory, &basename);
1797 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1799 if (status || directory_id == (unsigned int)-1) {
1804 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1806 return NOTMUCH_STATUS_SUCCESS;
1809 /* Given a legal 'path' for the database, return the relative path.
1811 * The return value will be a pointer to the original path contents,
1812 * and will be either the original string (if 'path' was relative) or
1813 * a portion of the string (if path was absolute and begins with the
1817 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1820 const char *db_path, *relative;
1821 unsigned int db_path_len;
1823 db_path = notmuch_database_get_path (notmuch);
1824 db_path_len = strlen (db_path);
1828 if (*relative == '/') {
1829 while (*relative == '/' && *(relative+1) == '/')
1832 if (strncmp (relative, db_path, db_path_len) == 0)
1834 relative += db_path_len;
1835 while (*relative == '/')
1844 notmuch_database_get_directory (notmuch_database_t *notmuch,
1846 notmuch_directory_t **directory)
1848 notmuch_status_t status;
1850 if (directory == NULL)
1851 return NOTMUCH_STATUS_NULL_POINTER;
1855 *directory = _notmuch_directory_create (notmuch, path,
1856 NOTMUCH_FIND_LOOKUP, &status);
1857 } catch (const Xapian::Error &error) {
1858 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1859 error.get_msg().c_str());
1860 notmuch->exception_reported = TRUE;
1861 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1866 /* Allocate a document ID that satisfies the following criteria:
1868 * 1. The ID does not exist for any document in the Xapian database
1870 * 2. The ID was not previously returned from this function
1872 * 3. The ID is the smallest integer satisfying (1) and (2)
1874 * This function will trigger an internal error if these constraints
1875 * cannot all be satisfied, (that is, the pool of available document
1876 * IDs has been exhausted).
1879 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1881 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1883 notmuch->last_doc_id++;
1885 if (notmuch->last_doc_id == 0)
1886 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1888 return notmuch->last_doc_id;
1892 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1894 /* 16 bytes (+ terminator) for hexadecimal representation of
1895 * a 64-bit integer. */
1896 static char thread_id[17];
1897 Xapian::WritableDatabase *db;
1899 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1901 notmuch->last_thread_id++;
1903 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1905 db->set_metadata ("last_thread_id", thread_id);
1911 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1913 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1914 message_id = _notmuch_message_id_compressed (ctx, message_id);
1916 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
1920 static notmuch_status_t
1921 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
1923 const char *message_id,
1924 const char **thread_id_ret);
1926 /* Find the thread ID to which the message with 'message_id' belongs.
1928 * Note: 'thread_id_ret' must not be NULL!
1929 * On success '*thread_id_ret' is set to a newly talloced string belonging to
1932 * Note: If there is no message in the database with the given
1933 * 'message_id' then a new thread_id will be allocated for this
1934 * message ID and stored in the database metadata so that the
1935 * thread ID can be looked up if the message is added to the database
1938 static notmuch_status_t
1939 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
1941 const char *message_id,
1942 const char **thread_id_ret)
1944 notmuch_private_status_t status;
1945 notmuch_message_t *message;
1947 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS))
1948 return _resolve_message_id_to_thread_id_old (notmuch, ctx, message_id,
1951 /* Look for this message (regular or ghost) */
1952 message = _notmuch_message_create_for_message_id (
1953 notmuch, message_id, &status);
1954 if (status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1955 /* Message exists */
1956 *thread_id_ret = talloc_steal (
1957 ctx, notmuch_message_get_thread_id (message));
1958 } else if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1959 /* Message did not exist. Give it a fresh thread ID and
1960 * populate this message as a ghost message. */
1961 *thread_id_ret = talloc_strdup (
1962 ctx, _notmuch_database_generate_thread_id (notmuch));
1963 if (! *thread_id_ret) {
1964 status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
1966 status = _notmuch_message_initialize_ghost (message, *thread_id_ret);
1968 /* Commit the new ghost message */
1969 _notmuch_message_sync (message);
1972 /* Create failed. Fall through. */
1975 notmuch_message_destroy (message);
1977 return COERCE_STATUS (status, "Error creating ghost message");
1980 /* Pre-ghost messages _resolve_message_id_to_thread_id */
1981 static notmuch_status_t
1982 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
1984 const char *message_id,
1985 const char **thread_id_ret)
1987 notmuch_status_t status;
1988 notmuch_message_t *message;
1989 string thread_id_string;
1991 Xapian::WritableDatabase *db;
1993 status = notmuch_database_find_message (notmuch, message_id, &message);
1999 *thread_id_ret = talloc_steal (ctx,
2000 notmuch_message_get_thread_id (message));
2002 notmuch_message_destroy (message);
2004 return NOTMUCH_STATUS_SUCCESS;
2007 /* Message has not been seen yet.
2009 * We may have seen a reference to it already, in which case, we
2010 * can return the thread ID stored in the metadata. Otherwise, we
2011 * generate a new thread ID and store it there.
2013 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2014 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2015 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
2017 if (thread_id_string.empty()) {
2018 *thread_id_ret = talloc_strdup (ctx,
2019 _notmuch_database_generate_thread_id (notmuch));
2020 db->set_metadata (metadata_key, *thread_id_ret);
2022 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
2025 talloc_free (metadata_key);
2027 return NOTMUCH_STATUS_SUCCESS;
2030 static notmuch_status_t
2031 _merge_threads (notmuch_database_t *notmuch,
2032 const char *winner_thread_id,
2033 const char *loser_thread_id)
2035 Xapian::PostingIterator loser, loser_end;
2036 notmuch_message_t *message = NULL;
2037 notmuch_private_status_t private_status;
2038 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2040 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
2042 for ( ; loser != loser_end; loser++) {
2043 message = _notmuch_message_create (notmuch, notmuch,
2044 *loser, &private_status);
2045 if (message == NULL) {
2046 ret = COERCE_STATUS (private_status,
2047 "Cannot find document for doc_id from query");
2051 _notmuch_message_remove_term (message, "thread", loser_thread_id);
2052 _notmuch_message_add_term (message, "thread", winner_thread_id);
2053 _notmuch_message_sync (message);
2055 notmuch_message_destroy (message);
2061 notmuch_message_destroy (message);
2067 _my_talloc_free_for_g_hash (void *ptr)
2072 static notmuch_status_t
2073 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
2074 notmuch_message_t *message,
2075 notmuch_message_file_t *message_file,
2076 const char **thread_id)
2078 GHashTable *parents = NULL;
2079 const char *refs, *in_reply_to, *in_reply_to_message_id;
2080 const char *last_ref_message_id, *this_message_id;
2081 GList *l, *keys = NULL;
2082 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2084 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
2085 _my_talloc_free_for_g_hash, NULL);
2086 this_message_id = notmuch_message_get_message_id (message);
2088 refs = _notmuch_message_file_get_header (message_file, "references");
2089 last_ref_message_id = parse_references (message,
2093 in_reply_to = _notmuch_message_file_get_header (message_file, "in-reply-to");
2094 in_reply_to_message_id = parse_references (message,
2096 parents, in_reply_to);
2098 /* For the parent of this message, use the last message ID of the
2099 * References header, if available. If not, fall back to the
2100 * first message ID in the In-Reply-To header. */
2101 if (last_ref_message_id) {
2102 _notmuch_message_add_term (message, "replyto",
2103 last_ref_message_id);
2104 } else if (in_reply_to_message_id) {
2105 _notmuch_message_add_term (message, "replyto",
2106 in_reply_to_message_id);
2109 keys = g_hash_table_get_keys (parents);
2110 for (l = keys; l; l = l->next) {
2111 char *parent_message_id;
2112 const char *parent_thread_id = NULL;
2114 parent_message_id = (char *) l->data;
2116 _notmuch_message_add_term (message, "reference",
2119 ret = _resolve_message_id_to_thread_id (notmuch,
2126 if (*thread_id == NULL) {
2127 *thread_id = talloc_strdup (message, parent_thread_id);
2128 _notmuch_message_add_term (message, "thread", *thread_id);
2129 } else if (strcmp (*thread_id, parent_thread_id)) {
2130 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
2140 g_hash_table_unref (parents);
2145 static notmuch_status_t
2146 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
2147 notmuch_message_t *message,
2148 const char **thread_id)
2150 const char *message_id = notmuch_message_get_message_id (message);
2151 Xapian::PostingIterator child, children_end;
2152 notmuch_message_t *child_message = NULL;
2153 const char *child_thread_id;
2154 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2155 notmuch_private_status_t private_status;
2157 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
2159 for ( ; child != children_end; child++) {
2161 child_message = _notmuch_message_create (message, notmuch,
2162 *child, &private_status);
2163 if (child_message == NULL) {
2164 ret = COERCE_STATUS (private_status,
2165 "Cannot find document for doc_id from query");
2169 child_thread_id = notmuch_message_get_thread_id (child_message);
2170 if (*thread_id == NULL) {
2171 *thread_id = talloc_strdup (message, child_thread_id);
2172 _notmuch_message_add_term (message, "thread", *thread_id);
2173 } else if (strcmp (*thread_id, child_thread_id)) {
2174 _notmuch_message_remove_term (child_message, "reference",
2176 _notmuch_message_sync (child_message);
2177 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
2182 notmuch_message_destroy (child_message);
2183 child_message = NULL;
2188 notmuch_message_destroy (child_message);
2193 /* Fetch and clear the stored thread_id for message, or NULL if none. */
2195 _consume_metadata_thread_id (void *ctx, notmuch_database_t *notmuch,
2196 notmuch_message_t *message)
2198 const char *message_id;
2202 message_id = notmuch_message_get_message_id (message);
2203 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2205 /* Check if we have already seen related messages to this one.
2206 * If we have then use the thread_id that we stored at that time.
2208 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
2209 if (stored_id.empty ()) {
2212 Xapian::WritableDatabase *db;
2214 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2216 /* Clear the metadata for this message ID. We don't need it
2218 db->set_metadata (metadata_key, "");
2220 return talloc_strdup (ctx, stored_id.c_str ());
2224 /* Given a blank or ghost 'message' and its corresponding
2225 * 'message_file' link it to existing threads in the database.
2227 * First, if is_ghost, this retrieves the thread ID already stored in
2228 * the message (which will be the case if a message was previously
2229 * added that referenced this one). If the message is blank
2230 * (!is_ghost), it doesn't have a thread ID yet (we'll generate one
2231 * later in this function). If the database does not support ghost
2232 * messages, this checks for a thread ID stored in database metadata
2233 * for this message ID.
2235 * Second, we look at 'message_file' and its link-relevant headers
2236 * (References and In-Reply-To) for message IDs.
2238 * Finally, we look in the database for existing message that
2239 * reference 'message'.
2241 * In all cases, we assign to the current message the first thread ID
2242 * found. We will also merge any existing, distinct threads where this
2243 * message belongs to both, (which is not uncommon when messages are
2244 * processed out of order).
2246 * Finally, if no thread ID has been found through referenced messages, we
2247 * call _notmuch_message_generate_thread_id to generate a new thread
2248 * ID. This should only happen for new, top-level messages, (no
2249 * References or In-Reply-To header in this message, and no previously
2250 * added message refers to this message).
2252 static notmuch_status_t
2253 _notmuch_database_link_message (notmuch_database_t *notmuch,
2254 notmuch_message_t *message,
2255 notmuch_message_file_t *message_file,
2256 notmuch_bool_t is_ghost)
2258 void *local = talloc_new (NULL);
2259 notmuch_status_t status;
2260 const char *thread_id = NULL;
2262 /* Check if the message already had a thread ID */
2263 if (notmuch->features & NOTMUCH_FEATURE_GHOSTS) {
2265 thread_id = notmuch_message_get_thread_id (message);
2267 thread_id = _consume_metadata_thread_id (local, notmuch, message);
2269 _notmuch_message_add_term (message, "thread", thread_id);
2272 status = _notmuch_database_link_message_to_parents (notmuch, message,
2278 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS)) {
2279 /* In general, it shouldn't be necessary to link children,
2280 * since the earlier indexing of those children will have
2281 * stored a thread ID for the missing parent. However, prior
2282 * to ghost messages, these stored thread IDs were NOT
2283 * rewritten during thread merging (and there was no
2284 * performant way to do so), so if indexed children were
2285 * pulled into a different thread ID by a merge, it was
2286 * necessary to pull them *back* into the stored thread ID of
2287 * the parent. With ghost messages, we just rewrite the
2288 * stored thread IDs during merging, so this workaround isn't
2290 status = _notmuch_database_link_message_to_children (notmuch, message,
2296 /* If not part of any existing thread, generate a new thread ID. */
2297 if (thread_id == NULL) {
2298 thread_id = _notmuch_database_generate_thread_id (notmuch);
2300 _notmuch_message_add_term (message, "thread", thread_id);
2304 talloc_free (local);
2310 notmuch_database_add_message (notmuch_database_t *notmuch,
2311 const char *filename,
2312 notmuch_message_t **message_ret)
2314 notmuch_message_file_t *message_file;
2315 notmuch_message_t *message = NULL;
2316 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
2317 notmuch_private_status_t private_status;
2318 notmuch_bool_t is_ghost = false;
2320 const char *date, *header;
2321 const char *from, *to, *subject;
2322 char *message_id = NULL;
2325 *message_ret = NULL;
2327 ret = _notmuch_database_ensure_writable (notmuch);
2331 message_file = _notmuch_message_file_open (notmuch, filename);
2332 if (message_file == NULL)
2333 return NOTMUCH_STATUS_FILE_ERROR;
2335 /* Adding a message may change many documents. Do this all
2337 ret = notmuch_database_begin_atomic (notmuch);
2341 /* Parse message up front to get better error status. */
2342 ret = _notmuch_message_file_parse (message_file);
2347 /* Before we do any real work, (especially before doing a
2348 * potential SHA-1 computation on the entire file's contents),
2349 * let's make sure that what we're looking at looks like an
2350 * actual email message.
2352 from = _notmuch_message_file_get_header (message_file, "from");
2353 subject = _notmuch_message_file_get_header (message_file, "subject");
2354 to = _notmuch_message_file_get_header (message_file, "to");
2356 if ((from == NULL || *from == '\0') &&
2357 (subject == NULL || *subject == '\0') &&
2358 (to == NULL || *to == '\0'))
2360 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
2364 /* Now that we're sure it's mail, the first order of business
2365 * is to find a message ID (or else create one ourselves). */
2367 header = _notmuch_message_file_get_header (message_file, "message-id");
2368 if (header && *header != '\0') {
2369 message_id = _parse_message_id (message_file, header, NULL);
2371 /* So the header value isn't RFC-compliant, but it's
2372 * better than no message-id at all. */
2373 if (message_id == NULL)
2374 message_id = talloc_strdup (message_file, header);
2377 if (message_id == NULL ) {
2378 /* No message-id at all, let's generate one by taking a
2379 * hash over the file's contents. */
2380 char *sha1 = _notmuch_sha1_of_file (filename);
2382 /* If that failed too, something is really wrong. Give up. */
2384 ret = NOTMUCH_STATUS_FILE_ERROR;
2388 message_id = talloc_asprintf (message_file,
2389 "notmuch-sha1-%s", sha1);
2393 /* Now that we have a message ID, we get a message object,
2394 * (which may or may not reference an existing document in the
2397 message = _notmuch_message_create_for_message_id (notmuch,
2401 talloc_free (message_id);
2403 if (message == NULL) {
2404 ret = COERCE_STATUS (private_status,
2405 "Unexpected status value from _notmuch_message_create_for_message_id");
2409 _notmuch_message_add_filename (message, filename);
2411 /* Is this a newly created message object or a ghost
2412 * message? We have to be slightly careful: if this is a
2413 * blank message, it's not safe to call
2414 * notmuch_message_get_flag yet. */
2415 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND ||
2416 (is_ghost = notmuch_message_get_flag (
2417 message, NOTMUCH_MESSAGE_FLAG_GHOST))) {
2418 _notmuch_message_add_term (message, "type", "mail");
2420 /* Convert ghost message to a regular message */
2421 _notmuch_message_remove_term (message, "type", "ghost");
2423 ret = _notmuch_database_link_message (notmuch, message,
2424 message_file, is_ghost);
2428 date = _notmuch_message_file_get_header (message_file, "date");
2429 _notmuch_message_set_header_values (message, date, from, subject);
2431 ret = _notmuch_message_index_file (message, message_file);
2435 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2438 _notmuch_message_sync (message);
2439 } catch (const Xapian::Error &error) {
2440 _notmuch_database_log (notmuch, "A Xapian exception occurred adding message: %s.\n",
2441 error.get_msg().c_str());
2442 notmuch->exception_reported = TRUE;
2443 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2449 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2450 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2451 *message_ret = message;
2453 notmuch_message_destroy (message);
2457 _notmuch_message_file_close (message_file);
2459 ret2 = notmuch_database_end_atomic (notmuch);
2460 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2461 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2462 ret2 != NOTMUCH_STATUS_SUCCESS)
2469 notmuch_database_remove_message (notmuch_database_t *notmuch,
2470 const char *filename)
2472 notmuch_status_t status;
2473 notmuch_message_t *message;
2475 status = notmuch_database_find_message_by_filename (notmuch, filename,
2478 if (status == NOTMUCH_STATUS_SUCCESS && message) {
2479 status = _notmuch_message_remove_filename (message, filename);
2480 if (status == NOTMUCH_STATUS_SUCCESS)
2481 _notmuch_message_delete (message);
2482 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2483 _notmuch_message_sync (message);
2485 notmuch_message_destroy (message);
2492 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2493 const char *filename,
2494 notmuch_message_t **message_ret)
2497 const char *prefix = _find_prefix ("file-direntry");
2498 char *direntry, *term;
2499 Xapian::PostingIterator i, end;
2500 notmuch_status_t status;
2502 if (message_ret == NULL)
2503 return NOTMUCH_STATUS_NULL_POINTER;
2505 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2506 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2508 /* return NULL on any failure */
2509 *message_ret = NULL;
2511 local = talloc_new (notmuch);
2514 status = _notmuch_database_filename_to_direntry (
2515 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2516 if (status || !direntry)
2519 term = talloc_asprintf (local, "%s%s", prefix, direntry);
2521 find_doc_ids_for_term (notmuch, term, &i, &end);
2524 notmuch_private_status_t private_status;
2526 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2528 if (*message_ret == NULL)
2529 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2531 } catch (const Xapian::Error &error) {
2532 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2533 error.get_msg().c_str());
2534 notmuch->exception_reported = TRUE;
2535 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2539 talloc_free (local);
2541 if (status && *message_ret) {
2542 notmuch_message_destroy (*message_ret);
2543 *message_ret = NULL;
2548 notmuch_string_list_t *
2549 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2550 Xapian::TermIterator &end,
2553 int prefix_len = strlen (prefix);
2554 notmuch_string_list_t *list;
2556 list = _notmuch_string_list_create (ctx);
2557 if (unlikely (list == NULL))
2560 for (i.skip_to (prefix); i != end; i++) {
2561 /* Terminate loop at first term without desired prefix. */
2562 if (strncmp ((*i).c_str (), prefix, prefix_len))
2565 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2572 notmuch_database_get_all_tags (notmuch_database_t *db)
2574 Xapian::TermIterator i, end;
2575 notmuch_string_list_t *tags;
2578 i = db->xapian_db->allterms_begin();
2579 end = db->xapian_db->allterms_end();
2580 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2581 _find_prefix ("tag"));
2582 _notmuch_string_list_sort (tags);
2583 return _notmuch_tags_create (db, tags);
2584 } catch (const Xapian::Error &error) {
2585 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2586 error.get_msg().c_str());
2587 db->exception_reported = TRUE;
2593 notmuch_database_status_string (notmuch_database_t *notmuch)
2595 return notmuch->status_string;