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 https://www.gnu.org/licenses/ .
18 * Author: Carl Worth <cworth@cworth.org>
21 #include "database-private.h"
22 #include "parse-time-vrp.h"
24 #include "string-util.h"
33 #include <glib.h> /* g_free, GPtrArray, GHashTable */
34 #include <glib-object.h> /* g_type_init */
36 #include <gmime/gmime.h> /* g_mime_init */
40 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
47 #define NOTMUCH_DATABASE_VERSION 3
49 #define STRINGIFY(s) _SUB_STRINGIFY(s)
50 #define _SUB_STRINGIFY(s) #s
52 #if HAVE_XAPIAN_DB_RETRY_LOCK
53 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
55 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
58 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
60 * We currently have three different types of documents (mail, ghost,
61 * and directory) and also some metadata.
65 * A mail document is associated with a particular email message. It
66 * is stored in one or more files on disk (though only one has its
67 * content indexed) and is uniquely identified by its "id" field
68 * (which is generally the message ID). It is indexed with the
69 * following prefixed terms which the database uses to construct
72 * Single terms of given prefix:
76 * id: Unique ID of mail. This is from the Message-ID header
77 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
78 * If it's present and too long, then we use
79 * "notmuch-sha1-<sha1_sum_of_message_id>".
80 * If this header is not present, we use
81 * "notmuch-sha1-<sha1_sum_of_entire_file>".
83 * thread: The ID of the thread to which the mail belongs
85 * replyto: The ID from the In-Reply-To header of the mail (if any).
87 * Multiple terms of given prefix:
89 * reference: All message IDs from In-Reply-To and References
90 * headers in the message.
92 * tag: Any tags associated with this message by the user.
94 * file-direntry: A colon-separated pair of values
95 * (INTEGER:STRING), where INTEGER is the
96 * document ID of a directory document, and
97 * STRING is the name of a file within that
98 * directory for this mail message.
100 * A mail document also has four values:
102 * TIMESTAMP: The time_t value corresponding to the message's
105 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
107 * FROM: The value of the "From" header
109 * SUBJECT: The value of the "Subject" header
111 * LAST_MOD: The revision number as of the last tag or
114 * In addition, terms from the content of the message are added with
115 * "from", "to", "attachment", and "subject" prefixes for use by the
116 * user in searching. Similarly, terms from the path of the mail
117 * message are added with "folder" and "path" prefixes. But the
118 * database doesn't really care itself about any of these.
120 * The data portion of a mail document is empty.
122 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
123 * -----------------------------------------------
124 * A ghost mail document is like a mail document, but where we don't
125 * have the message content. These are used to track thread reference
126 * information for messages we haven't received.
128 * A ghost mail document has type: ghost; id and thread fields that
129 * are identical to the mail document fields; and a MESSAGE_ID value.
133 * A directory document is used by a client of the notmuch library to
134 * maintain data necessary to allow for efficient polling of mail
137 * All directory documents contain one term:
139 * directory: The directory path (relative to the database path)
140 * Or the SHA1 sum of the directory path (if the
141 * path itself is too long to fit in a Xapian
144 * And all directory documents for directories other than top-level
145 * directories also contain the following term:
147 * directory-direntry: A colon-separated pair of values
148 * (INTEGER:STRING), where INTEGER is the
149 * document ID of the parent directory
150 * document, and STRING is the name of this
151 * directory within that parent.
153 * All directory documents have a single value:
155 * TIMESTAMP: The mtime of the directory (at last scan)
157 * The data portion of a directory document contains the path of the
158 * directory (relative to the database path).
162 * Xapian allows us to store arbitrary name-value pairs as
163 * "metadata". We currently use the following metadata names with the
166 * version The database schema version, (which is distinct
167 * from both the notmuch package version (see
168 * notmuch --version) and the libnotmuch library
169 * version. The version is stored as an base-10
170 * ASCII integer. The initial database version
171 * was 1, (though a schema existed before that
172 * were no "version" database value existed at
173 * all). Successive versions are allocated as
174 * changes are made to the database (such as by
175 * indexing new fields).
177 * features The set of features supported by this
178 * database. This consists of a set of
179 * '\n'-separated lines, where each is a feature
180 * name, a '\t', and compatibility flags. If the
181 * compatibility flags contain 'w', then the
182 * opener must support this feature to safely
183 * write this database. If the compatibility
184 * flags contain 'r', then the opener must
185 * support this feature to read this database.
186 * Introduced in database version 3.
188 * last_thread_id The last thread ID generated. This is stored
189 * as a 16-byte hexadecimal ASCII representation
190 * of a 64-bit unsigned integer. The first ID
191 * generated is 1 and the value will be
192 * incremented for each thread ID.
194 * C* metadata keys starting with C indicate
195 * configuration data. It can be managed with the
196 * n_database_*config* API. There is a convention
197 * of hierarchical keys separated by '.' (e.g.
198 * query.notmuch stores the value for the named
199 * query 'notmuch'), but it is not enforced by the
205 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
206 * Instead, the database has the following additional database
209 * thread_id_* A pre-allocated thread ID for a particular
210 * message. This is actually an arbitrarily large
211 * family of metadata name. Any particular name is
212 * formed by concatenating "thread_id_" with a message
213 * ID (or the SHA1 sum of a message ID if it is very
214 * long---see description of 'id' in the mail
215 * document). The value stored is a thread ID.
217 * These thread ID metadata values are stored
218 * whenever a message references a parent message
219 * that does not yet exist in the database. A
220 * thread ID will be allocated and stored, and if
221 * the message is later added, the stored thread
222 * ID will be used (and the metadata value will
225 * Even before a message is added, it's
226 * pre-allocated thread ID is useful so that all
227 * descendant messages that reference this common
228 * parent can be recognized as belonging to the
232 /* With these prefix values we follow the conventions published here:
234 * https://xapian.org/docs/omega/termprefixes.html
236 * as much as makes sense. Note that I took some liberty in matching
237 * the reserved prefix values to notmuch concepts, (for example, 'G'
238 * is documented as "newsGroup (or similar entity - e.g. a web forum
239 * name)", for which I think the thread is the closest analogue in
240 * notmuch. This in spite of the fact that we will eventually be
241 * storing mailing-list messages where 'G' for "mailing list name"
242 * might be even a closer analogue. I'm treating the single-character
243 * prefixes preferentially for core notmuch concepts (which will be
244 * nearly universal to all mail messages).
247 static prefix_t BOOLEAN_PREFIX_INTERNAL[] = {
249 { "reference", "XREFERENCE" },
250 { "replyto", "XREPLYTO" },
251 { "directory", "XDIRECTORY" },
252 { "file-direntry", "XFDIRENTRY" },
253 { "directory-direntry", "XDDIRENTRY" },
254 { "property", "XPROPERTY" },
257 static prefix_t BOOLEAN_PREFIX_EXTERNAL[] = {
264 * Unconditionally add ':' to reduce potential ambiguity with
265 * overlapping prefixes and/or terms that start with capital
266 * letters. See Xapian document termprefixes.html for related
269 { "folder", "XFOLDER:" },
272 static prefix_t PROBABILISTIC_PREFIX[]= {
275 { "attachment", "XATTACHMENT" },
276 { "mimetype", "XMIMETYPE"},
277 { "subject", "XSUBJECT"},
281 _find_prefix (const char *name)
285 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_INTERNAL); i++) {
286 if (strcmp (name, BOOLEAN_PREFIX_INTERNAL[i].name) == 0)
287 return BOOLEAN_PREFIX_INTERNAL[i].prefix;
290 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
291 if (strcmp (name, BOOLEAN_PREFIX_EXTERNAL[i].name) == 0)
292 return BOOLEAN_PREFIX_EXTERNAL[i].prefix;
295 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
296 if (strcmp (name, PROBABILISTIC_PREFIX[i].name) == 0)
297 return PROBABILISTIC_PREFIX[i].prefix;
300 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
305 static const struct {
306 /* NOTMUCH_FEATURE_* value. */
307 _notmuch_features value;
308 /* Feature name as it appears in the database. This name should
309 * be appropriate for displaying to the user if an older version
310 * of notmuch doesn't support this feature. */
312 /* Compatibility flags when this feature is declared. */
314 } feature_names[] = {
315 { NOTMUCH_FEATURE_FILE_TERMS,
316 "multiple paths per message", "rw" },
317 { NOTMUCH_FEATURE_DIRECTORY_DOCS,
318 "relative directory paths", "rw" },
319 /* Header values are not required for reading a database because a
320 * reader can just refer to the message file. */
321 { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
322 "from/subject/message-ID in database", "w" },
323 { NOTMUCH_FEATURE_BOOL_FOLDER,
324 "exact folder:/path: search", "rw" },
325 { NOTMUCH_FEATURE_GHOSTS,
326 "mail documents for missing messages", "w"},
327 /* Knowledge of the index mime-types are not required for reading
328 * a database because a reader will just be unable to query
330 { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
331 "indexed MIME types", "w"},
332 { NOTMUCH_FEATURE_LAST_MOD,
333 "modification tracking", "w"},
337 notmuch_status_to_string (notmuch_status_t status)
340 case NOTMUCH_STATUS_SUCCESS:
341 return "No error occurred";
342 case NOTMUCH_STATUS_OUT_OF_MEMORY:
343 return "Out of memory";
344 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
345 return "Attempt to write to a read-only database";
346 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
347 return "A Xapian exception occurred";
348 case NOTMUCH_STATUS_FILE_ERROR:
349 return "Something went wrong trying to read or write a file";
350 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
351 return "File is not an email";
352 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
353 return "Message ID is identical to a message in database";
354 case NOTMUCH_STATUS_NULL_POINTER:
355 return "Erroneous NULL pointer";
356 case NOTMUCH_STATUS_TAG_TOO_LONG:
357 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
358 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
359 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
360 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
361 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
362 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
363 return "Unsupported operation";
364 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
365 return "Operation requires a database upgrade";
366 case NOTMUCH_STATUS_PATH_ERROR:
367 return "Path supplied is illegal for this function";
369 case NOTMUCH_STATUS_LAST_STATUS:
370 return "Unknown error status value";
375 _notmuch_database_log (notmuch_database_t *notmuch,
381 va_start (va_args, format);
383 if (notmuch->status_string)
384 talloc_free (notmuch->status_string);
386 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
391 _notmuch_database_log_append (notmuch_database_t *notmuch,
397 va_start (va_args, format);
399 if (notmuch->status_string)
400 notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
402 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
408 find_doc_ids_for_term (notmuch_database_t *notmuch,
410 Xapian::PostingIterator *begin,
411 Xapian::PostingIterator *end)
413 *begin = notmuch->xapian_db->postlist_begin (term);
415 *end = notmuch->xapian_db->postlist_end (term);
419 find_doc_ids (notmuch_database_t *notmuch,
420 const char *prefix_name,
422 Xapian::PostingIterator *begin,
423 Xapian::PostingIterator *end)
427 term = talloc_asprintf (notmuch, "%s%s",
428 _find_prefix (prefix_name), value);
430 find_doc_ids_for_term (notmuch, term, begin, end);
435 notmuch_private_status_t
436 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
437 const char *prefix_name,
439 unsigned int *doc_id)
441 Xapian::PostingIterator i, end;
443 find_doc_ids (notmuch, prefix_name, value, &i, &end);
447 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
452 #if DEBUG_DATABASE_SANITY
456 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
460 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
463 static Xapian::Document
464 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
466 return notmuch->xapian_db->get_document (doc_id);
469 /* Generate a compressed version of 'message_id' of the form:
471 * notmuch-sha1-<sha1_sum_of_message_id>
474 _notmuch_message_id_compressed (void *ctx, const char *message_id)
476 char *sha1, *compressed;
478 sha1 = _notmuch_sha1_of_string (message_id);
480 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
487 notmuch_database_find_message (notmuch_database_t *notmuch,
488 const char *message_id,
489 notmuch_message_t **message_ret)
491 notmuch_private_status_t status;
494 if (message_ret == NULL)
495 return NOTMUCH_STATUS_NULL_POINTER;
497 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
498 message_id = _notmuch_message_id_compressed (notmuch, message_id);
501 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
502 message_id, &doc_id);
504 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
507 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
509 if (*message_ret == NULL)
510 return NOTMUCH_STATUS_OUT_OF_MEMORY;
513 return NOTMUCH_STATUS_SUCCESS;
514 } catch (const Xapian::Error &error) {
515 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
516 error.get_msg().c_str());
517 notmuch->exception_reported = TRUE;
519 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
523 /* Advance 'str' past any whitespace or RFC 822 comments. A comment is
524 * a (potentially nested) parenthesized sequence with '\' used to
525 * escape any character (including parentheses).
527 * If the sequence to be skipped continues to the end of the string,
528 * then 'str' will be left pointing at the final terminating '\0'
532 skip_space_and_comments (const char **str)
537 while (*s && (isspace (*s) || *s == '(')) {
538 while (*s && isspace (*s))
543 while (*s && nesting) {
546 } else if (*s == ')') {
548 } else if (*s == '\\') {
560 /* Parse an RFC 822 message-id, discarding whitespace, any RFC 822
561 * comments, and the '<' and '>' delimiters.
563 * If not NULL, then *next will be made to point to the first character
564 * not parsed, (possibly pointing to the final '\0' terminator.
566 * Returns a newly talloc'ed string belonging to 'ctx'.
568 * Returns NULL if there is any error parsing the message-id. */
570 _parse_message_id (void *ctx, const char *message_id, const char **next)
575 if (message_id == NULL || *message_id == '\0')
580 skip_space_and_comments (&s);
582 /* Skip any unstructured text as well. */
583 while (*s && *s != '<')
594 skip_space_and_comments (&s);
597 while (*end && *end != '>')
606 if (end > s && *end == '>')
611 result = talloc_strndup (ctx, s, end - s + 1);
613 /* Finally, collapse any whitespace that is within the message-id
619 for (r = result, len = strlen (r); *r; r++, len--)
620 if (*r == ' ' || *r == '\t')
621 memmove (r, r+1, len);
627 /* Parse a References header value, putting a (talloc'ed under 'ctx')
628 * copy of each referenced message-id into 'hash'.
630 * We explicitly avoid including any reference identical to
631 * 'message_id' in the result (to avoid mass confusion when a single
632 * message references itself cyclically---and yes, mail messages are
633 * not infrequent in the wild that do this---don't ask me why).
635 * Return the last reference parsed, if it is not equal to message_id.
638 parse_references (void *ctx,
639 const char *message_id,
643 char *ref, *last_ref = NULL;
645 if (refs == NULL || *refs == '\0')
649 ref = _parse_message_id (ctx, refs, &refs);
651 if (ref && strcmp (ref, message_id)) {
652 g_hash_table_insert (hash, ref, NULL);
657 /* The return value of this function is used to add a parent
658 * reference to the database. We should avoid making a message
659 * its own parent, thus the above check.
665 notmuch_database_create (const char *path, notmuch_database_t **database)
667 char *status_string = NULL;
668 notmuch_status_t status;
670 status = notmuch_database_create_verbose (path, database,
674 fputs (status_string, stderr);
675 free (status_string);
682 notmuch_database_create_verbose (const char *path,
683 notmuch_database_t **database,
684 char **status_string)
686 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
687 notmuch_database_t *notmuch = NULL;
688 char *notmuch_path = NULL;
689 char *message = NULL;
694 message = strdup ("Error: Cannot create a database for a NULL path.\n");
695 status = NOTMUCH_STATUS_NULL_POINTER;
699 if (path[0] != '/') {
700 message = strdup ("Error: Database path must be absolute.\n");
701 status = NOTMUCH_STATUS_PATH_ERROR;
705 err = stat (path, &st);
707 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
708 path, strerror (errno)));
709 status = NOTMUCH_STATUS_FILE_ERROR;
713 if (! S_ISDIR (st.st_mode)) {
714 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
715 "Not a directory.\n",
717 status = NOTMUCH_STATUS_FILE_ERROR;
721 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
723 err = mkdir (notmuch_path, 0755);
726 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
727 notmuch_path, strerror (errno)));
728 status = NOTMUCH_STATUS_FILE_ERROR;
732 status = notmuch_database_open_verbose (path,
733 NOTMUCH_DATABASE_MODE_READ_WRITE,
738 /* Upgrade doesn't add these feature to existing databases, but
739 * new databases have them. */
740 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
741 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
743 status = notmuch_database_upgrade (notmuch, NULL, NULL);
745 notmuch_database_close(notmuch);
751 talloc_free (notmuch_path);
755 *status_string = message;
762 talloc_free (notmuch);
767 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
769 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
770 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
771 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
774 return NOTMUCH_STATUS_SUCCESS;
777 /* Allocate a revision number for the next change. */
779 _notmuch_database_new_revision (notmuch_database_t *notmuch)
781 unsigned long new_revision = notmuch->revision + 1;
783 /* If we're in an atomic section, hold off on updating the
784 * committed revision number until we commit the atomic section.
786 if (notmuch->atomic_nesting)
787 notmuch->atomic_dirty = TRUE;
789 notmuch->revision = new_revision;
794 /* Parse a database features string from the given database version.
795 * Returns the feature bit set.
797 * For version < 3, this ignores the features string and returns a
798 * hard-coded set of features.
800 * If there are unrecognized features that are required to open the
801 * database in mode (which should be 'r' or 'w'), return a
802 * comma-separated list of unrecognized but required features in
803 * *incompat_out suitable for presenting to the user. *incompat_out
804 * will be allocated from ctx.
806 static _notmuch_features
807 _parse_features (const void *ctx, const char *features, unsigned int version,
808 char mode, char **incompat_out)
810 _notmuch_features res = static_cast<_notmuch_features>(0);
811 unsigned int namelen, i;
815 /* Prior to database version 3, features were implied by the
818 return NOTMUCH_FEATURES_V0;
819 else if (version == 1)
820 return NOTMUCH_FEATURES_V1;
821 else if (version == 2)
822 return NOTMUCH_FEATURES_V2;
824 /* Parse the features string */
825 while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
826 flags = strchr (features, '\t');
827 if (! flags || flags > features + llen)
829 namelen = flags - features;
831 for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
832 if (strlen (feature_names[i].name) == namelen &&
833 strncmp (feature_names[i].name, features, namelen) == 0) {
834 res |= feature_names[i].value;
839 if (i == ARRAY_SIZE (feature_names) && incompat_out) {
840 /* Unrecognized feature */
841 const char *have = strchr (flags, mode);
842 if (have && have < features + llen) {
843 /* This feature is required to access this database in
844 * 'mode', but we don't understand it. */
846 *incompat_out = talloc_strdup (ctx, "");
847 *incompat_out = talloc_asprintf_append_buffer (
848 *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
858 _print_features (const void *ctx, unsigned int features)
861 char *res = talloc_strdup (ctx, "");
863 for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
864 if (features & feature_names[i].value)
865 res = talloc_asprintf_append_buffer (
866 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
872 notmuch_database_open (const char *path,
873 notmuch_database_mode_t mode,
874 notmuch_database_t **database)
876 char *status_string = NULL;
877 notmuch_status_t status;
879 status = notmuch_database_open_verbose (path, mode, database,
883 fputs (status_string, stderr);
884 free (status_string);
891 notmuch_database_open_verbose (const char *path,
892 notmuch_database_mode_t mode,
893 notmuch_database_t **database,
894 char **status_string)
896 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
897 void *local = talloc_new (NULL);
898 notmuch_database_t *notmuch = NULL;
899 char *notmuch_path, *xapian_path, *incompat_features;
900 char *message = NULL;
903 unsigned int i, version;
904 static int initialized = 0;
907 message = strdup ("Error: Cannot open a database for a NULL path.\n");
908 status = NOTMUCH_STATUS_NULL_POINTER;
912 if (path[0] != '/') {
913 message = strdup ("Error: Database path must be absolute.\n");
914 status = NOTMUCH_STATUS_PATH_ERROR;
918 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
919 message = strdup ("Out of memory\n");
920 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
924 err = stat (notmuch_path, &st);
926 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
927 notmuch_path, strerror (errno)));
928 status = NOTMUCH_STATUS_FILE_ERROR;
932 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
933 message = strdup ("Out of memory\n");
934 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
938 /* Initialize the GLib type system and threads */
939 #if !GLIB_CHECK_VERSION(2, 35, 1)
943 /* Initialize gmime */
945 g_mime_init (GMIME_ENABLE_RFC2047_WORKAROUNDS);
949 notmuch = talloc_zero (NULL, notmuch_database_t);
950 notmuch->exception_reported = FALSE;
951 notmuch->status_string = NULL;
952 notmuch->path = talloc_strdup (notmuch, path);
954 if (notmuch->path[strlen (notmuch->path) - 1] == '/')
955 notmuch->path[strlen (notmuch->path) - 1] = '\0';
957 notmuch->mode = mode;
958 notmuch->atomic_nesting = 0;
960 string last_thread_id;
963 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
964 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
967 notmuch->xapian_db = new Xapian::Database (xapian_path);
970 /* Check version. As of database version 3, we represent
971 * changes in terms of features, so assume a version bump
972 * means a dramatically incompatible change. */
973 version = notmuch_database_get_version (notmuch);
974 if (version > NOTMUCH_DATABASE_VERSION) {
975 IGNORE_RESULT (asprintf (&message,
976 "Error: Notmuch database at %s\n"
977 " has a newer database format version (%u) than supported by this\n"
978 " version of notmuch (%u).\n",
979 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
980 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
981 notmuch_database_destroy (notmuch);
983 status = NOTMUCH_STATUS_FILE_ERROR;
987 /* Check features. */
988 incompat_features = NULL;
989 notmuch->features = _parse_features (
990 local, notmuch->xapian_db->get_metadata ("features").c_str (),
991 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
993 if (incompat_features) {
994 IGNORE_RESULT (asprintf (&message,
995 "Error: Notmuch database at %s\n"
996 " requires features (%s)\n"
997 " not supported by this version of notmuch.\n",
998 notmuch_path, incompat_features));
999 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
1000 notmuch_database_destroy (notmuch);
1002 status = NOTMUCH_STATUS_FILE_ERROR;
1006 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
1007 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
1008 if (last_thread_id.empty ()) {
1009 notmuch->last_thread_id = 0;
1014 str = last_thread_id.c_str ();
1015 notmuch->last_thread_id = strtoull (str, &end, 16);
1017 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
1020 /* Get current highest revision number. */
1021 last_mod = notmuch->xapian_db->get_value_upper_bound (
1022 NOTMUCH_VALUE_LAST_MOD);
1023 if (last_mod.empty ())
1024 notmuch->revision = 0;
1026 notmuch->revision = Xapian::sortable_unserialise (last_mod);
1027 notmuch->uuid = talloc_strdup (
1028 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
1030 notmuch->query_parser = new Xapian::QueryParser;
1031 notmuch->term_gen = new Xapian::TermGenerator;
1032 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
1033 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1034 notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1035 #if HAVE_XAPIAN_FIELD_PROCESSOR
1036 /* This currently relies on the query parser to pass anything
1037 * with a .. to the range processor */
1038 notmuch->date_field_processor = new DateFieldProcessor();
1039 notmuch->query_parser->add_boolean_prefix("date", notmuch->date_field_processor);
1040 notmuch->query_field_processor = new QueryFieldProcessor (*notmuch->query_parser, notmuch);
1041 notmuch->query_parser->add_boolean_prefix("query", notmuch->query_field_processor);
1043 notmuch->last_mod_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
1045 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
1046 notmuch->query_parser->set_database (*notmuch->xapian_db);
1047 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
1048 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
1049 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
1050 notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
1051 notmuch->query_parser->add_valuerangeprocessor (notmuch->last_mod_range_processor);
1053 for (i = 0; i < ARRAY_SIZE (BOOLEAN_PREFIX_EXTERNAL); i++) {
1054 prefix_t *prefix = &BOOLEAN_PREFIX_EXTERNAL[i];
1055 notmuch->query_parser->add_boolean_prefix (prefix->name,
1059 for (i = 0; i < ARRAY_SIZE (PROBABILISTIC_PREFIX); i++) {
1060 prefix_t *prefix = &PROBABILISTIC_PREFIX[i];
1061 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
1063 } catch (const Xapian::Error &error) {
1064 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
1065 error.get_msg().c_str()));
1066 notmuch_database_destroy (notmuch);
1068 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1072 talloc_free (local);
1076 *status_string = message;
1082 *database = notmuch;
1084 talloc_free (notmuch);
1089 notmuch_database_close (notmuch_database_t *notmuch)
1091 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1093 /* Many Xapian objects (and thus notmuch objects) hold references to
1094 * the database, so merely deleting the database may not suffice to
1095 * close it. Thus, we explicitly close it here. */
1096 if (notmuch->xapian_db != NULL) {
1098 /* If there's an outstanding transaction, it's unclear if
1099 * closing the Xapian database commits everything up to
1100 * that transaction, or may discard committed (but
1101 * unflushed) transactions. To be certain, explicitly
1102 * cancel any outstanding transaction before closing. */
1103 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1104 notmuch->atomic_nesting)
1105 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1106 ->cancel_transaction ();
1108 /* Close the database. This implicitly flushes
1109 * outstanding changes. */
1110 notmuch->xapian_db->close();
1111 } catch (const Xapian::Error &error) {
1112 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1113 if (! notmuch->exception_reported) {
1114 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1115 error.get_msg().c_str());
1120 delete notmuch->term_gen;
1121 notmuch->term_gen = NULL;
1122 delete notmuch->query_parser;
1123 notmuch->query_parser = NULL;
1124 delete notmuch->xapian_db;
1125 notmuch->xapian_db = NULL;
1126 delete notmuch->value_range_processor;
1127 notmuch->value_range_processor = NULL;
1128 delete notmuch->date_range_processor;
1129 notmuch->date_range_processor = NULL;
1130 delete notmuch->last_mod_range_processor;
1131 notmuch->last_mod_range_processor = NULL;
1133 #if HAVE_XAPIAN_FIELD_PROCESSOR
1134 delete notmuch->date_field_processor;
1135 notmuch->date_field_processor = NULL;
1136 delete notmuch->query_field_processor;
1137 notmuch->query_field_processor = NULL;
1143 #if HAVE_XAPIAN_COMPACT
1145 unlink_cb (const char *path,
1146 unused (const struct stat *sb),
1148 unused (struct FTW *ftw))
1150 return remove (path);
1154 rmtree (const char *path)
1156 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1159 class NotmuchCompactor : public Xapian::Compactor
1161 notmuch_compact_status_cb_t status_cb;
1162 void *status_closure;
1165 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1166 status_cb (cb), status_closure (closure) { }
1169 set_status (const std::string &table, const std::string &status)
1173 if (status_cb == NULL)
1176 if (status.length () == 0)
1177 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
1179 msg = talloc_asprintf (NULL, " %s", status.c_str());
1185 status_cb (msg, status_closure);
1190 /* Compacts the given database, optionally saving the original database
1191 * in backup_path. Additionally, a callback function can be provided to
1192 * give the user feedback on the progress of the (likely long-lived)
1193 * compaction process.
1195 * The backup path must point to a directory on the same volume as the
1196 * original database. Passing a NULL backup_path will result in the
1197 * uncompacted database being deleted after compaction has finished.
1198 * Note that the database write lock will be held during the
1199 * compaction process to protect data integrity.
1202 notmuch_database_compact (const char *path,
1203 const char *backup_path,
1204 notmuch_compact_status_cb_t status_cb,
1208 char *notmuch_path, *xapian_path, *compact_xapian_path;
1209 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1210 notmuch_database_t *notmuch = NULL;
1211 struct stat statbuf;
1212 notmuch_bool_t keep_backup;
1213 char *message = NULL;
1215 local = talloc_new (NULL);
1217 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1219 ret = notmuch_database_open_verbose (path,
1220 NOTMUCH_DATABASE_MODE_READ_WRITE,
1224 if (status_cb) status_cb (message, closure);
1228 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1229 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1233 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1234 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1238 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1239 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1243 if (backup_path == NULL) {
1244 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1245 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1248 keep_backup = FALSE;
1254 if (stat (backup_path, &statbuf) != -1) {
1255 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1256 ret = NOTMUCH_STATUS_FILE_ERROR;
1259 if (errno != ENOENT) {
1260 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1262 ret = NOTMUCH_STATUS_FILE_ERROR;
1266 /* Unconditionally attempt to remove old work-in-progress database (if
1267 * any). This is "protected" by database lock. If this fails due to write
1268 * errors (etc), the following code will fail and provide error message.
1270 (void) rmtree (compact_xapian_path);
1273 NotmuchCompactor compactor (status_cb, closure);
1275 compactor.set_renumber (false);
1276 compactor.add_source (xapian_path);
1277 compactor.set_destdir (compact_xapian_path);
1278 compactor.compact ();
1279 } catch (const Xapian::Error &error) {
1280 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg().c_str());
1281 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1285 if (rename (xapian_path, backup_path)) {
1286 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1287 xapian_path, backup_path, strerror (errno));
1288 ret = NOTMUCH_STATUS_FILE_ERROR;
1292 if (rename (compact_xapian_path, xapian_path)) {
1293 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1294 compact_xapian_path, xapian_path, strerror (errno));
1295 ret = NOTMUCH_STATUS_FILE_ERROR;
1299 if (! keep_backup) {
1300 if (rmtree (backup_path)) {
1301 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1302 backup_path, strerror (errno));
1303 ret = NOTMUCH_STATUS_FILE_ERROR;
1310 notmuch_status_t ret2;
1312 const char *str = notmuch_database_status_string (notmuch);
1313 if (status_cb && str)
1314 status_cb (str, closure);
1316 ret2 = notmuch_database_destroy (notmuch);
1318 /* don't clobber previous error status */
1319 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1323 talloc_free (local);
1329 notmuch_database_compact (unused (const char *path),
1330 unused (const char *backup_path),
1331 unused (notmuch_compact_status_cb_t status_cb),
1332 unused (void *closure))
1334 _notmuch_database_log (notmuch, "notmuch was compiled against a xapian version lacking compaction support.\n");
1335 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1340 notmuch_database_destroy (notmuch_database_t *notmuch)
1342 notmuch_status_t status;
1344 status = notmuch_database_close (notmuch);
1345 talloc_free (notmuch);
1351 notmuch_database_get_path (notmuch_database_t *notmuch)
1353 return notmuch->path;
1357 notmuch_database_get_version (notmuch_database_t *notmuch)
1359 unsigned int version;
1360 string version_string;
1364 version_string = notmuch->xapian_db->get_metadata ("version");
1365 if (version_string.empty ())
1368 str = version_string.c_str ();
1369 if (str == NULL || *str == '\0')
1372 version = strtoul (str, &end, 10);
1374 INTERNAL_ERROR ("Malformed database version: %s", str);
1380 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1382 return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1383 ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1384 (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1387 static volatile sig_atomic_t do_progress_notify = 0;
1390 handle_sigalrm (unused (int signal))
1392 do_progress_notify = 1;
1395 /* Upgrade the current database.
1397 * After opening a database in read-write mode, the client should
1398 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1399 * if so, upgrade with this function before making any modifications.
1401 * The optional progress_notify callback can be used by the caller to
1402 * provide progress indication to the user. If non-NULL it will be
1403 * called periodically with 'count' as the number of messages upgraded
1404 * so far and 'total' the overall number of messages that will be
1408 notmuch_database_upgrade (notmuch_database_t *notmuch,
1409 void (*progress_notify) (void *closure,
1413 void *local = talloc_new (NULL);
1414 Xapian::TermIterator t, t_end;
1415 Xapian::WritableDatabase *db;
1416 struct sigaction action;
1417 struct itimerval timerval;
1418 notmuch_bool_t timer_is_active = FALSE;
1419 enum _notmuch_features target_features, new_features;
1420 notmuch_status_t status;
1421 notmuch_private_status_t private_status;
1422 notmuch_query_t *query = NULL;
1423 unsigned int count = 0, total = 0;
1425 status = _notmuch_database_ensure_writable (notmuch);
1429 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1431 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1432 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1434 if (! notmuch_database_needs_upgrade (notmuch))
1435 return NOTMUCH_STATUS_SUCCESS;
1437 if (progress_notify) {
1438 /* Set up our handler for SIGALRM */
1439 memset (&action, 0, sizeof (struct sigaction));
1440 action.sa_handler = handle_sigalrm;
1441 sigemptyset (&action.sa_mask);
1442 action.sa_flags = SA_RESTART;
1443 sigaction (SIGALRM, &action, NULL);
1445 /* Then start a timer to send SIGALRM once per second. */
1446 timerval.it_interval.tv_sec = 1;
1447 timerval.it_interval.tv_usec = 0;
1448 timerval.it_value.tv_sec = 1;
1449 timerval.it_value.tv_usec = 0;
1450 setitimer (ITIMER_REAL, &timerval, NULL);
1452 timer_is_active = TRUE;
1455 /* Figure out how much total work we need to do. */
1457 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1458 NOTMUCH_FEATURE_LAST_MOD)) {
1459 query = notmuch_query_create (notmuch, "");
1462 status = notmuch_query_count_messages_st (query, &msg_count);
1467 notmuch_query_destroy (query);
1470 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1471 t_end = db->allterms_end ("XTIMESTAMP");
1472 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1475 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1476 /* The ghost message upgrade converts all thread_id_*
1477 * metadata values into ghost message documents. */
1478 t_end = db->metadata_keys_end ("thread_id_");
1479 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1483 /* Perform the upgrade in a transaction. */
1484 db->begin_transaction (true);
1486 /* Set the target features so we write out changes in the desired
1488 notmuch->features = target_features;
1490 /* Perform per-message upgrades. */
1492 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1493 NOTMUCH_FEATURE_LAST_MOD)) {
1494 notmuch_messages_t *messages;
1495 notmuch_message_t *message;
1498 query = notmuch_query_create (notmuch, "");
1500 status = notmuch_query_search_messages_st (query, &messages);
1504 notmuch_messages_valid (messages);
1505 notmuch_messages_move_to_next (messages))
1507 if (do_progress_notify) {
1508 progress_notify (closure, (double) count / total);
1509 do_progress_notify = 0;
1512 message = notmuch_messages_get (messages);
1514 /* Before version 1, each message document had its
1515 * filename in the data field. Copy that into the new
1516 * format by calling notmuch_message_add_filename.
1518 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1519 filename = _notmuch_message_talloc_copy_data (message);
1520 if (filename && *filename != '\0') {
1521 _notmuch_message_add_filename (message, filename);
1522 _notmuch_message_clear_data (message);
1524 talloc_free (filename);
1527 /* Prior to version 2, the "folder:" prefix was
1528 * probabilistic and stemmed. Change it to the current
1529 * boolean prefix. Add "path:" prefixes while at it.
1531 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1532 _notmuch_message_upgrade_folder (message);
1534 /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
1535 * track modification revisions. Give all messages the
1536 * next available revision; since we just started tracking
1537 * revisions for this database, that will be 1.
1539 if (new_features & NOTMUCH_FEATURE_LAST_MOD)
1540 _notmuch_message_upgrade_last_mod (message);
1542 _notmuch_message_sync (message);
1544 notmuch_message_destroy (message);
1549 notmuch_query_destroy (query);
1553 /* Perform per-directory upgrades. */
1555 /* Before version 1 we stored directory timestamps in
1556 * XTIMESTAMP documents instead of the current XDIRECTORY
1557 * documents. So copy those as well. */
1558 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1559 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1561 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1565 Xapian::PostingIterator p, p_end;
1566 std::string term = *t;
1568 p_end = notmuch->xapian_db->postlist_end (term);
1570 for (p = notmuch->xapian_db->postlist_begin (term);
1574 Xapian::Document document;
1576 notmuch_directory_t *directory;
1578 if (do_progress_notify) {
1579 progress_notify (closure, (double) count / total);
1580 do_progress_notify = 0;
1583 document = find_document_for_doc_id (notmuch, *p);
1584 mtime = Xapian::sortable_unserialise (
1585 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1587 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1588 NOTMUCH_FIND_CREATE, &status);
1589 notmuch_directory_set_mtime (directory, mtime);
1590 notmuch_directory_destroy (directory);
1592 db->delete_document (*p);
1599 /* Perform metadata upgrades. */
1601 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1602 * messages were stored as database metadata. Change these to
1605 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1606 notmuch_message_t *message;
1607 std::string message_id, thread_id;
1609 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1610 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1612 if (do_progress_notify) {
1613 progress_notify (closure, (double) count / total);
1614 do_progress_notify = 0;
1617 message_id = (*t).substr (
1618 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1619 thread_id = db->get_metadata (*t);
1621 /* Create ghost message */
1622 message = _notmuch_message_create_for_message_id (
1623 notmuch, message_id.c_str (), &private_status);
1624 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1625 /* Document already exists; ignore the stored thread ID */
1626 } else if (private_status ==
1627 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1628 private_status = _notmuch_message_initialize_ghost (
1629 message, thread_id.c_str ());
1630 if (! private_status)
1631 _notmuch_message_sync (message);
1634 if (private_status) {
1635 _notmuch_database_log (notmuch,
1636 "Upgrade failed while creating ghost messages.\n");
1637 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1641 /* Clear saved metadata thread ID */
1642 db->set_metadata (*t, "");
1648 status = NOTMUCH_STATUS_SUCCESS;
1649 db->set_metadata ("features", _print_features (local, notmuch->features));
1650 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1653 if (status == NOTMUCH_STATUS_SUCCESS)
1654 db->commit_transaction ();
1656 db->cancel_transaction ();
1658 if (timer_is_active) {
1659 /* Now stop the timer. */
1660 timerval.it_interval.tv_sec = 0;
1661 timerval.it_interval.tv_usec = 0;
1662 timerval.it_value.tv_sec = 0;
1663 timerval.it_value.tv_usec = 0;
1664 setitimer (ITIMER_REAL, &timerval, NULL);
1666 /* And disable the signal handler. */
1667 action.sa_handler = SIG_IGN;
1668 sigaction (SIGALRM, &action, NULL);
1672 notmuch_query_destroy (query);
1674 talloc_free (local);
1679 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1681 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1682 notmuch->atomic_nesting > 0)
1685 if (notmuch_database_needs_upgrade(notmuch))
1686 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1689 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1690 } catch (const Xapian::Error &error) {
1691 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1692 error.get_msg().c_str());
1693 notmuch->exception_reported = TRUE;
1694 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1698 notmuch->atomic_nesting++;
1699 return NOTMUCH_STATUS_SUCCESS;
1703 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1705 Xapian::WritableDatabase *db;
1707 if (notmuch->atomic_nesting == 0)
1708 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1710 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1711 notmuch->atomic_nesting > 1)
1714 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1716 db->commit_transaction ();
1718 /* This is a hack for testing. Xapian never flushes on a
1719 * non-flushed commit, even if the flush threshold is 1.
1720 * However, we rely on flushing to test atomicity. */
1721 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1722 if (thresh && atoi (thresh) == 1)
1724 } catch (const Xapian::Error &error) {
1725 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1726 error.get_msg().c_str());
1727 notmuch->exception_reported = TRUE;
1728 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1731 if (notmuch->atomic_dirty) {
1732 ++notmuch->revision;
1733 notmuch->atomic_dirty = FALSE;
1737 notmuch->atomic_nesting--;
1738 return NOTMUCH_STATUS_SUCCESS;
1742 notmuch_database_get_revision (notmuch_database_t *notmuch,
1746 *uuid = notmuch->uuid;
1747 return notmuch->revision;
1750 /* We allow the user to use arbitrarily long paths for directories. But
1751 * we have a term-length limit. So if we exceed that, we'll use the
1752 * SHA-1 of the path for the database term.
1754 * Note: This function may return the original value of 'path'. If it
1755 * does not, then the caller is responsible to free() the returned
1759 _notmuch_database_get_directory_db_path (const char *path)
1761 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1763 if (term_len > NOTMUCH_TERM_MAX)
1764 return _notmuch_sha1_of_string (path);
1769 /* Given a path, split it into two parts: the directory part is all
1770 * components except for the last, and the basename is that last
1771 * component. Getting the return-value for either part is optional
1772 * (the caller can pass NULL).
1774 * The original 'path' can represent either a regular file or a
1775 * directory---the splitting will be carried out in the same way in
1776 * either case. Trailing slashes on 'path' will be ignored, and any
1777 * cases of multiple '/' characters appearing in series will be
1778 * treated as a single '/'.
1780 * Allocation (if any) will have 'ctx' as the talloc owner. But
1781 * pointers will be returned within the original path string whenever
1784 * Note: If 'path' is non-empty and contains no non-trailing slash,
1785 * (that is, consists of a filename with no parent directory), then
1786 * the directory returned will be an empty string. However, if 'path'
1787 * is an empty string, then both directory and basename will be
1791 _notmuch_database_split_path (void *ctx,
1793 const char **directory,
1794 const char **basename)
1798 if (path == NULL || *path == '\0') {
1803 return NOTMUCH_STATUS_SUCCESS;
1806 /* Find the last slash (not counting a trailing slash), if any. */
1808 slash = path + strlen (path) - 1;
1810 /* First, skip trailing slashes. */
1811 while (slash != path && *slash == '/')
1814 /* Then, find a slash. */
1815 while (slash != path && *slash != '/') {
1822 /* Finally, skip multiple slashes. */
1823 while (slash != path && *(slash - 1) == '/')
1826 if (slash == path) {
1828 *directory = talloc_strdup (ctx, "");
1833 *directory = talloc_strndup (ctx, path, slash - path);
1836 return NOTMUCH_STATUS_SUCCESS;
1839 /* Find the document ID of the specified directory.
1841 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1842 * created if one does not exist for 'path'. Otherwise, if the
1843 * directory document does not exist, this sets *directory_id to
1844 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1847 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1849 notmuch_find_flags_t flags,
1850 unsigned int *directory_id)
1852 notmuch_directory_t *directory;
1853 notmuch_status_t status;
1857 return NOTMUCH_STATUS_SUCCESS;
1860 directory = _notmuch_directory_create (notmuch, path, flags, &status);
1861 if (status || !directory) {
1866 *directory_id = _notmuch_directory_get_document_id (directory);
1868 notmuch_directory_destroy (directory);
1870 return NOTMUCH_STATUS_SUCCESS;
1874 _notmuch_database_get_directory_path (void *ctx,
1875 notmuch_database_t *notmuch,
1876 unsigned int doc_id)
1878 Xapian::Document document;
1880 document = find_document_for_doc_id (notmuch, doc_id);
1882 return talloc_strdup (ctx, document.get_data ().c_str ());
1885 /* Given a legal 'filename' for the database, (either relative to
1886 * database path or absolute with initial components identical to
1887 * database path), return a new string (with 'ctx' as the talloc
1888 * owner) suitable for use as a direntry term value.
1890 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1891 * will be created in the database as needed. Otherwise, if the
1892 * necessary directory documents do not exist, this sets
1893 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1896 _notmuch_database_filename_to_direntry (void *ctx,
1897 notmuch_database_t *notmuch,
1898 const char *filename,
1899 notmuch_find_flags_t flags,
1902 const char *relative, *directory, *basename;
1903 Xapian::docid directory_id;
1904 notmuch_status_t status;
1906 relative = _notmuch_database_relative_path (notmuch, filename);
1908 status = _notmuch_database_split_path (ctx, relative,
1909 &directory, &basename);
1913 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1915 if (status || directory_id == (unsigned int)-1) {
1920 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1922 return NOTMUCH_STATUS_SUCCESS;
1925 /* Given a legal 'path' for the database, return the relative path.
1927 * The return value will be a pointer to the original path contents,
1928 * and will be either the original string (if 'path' was relative) or
1929 * a portion of the string (if path was absolute and begins with the
1933 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1936 const char *db_path, *relative;
1937 unsigned int db_path_len;
1939 db_path = notmuch_database_get_path (notmuch);
1940 db_path_len = strlen (db_path);
1944 if (*relative == '/') {
1945 while (*relative == '/' && *(relative+1) == '/')
1948 if (strncmp (relative, db_path, db_path_len) == 0)
1950 relative += db_path_len;
1951 while (*relative == '/')
1960 notmuch_database_get_directory (notmuch_database_t *notmuch,
1962 notmuch_directory_t **directory)
1964 notmuch_status_t status;
1966 if (directory == NULL)
1967 return NOTMUCH_STATUS_NULL_POINTER;
1971 *directory = _notmuch_directory_create (notmuch, path,
1972 NOTMUCH_FIND_LOOKUP, &status);
1973 } catch (const Xapian::Error &error) {
1974 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1975 error.get_msg().c_str());
1976 notmuch->exception_reported = TRUE;
1977 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1982 /* Allocate a document ID that satisfies the following criteria:
1984 * 1. The ID does not exist for any document in the Xapian database
1986 * 2. The ID was not previously returned from this function
1988 * 3. The ID is the smallest integer satisfying (1) and (2)
1990 * This function will trigger an internal error if these constraints
1991 * cannot all be satisfied, (that is, the pool of available document
1992 * IDs has been exhausted).
1995 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1997 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1999 notmuch->last_doc_id++;
2001 if (notmuch->last_doc_id == 0)
2002 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
2004 return notmuch->last_doc_id;
2008 _notmuch_database_generate_thread_id (notmuch_database_t *notmuch)
2010 /* 16 bytes (+ terminator) for hexadecimal representation of
2011 * a 64-bit integer. */
2012 static char thread_id[17];
2013 Xapian::WritableDatabase *db;
2015 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2017 notmuch->last_thread_id++;
2019 sprintf (thread_id, "%016" PRIx64, notmuch->last_thread_id);
2021 db->set_metadata ("last_thread_id", thread_id);
2027 _get_metadata_thread_id_key (void *ctx, const char *message_id)
2029 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
2030 message_id = _notmuch_message_id_compressed (ctx, message_id);
2032 return talloc_asprintf (ctx, NOTMUCH_METADATA_THREAD_ID_PREFIX "%s",
2036 static notmuch_status_t
2037 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
2039 const char *message_id,
2040 const char **thread_id_ret);
2042 /* Find the thread ID to which the message with 'message_id' belongs.
2044 * Note: 'thread_id_ret' must not be NULL!
2045 * On success '*thread_id_ret' is set to a newly talloced string belonging to
2048 * Note: If there is no message in the database with the given
2049 * 'message_id' then a new thread_id will be allocated for this
2050 * message ID and stored in the database metadata so that the
2051 * thread ID can be looked up if the message is added to the database
2054 static notmuch_status_t
2055 _resolve_message_id_to_thread_id (notmuch_database_t *notmuch,
2057 const char *message_id,
2058 const char **thread_id_ret)
2060 notmuch_private_status_t status;
2061 notmuch_message_t *message;
2063 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS))
2064 return _resolve_message_id_to_thread_id_old (notmuch, ctx, message_id,
2067 /* Look for this message (regular or ghost) */
2068 message = _notmuch_message_create_for_message_id (
2069 notmuch, message_id, &status);
2070 if (status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
2071 /* Message exists */
2072 *thread_id_ret = talloc_steal (
2073 ctx, notmuch_message_get_thread_id (message));
2074 } else if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
2075 /* Message did not exist. Give it a fresh thread ID and
2076 * populate this message as a ghost message. */
2077 *thread_id_ret = talloc_strdup (
2078 ctx, _notmuch_database_generate_thread_id (notmuch));
2079 if (! *thread_id_ret) {
2080 status = NOTMUCH_PRIVATE_STATUS_OUT_OF_MEMORY;
2082 status = _notmuch_message_initialize_ghost (message, *thread_id_ret);
2084 /* Commit the new ghost message */
2085 _notmuch_message_sync (message);
2088 /* Create failed. Fall through. */
2091 notmuch_message_destroy (message);
2093 return COERCE_STATUS (status, "Error creating ghost message");
2096 /* Pre-ghost messages _resolve_message_id_to_thread_id */
2097 static notmuch_status_t
2098 _resolve_message_id_to_thread_id_old (notmuch_database_t *notmuch,
2100 const char *message_id,
2101 const char **thread_id_ret)
2103 notmuch_status_t status;
2104 notmuch_message_t *message;
2105 string thread_id_string;
2107 Xapian::WritableDatabase *db;
2109 status = notmuch_database_find_message (notmuch, message_id, &message);
2115 *thread_id_ret = talloc_steal (ctx,
2116 notmuch_message_get_thread_id (message));
2118 notmuch_message_destroy (message);
2120 return NOTMUCH_STATUS_SUCCESS;
2123 /* Message has not been seen yet.
2125 * We may have seen a reference to it already, in which case, we
2126 * can return the thread ID stored in the metadata. Otherwise, we
2127 * generate a new thread ID and store it there.
2129 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2130 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2131 thread_id_string = notmuch->xapian_db->get_metadata (metadata_key);
2133 if (thread_id_string.empty()) {
2134 *thread_id_ret = talloc_strdup (ctx,
2135 _notmuch_database_generate_thread_id (notmuch));
2136 db->set_metadata (metadata_key, *thread_id_ret);
2138 *thread_id_ret = talloc_strdup (ctx, thread_id_string.c_str());
2141 talloc_free (metadata_key);
2143 return NOTMUCH_STATUS_SUCCESS;
2146 static notmuch_status_t
2147 _merge_threads (notmuch_database_t *notmuch,
2148 const char *winner_thread_id,
2149 const char *loser_thread_id)
2151 Xapian::PostingIterator loser, loser_end;
2152 notmuch_message_t *message = NULL;
2153 notmuch_private_status_t private_status;
2154 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2156 find_doc_ids (notmuch, "thread", loser_thread_id, &loser, &loser_end);
2158 for ( ; loser != loser_end; loser++) {
2159 message = _notmuch_message_create (notmuch, notmuch,
2160 *loser, &private_status);
2161 if (message == NULL) {
2162 ret = COERCE_STATUS (private_status,
2163 "Cannot find document for doc_id from query");
2167 _notmuch_message_remove_term (message, "thread", loser_thread_id);
2168 _notmuch_message_add_term (message, "thread", winner_thread_id);
2169 _notmuch_message_sync (message);
2171 notmuch_message_destroy (message);
2177 notmuch_message_destroy (message);
2183 _my_talloc_free_for_g_hash (void *ptr)
2188 static notmuch_status_t
2189 _notmuch_database_link_message_to_parents (notmuch_database_t *notmuch,
2190 notmuch_message_t *message,
2191 notmuch_message_file_t *message_file,
2192 const char **thread_id)
2194 GHashTable *parents = NULL;
2195 const char *refs, *in_reply_to, *in_reply_to_message_id;
2196 const char *last_ref_message_id, *this_message_id;
2197 GList *l, *keys = NULL;
2198 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2200 parents = g_hash_table_new_full (g_str_hash, g_str_equal,
2201 _my_talloc_free_for_g_hash, NULL);
2202 this_message_id = notmuch_message_get_message_id (message);
2204 refs = _notmuch_message_file_get_header (message_file, "references");
2205 last_ref_message_id = parse_references (message,
2209 in_reply_to = _notmuch_message_file_get_header (message_file, "in-reply-to");
2210 in_reply_to_message_id = parse_references (message,
2212 parents, in_reply_to);
2214 /* For the parent of this message, use the last message ID of the
2215 * References header, if available. If not, fall back to the
2216 * first message ID in the In-Reply-To header. */
2217 if (last_ref_message_id) {
2218 _notmuch_message_add_term (message, "replyto",
2219 last_ref_message_id);
2220 } else if (in_reply_to_message_id) {
2221 _notmuch_message_add_term (message, "replyto",
2222 in_reply_to_message_id);
2225 keys = g_hash_table_get_keys (parents);
2226 for (l = keys; l; l = l->next) {
2227 char *parent_message_id;
2228 const char *parent_thread_id = NULL;
2230 parent_message_id = (char *) l->data;
2232 _notmuch_message_add_term (message, "reference",
2235 ret = _resolve_message_id_to_thread_id (notmuch,
2242 if (*thread_id == NULL) {
2243 *thread_id = talloc_strdup (message, parent_thread_id);
2244 _notmuch_message_add_term (message, "thread", *thread_id);
2245 } else if (strcmp (*thread_id, parent_thread_id)) {
2246 ret = _merge_threads (notmuch, *thread_id, parent_thread_id);
2256 g_hash_table_unref (parents);
2261 static notmuch_status_t
2262 _notmuch_database_link_message_to_children (notmuch_database_t *notmuch,
2263 notmuch_message_t *message,
2264 const char **thread_id)
2266 const char *message_id = notmuch_message_get_message_id (message);
2267 Xapian::PostingIterator child, children_end;
2268 notmuch_message_t *child_message = NULL;
2269 const char *child_thread_id;
2270 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
2271 notmuch_private_status_t private_status;
2273 find_doc_ids (notmuch, "reference", message_id, &child, &children_end);
2275 for ( ; child != children_end; child++) {
2277 child_message = _notmuch_message_create (message, notmuch,
2278 *child, &private_status);
2279 if (child_message == NULL) {
2280 ret = COERCE_STATUS (private_status,
2281 "Cannot find document for doc_id from query");
2285 child_thread_id = notmuch_message_get_thread_id (child_message);
2286 if (*thread_id == NULL) {
2287 *thread_id = talloc_strdup (message, child_thread_id);
2288 _notmuch_message_add_term (message, "thread", *thread_id);
2289 } else if (strcmp (*thread_id, child_thread_id)) {
2290 _notmuch_message_remove_term (child_message, "reference",
2292 _notmuch_message_sync (child_message);
2293 ret = _merge_threads (notmuch, *thread_id, child_thread_id);
2298 notmuch_message_destroy (child_message);
2299 child_message = NULL;
2304 notmuch_message_destroy (child_message);
2309 /* Fetch and clear the stored thread_id for message, or NULL if none. */
2311 _consume_metadata_thread_id (void *ctx, notmuch_database_t *notmuch,
2312 notmuch_message_t *message)
2314 const char *message_id;
2318 message_id = notmuch_message_get_message_id (message);
2319 metadata_key = _get_metadata_thread_id_key (ctx, message_id);
2321 /* Check if we have already seen related messages to this one.
2322 * If we have then use the thread_id that we stored at that time.
2324 stored_id = notmuch->xapian_db->get_metadata (metadata_key);
2325 if (stored_id.empty ()) {
2328 Xapian::WritableDatabase *db;
2330 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
2332 /* Clear the metadata for this message ID. We don't need it
2334 db->set_metadata (metadata_key, "");
2336 return talloc_strdup (ctx, stored_id.c_str ());
2340 /* Given a blank or ghost 'message' and its corresponding
2341 * 'message_file' link it to existing threads in the database.
2343 * First, if is_ghost, this retrieves the thread ID already stored in
2344 * the message (which will be the case if a message was previously
2345 * added that referenced this one). If the message is blank
2346 * (!is_ghost), it doesn't have a thread ID yet (we'll generate one
2347 * later in this function). If the database does not support ghost
2348 * messages, this checks for a thread ID stored in database metadata
2349 * for this message ID.
2351 * Second, we look at 'message_file' and its link-relevant headers
2352 * (References and In-Reply-To) for message IDs.
2354 * Finally, we look in the database for existing message that
2355 * reference 'message'.
2357 * In all cases, we assign to the current message the first thread ID
2358 * found. We will also merge any existing, distinct threads where this
2359 * message belongs to both, (which is not uncommon when messages are
2360 * processed out of order).
2362 * Finally, if no thread ID has been found through referenced messages, we
2363 * call _notmuch_message_generate_thread_id to generate a new thread
2364 * ID. This should only happen for new, top-level messages, (no
2365 * References or In-Reply-To header in this message, and no previously
2366 * added message refers to this message).
2368 static notmuch_status_t
2369 _notmuch_database_link_message (notmuch_database_t *notmuch,
2370 notmuch_message_t *message,
2371 notmuch_message_file_t *message_file,
2372 notmuch_bool_t is_ghost)
2374 void *local = talloc_new (NULL);
2375 notmuch_status_t status;
2376 const char *thread_id = NULL;
2378 /* Check if the message already had a thread ID */
2379 if (notmuch->features & NOTMUCH_FEATURE_GHOSTS) {
2381 thread_id = notmuch_message_get_thread_id (message);
2383 thread_id = _consume_metadata_thread_id (local, notmuch, message);
2385 _notmuch_message_add_term (message, "thread", thread_id);
2388 status = _notmuch_database_link_message_to_parents (notmuch, message,
2394 if (! (notmuch->features & NOTMUCH_FEATURE_GHOSTS)) {
2395 /* In general, it shouldn't be necessary to link children,
2396 * since the earlier indexing of those children will have
2397 * stored a thread ID for the missing parent. However, prior
2398 * to ghost messages, these stored thread IDs were NOT
2399 * rewritten during thread merging (and there was no
2400 * performant way to do so), so if indexed children were
2401 * pulled into a different thread ID by a merge, it was
2402 * necessary to pull them *back* into the stored thread ID of
2403 * the parent. With ghost messages, we just rewrite the
2404 * stored thread IDs during merging, so this workaround isn't
2406 status = _notmuch_database_link_message_to_children (notmuch, message,
2412 /* If not part of any existing thread, generate a new thread ID. */
2413 if (thread_id == NULL) {
2414 thread_id = _notmuch_database_generate_thread_id (notmuch);
2416 _notmuch_message_add_term (message, "thread", thread_id);
2420 talloc_free (local);
2426 notmuch_database_add_message (notmuch_database_t *notmuch,
2427 const char *filename,
2428 notmuch_message_t **message_ret)
2430 notmuch_message_file_t *message_file;
2431 notmuch_message_t *message = NULL;
2432 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS, ret2;
2433 notmuch_private_status_t private_status;
2434 notmuch_bool_t is_ghost = false;
2436 const char *date, *header;
2437 const char *from, *to, *subject;
2438 char *message_id = NULL;
2441 *message_ret = NULL;
2443 ret = _notmuch_database_ensure_writable (notmuch);
2447 message_file = _notmuch_message_file_open (notmuch, filename);
2448 if (message_file == NULL)
2449 return NOTMUCH_STATUS_FILE_ERROR;
2451 /* Adding a message may change many documents. Do this all
2453 ret = notmuch_database_begin_atomic (notmuch);
2457 /* Parse message up front to get better error status. */
2458 ret = _notmuch_message_file_parse (message_file);
2463 /* Before we do any real work, (especially before doing a
2464 * potential SHA-1 computation on the entire file's contents),
2465 * let's make sure that what we're looking at looks like an
2466 * actual email message.
2468 from = _notmuch_message_file_get_header (message_file, "from");
2469 subject = _notmuch_message_file_get_header (message_file, "subject");
2470 to = _notmuch_message_file_get_header (message_file, "to");
2472 if ((from == NULL || *from == '\0') &&
2473 (subject == NULL || *subject == '\0') &&
2474 (to == NULL || *to == '\0'))
2476 ret = NOTMUCH_STATUS_FILE_NOT_EMAIL;
2480 /* Now that we're sure it's mail, the first order of business
2481 * is to find a message ID (or else create one ourselves). */
2483 header = _notmuch_message_file_get_header (message_file, "message-id");
2484 if (header && *header != '\0') {
2485 message_id = _parse_message_id (message_file, header, NULL);
2487 /* So the header value isn't RFC-compliant, but it's
2488 * better than no message-id at all. */
2489 if (message_id == NULL)
2490 message_id = talloc_strdup (message_file, header);
2493 if (message_id == NULL ) {
2494 /* No message-id at all, let's generate one by taking a
2495 * hash over the file's contents. */
2496 char *sha1 = _notmuch_sha1_of_file (filename);
2498 /* If that failed too, something is really wrong. Give up. */
2500 ret = NOTMUCH_STATUS_FILE_ERROR;
2504 message_id = talloc_asprintf (message_file,
2505 "notmuch-sha1-%s", sha1);
2509 /* Now that we have a message ID, we get a message object,
2510 * (which may or may not reference an existing document in the
2513 message = _notmuch_message_create_for_message_id (notmuch,
2517 talloc_free (message_id);
2519 if (message == NULL) {
2520 ret = COERCE_STATUS (private_status,
2521 "Unexpected status value from _notmuch_message_create_for_message_id");
2525 _notmuch_message_add_filename (message, filename);
2527 /* Is this a newly created message object or a ghost
2528 * message? We have to be slightly careful: if this is a
2529 * blank message, it's not safe to call
2530 * notmuch_message_get_flag yet. */
2531 if (private_status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND ||
2532 (is_ghost = notmuch_message_get_flag (
2533 message, NOTMUCH_MESSAGE_FLAG_GHOST))) {
2534 _notmuch_message_add_term (message, "type", "mail");
2536 /* Convert ghost message to a regular message */
2537 _notmuch_message_remove_term (message, "type", "ghost");
2539 ret = _notmuch_database_link_message (notmuch, message,
2540 message_file, is_ghost);
2544 date = _notmuch_message_file_get_header (message_file, "date");
2545 _notmuch_message_set_header_values (message, date, from, subject);
2547 ret = _notmuch_message_index_file (message, message_file);
2551 ret = NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID;
2554 _notmuch_message_sync (message);
2555 } catch (const Xapian::Error &error) {
2556 _notmuch_database_log (notmuch, "A Xapian exception occurred adding message: %s.\n",
2557 error.get_msg().c_str());
2558 notmuch->exception_reported = TRUE;
2559 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2565 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2566 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) && message_ret)
2567 *message_ret = message;
2569 notmuch_message_destroy (message);
2573 _notmuch_message_file_close (message_file);
2575 ret2 = notmuch_database_end_atomic (notmuch);
2576 if ((ret == NOTMUCH_STATUS_SUCCESS ||
2577 ret == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID) &&
2578 ret2 != NOTMUCH_STATUS_SUCCESS)
2585 notmuch_database_remove_message (notmuch_database_t *notmuch,
2586 const char *filename)
2588 notmuch_status_t status;
2589 notmuch_message_t *message;
2591 status = notmuch_database_find_message_by_filename (notmuch, filename,
2594 if (status == NOTMUCH_STATUS_SUCCESS && message) {
2595 status = _notmuch_message_remove_filename (message, filename);
2596 if (status == NOTMUCH_STATUS_SUCCESS)
2597 _notmuch_message_delete (message);
2598 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2599 _notmuch_message_sync (message);
2601 notmuch_message_destroy (message);
2608 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2609 const char *filename,
2610 notmuch_message_t **message_ret)
2613 const char *prefix = _find_prefix ("file-direntry");
2614 char *direntry, *term;
2615 Xapian::PostingIterator i, end;
2616 notmuch_status_t status;
2618 if (message_ret == NULL)
2619 return NOTMUCH_STATUS_NULL_POINTER;
2621 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2622 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2624 /* return NULL on any failure */
2625 *message_ret = NULL;
2627 local = talloc_new (notmuch);
2630 status = _notmuch_database_filename_to_direntry (
2631 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2632 if (status || !direntry)
2635 term = talloc_asprintf (local, "%s%s", prefix, direntry);
2637 find_doc_ids_for_term (notmuch, term, &i, &end);
2640 notmuch_private_status_t private_status;
2642 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2644 if (*message_ret == NULL)
2645 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2647 } catch (const Xapian::Error &error) {
2648 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2649 error.get_msg().c_str());
2650 notmuch->exception_reported = TRUE;
2651 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2655 talloc_free (local);
2657 if (status && *message_ret) {
2658 notmuch_message_destroy (*message_ret);
2659 *message_ret = NULL;
2664 notmuch_string_list_t *
2665 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2666 Xapian::TermIterator &end,
2669 int prefix_len = strlen (prefix);
2670 notmuch_string_list_t *list;
2672 list = _notmuch_string_list_create (ctx);
2673 if (unlikely (list == NULL))
2676 for (i.skip_to (prefix); i != end; i++) {
2677 /* Terminate loop at first term without desired prefix. */
2678 if (strncmp ((*i).c_str (), prefix, prefix_len))
2681 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2688 notmuch_database_get_all_tags (notmuch_database_t *db)
2690 Xapian::TermIterator i, end;
2691 notmuch_string_list_t *tags;
2694 i = db->xapian_db->allterms_begin();
2695 end = db->xapian_db->allterms_end();
2696 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2697 _find_prefix ("tag"));
2698 _notmuch_string_list_sort (tags);
2699 return _notmuch_tags_create (db, tags);
2700 } catch (const Xapian::Error &error) {
2701 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2702 error.get_msg().c_str());
2703 db->exception_reported = TRUE;
2709 notmuch_database_status_string (const notmuch_database_t *notmuch)
2711 return notmuch->status_string;