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 * LAST_MOD: The revision number as of the last tag or
107 * In addition, terms from the content of the message are added with
108 * "from", "to", "attachment", and "subject" prefixes for use by the
109 * user in searching. Similarly, terms from the path of the mail
110 * message are added with "folder" and "path" prefixes. But the
111 * database doesn't really care itself about any of these.
113 * The data portion of a mail document is empty.
115 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
116 * -----------------------------------------------
117 * A ghost mail document is like a mail document, but where we don't
118 * have the message content. These are used to track thread reference
119 * information for messages we haven't received.
121 * A ghost mail document has type: ghost; id and thread fields that
122 * are identical to the mail document fields; and a MESSAGE_ID value.
126 * A directory document is used by a client of the notmuch library to
127 * maintain data necessary to allow for efficient polling of mail
130 * All directory documents contain one term:
132 * directory: The directory path (relative to the database path)
133 * Or the SHA1 sum of the directory path (if the
134 * path itself is too long to fit in a Xapian
137 * And all directory documents for directories other than top-level
138 * directories also contain the following term:
140 * directory-direntry: A colon-separated pair of values
141 * (INTEGER:STRING), where INTEGER is the
142 * document ID of the parent directory
143 * document, and STRING is the name of this
144 * directory within that parent.
146 * All directory documents have a single value:
148 * TIMESTAMP: The mtime of the directory (at last scan)
150 * The data portion of a directory document contains the path of the
151 * directory (relative to the database path).
155 * Xapian allows us to store arbitrary name-value pairs as
156 * "metadata". We currently use the following metadata names with the
159 * version The database schema version, (which is distinct
160 * from both the notmuch package version (see
161 * notmuch --version) and the libnotmuch library
162 * version. The version is stored as an base-10
163 * ASCII integer. The initial database version
164 * was 1, (though a schema existed before that
165 * were no "version" database value existed at
166 * all). Successive versions are allocated as
167 * changes are made to the database (such as by
168 * indexing new fields).
170 * features The set of features supported by this
171 * database. This consists of a set of
172 * '\n'-separated lines, where each is a feature
173 * name, a '\t', and compatibility flags. If the
174 * compatibility flags contain 'w', then the
175 * opener must support this feature to safely
176 * write this database. If the compatibility
177 * flags contain 'r', then the opener must
178 * support this feature to read this database.
179 * Introduced in database version 3.
181 * last_thread_id The last thread ID generated. This is stored
182 * as a 16-byte hexadecimal ASCII representation
183 * of a 64-bit unsigned integer. The first ID
184 * generated is 1 and the value will be
185 * incremented for each thread ID.
190 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
191 * Instead, the database has the following additional database
194 * thread_id_* A pre-allocated thread ID for a particular
195 * message. This is actually an arbitrarily large
196 * family of metadata name. Any particular name is
197 * formed by concatenating "thread_id_" with a message
198 * ID (or the SHA1 sum of a message ID if it is very
199 * long---see description of 'id' in the mail
200 * document). The value stored is a thread ID.
202 * These thread ID metadata values are stored
203 * whenever a message references a parent message
204 * that does not yet exist in the database. A
205 * thread ID will be allocated and stored, and if
206 * the message is later added, the stored thread
207 * ID will be used (and the metadata value will
210 * Even before a message is added, it's
211 * pre-allocated thread ID is useful so that all
212 * descendant messages that reference this common
213 * parent can be recognized as belonging to the
217 /* With these prefix values we follow the conventions published here:
219 * http://xapian.org/docs/omega/termprefixes.html
221 * as much as makes sense. Note that I took some liberty in matching
222 * the reserved prefix values to notmuch concepts, (for example, 'G'
223 * is documented as "newsGroup (or similar entity - e.g. a web forum
224 * name)", for which I think the thread is the closest analogue in
225 * notmuch. This in spite of the fact that we will eventually be
226 * storing mailing-list messages where 'G' for "mailing list name"
227 * might be even a closer analogue. I'm treating the single-character
228 * prefixes preferentially for core notmuch concepts (which will be
229 * nearly universal to all mail messages).
232 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
234 { "reference", "XREFERENCE" },
235 { "replyto", "XREPLYTO" },
236 { "directory", "XDIRECTORY" },
237 { "file-direntry", "XFDIRENTRY" },
238 { "directory-direntry", "XDDIRENTRY" },
241 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
248 * Without the ":", since this is a multi-letter prefix, Xapian
249 * will add a colon itself if the first letter of the path is
250 * upper-case ASCII. Including the ":" forces there to always be a
251 * colon, which keeps our own logic simpler.
253 { "folder", "XFOLDER:" },
256 static prefix_t PROBABILISTIC_PREFIX[]= {
259 { "attachment", "XATTACHMENT" },
260 { "mimetype", "XMIMETYPE"},
261 { "subject", "XSUBJECT"},
265 _find_prefix (const char *name)
269 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
270 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
271 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
274 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
275 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
276 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
279 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
280 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
281 return PROBABILISTIC_PREFIX[i].prefix;
284 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
289 static const struct {
290 /* NOTMUCH_FEATURE_* value. */
291 _notmuch_features value;
292 /* Feature name as it appears in the database. This name should
293 * be appropriate for displaying to the user if an older version
294 * of notmuch doesn't support this feature. */
296 /* Compatibility flags when this feature is declared. */
298 } feature_names[] = {
299 { NOTMUCH_FEATURE_FILE_TERMS,
300 "multiple paths per message", "rw" },
301 { NOTMUCH_FEATURE_DIRECTORY_DOCS,
302 "relative directory paths", "rw" },
303 /* Header values are not required for reading a database because a
304 * reader can just refer to the message file. */
305 { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
306 "from/subject/message-ID in database", "w" },
307 { NOTMUCH_FEATURE_BOOL_FOLDER,
308 "exact folder:/path: search", "rw" },
309 { NOTMUCH_FEATURE_GHOSTS,
310 "mail documents for missing messages", "w"},
311 /* Knowledge of the index mime-types are not required for reading
312 * a database because a reader will just be unable to query
314 { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
315 "indexed MIME types", "w"},
316 { NOTMUCH_FEATURE_LAST_MOD,
317 "modification tracking", "w"},
321 notmuch_status_to_string (notmuch_status_t status)
324 case NOTMUCH_STATUS_SUCCESS:
325 return "No error occurred";
326 case NOTMUCH_STATUS_OUT_OF_MEMORY:
327 return "Out of memory";
328 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
329 return "Attempt to write to a read-only database";
330 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
331 return "A Xapian exception occurred";
332 case NOTMUCH_STATUS_FILE_ERROR:
333 return "Something went wrong trying to read or write a file";
334 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
335 return "File is not an email";
336 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
337 return "Message ID is identical to a message in database";
338 case NOTMUCH_STATUS_NULL_POINTER:
339 return "Erroneous NULL pointer";
340 case NOTMUCH_STATUS_TAG_TOO_LONG:
341 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
342 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
343 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
344 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
345 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
346 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
347 return "Unsupported operation";
348 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
349 return "Operation requires a database upgrade";
350 case NOTMUCH_STATUS_PATH_ERROR:
351 return "Path supplied is illegal for this function";
353 case NOTMUCH_STATUS_LAST_STATUS:
354 return "Unknown error status value";
359 _notmuch_database_log (notmuch_database_t *notmuch,
365 va_start (va_args, format);
367 if (notmuch->status_string)
368 talloc_free (notmuch->status_string);
370 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
376 find_doc_ids_for_term (notmuch_database_t *notmuch,
378 Xapian::PostingIterator *begin,
379 Xapian::PostingIterator *end)
381 *begin = notmuch->xapian_db->postlist_begin (term);
383 *end = notmuch->xapian_db->postlist_end (term);
387 find_doc_ids (notmuch_database_t *notmuch,
388 const char *prefix_name,
390 Xapian::PostingIterator *begin,
391 Xapian::PostingIterator *end)
395 term = talloc_asprintf (notmuch, "%s%s",
396 _find_prefix (prefix_name), value);
398 find_doc_ids_for_term (notmuch, term, begin, end);
403 notmuch_private_status_t
404 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
405 const char *prefix_name,
407 unsigned int *doc_id)
409 Xapian::PostingIterator i, end;
411 find_doc_ids (notmuch, prefix_name, value, &i, &end);
415 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
420 #if DEBUG_DATABASE_SANITY
424 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
428 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
431 static Xapian::Document
432 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
434 return notmuch->xapian_db->get_document (doc_id);
437 /* Generate a compressed version of 'message_id' of the form:
439 * notmuch-sha1-<sha1_sum_of_message_id>
442 _notmuch_message_id_compressed (void *ctx, const char *message_id)
444 char *sha1, *compressed;
446 sha1 = _notmuch_sha1_of_string (message_id);
448 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
455 notmuch_database_find_message (notmuch_database_t *notmuch,
456 const char *message_id,
457 notmuch_message_t **message_ret)
459 notmuch_private_status_t status;
462 if (message_ret == NULL)
463 return NOTMUCH_STATUS_NULL_POINTER;
465 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
466 message_id = _notmuch_message_id_compressed (notmuch, message_id);
469 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
470 message_id, &doc_id);
472 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
475 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
477 if (*message_ret == NULL)
478 return NOTMUCH_STATUS_OUT_OF_MEMORY;
481 return NOTMUCH_STATUS_SUCCESS;
482 } catch (const Xapian::Error &error) {
483 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
484 error.get_msg().c_str());
485 notmuch->exception_reported = TRUE;
487 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
491 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
492 * a (potentially nested) parenthesized sequence with '\' used to
493 * escape any character (including parentheses).
495 * If the sequence to be skipped continues to the end of the string,
496 * then 'str' will be left pointing at the final terminating '\0'
500 skip_space_and_comments (const char **str)
505 while (*s && (isspace (*s) || *s == '(')) {
506 while (*s && isspace (*s))
511 while (*s && nesting) {
514 } else if (*s == ')') {
516 } else if (*s == '\\') {
528 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
529 * comments, and the '<' and '>' delimiters.
531 * If not NULL, then *next will be made to point to the first character
532 * not parsed, (possibly pointing to the final '\0' terminator.
534 * Returns a newly talloc'ed string belonging to 'ctx'.
536 * Returns NULL if there is any error parsing the message-id. */
538 _parse_message_id (void *ctx, const char *message_id, const char **next)
543 if (message_id == NULL || *message_id == '\0')
548 skip_space_and_comments (&s);
550 /* Skip any unstructured text as well. */
551 while (*s && *s != '<')
562 skip_space_and_comments (&s);
565 while (*end && *end != '>')
574 if (end > s && *end == '>')
579 result = talloc_strndup (ctx, s, end - s + 1);
581 /* Finally, collapse any whitespace that is within the message-id
587 for (r = result, len = strlen (r); *r; r++, len--)
588 if (*r == ' ' || *r == '\t')
589 memmove (r, r+1, len);
595 /* Parse a References header value, putting a (talloc'ed under 'ctx')
596 * copy of each referenced message-id into 'hash'.
598 * We explicitly avoid including any reference identical to
599 * 'message_id' in the result (to avoid mass confusion when a single
600 * message references itself cyclically---and yes, mail messages are
601 * not infrequent in the wild that do this---don't ask me why).
603 * Return the last reference parsed, if it is not equal to message_id.
606 parse_references (void *ctx,
607 const char *message_id,
611 char *ref, *last_ref = NULL;
613 if (refs == NULL || *refs == '\0')
617 ref = _parse_message_id (ctx, refs, &refs);
619 if (ref && strcmp (ref, message_id)) {
620 g_hash_table_insert (hash, ref, NULL);
625 /* The return value of this function is used to add a parent
626 * reference to the database. We should avoid making a message
627 * its own parent, thus the above check.
633 notmuch_database_create (const char *path, notmuch_database_t **database)
635 char *status_string = NULL;
636 notmuch_status_t status;
638 status = notmuch_database_create_verbose (path, database,
642 fputs (status_string, stderr);
643 free (status_string);
650 notmuch_database_create_verbose (const char *path,
651 notmuch_database_t **database,
652 char **status_string)
654 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
655 notmuch_database_t *notmuch = NULL;
656 char *notmuch_path = NULL;
657 char *message = NULL;
662 message = strdup ("Error: Cannot create a database for a NULL path.\n");
663 status = NOTMUCH_STATUS_NULL_POINTER;
667 if (path[0] != '/') {
668 message = strdup ("Error: Database path must be absolute.\n");
669 status = NOTMUCH_STATUS_PATH_ERROR;
673 err = stat (path, &st);
675 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
676 path, strerror (errno)));
677 status = NOTMUCH_STATUS_FILE_ERROR;
681 if (! S_ISDIR (st.st_mode)) {
682 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
683 "Not a directory.\n",
685 status = NOTMUCH_STATUS_FILE_ERROR;
689 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
691 err = mkdir (notmuch_path, 0755);
694 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
695 notmuch_path, strerror (errno)));
696 status = NOTMUCH_STATUS_FILE_ERROR;
700 status = notmuch_database_open_verbose (path,
701 NOTMUCH_DATABASE_MODE_READ_WRITE,
706 /* Upgrade doesn't add these feature to existing databases, but
707 * new databases have them. */
708 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
709 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
711 status = notmuch_database_upgrade (notmuch, NULL, NULL);
713 notmuch_database_close(notmuch);
719 talloc_free (notmuch_path);
723 *status_string = message;
730 talloc_free (notmuch);
735 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
737 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
738 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
739 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
742 return NOTMUCH_STATUS_SUCCESS;
745 /* Allocate a revision number for the next change. */
747 _notmuch_database_new_revision (notmuch_database_t *notmuch)
749 unsigned long new_revision = notmuch->revision + 1;
751 /* If we're in an atomic section, hold off on updating the
752 * committed revision number until we commit the atomic section.
754 if (notmuch->atomic_nesting)
755 notmuch->atomic_dirty = TRUE;
757 notmuch->revision = new_revision;
762 /* Parse a database features string from the given database version.
763 * Returns the feature bit set.
765 * For version < 3, this ignores the features string and returns a
766 * hard-coded set of features.
768 * If there are unrecognized features that are required to open the
769 * database in mode (which should be 'r' or 'w'), return a
770 * comma-separated list of unrecognized but required features in
771 * *incompat_out suitable for presenting to the user. *incompat_out
772 * will be allocated from ctx.
774 static _notmuch_features
775 _parse_features (const void *ctx, const char *features, unsigned int version,
776 char mode, char **incompat_out)
778 _notmuch_features res = static_cast<_notmuch_features>(0);
779 unsigned int namelen, i;
783 /* Prior to database version 3, features were implied by the
786 return NOTMUCH_FEATURES_V0;
787 else if (version == 1)
788 return NOTMUCH_FEATURES_V1;
789 else if (version == 2)
790 return NOTMUCH_FEATURES_V2;
792 /* Parse the features string */
793 while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
794 flags = strchr (features, '\t');
795 if (! flags || flags > features + llen)
797 namelen = flags - features;
799 for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
800 if (strlen (feature_names[i].name) == namelen &&
801 strncmp (feature_names[i].name, features, namelen) == 0) {
802 res |= feature_names[i].value;
807 if (i == ARRAY_SIZE (feature_names) && incompat_out) {
808 /* Unrecognized feature */
809 const char *have = strchr (flags, mode);
810 if (have && have < features + llen) {
811 /* This feature is required to access this database in
812 * 'mode', but we don't understand it. */
814 *incompat_out = talloc_strdup (ctx, "");
815 *incompat_out = talloc_asprintf_append_buffer (
816 *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
826 _print_features (const void *ctx, unsigned int features)
829 char *res = talloc_strdup (ctx, "");
831 for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
832 if (features & feature_names[i].value)
833 res = talloc_asprintf_append_buffer (
834 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
840 notmuch_database_open (const char *path,
841 notmuch_database_mode_t mode,
842 notmuch_database_t **database)
844 char *status_string = NULL;
845 notmuch_status_t status;
847 status = notmuch_database_open_verbose (path, mode, database,
851 fputs (status_string, stderr);
852 free (status_string);
859 notmuch_database_open_verbose (const char *path,
860 notmuch_database_mode_t mode,
861 notmuch_database_t **database,
862 char **status_string)
864 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
865 void *local = talloc_new (NULL);
866 notmuch_database_t *notmuch = NULL;
867 char *notmuch_path, *xapian_path, *incompat_features;
868 char *message = NULL;
871 unsigned int i, version;
872 static int initialized = 0;
875 message = strdup ("Error: Cannot open a database for a NULL path.\n");
876 status = NOTMUCH_STATUS_NULL_POINTER;
880 if (path[0] != '/') {
881 message = strdup ("Error: Database path must be absolute.\n");
882 status = NOTMUCH_STATUS_PATH_ERROR;
886 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
887 message = strdup ("Out of memory\n");
888 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
892 err = stat (notmuch_path, &st);
894 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
895 notmuch_path, strerror (errno)));
896 status = NOTMUCH_STATUS_FILE_ERROR;
900 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
901 message = strdup ("Out of memory\n");
902 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
906 /* Initialize the GLib type system and threads */
907 #if !GLIB_CHECK_VERSION(2, 35, 1)
911 /* Initialize gmime */
913 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
917 notmuch = talloc_zero (NULL, notmuch_database_t);
918 notmuch->exception_reported = FALSE;
919 notmuch->status_string = NULL;
920 notmuch->path = talloc_strdup (notmuch, path);
922 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
923 notmuch->path[strlen (notmuch->path) - 1] = '\0';
925 notmuch->mode = mode;
926 notmuch->atomic_nesting = 0;
928 string last_thread_id;
931 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
932 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
933 Xapian::DB_CREATE_OR_OPEN);
935 notmuch->xapian_db = new Xapian::Database (xapian_path);
938 /* Check version. As of database version 3, we represent
939 * changes in terms of features, so assume a version bump
940 * means a dramatically incompatible change. */
941 version = notmuch_database_get_version (notmuch);
942 if (version > NOTMUCH_DATABASE_VERSION) {
943 IGNORE_RESULT (asprintf (&message,
944 "Error: Notmuch database at %s\n"
945 " has a newer database format version (%u) than supported by this\n"
946 " version of notmuch (%u).\n",
947 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
948 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
949 notmuch_database_destroy (notmuch);
951 status = NOTMUCH_STATUS_FILE_ERROR;
955 /* Check features. */
956 incompat_features = NULL;
957 notmuch->features = _parse_features (
958 local, notmuch->xapian_db->get_metadata ("features").c_str (),
959 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
961 if (incompat_features) {
962 IGNORE_RESULT (asprintf (&message,
963 "Error: Notmuch database at %s\n"
964 " requires features (%s)\n"
965 " not supported by this version of notmuch.\n",
966 notmuch_path, incompat_features));
967 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
968 notmuch_database_destroy (notmuch);
970 status = NOTMUCH_STATUS_FILE_ERROR;
974 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
975 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
976 if (last_thread_id.empty ()) {
977 notmuch->last_thread_id = 0;
982 str = last_thread_id.c_str ();
983 notmuch->last_thread_id = strtoull (str, &end, 16);
985 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
988 /* Get current highest revision number. */
989 last_mod = notmuch->xapian_db->get_value_upper_bound (
990 NOTMUCH_VALUE_LAST_MOD);
991 if (last_mod.empty ())
992 notmuch->revision = 0;
994 notmuch->revision = Xapian::sortable_unserialise (last_mod);
995 notmuch->uuid = talloc_strdup (
996 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
998 notmuch->query_parser = new Xapian::QueryParser;
999 notmuch->term_gen = new Xapian::TermGenerator;
1000 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
1001 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1002 notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1003 notmuch->last_mod_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
1005 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
1006 notmuch->query_parser->set_database (*notmuch->xapian_db);
1007 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
1008 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
1009 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
1010 notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
1011 notmuch->query_parser->add_valuerangeprocessor (notmuch->last_mod_range_processor);
1013 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
1014 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
1015 notmuch->query_parser->add_boolean_prefix (prefix->name,
1019 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
1020 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
1021 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
1023 } catch (const Xapian::Error &error) {
1024 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
1025 error.get_msg().c_str()));
1026 notmuch_database_destroy (notmuch);
1028 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1032 talloc_free (local);
1036 *status_string = message;
1042 *database = notmuch;
1044 talloc_free (notmuch);
1049 notmuch_database_close (notmuch_database_t *notmuch)
1051 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1053 /* Many Xapian objects (and thus notmuch objects) hold references to
1054 * the database, so merely deleting the database may not suffice to
1055 * close it. Thus, we explicitly close it here. */
1056 if (notmuch->xapian_db != NULL) {
1058 /* If there's an outstanding transaction, it's unclear if
1059 * closing the Xapian database commits everything up to
1060 * that transaction, or may discard committed (but
1061 * unflushed) transactions. To be certain, explicitly
1062 * cancel any outstanding transaction before closing. */
1063 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1064 notmuch->atomic_nesting)
1065 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1066 ->cancel_transaction ();
1068 /* Close the database. This implicitly flushes
1069 * outstanding changes. */
1070 notmuch->xapian_db->close();
1071 } catch (const Xapian::Error &error) {
1072 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1073 if (! notmuch->exception_reported) {
1074 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1075 error.get_msg().c_str());
1080 delete notmuch->term_gen;
1081 notmuch->term_gen = NULL;
1082 delete notmuch->query_parser;
1083 notmuch->query_parser = NULL;
1084 delete notmuch->xapian_db;
1085 notmuch->xapian_db = NULL;
1086 delete notmuch->value_range_processor;
1087 notmuch->value_range_processor = NULL;
1088 delete notmuch->date_range_processor;
1089 notmuch->date_range_processor = NULL;
1090 delete notmuch->last_mod_range_processor;
1091 notmuch->last_mod_range_processor = NULL;
1096 #if HAVE_XAPIAN_COMPACT
1098 unlink_cb (const char *path,
1099 unused (const struct stat *sb),
1101 unused (struct FTW *ftw))
1103 return remove (path);
1107 rmtree (const char *path)
1109 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1112 class NotmuchCompactor : public Xapian::Compactor
1114 notmuch_compact_status_cb_t status_cb;
1115 void *status_closure;
1118 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1119 status_cb (cb), status_closure (closure) { }
1122 set_status (const std::string &table, const std::string &status)
1126 if (status_cb == NULL)
1129 if (status.length () == 0)
1130 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
1132 msg = talloc_asprintf (NULL, " %s", status.c_str());
1138 status_cb (msg, status_closure);
1143 /* Compacts the given database, optionally saving the original database
1144 * in backup_path. Additionally, a callback function can be provided to
1145 * give the user feedback on the progress of the (likely long-lived)
1146 * compaction process.
1148 * The backup path must point to a directory on the same volume as the
1149 * original database. Passing a NULL backup_path will result in the
1150 * uncompacted database being deleted after compaction has finished.
1151 * Note that the database write lock will be held during the
1152 * compaction process to protect data integrity.
1155 notmuch_database_compact (const char *path,
1156 const char *backup_path,
1157 notmuch_compact_status_cb_t status_cb,
1161 char *notmuch_path, *xapian_path, *compact_xapian_path;
1162 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1163 notmuch_database_t *notmuch = NULL;
1164 struct stat statbuf;
1165 notmuch_bool_t keep_backup;
1166 char *message = NULL;
1168 local = talloc_new (NULL);
1170 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1172 ret = notmuch_database_open_verbose (path,
1173 NOTMUCH_DATABASE_MODE_READ_WRITE,
1177 if (status_cb) status_cb (message, closure);
1181 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1182 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1186 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1187 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1191 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1192 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1196 if (backup_path == NULL) {
1197 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1198 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1201 keep_backup = FALSE;
1207 if (stat (backup_path, &statbuf) != -1) {
1208 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1209 ret = NOTMUCH_STATUS_FILE_ERROR;
1212 if (errno != ENOENT) {
1213 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1215 ret = NOTMUCH_STATUS_FILE_ERROR;
1219 /* Unconditionally attempt to remove old work-in-progress database (if
1220 * any). This is "protected" by database lock. If this fails due to write
1221 * errors (etc), the following code will fail and provide error message.
1223 (void) rmtree (compact_xapian_path);
1226 NotmuchCompactor compactor (status_cb, closure);
1228 compactor.set_renumber (false);
1229 compactor.add_source (xapian_path);
1230 compactor.set_destdir (compact_xapian_path);
1231 compactor.compact ();
1232 } catch (const Xapian::Error &error) {
1233 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg().c_str());
1234 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1238 if (rename (xapian_path, backup_path)) {
1239 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1240 xapian_path, backup_path, strerror (errno));
1241 ret = NOTMUCH_STATUS_FILE_ERROR;
1245 if (rename (compact_xapian_path, xapian_path)) {
1246 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1247 compact_xapian_path, xapian_path, strerror (errno));
1248 ret = NOTMUCH_STATUS_FILE_ERROR;
1252 if (! keep_backup) {
1253 if (rmtree (backup_path)) {
1254 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1255 backup_path, strerror (errno));
1256 ret = NOTMUCH_STATUS_FILE_ERROR;
1263 notmuch_status_t ret2;
1265 const char *str = notmuch_database_status_string (notmuch);
1266 if (status_cb && str)
1267 status_cb (str, closure);
1269 ret2 = notmuch_database_destroy (notmuch);
1271 /* don't clobber previous error status */
1272 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1276 talloc_free (local);
1282 notmuch_database_compact (unused (const char *path),
1283 unused (const char *backup_path),
1284 unused (notmuch_compact_status_cb_t status_cb),
1285 unused (void *closure))
1287 _notmuch_database_log (notmuch, "notmuch was compiled against a xapian version lacking compaction support.\n");
1288 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1293 notmuch_database_destroy (notmuch_database_t *notmuch)
1295 notmuch_status_t status;
1297 status = notmuch_database_close (notmuch);
1298 talloc_free (notmuch);
1304 notmuch_database_get_path (notmuch_database_t *notmuch)
1306 return notmuch->path;
1310 notmuch_database_get_version (notmuch_database_t *notmuch)
1312 unsigned int version;
1313 string version_string;
1317 version_string = notmuch->xapian_db->get_metadata ("version");
1318 if (version_string.empty ())
1321 str = version_string.c_str ();
1322 if (str == NULL || *str == '\0')
1325 version = strtoul (str, &end, 10);
1327 INTERNAL_ERROR ("Malformed database version: %s", str);
1333 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1335 return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1336 ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1337 (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1340 static volatile sig_atomic_t do_progress_notify = 0;
1343 handle_sigalrm (unused (int signal))
1345 do_progress_notify = 1;
1348 /* Upgrade the current database.
1350 * After opening a database in read-write mode, the client should
1351 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1352 * if so, upgrade with this function before making any modifications.
1354 * The optional progress_notify callback can be used by the caller to
1355 * provide progress indication to the user. If non-NULL it will be
1356 * called periodically with 'count' as the number of messages upgraded
1357 * so far and 'total' the overall number of messages that will be
1361 notmuch_database_upgrade (notmuch_database_t *notmuch,
1362 void (*progress_notify) (void *closure,
1366 void *local = talloc_new (NULL);
1367 Xapian::TermIterator t, t_end;
1368 Xapian::WritableDatabase *db;
1369 struct sigaction action;
1370 struct itimerval timerval;
1371 notmuch_bool_t timer_is_active = FALSE;
1372 enum _notmuch_features target_features, new_features;
1373 notmuch_status_t status;
1374 notmuch_private_status_t private_status;
1375 notmuch_query_t *query = NULL;
1376 unsigned int count = 0, total = 0;
1378 status = _notmuch_database_ensure_writable (notmuch);
1382 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1384 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1385 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1387 if (! notmuch_database_needs_upgrade (notmuch))
1388 return NOTMUCH_STATUS_SUCCESS;
1390 if (progress_notify) {
1391 /* Set up our handler for SIGALRM */
1392 memset (&action, 0, sizeof (struct sigaction));
1393 action.sa_handler = handle_sigalrm;
1394 sigemptyset (&action.sa_mask);
1395 action.sa_flags = SA_RESTART;
1396 sigaction (SIGALRM, &action, NULL);
1398 /* Then start a timer to send SIGALRM once per second. */
1399 timerval.it_interval.tv_sec = 1;
1400 timerval.it_interval.tv_usec = 0;
1401 timerval.it_value.tv_sec = 1;
1402 timerval.it_value.tv_usec = 0;
1403 setitimer (ITIMER_REAL, &timerval, NULL);
1405 timer_is_active = TRUE;
1408 /* Figure out how much total work we need to do. */
1410 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1411 NOTMUCH_FEATURE_LAST_MOD)) {
1412 query = notmuch_query_create (notmuch, "");
1415 status = notmuch_query_count_messages_st (query, &msg_count);
1420 notmuch_query_destroy (query);
1423 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1424 t_end = db->allterms_end ("XTIMESTAMP");
1425 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1428 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1429 /* The ghost message upgrade converts all thread_id_*
1430 * metadata values into ghost message documents. */
1431 t_end = db->metadata_keys_end ("thread_id_");
1432 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1436 /* Perform the upgrade in a transaction. */
1437 db->begin_transaction (true);
1439 /* Set the target features so we write out changes in the desired
1441 notmuch->features = target_features;
1443 /* Perform per-message upgrades. */
1445 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1446 NOTMUCH_FEATURE_LAST_MOD)) {
1447 notmuch_messages_t *messages;
1448 notmuch_message_t *message;
1451 query = notmuch_query_create (notmuch, "");
1453 status = notmuch_query_search_messages_st (query, &messages);
1457 notmuch_messages_valid (messages);
1458 notmuch_messages_move_to_next (messages))
1460 if (do_progress_notify) {
1461 progress_notify (closure, (double) count / total);
1462 do_progress_notify = 0;
1465 message = notmuch_messages_get (messages);
1467 /* Before version 1, each message document had its
1468 * filename in the data field. Copy that into the new
1469 * format by calling notmuch_message_add_filename.
1471 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1472 filename = _notmuch_message_talloc_copy_data (message);
1473 if (filename && *filename != '\0') {
1474 _notmuch_message_add_filename (message, filename);
1475 _notmuch_message_clear_data (message);
1477 talloc_free (filename);
1480 /* Prior to version 2, the "folder:" prefix was
1481 * probabilistic and stemmed. Change it to the current
1482 * boolean prefix. Add "path:" prefixes while at it.
1484 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1485 _notmuch_message_upgrade_folder (message);
1487 /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
1488 * track modification revisions. Give all messages the
1489 * next available revision; since we just started tracking
1490 * revisions for this database, that will be 1.
1492 if (new_features & NOTMUCH_FEATURE_LAST_MOD)
1493 _notmuch_message_upgrade_last_mod (message);
1495 _notmuch_message_sync (message);
1497 notmuch_message_destroy (message);
1502 notmuch_query_destroy (query);
1506 /* Perform per-directory upgrades. */
1508 /* Before version 1 we stored directory timestamps in
1509 * XTIMESTAMP documents instead of the current XDIRECTORY
1510 * documents. So copy those as well. */
1511 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1512 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1514 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1518 Xapian::PostingIterator p, p_end;
1519 std::string term = *t;
1521 p_end = notmuch->xapian_db->postlist_end (term);
1523 for (p = notmuch->xapian_db->postlist_begin (term);
1527 Xapian::Document document;
1529 notmuch_directory_t *directory;
1531 if (do_progress_notify) {
1532 progress_notify (closure, (double) count / total);
1533 do_progress_notify = 0;
1536 document = find_document_for_doc_id (notmuch, *p);
1537 mtime = Xapian::sortable_unserialise (
1538 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1540 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1541 NOTMUCH_FIND_CREATE, &status);
1542 notmuch_directory_set_mtime (directory, mtime);
1543 notmuch_directory_destroy (directory);
1545 db->delete_document (*p);
1552 /* Perform metadata upgrades. */
1554 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1555 * messages were stored as database metadata. Change these to
1558 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1559 notmuch_message_t *message;
1560 std::string message_id, thread_id;
1562 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1563 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1565 if (do_progress_notify) {
1566 progress_notify (closure, (double) count / total);
1567 do_progress_notify = 0;
1570 message_id = (*t).substr (
1571 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1572 thread_id = db->get_metadata (*t);
1574 /* Create ghost message */
1575 message = _notmuch_message_create_for_message_id (
1576 notmuch, message_id.c_str (), &private_status);
1577 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1578 /* Document already exists; ignore the stored thread ID */
1579 } else if (private_status ==
1580 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1581 private_status = _notmuch_message_initialize_ghost (
1582 message, thread_id.c_str ());
1583 if (! private_status)
1584 _notmuch_message_sync (message);
1587 if (private_status) {
1588 _notmuch_database_log (notmuch,
1589 "Upgrade failed while creating ghost messages.\n");
1590 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1594 /* Clear saved metadata thread ID */
1595 db->set_metadata (*t, "");
1601 status = NOTMUCH_STATUS_SUCCESS;
1602 db->set_metadata ("features", _print_features (local, notmuch->features));
1603 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1606 if (status == NOTMUCH_STATUS_SUCCESS)
1607 db->commit_transaction ();
1609 db->cancel_transaction ();
1611 if (timer_is_active) {
1612 /* Now stop the timer. */
1613 timerval.it_interval.tv_sec = 0;
1614 timerval.it_interval.tv_usec = 0;
1615 timerval.it_value.tv_sec = 0;
1616 timerval.it_value.tv_usec = 0;
1617 setitimer (ITIMER_REAL, &timerval, NULL);
1619 /* And disable the signal handler. */
1620 action.sa_handler = SIG_IGN;
1621 sigaction (SIGALRM, &action, NULL);
1625 notmuch_query_destroy (query);
1627 talloc_free (local);
1632 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1634 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1635 notmuch->atomic_nesting > 0)
1638 if (notmuch_database_needs_upgrade(notmuch))
1639 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1642 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1643 } catch (const Xapian::Error &error) {
1644 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1645 error.get_msg().c_str());
1646 notmuch->exception_reported = TRUE;
1647 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1651 notmuch->atomic_nesting++;
1652 return NOTMUCH_STATUS_SUCCESS;
1656 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1658 Xapian::WritableDatabase *db;
1660 if (notmuch->atomic_nesting == 0)
1661 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1663 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1664 notmuch->atomic_nesting > 1)
1667 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1669 db->commit_transaction ();
1671 /* This is a hack for testing. Xapian never flushes on a
1672 * non-flushed commit, even if the flush threshold is 1.
1673 * However, we rely on flushing to test atomicity. */
1674 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1675 if (thresh && atoi (thresh) == 1)
1677 } catch (const Xapian::Error &error) {
1678 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1679 error.get_msg().c_str());
1680 notmuch->exception_reported = TRUE;
1681 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1684 if (notmuch->atomic_dirty) {
1685 ++notmuch->revision;
1686 notmuch->atomic_dirty = FALSE;
1690 notmuch->atomic_nesting--;
1691 return NOTMUCH_STATUS_SUCCESS;
1695 notmuch_database_get_revision (notmuch_database_t *notmuch,
1699 *uuid = notmuch->uuid;
1700 return notmuch->revision;
1703 /* We allow the user to use arbitrarily long paths for directories. But
1704 * we have a term-length limit. So if we exceed that, we'll use the
1705 * SHA-1 of the path for the database term.
1707 * Note: This function may return the original value of 'path'. If it
1708 * does not, then the caller is responsible to free() the returned
1712 _notmuch_database_get_directory_db_path (const char *path)
1714 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1716 if (term_len > NOTMUCH_TERM_MAX)
1717 return _notmuch_sha1_of_string (path);
1722 /* Given a path, split it into two parts: the directory part is all
1723 * components except for the last, and the basename is that last
1724 * component. Getting the return-value for either part is optional
1725 * (the caller can pass NULL).
1727 * The original 'path' can represent either a regular file or a
1728 * directory---the splitting will be carried out in the same way in
1729 * either case. Trailing slashes on 'path' will be ignored, and any
1730 * cases of multiple '/' characters appearing in series will be
1731 * treated as a single '/'.
1733 * Allocation (if any) will have 'ctx' as the talloc owner. But
1734 * pointers will be returned within the original path string whenever
1737 * Note: If 'path' is non-empty and contains no non-trailing slash,
1738 * (that is, consists of a filename with no parent directory), then
1739 * the directory returned will be an empty string. However, if 'path'
1740 * is an empty string, then both directory and basename will be
1744 _notmuch_database_split_path (void *ctx,
1746 const char **directory,
1747 const char **basename)
1751 if (path == NULL || *path == '\0') {
1756 return NOTMUCH_STATUS_SUCCESS;
1759 /* Find the last slash (not counting a trailing slash), if any. */
1761 slash = path + strlen (path) - 1;
1763 /* First, skip trailing slashes. */
1764 while (slash != path) {
1771 /* Then, find a slash. */
1772 while (slash != path) {
1782 /* Finally, skip multiple slashes. */
1783 while (slash != path) {
1790 if (slash == path) {
1792 *directory = talloc_strdup (ctx, "");
1797 *directory = talloc_strndup (ctx, path, slash - path + 1);
1800 return NOTMUCH_STATUS_SUCCESS;
1803 /* Find the document ID of the specified directory.
1805 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1806 * created if one does not exist for 'path'. Otherwise, if the
1807 * directory document does not exist, this sets *directory_id to
1808 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1811 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1813 notmuch_find_flags_t flags,
1814 unsigned int *directory_id)
1816 notmuch_directory_t *directory;
1817 notmuch_status_t status;
1821 return NOTMUCH_STATUS_SUCCESS;
1824 directory = _notmuch_directory_create (notmuch, path, flags, &status);
1825 if (status || !directory) {
1830 *directory_id = _notmuch_directory_get_document_id (directory);
1832 notmuch_directory_destroy (directory);
1834 return NOTMUCH_STATUS_SUCCESS;
1838 _notmuch_database_get_directory_path (void *ctx,
1839 notmuch_database_t *notmuch,
1840 unsigned int doc_id)
1842 Xapian::Document document;
1844 document = find_document_for_doc_id (notmuch, doc_id);
1846 return talloc_strdup (ctx, document.get_data ().c_str ());
1849 /* Given a legal 'filename' for the database, (either relative to
1850 * database path or absolute with initial components identical to
1851 * database path), return a new string (with 'ctx' as the talloc
1852 * owner) suitable for use as a direntry term value.
1854 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1855 * will be created in the database as needed. Otherwise, if the
1856 * necessary directory documents do not exist, this sets
1857 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1860 _notmuch_database_filename_to_direntry (void *ctx,
1861 notmuch_database_t *notmuch,
1862 const char *filename,
1863 notmuch_find_flags_t flags,
1866 const char *relative, *directory, *basename;
1867 Xapian::docid directory_id;
1868 notmuch_status_t status;
1870 relative = _notmuch_database_relative_path (notmuch, filename);
1872 status = _notmuch_database_split_path (ctx, relative,
1873 &directory, &basename);
1877 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1879 if (status || directory_id == (unsigned int)-1) {
1884 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1886 return NOTMUCH_STATUS_SUCCESS;
1889 /* Given a legal 'path' for the database, return the relative path.
1891 * The return value will be a pointer to the original path contents,
1892 * and will be either the original string (if 'path' was relative) or
1893 * a portion of the string (if path was absolute and begins with the
1897 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1900 const char *db_path, *relative;
1901 unsigned int db_path_len;
1903 db_path = notmuch_database_get_path (notmuch);
1904 db_path_len = strlen (db_path);
1908 if (*relative == '/') {
1909 while (*relative == '/' && *(relative+1) == '/')
1912 if (strncmp (relative, db_path, db_path_len) == 0)
1914 relative += db_path_len;
1915 while (*relative == '/')
1924 notmuch_database_get_directory (notmuch_database_t *notmuch,
1926 notmuch_directory_t **directory)
1928 notmuch_status_t status;
1930 if (directory == NULL)
1931 return NOTMUCH_STATUS_NULL_POINTER;
1935 *directory = _notmuch_directory_create (notmuch, path,
1936 NOTMUCH_FIND_LOOKUP, &status);
1937 } catch (const Xapian::Error &error) {
1938 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1939 error.get_msg().c_str());
1940 notmuch->exception_reported = TRUE;
1941 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1946 /* Allocate a document ID that satisfies the following criteria:
1948 * 1. The ID does not exist for any document in the Xapian database
1950 * 2. The ID was not previously returned from this function
1952 * 3. The ID is the smallest integer satisfying (1) and (2)
1954 * This function will trigger an internal error if these constraints
1955 * cannot all be satisfied, (that is, the pool of available document
1956 * IDs has been exhausted).
1959 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1961 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1963 notmuch->last_doc_id++;
1965 if (notmuch->last_doc_id == 0)
1966 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1968 return notmuch->last_doc_id;
1972 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
1974 /* 16 bytes (+ terminator) for hexadecimal representation of
1975 * a 64-bit integer. */
1976 static char thread_id[17];
1977 Xapian::WritableDatabase *db;
1979 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1981 notmuch->last_thread_id++;
1983 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
1985 db->set_metadata ("last_thread_id", thread_id);
1991 _get_metadata_thread_id_key (void *ctx, const char *message_id)
1993 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
1994 message_id = _notmuch_message_id_compressed (ctx, message_id);
1996 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
2000 static notmuch_status_t
2001 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
2003 const char *message_id,
2004 const char **thread_id_ret);
2006 /* Find the thread ID to which the message with 'message_id' belongs.
2008 * Note: 'thread_id_ret' must not be NULL!
2009 * On success '*thread_id_ret' is set to a newly talloced string belonging to
2012 * Note: If there is no message in the database with the given
2013 * 'message_id' then a new thread_id will be allocated for this
2014 * message ID and stored in the database metadata so that the
2015 * thread ID can be looked up if the message is added to the database
2018 static notmuch_status_t
2019 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
2021 const char *message_id,
2022 const char **thread_id_ret)
2024 notmuch_private_status_t status;
2025 notmuch_message_t *message;
2027 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS))
2028 return _resolve_message_id_to_thread_id_old (notmuch, ctx, message_id,
2031 /* Look for this message (regular or ghost) */
2032 message = _notmuch_message_create_for_message_id (
2033 notmuch, message_id, &status);
2034 if (status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
2035 /* Message exists */
2036 *thread_id_ret = talloc_steal (
2037 ctx, notmuch_message_get_thread_id (message));
2038 } else if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
2039 /* Message did not exist. Give it a fresh thread ID and
2040 * populate this message as a ghost message. */
2041 *thread_id_ret = talloc_strdup (
2042 ctx, _notmuch_database_generate_thread_id (notmuch));
2043 if (! *thread_id_ret) {
2044 status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
2046 status = _notmuch_message_initialize_ghost (message, *thread_id_ret);
2048 /* Commit the new ghost message */
2049 _notmuch_message_sync (message);
2052 /* Create failed. Fall through. */
2055 notmuch_message_destroy (message);
2057 return COERCE_STATUS (status, "Error creating ghost message");
2060 /* Pre-ghost messages _resolve_message_id_to_thread_id */
2061 static notmuch_status_t
2062 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
2064 const char *message_id,
2065 const char **thread_id_ret)
2067 notmuch_status_t status;
2068 notmuch_message_t *message;
2069 string thread_id_string;
2071 Xapian::WritableDatabase *db;
2073 status = notmuch_database_find_message (notmuch, message_id, &message);
2079 *thread_id_ret = talloc_steal (ctx,
2080 notmuch_message_get_thread_id (message));
2082 notmuch_message_destroy (message);
2084 return NOTMUCH_STATUS_SUCCESS;
2087 /* Message has not been seen yet.
2089 * We may have seen a reference to it already, in which case, we
2090 * can return the thread ID stored in the metadata. Otherwise, we
2091 * generate a new thread ID and store it there.
2093 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2094 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2095 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
2097 if (thread_id_string.empty()) {
2098 *thread_id_ret = talloc_strdup (ctx,
2099 _notmuch_database_generate_thread_id (notmuch));
2100 db->set_metadata (metadata_key, *thread_id_ret);
2102 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
2105 talloc_free (metadata_key);
2107 return NOTMUCH_STATUS_SUCCESS;
2110 static notmuch_status_t
2111 _merge_threads (notmuch_database_t *notmuch,
2112 const char *winner_thread_id,
2113 const char *loser_thread_id)
2115 Xapian::PostingIterator loser, loser_end;
2116 notmuch_message_t *message = NULL;
2117 notmuch_private_status_t private_status;
2118 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2120 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
2122 for ( ; loser != loser_end; loser++) {
2123 message = _notmuch_message_create (notmuch, notmuch,
2124 *loser, &private_status);
2125 if (message == NULL) {
2126 ret = COERCE_STATUS (private_status,
2127 "Cannot find document for doc_id from query");
2131 _notmuch_message_remove_term (message, "thread", loser_thread_id);
2132 _notmuch_message_add_term (message, "thread", winner_thread_id);
2133 _notmuch_message_sync (message);
2135 notmuch_message_destroy (message);
2141 notmuch_message_destroy (message);
2147 _my_talloc_free_for_g_hash (void *ptr)
2152 static notmuch_status_t
2153 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
2154 notmuch_message_t *message,
2155 notmuch_message_file_t *message_file,
2156 const char **thread_id)
2158 GHashTable *parents = NULL;
2159 const char *refs, *in_reply_to, *in_reply_to_message_id;
2160 const char *last_ref_message_id, *this_message_id;
2161 GList *l, *keys = NULL;
2162 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2164 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
2165 _my_talloc_free_for_g_hash, NULL);
2166 this_message_id = notmuch_message_get_message_id (message);
2168 refs = _notmuch_message_file_get_header (message_file, "references");
2169 last_ref_message_id = parse_references (message,
2173 in_reply_to = _notmuch_message_file_get_header (message_file, "in-reply-to");
2174 in_reply_to_message_id = parse_references (message,
2176 parents, in_reply_to);
2178 /* For the parent of this message, use the last message ID of the
2179 * References header, if available. If not, fall back to the
2180 * first message ID in the In-Reply-To header. */
2181 if (last_ref_message_id) {
2182 _notmuch_message_add_term (message, "replyto",
2183 last_ref_message_id);
2184 } else if (in_reply_to_message_id) {
2185 _notmuch_message_add_term (message, "replyto",
2186 in_reply_to_message_id);
2189 keys = g_hash_table_get_keys (parents);
2190 for (l = keys; l; l = l->next) {
2191 char *parent_message_id;
2192 const char *parent_thread_id = NULL;
2194 parent_message_id = (char *) l->data;
2196 _notmuch_message_add_term (message, "reference",
2199 ret = _resolve_message_id_to_thread_id (notmuch,
2206 if (*thread_id == NULL) {
2207 *thread_id = talloc_strdup (message, parent_thread_id);
2208 _notmuch_message_add_term (message, "thread", *thread_id);
2209 } else if (strcmp (*thread_id, parent_thread_id)) {
2210 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
2220 g_hash_table_unref (parents);
2225 static notmuch_status_t
2226 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
2227 notmuch_message_t *message,
2228 const char **thread_id)
2230 const char *message_id = notmuch_message_get_message_id (message);
2231 Xapian::PostingIterator child, children_end;
2232 notmuch_message_t *child_message = NULL;
2233 const char *child_thread_id;
2234 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2235 notmuch_private_status_t private_status;
2237 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
2239 for ( ; child != children_end; child++) {
2241 child_message = _notmuch_message_create (message, notmuch,
2242 *child, &private_status);
2243 if (child_message == NULL) {
2244 ret = COERCE_STATUS (private_status,
2245 "Cannot find document for doc_id from query");
2249 child_thread_id = notmuch_message_get_thread_id (child_message);
2250 if (*thread_id == NULL) {
2251 *thread_id = talloc_strdup (message, child_thread_id);
2252 _notmuch_message_add_term (message, "thread", *thread_id);
2253 } else if (strcmp (*thread_id, child_thread_id)) {
2254 _notmuch_message_remove_term (child_message, "reference",
2256 _notmuch_message_sync (child_message);
2257 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
2262 notmuch_message_destroy (child_message);
2263 child_message = NULL;
2268 notmuch_message_destroy (child_message);
2273 /* Fetch and clear the stored thread_id for message, or NULL if none. */
2275 _consume_metadata_thread_id (void *ctx, notmuch_database_t *notmuch,
2276 notmuch_message_t *message)
2278 const char *message_id;
2282 message_id = notmuch_message_get_message_id (message);
2283 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2285 /* Check if we have already seen related messages to this one.
2286 * If we have then use the thread_id that we stored at that time.
2288 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
2289 if (stored_id.empty ()) {
2292 Xapian::WritableDatabase *db;
2294 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2296 /* Clear the metadata for this message ID. We don't need it
2298 db->set_metadata (metadata_key, "");
2300 return talloc_strdup (ctx, stored_id.c_str ());
2304 /* Given a blank or ghost 'message' and its corresponding
2305 * 'message_file' link it to existing threads in the database.
2307 * First, if is_ghost, this retrieves the thread ID already stored in
2308 * the message (which will be the case if a message was previously
2309 * added that referenced this one). If the message is blank
2310 * (!is_ghost), it doesn't have a thread ID yet (we'll generate one
2311 * later in this function). If the database does not support ghost
2312 * messages, this checks for a thread ID stored in database metadata
2313 * for this message ID.
2315 * Second, we look at 'message_file' and its link-relevant headers
2316 * (References and In-Reply-To) for message IDs.
2318 * Finally, we look in the database for existing message that
2319 * reference 'message'.
2321 * In all cases, we assign to the current message the first thread ID
2322 * found. We will also merge any existing, distinct threads where this
2323 * message belongs to both, (which is not uncommon when messages are
2324 * processed out of order).
2326 * Finally, if no thread ID has been found through referenced messages, we
2327 * call _notmuch_message_generate_thread_id to generate a new thread
2328 * ID. This should only happen for new, top-level messages, (no
2329 * References or In-Reply-To header in this message, and no previously
2330 * added message refers to this message).
2332 static notmuch_status_t
2333 _notmuch_database_link_message (notmuch_database_t *notmuch,
2334 notmuch_message_t *message,
2335 notmuch_message_file_t *message_file,
2336 notmuch_bool_t is_ghost)
2338 void *local = talloc_new (NULL);
2339 notmuch_status_t status;
2340 const char *thread_id = NULL;
2342 /* Check if the message already had a thread ID */
2343 if (notmuch->features & NOTMUCH_FEATURE_GHOSTS) {
2345 thread_id = notmuch_message_get_thread_id (message);
2347 thread_id = _consume_metadata_thread_id (local, notmuch, message);
2349 _notmuch_message_add_term (message, "thread", thread_id);
2352 status = _notmuch_database_link_message_to_parents (notmuch, message,
2358 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS)) {
2359 /* In general, it shouldn't be necessary to link children,
2360 * since the earlier indexing of those children will have
2361 * stored a thread ID for the missing parent. However, prior
2362 * to ghost messages, these stored thread IDs were NOT
2363 * rewritten during thread merging (and there was no
2364 * performant way to do so), so if indexed children were
2365 * pulled into a different thread ID by a merge, it was
2366 * necessary to pull them *back* into the stored thread ID of
2367 * the parent. With ghost messages, we just rewrite the
2368 * stored thread IDs during merging, so this workaround isn't
2370 status = _notmuch_database_link_message_to_children (notmuch, message,
2376 /* If not part of any existing thread, generate a new thread ID. */
2377 if (thread_id == NULL) {
2378 thread_id = _notmuch_database_generate_thread_id (notmuch);
2380 _notmuch_message_add_term (message, "thread", thread_id);
2384 talloc_free (local);
2390 notmuch_database_add_message (notmuch_database_t *notmuch,
2391 const char *filename,
2392 notmuch_message_t **message_ret)
2394 notmuch_message_file_t *message_file;
2395 notmuch_message_t *message = NULL;
2396 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
2397 notmuch_private_status_t private_status;
2398 notmuch_bool_t is_ghost = false;
2400 const char *date, *header;
2401 const char *from, *to, *subject;
2402 char *message_id = NULL;
2405 *message_ret = NULL;
2407 ret = _notmuch_database_ensure_writable (notmuch);
2411 message_file = _notmuch_message_file_open (notmuch, filename);
2412 if (message_file == NULL)
2413 return NOTMUCH_STATUS_FILE_ERROR;
2415 /* Adding a message may change many documents. Do this all
2417 ret = notmuch_database_begin_atomic (notmuch);
2421 /* Parse message up front to get better error status. */
2422 ret = _notmuch_message_file_parse (message_file);
2427 /* Before we do any real work, (especially before doing a
2428 * potential SHA-1 computation on the entire file's contents),
2429 * let's make sure that what we're looking at looks like an
2430 * actual email message.
2432 from = _notmuch_message_file_get_header (message_file, "from");
2433 subject = _notmuch_message_file_get_header (message_file, "subject");
2434 to = _notmuch_message_file_get_header (message_file, "to");
2436 if ((from == NULL || *from == '\0') &&
2437 (subject == NULL || *subject == '\0') &&
2438 (to == NULL || *to == '\0'))
2440 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
2444 /* Now that we're sure it's mail, the first order of business
2445 * is to find a message ID (or else create one ourselves). */
2447 header = _notmuch_message_file_get_header (message_file, "message-id");
2448 if (header && *header != '\0') {
2449 message_id = _parse_message_id (message_file, header, NULL);
2451 /* So the header value isn't RFC-compliant, but it's
2452 * better than no message-id at all. */
2453 if (message_id == NULL)
2454 message_id = talloc_strdup (message_file, header);
2457 if (message_id == NULL ) {
2458 /* No message-id at all, let's generate one by taking a
2459 * hash over the file's contents. */
2460 char *sha1 = _notmuch_sha1_of_file (filename);
2462 /* If that failed too, something is really wrong. Give up. */
2464 ret = NOTMUCH_STATUS_FILE_ERROR;
2468 message_id = talloc_asprintf (message_file,
2469 "notmuch-sha1-%s", sha1);
2473 /* Now that we have a message ID, we get a message object,
2474 * (which may or may not reference an existing document in the
2477 message = _notmuch_message_create_for_message_id (notmuch,
2481 talloc_free (message_id);
2483 if (message == NULL) {
2484 ret = COERCE_STATUS (private_status,
2485 "Unexpected status value from _notmuch_message_create_for_message_id");
2489 _notmuch_message_add_filename (message, filename);
2491 /* Is this a newly created message object or a ghost
2492 * message? We have to be slightly careful: if this is a
2493 * blank message, it's not safe to call
2494 * notmuch_message_get_flag yet. */
2495 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND ||
2496 (is_ghost = notmuch_message_get_flag (
2497 message, NOTMUCH_MESSAGE_FLAG_GHOST))) {
2498 _notmuch_message_add_term (message, "type", "mail");
2500 /* Convert ghost message to a regular message */
2501 _notmuch_message_remove_term (message, "type", "ghost");
2503 ret = _notmuch_database_link_message (notmuch, message,
2504 message_file, is_ghost);
2508 date = _notmuch_message_file_get_header (message_file, "date");
2509 _notmuch_message_set_header_values (message, date, from, subject);
2511 ret = _notmuch_message_index_file (message, message_file);
2515 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2518 _notmuch_message_sync (message);
2519 } catch (const Xapian::Error &error) {
2520 _notmuch_database_log (notmuch, "A Xapian exception occurred adding message: %s.\n",
2521 error.get_msg().c_str());
2522 notmuch->exception_reported = TRUE;
2523 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2529 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2530 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2531 *message_ret = message;
2533 notmuch_message_destroy (message);
2537 _notmuch_message_file_close (message_file);
2539 ret2 = notmuch_database_end_atomic (notmuch);
2540 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2541 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2542 ret2 != NOTMUCH_STATUS_SUCCESS)
2549 notmuch_database_remove_message (notmuch_database_t *notmuch,
2550 const char *filename)
2552 notmuch_status_t status;
2553 notmuch_message_t *message;
2555 status = notmuch_database_find_message_by_filename (notmuch, filename,
2558 if (status == NOTMUCH_STATUS_SUCCESS && message) {
2559 status = _notmuch_message_remove_filename (message, filename);
2560 if (status == NOTMUCH_STATUS_SUCCESS)
2561 _notmuch_message_delete (message);
2562 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2563 _notmuch_message_sync (message);
2565 notmuch_message_destroy (message);
2572 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2573 const char *filename,
2574 notmuch_message_t **message_ret)
2577 const char *prefix = _find_prefix ("file-direntry");
2578 char *direntry, *term;
2579 Xapian::PostingIterator i, end;
2580 notmuch_status_t status;
2582 if (message_ret == NULL)
2583 return NOTMUCH_STATUS_NULL_POINTER;
2585 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2586 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2588 /* return NULL on any failure */
2589 *message_ret = NULL;
2591 local = talloc_new (notmuch);
2594 status = _notmuch_database_filename_to_direntry (
2595 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2596 if (status || !direntry)
2599 term = talloc_asprintf (local, "%s%s", prefix, direntry);
2601 find_doc_ids_for_term (notmuch, term, &i, &end);
2604 notmuch_private_status_t private_status;
2606 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2608 if (*message_ret == NULL)
2609 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2611 } catch (const Xapian::Error &error) {
2612 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2613 error.get_msg().c_str());
2614 notmuch->exception_reported = TRUE;
2615 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2619 talloc_free (local);
2621 if (status && *message_ret) {
2622 notmuch_message_destroy (*message_ret);
2623 *message_ret = NULL;
2628 notmuch_string_list_t *
2629 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2630 Xapian::TermIterator &end,
2633 int prefix_len = strlen (prefix);
2634 notmuch_string_list_t *list;
2636 list = _notmuch_string_list_create (ctx);
2637 if (unlikely (list == NULL))
2640 for (i.skip_to (prefix); i != end; i++) {
2641 /* Terminate loop at first term without desired prefix. */
2642 if (strncmp ((*i).c_str (), prefix, prefix_len))
2645 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2652 notmuch_database_get_all_tags (notmuch_database_t *db)
2654 Xapian::TermIterator i, end;
2655 notmuch_string_list_t *tags;
2658 i = db->xapian_db->allterms_begin();
2659 end = db->xapian_db->allterms_end();
2660 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2661 _find_prefix ("tag"));
2662 _notmuch_string_list_sort (tags);
2663 return _notmuch_tags_create (db, tags);
2664 } catch (const Xapian::Error &error) {
2665 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2666 error.get_msg().c_str());
2667 db->exception_reported = TRUE;
2673 notmuch_database_status_string (const notmuch_database_t *notmuch)
2675 return notmuch->status_string;