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 "thread-fp.h"
25 #include "regexp-fields.h"
26 #include "string-util.h"
35 #include <glib.h> /* g_free, GPtrArray, GHashTable */
36 #include <glib-object.h> /* g_type_init */
38 #include <gmime/gmime.h> /* g_mime_init */
42 #define ARRAY_SIZE(arr) (sizeof (arr) / sizeof (arr[0]))
47 notmuch_field_flag_t flags;
50 #define NOTMUCH_DATABASE_VERSION 3
52 #define STRINGIFY(s) _SUB_STRINGIFY(s)
53 #define _SUB_STRINGIFY(s) #s
55 #if HAVE_XAPIAN_DB_RETRY_LOCK
56 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
58 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
61 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
63 * We currently have three different types of documents (mail, ghost,
64 * and directory) and also some metadata.
66 * There are two kinds of prefixes used in notmuch. There are the
67 * human friendly 'prefix names' like "thread:", which are also used
68 * in the query parser, and the actual prefix terms in the database
69 * (e.g. "G"). The correspondence is maintained in the file scope data
70 * structure 'prefix_table'.
74 * A mail document is associated with a particular email message. It
75 * is stored in one or more files on disk and is uniquely identified
76 * by its "id" field (which is generally the message ID). It is
77 * indexed with the following prefixed terms which the database uses
78 * to construct threads, etc.:
80 * Single terms of given prefix:
84 * id: Unique ID of mail. This is from the Message-ID header
85 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
86 * If it's present and too long, then we use
87 * "notmuch-sha1-<sha1_sum_of_message_id>".
88 * If this header is not present, we use
89 * "notmuch-sha1-<sha1_sum_of_entire_file>".
91 * thread: The ID of the thread to which the mail belongs
93 * replyto: The ID from the In-Reply-To header of the mail (if any).
95 * Multiple terms of given prefix:
97 * reference: All message IDs from In-Reply-To and References
98 * headers in the message.
100 * tag: Any tags associated with this message by the user.
102 * file-direntry: A colon-separated pair of values
103 * (INTEGER:STRING), where INTEGER is the
104 * document ID of a directory document, and
105 * STRING is the name of a file within that
106 * directory for this mail message.
108 * property: Has a property with key=value
109 * FIXME: if no = is present, should match on any value
111 * A mail document also has four values:
113 * TIMESTAMP: The time_t value corresponding to the message's
116 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
118 * FROM: The value of the "From" header
120 * SUBJECT: The value of the "Subject" header
122 * LAST_MOD: The revision number as of the last tag or
125 * The prefixed terms described above are also searchable without an
126 * explicit field name, but as of notmuch 0.29 this is due to
127 * query-parser setup, not extra terms in the database. In addition,
128 * terms from the content of the message are added without a prefix
129 * for use by the user in searching. Note that the prefix name "body"
130 * is used to refer to the empty prefix string in the database.
132 * The path of the containing folder is added with the "folder" prefix
133 * (see _notmuch_message_add_folder_terms). Sub-paths of the the path
134 * of the mail message are added with the "path" prefix.
136 * The data portion of a mail document is empty.
138 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
139 * -----------------------------------------------
140 * A ghost mail document is like a mail document, but where we don't
141 * have the message content. These are used to track thread reference
142 * information for messages we haven't received.
144 * A ghost mail document has type: ghost; id and thread fields that
145 * are identical to the mail document fields; and a MESSAGE_ID value.
149 * A directory document is used by a client of the notmuch library to
150 * maintain data necessary to allow for efficient polling of mail
153 * All directory documents contain one term:
155 * directory: The directory path (relative to the database path)
156 * Or the SHA1 sum of the directory path (if the
157 * path itself is too long to fit in a Xapian
160 * And all directory documents for directories other than top-level
161 * directories also contain the following term:
163 * directory-direntry: A colon-separated pair of values
164 * (INTEGER:STRING), where INTEGER is the
165 * document ID of the parent directory
166 * document, and STRING is the name of this
167 * directory within that parent.
169 * All directory documents have a single value:
171 * TIMESTAMP: The mtime of the directory (at last scan)
173 * The data portion of a directory document contains the path of the
174 * directory (relative to the database path).
178 * Xapian allows us to store arbitrary name-value pairs as
179 * "metadata". We currently use the following metadata names with the
182 * version The database schema version, (which is distinct
183 * from both the notmuch package version (see
184 * notmuch --version) and the libnotmuch library
185 * version. The version is stored as an base-10
186 * ASCII integer. The initial database version
187 * was 1, (though a schema existed before that
188 * were no "version" database value existed at
189 * all). Successive versions are allocated as
190 * changes are made to the database (such as by
191 * indexing new fields).
193 * features The set of features supported by this
194 * database. This consists of a set of
195 * '\n'-separated lines, where each is a feature
196 * name, a '\t', and compatibility flags. If the
197 * compatibility flags contain 'w', then the
198 * opener must support this feature to safely
199 * write this database. If the compatibility
200 * flags contain 'r', then the opener must
201 * support this feature to read this database.
202 * Introduced in database version 3.
204 * last_thread_id The last thread ID generated. This is stored
205 * as a 16-byte hexadecimal ASCII representation
206 * of a 64-bit unsigned integer. The first ID
207 * generated is 1 and the value will be
208 * incremented for each thread ID.
210 * C* metadata keys starting with C indicate
211 * configuration data. It can be managed with the
212 * n_database_*config* API. There is a convention
213 * of hierarchical keys separated by '.' (e.g.
214 * query.notmuch stores the value for the named
215 * query 'notmuch'), but it is not enforced by the
221 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
222 * Instead, the database has the following additional database
225 * thread_id_* A pre-allocated thread ID for a particular
226 * message. This is actually an arbitrarily large
227 * family of metadata name. Any particular name is
228 * formed by concatenating "thread_id_" with a message
229 * ID (or the SHA1 sum of a message ID if it is very
230 * long---see description of 'id' in the mail
231 * document). The value stored is a thread ID.
233 * These thread ID metadata values are stored
234 * whenever a message references a parent message
235 * that does not yet exist in the database. A
236 * thread ID will be allocated and stored, and if
237 * the message is later added, the stored thread
238 * ID will be used (and the metadata value will
241 * Even before a message is added, it's
242 * pre-allocated thread ID is useful so that all
243 * descendant messages that reference this common
244 * parent can be recognized as belonging to the
248 /* With these prefix values we follow the conventions published here:
250 * https://xapian.org/docs/omega/termprefixes.html
252 * as much as makes sense. Note that I took some liberty in matching
253 * the reserved prefix values to notmuch concepts, (for example, 'G'
254 * is documented as "newsGroup (or similar entity - e.g. a web forum
255 * name)", for which I think the thread is the closest analogue in
256 * notmuch. This in spite of the fact that we will eventually be
257 * storing mailing-list messages where 'G' for "mailing list name"
258 * might be even a closer analogue. I'm treating the single-character
259 * prefixes preferentially for core notmuch concepts (which will be
260 * nearly universal to all mail messages).
264 prefix_t prefix_table[] = {
265 /* name term prefix flags */
266 { "type", "T", NOTMUCH_FIELD_NO_FLAGS },
267 { "reference", "XREFERENCE", NOTMUCH_FIELD_NO_FLAGS },
268 { "replyto", "XREPLYTO", NOTMUCH_FIELD_NO_FLAGS },
269 { "directory", "XDIRECTORY", NOTMUCH_FIELD_NO_FLAGS },
270 { "file-direntry", "XFDIRENTRY", NOTMUCH_FIELD_NO_FLAGS },
271 { "directory-direntry", "XDDIRENTRY", NOTMUCH_FIELD_NO_FLAGS },
272 { "body", "", NOTMUCH_FIELD_EXTERNAL |
273 NOTMUCH_FIELD_PROBABILISTIC},
274 { "thread", "G", NOTMUCH_FIELD_EXTERNAL |
275 NOTMUCH_FIELD_PROCESSOR },
276 { "tag", "K", NOTMUCH_FIELD_EXTERNAL |
277 NOTMUCH_FIELD_PROCESSOR },
278 { "is", "K", NOTMUCH_FIELD_EXTERNAL |
279 NOTMUCH_FIELD_PROCESSOR },
280 { "id", "Q", NOTMUCH_FIELD_EXTERNAL },
281 { "mid", "Q", NOTMUCH_FIELD_EXTERNAL |
282 NOTMUCH_FIELD_PROCESSOR },
283 { "path", "P", NOTMUCH_FIELD_EXTERNAL|
284 NOTMUCH_FIELD_PROCESSOR },
285 { "property", "XPROPERTY", NOTMUCH_FIELD_EXTERNAL },
287 * Unconditionally add ':' to reduce potential ambiguity with
288 * overlapping prefixes and/or terms that start with capital
289 * letters. See Xapian document termprefixes.html for related
292 { "folder", "XFOLDER:", NOTMUCH_FIELD_EXTERNAL |
293 NOTMUCH_FIELD_PROCESSOR },
294 #if HAVE_XAPIAN_FIELD_PROCESSOR
295 { "date", NULL, NOTMUCH_FIELD_EXTERNAL |
296 NOTMUCH_FIELD_PROCESSOR },
297 { "query", NULL, NOTMUCH_FIELD_EXTERNAL |
298 NOTMUCH_FIELD_PROCESSOR },
300 { "from", "XFROM", NOTMUCH_FIELD_EXTERNAL |
301 NOTMUCH_FIELD_PROBABILISTIC |
302 NOTMUCH_FIELD_PROCESSOR },
303 { "to", "XTO", NOTMUCH_FIELD_EXTERNAL |
304 NOTMUCH_FIELD_PROBABILISTIC },
305 { "attachment", "XATTACHMENT", NOTMUCH_FIELD_EXTERNAL |
306 NOTMUCH_FIELD_PROBABILISTIC },
307 { "mimetype", "XMIMETYPE", NOTMUCH_FIELD_EXTERNAL |
308 NOTMUCH_FIELD_PROBABILISTIC },
309 { "subject", "XSUBJECT", NOTMUCH_FIELD_EXTERNAL |
310 NOTMUCH_FIELD_PROBABILISTIC |
311 NOTMUCH_FIELD_PROCESSOR},
315 _setup_query_field_default (const prefix_t *prefix, notmuch_database_t *notmuch)
318 notmuch->query_parser->add_prefix ("",prefix->prefix);
319 if (prefix->flags & NOTMUCH_FIELD_PROBABILISTIC)
320 notmuch->query_parser->add_prefix (prefix->name, prefix->prefix);
322 notmuch->query_parser->add_boolean_prefix (prefix->name, prefix->prefix);
326 _user_prefix (void *ctx, const char* name)
328 return talloc_asprintf(ctx, "XU%s:", name);
331 static notmuch_status_t
332 _setup_user_query_fields (notmuch_database_t *notmuch)
334 notmuch_config_list_t *list;
335 notmuch_status_t status;
337 notmuch->user_prefix = _notmuch_string_map_create (notmuch);
338 if (notmuch->user_prefix == NULL)
339 return NOTMUCH_STATUS_OUT_OF_MEMORY;
341 notmuch->user_header = _notmuch_string_map_create (notmuch);
342 if (notmuch->user_header == NULL)
343 return NOTMUCH_STATUS_OUT_OF_MEMORY;
345 status = notmuch_database_get_config_list (notmuch, CONFIG_HEADER_PREFIX, &list);
349 for (; notmuch_config_list_valid (list); notmuch_config_list_move_to_next (list)) {
351 prefix_t query_field;
353 const char *key = notmuch_config_list_key (list)
354 + sizeof (CONFIG_HEADER_PREFIX) - 1;
356 _notmuch_string_map_append (notmuch->user_prefix,
358 _user_prefix (notmuch, key));
360 _notmuch_string_map_append (notmuch->user_header,
362 notmuch_config_list_value (list));
364 query_field.name = talloc_strdup (notmuch, key);
365 query_field.prefix = _user_prefix (notmuch, key);
366 query_field.flags = NOTMUCH_FIELD_PROBABILISTIC
367 | NOTMUCH_FIELD_EXTERNAL;
369 _setup_query_field_default (&query_field, notmuch);
372 notmuch_config_list_destroy (list);
374 return NOTMUCH_STATUS_SUCCESS;
377 #if HAVE_XAPIAN_FIELD_PROCESSOR
379 _setup_query_field (const prefix_t *prefix, notmuch_database_t *notmuch)
381 if (prefix->flags & NOTMUCH_FIELD_PROCESSOR) {
382 Xapian::FieldProcessor *fp;
384 if (STRNCMP_LITERAL (prefix->name, "date") == 0)
385 fp = (new DateFieldProcessor())->release ();
386 else if (STRNCMP_LITERAL(prefix->name, "query") == 0)
387 fp = (new QueryFieldProcessor (*notmuch->query_parser, notmuch))->release ();
388 else if (STRNCMP_LITERAL(prefix->name, "thread") == 0)
389 fp = (new ThreadFieldProcessor (*notmuch->query_parser, notmuch))->release ();
391 fp = (new RegexpFieldProcessor (prefix->name, prefix->flags,
392 *notmuch->query_parser, notmuch))->release ();
394 /* we treat all field-processor fields as boolean in order to get the raw input */
396 notmuch->query_parser->add_prefix ("",prefix->prefix);
397 notmuch->query_parser->add_boolean_prefix (prefix->name, fp);
399 _setup_query_field_default (prefix, notmuch);
404 _setup_query_field (const prefix_t *prefix, notmuch_database_t *notmuch)
406 _setup_query_field_default (prefix, notmuch);
411 _find_prefix (const char *name)
415 for (i = 0; i < ARRAY_SIZE (prefix_table); i++) {
416 if (strcmp (name, prefix_table[i].name) == 0)
417 return prefix_table[i].prefix;
420 INTERNAL_ERROR ("No prefix exists for '%s'\n", name);
425 static const struct {
426 /* NOTMUCH_FEATURE_* value. */
427 _notmuch_features value;
428 /* Feature name as it appears in the database. This name should
429 * be appropriate for displaying to the user if an older version
430 * of notmuch doesn't support this feature. */
432 /* Compatibility flags when this feature is declared. */
434 } feature_names[] = {
435 { NOTMUCH_FEATURE_FILE_TERMS,
436 "multiple paths per message", "rw" },
437 { NOTMUCH_FEATURE_DIRECTORY_DOCS,
438 "relative directory paths", "rw" },
439 /* Header values are not required for reading a database because a
440 * reader can just refer to the message file. */
441 { NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES,
442 "from/subject/message-ID in database", "w" },
443 { NOTMUCH_FEATURE_BOOL_FOLDER,
444 "exact folder:/path: search", "rw" },
445 { NOTMUCH_FEATURE_GHOSTS,
446 "mail documents for missing messages", "w"},
447 /* Knowledge of the index mime-types are not required for reading
448 * a database because a reader will just be unable to query
450 { NOTMUCH_FEATURE_INDEXED_MIMETYPES,
451 "indexed MIME types", "w"},
452 { NOTMUCH_FEATURE_LAST_MOD,
453 "modification tracking", "w"},
454 /* Existing databases will work fine for all queries not involving
456 { NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY,
457 "index body and headers separately", "w"},
461 notmuch_status_to_string (notmuch_status_t status)
464 case NOTMUCH_STATUS_SUCCESS:
465 return "No error occurred";
466 case NOTMUCH_STATUS_OUT_OF_MEMORY:
467 return "Out of memory";
468 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
469 return "Attempt to write to a read-only database";
470 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
471 return "A Xapian exception occurred";
472 case NOTMUCH_STATUS_FILE_ERROR:
473 return "Something went wrong trying to read or write a file";
474 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
475 return "File is not an email";
476 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
477 return "Message ID is identical to a message in database";
478 case NOTMUCH_STATUS_NULL_POINTER:
479 return "Erroneous NULL pointer";
480 case NOTMUCH_STATUS_TAG_TOO_LONG:
481 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
482 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
483 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
484 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
485 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
486 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
487 return "Unsupported operation";
488 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
489 return "Operation requires a database upgrade";
490 case NOTMUCH_STATUS_PATH_ERROR:
491 return "Path supplied is illegal for this function";
492 case NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL:
493 return "Crypto protocol missing, malformed, or unintelligible";
494 case NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION:
495 return "Crypto engine initialization failure";
496 case NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL:
497 return "Unknown crypto protocol";
499 case NOTMUCH_STATUS_LAST_STATUS:
500 return "Unknown error status value";
505 _notmuch_database_log (notmuch_database_t *notmuch,
511 va_start (va_args, format);
513 if (notmuch->status_string)
514 talloc_free (notmuch->status_string);
516 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
521 _notmuch_database_log_append (notmuch_database_t *notmuch,
527 va_start (va_args, format);
529 if (notmuch->status_string)
530 notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
532 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
538 find_doc_ids_for_term (notmuch_database_t *notmuch,
540 Xapian::PostingIterator *begin,
541 Xapian::PostingIterator *end)
543 *begin = notmuch->xapian_db->postlist_begin (term);
545 *end = notmuch->xapian_db->postlist_end (term);
549 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
550 const char *prefix_name,
552 Xapian::PostingIterator *begin,
553 Xapian::PostingIterator *end)
557 term = talloc_asprintf (notmuch, "%s%s",
558 _find_prefix (prefix_name), value);
560 find_doc_ids_for_term (notmuch, term, begin, end);
565 notmuch_private_status_t
566 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
567 const char *prefix_name,
569 unsigned int *doc_id)
571 Xapian::PostingIterator i, end;
573 _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
577 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
582 #if DEBUG_DATABASE_SANITY
586 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
590 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
593 static Xapian::Document
594 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
596 return notmuch->xapian_db->get_document (doc_id);
599 /* Generate a compressed version of 'message_id' of the form:
601 * notmuch-sha1-<sha1_sum_of_message_id>
604 _notmuch_message_id_compressed (void *ctx, const char *message_id)
606 char *sha1, *compressed;
608 sha1 = _notmuch_sha1_of_string (message_id);
610 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
617 notmuch_database_find_message (notmuch_database_t *notmuch,
618 const char *message_id,
619 notmuch_message_t **message_ret)
621 notmuch_private_status_t status;
624 if (message_ret == NULL)
625 return NOTMUCH_STATUS_NULL_POINTER;
627 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
628 message_id = _notmuch_message_id_compressed (notmuch, message_id);
631 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
632 message_id, &doc_id);
634 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
637 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
639 if (*message_ret == NULL)
640 return NOTMUCH_STATUS_OUT_OF_MEMORY;
643 return NOTMUCH_STATUS_SUCCESS;
644 } catch (const Xapian::Error &error) {
645 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
646 error.get_msg().c_str());
647 notmuch->exception_reported = true;
649 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
654 notmuch_database_create (const char *path, notmuch_database_t **database)
656 char *status_string = NULL;
657 notmuch_status_t status;
659 status = notmuch_database_create_verbose (path, database,
663 fputs (status_string, stderr);
664 free (status_string);
671 notmuch_database_create_verbose (const char *path,
672 notmuch_database_t **database,
673 char **status_string)
675 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
676 notmuch_database_t *notmuch = NULL;
677 char *notmuch_path = NULL;
678 char *message = NULL;
683 message = strdup ("Error: Cannot create a database for a NULL path.\n");
684 status = NOTMUCH_STATUS_NULL_POINTER;
688 if (path[0] != '/') {
689 message = strdup ("Error: Database path must be absolute.\n");
690 status = NOTMUCH_STATUS_PATH_ERROR;
694 err = stat (path, &st);
696 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
697 path, strerror (errno)));
698 status = NOTMUCH_STATUS_FILE_ERROR;
702 if (! S_ISDIR (st.st_mode)) {
703 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
704 "Not a directory.\n",
706 status = NOTMUCH_STATUS_FILE_ERROR;
710 notmuch_path = talloc_asprintf (NULL, "%s/%s", path, ".notmuch");
712 err = mkdir (notmuch_path, 0755);
715 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
716 notmuch_path, strerror (errno)));
717 status = NOTMUCH_STATUS_FILE_ERROR;
721 status = notmuch_database_open_verbose (path,
722 NOTMUCH_DATABASE_MODE_READ_WRITE,
727 /* Upgrade doesn't add these feature to existing databases, but
728 * new databases have them. */
729 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
730 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
731 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
733 status = notmuch_database_upgrade (notmuch, NULL, NULL);
735 notmuch_database_close(notmuch);
741 talloc_free (notmuch_path);
745 *status_string = message;
752 talloc_free (notmuch);
757 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
759 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
760 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
761 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
764 return NOTMUCH_STATUS_SUCCESS;
767 /* Allocate a revision number for the next change. */
769 _notmuch_database_new_revision (notmuch_database_t *notmuch)
771 unsigned long new_revision = notmuch->revision + 1;
773 /* If we're in an atomic section, hold off on updating the
774 * committed revision number until we commit the atomic section.
776 if (notmuch->atomic_nesting)
777 notmuch->atomic_dirty = true;
779 notmuch->revision = new_revision;
784 /* Parse a database features string from the given database version.
785 * Returns the feature bit set.
787 * For version < 3, this ignores the features string and returns a
788 * hard-coded set of features.
790 * If there are unrecognized features that are required to open the
791 * database in mode (which should be 'r' or 'w'), return a
792 * comma-separated list of unrecognized but required features in
793 * *incompat_out suitable for presenting to the user. *incompat_out
794 * will be allocated from ctx.
796 static _notmuch_features
797 _parse_features (const void *ctx, const char *features, unsigned int version,
798 char mode, char **incompat_out)
800 _notmuch_features res = static_cast<_notmuch_features>(0);
801 unsigned int namelen, i;
805 /* Prior to database version 3, features were implied by the
808 return NOTMUCH_FEATURES_V0;
809 else if (version == 1)
810 return NOTMUCH_FEATURES_V1;
811 else if (version == 2)
812 return NOTMUCH_FEATURES_V2;
814 /* Parse the features string */
815 while ((features = strtok_len_c (features + llen, "\n", &llen)) != NULL) {
816 flags = strchr (features, '\t');
817 if (! flags || flags > features + llen)
819 namelen = flags - features;
821 for (i = 0; i < ARRAY_SIZE (feature_names); ++i) {
822 if (strlen (feature_names[i].name) == namelen &&
823 strncmp (feature_names[i].name, features, namelen) == 0) {
824 res |= feature_names[i].value;
829 if (i == ARRAY_SIZE (feature_names) && incompat_out) {
830 /* Unrecognized feature */
831 const char *have = strchr (flags, mode);
832 if (have && have < features + llen) {
833 /* This feature is required to access this database in
834 * 'mode', but we don't understand it. */
836 *incompat_out = talloc_strdup (ctx, "");
837 *incompat_out = talloc_asprintf_append_buffer (
838 *incompat_out, "%s%.*s", **incompat_out ? ", " : "",
848 _print_features (const void *ctx, unsigned int features)
851 char *res = talloc_strdup (ctx, "");
853 for (i = 0; i < ARRAY_SIZE (feature_names); ++i)
854 if (features & feature_names[i].value)
855 res = talloc_asprintf_append_buffer (
856 res, "%s\t%s\n", feature_names[i].name, feature_names[i].flags);
862 notmuch_database_open (const char *path,
863 notmuch_database_mode_t mode,
864 notmuch_database_t **database)
866 char *status_string = NULL;
867 notmuch_status_t status;
869 status = notmuch_database_open_verbose (path, mode, database,
873 fputs (status_string, stderr);
874 free (status_string);
881 notmuch_database_open_verbose (const char *path,
882 notmuch_database_mode_t mode,
883 notmuch_database_t **database,
884 char **status_string)
886 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
887 void *local = talloc_new (NULL);
888 notmuch_database_t *notmuch = NULL;
889 char *notmuch_path, *xapian_path, *incompat_features;
890 char *message = NULL;
893 unsigned int i, version;
894 static int initialized = 0;
897 message = strdup ("Error: Cannot open a database for a NULL path.\n");
898 status = NOTMUCH_STATUS_NULL_POINTER;
902 if (path[0] != '/') {
903 message = strdup ("Error: Database path must be absolute.\n");
904 status = NOTMUCH_STATUS_PATH_ERROR;
908 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
909 message = strdup ("Out of memory\n");
910 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
914 err = stat (notmuch_path, &st);
916 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
917 notmuch_path, strerror (errno)));
918 status = NOTMUCH_STATUS_FILE_ERROR;
922 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
923 message = strdup ("Out of memory\n");
924 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
928 /* Initialize the GLib type system and threads */
929 #if !GLIB_CHECK_VERSION(2, 35, 1)
933 /* Initialize gmime */
939 notmuch = talloc_zero (NULL, notmuch_database_t);
940 notmuch->exception_reported = false;
941 notmuch->status_string = NULL;
942 notmuch->path = talloc_strdup (notmuch, path);
944 strip_trailing(notmuch->path, '/');
946 notmuch->mode = mode;
947 notmuch->atomic_nesting = 0;
950 string last_thread_id;
953 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
954 notmuch->xapian_db = new Xapian::WritableDatabase (xapian_path,
957 notmuch->xapian_db = new Xapian::Database (xapian_path);
960 /* Check version. As of database version 3, we represent
961 * changes in terms of features, so assume a version bump
962 * means a dramatically incompatible change. */
963 version = notmuch_database_get_version (notmuch);
964 if (version > NOTMUCH_DATABASE_VERSION) {
965 IGNORE_RESULT (asprintf (&message,
966 "Error: Notmuch database at %s\n"
967 " has a newer database format version (%u) than supported by this\n"
968 " version of notmuch (%u).\n",
969 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
970 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
971 notmuch_database_destroy (notmuch);
973 status = NOTMUCH_STATUS_FILE_ERROR;
977 /* Check features. */
978 incompat_features = NULL;
979 notmuch->features = _parse_features (
980 local, notmuch->xapian_db->get_metadata ("features").c_str (),
981 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
983 if (incompat_features) {
984 IGNORE_RESULT (asprintf (&message,
985 "Error: Notmuch database at %s\n"
986 " requires features (%s)\n"
987 " not supported by this version of notmuch.\n",
988 notmuch_path, incompat_features));
989 notmuch->mode = NOTMUCH_DATABASE_MODE_READ_ONLY;
990 notmuch_database_destroy (notmuch);
992 status = NOTMUCH_STATUS_FILE_ERROR;
996 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
997 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
998 if (last_thread_id.empty ()) {
999 notmuch->last_thread_id = 0;
1004 str = last_thread_id.c_str ();
1005 notmuch->last_thread_id = strtoull (str, &end, 16);
1007 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
1010 /* Get current highest revision number. */
1011 last_mod = notmuch->xapian_db->get_value_upper_bound (
1012 NOTMUCH_VALUE_LAST_MOD);
1013 if (last_mod.empty ())
1014 notmuch->revision = 0;
1016 notmuch->revision = Xapian::sortable_unserialise (last_mod);
1017 notmuch->uuid = talloc_strdup (
1018 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
1020 notmuch->query_parser = new Xapian::QueryParser;
1021 notmuch->term_gen = new Xapian::TermGenerator;
1022 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
1023 notmuch->value_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1024 notmuch->date_range_processor = new ParseTimeValueRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
1025 notmuch->last_mod_range_processor = new Xapian::NumberValueRangeProcessor (NOTMUCH_VALUE_LAST_MOD, "lastmod:");
1027 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
1028 notmuch->query_parser->set_database (*notmuch->xapian_db);
1029 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
1030 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
1031 notmuch->query_parser->add_valuerangeprocessor (notmuch->value_range_processor);
1032 notmuch->query_parser->add_valuerangeprocessor (notmuch->date_range_processor);
1033 notmuch->query_parser->add_valuerangeprocessor (notmuch->last_mod_range_processor);
1035 for (i = 0; i < ARRAY_SIZE (prefix_table); i++) {
1036 const prefix_t *prefix = &prefix_table[i];
1037 if (prefix->flags & NOTMUCH_FIELD_EXTERNAL) {
1038 _setup_query_field (prefix, notmuch);
1041 status = _setup_user_query_fields (notmuch);
1042 } catch (const Xapian::Error &error) {
1043 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
1044 error.get_msg().c_str()));
1045 notmuch_database_destroy (notmuch);
1047 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1051 talloc_free (local);
1055 *status_string = message;
1061 *database = notmuch;
1063 talloc_free (notmuch);
1068 notmuch_database_close (notmuch_database_t *notmuch)
1070 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
1072 /* Many Xapian objects (and thus notmuch objects) hold references to
1073 * the database, so merely deleting the database may not suffice to
1074 * close it. Thus, we explicitly close it here. */
1075 if (notmuch->xapian_db != NULL) {
1077 /* If there's an outstanding transaction, it's unclear if
1078 * closing the Xapian database commits everything up to
1079 * that transaction, or may discard committed (but
1080 * unflushed) transactions. To be certain, explicitly
1081 * cancel any outstanding transaction before closing. */
1082 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1083 notmuch->atomic_nesting)
1084 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))
1085 ->cancel_transaction ();
1087 /* Close the database. This implicitly flushes
1088 * outstanding changes. */
1089 notmuch->xapian_db->close();
1090 } catch (const Xapian::Error &error) {
1091 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1092 if (! notmuch->exception_reported) {
1093 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
1094 error.get_msg().c_str());
1099 delete notmuch->term_gen;
1100 notmuch->term_gen = NULL;
1101 delete notmuch->query_parser;
1102 notmuch->query_parser = NULL;
1103 delete notmuch->xapian_db;
1104 notmuch->xapian_db = NULL;
1105 delete notmuch->value_range_processor;
1106 notmuch->value_range_processor = NULL;
1107 delete notmuch->date_range_processor;
1108 notmuch->date_range_processor = NULL;
1109 delete notmuch->last_mod_range_processor;
1110 notmuch->last_mod_range_processor = NULL;
1116 _notmuch_database_reopen (notmuch_database_t *notmuch)
1118 if (notmuch->mode != NOTMUCH_DATABASE_MODE_READ_ONLY)
1119 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
1122 notmuch->xapian_db->reopen ();
1123 } catch (const Xapian::Error &error) {
1124 if (! notmuch->exception_reported) {
1125 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
1126 error.get_msg ().c_str ());
1127 notmuch->exception_reported = true;
1129 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1134 return NOTMUCH_STATUS_SUCCESS;
1138 unlink_cb (const char *path,
1139 unused (const struct stat *sb),
1141 unused (struct FTW *ftw))
1143 return remove (path);
1147 rmtree (const char *path)
1149 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
1152 class NotmuchCompactor : public Xapian::Compactor
1154 notmuch_compact_status_cb_t status_cb;
1155 void *status_closure;
1158 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
1159 status_cb (cb), status_closure (closure) { }
1162 set_status (const std::string &table, const std::string &status)
1166 if (status_cb == NULL)
1169 if (status.length () == 0)
1170 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str());
1172 msg = talloc_asprintf (NULL, " %s", status.c_str());
1178 status_cb (msg, status_closure);
1183 /* Compacts the given database, optionally saving the original database
1184 * in backup_path. Additionally, a callback function can be provided to
1185 * give the user feedback on the progress of the (likely long-lived)
1186 * compaction process.
1188 * The backup path must point to a directory on the same volume as the
1189 * original database. Passing a NULL backup_path will result in the
1190 * uncompacted database being deleted after compaction has finished.
1191 * Note that the database write lock will be held during the
1192 * compaction process to protect data integrity.
1195 notmuch_database_compact (const char *path,
1196 const char *backup_path,
1197 notmuch_compact_status_cb_t status_cb,
1201 char *notmuch_path, *xapian_path, *compact_xapian_path;
1202 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
1203 notmuch_database_t *notmuch = NULL;
1204 struct stat statbuf;
1206 char *message = NULL;
1208 local = talloc_new (NULL);
1210 return NOTMUCH_STATUS_OUT_OF_MEMORY;
1212 ret = notmuch_database_open_verbose (path,
1213 NOTMUCH_DATABASE_MODE_READ_WRITE,
1217 if (status_cb) status_cb (message, closure);
1221 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
1222 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1226 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
1227 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1231 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
1232 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1236 if (backup_path == NULL) {
1237 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
1238 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
1241 keep_backup = false;
1247 if (stat (backup_path, &statbuf) != -1) {
1248 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
1249 ret = NOTMUCH_STATUS_FILE_ERROR;
1252 if (errno != ENOENT) {
1253 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
1255 ret = NOTMUCH_STATUS_FILE_ERROR;
1259 /* Unconditionally attempt to remove old work-in-progress database (if
1260 * any). This is "protected" by database lock. If this fails due to write
1261 * errors (etc), the following code will fail and provide error message.
1263 (void) rmtree (compact_xapian_path);
1266 NotmuchCompactor compactor (status_cb, closure);
1268 compactor.set_renumber (false);
1269 compactor.add_source (xapian_path);
1270 compactor.set_destdir (compact_xapian_path);
1271 compactor.compact ();
1272 } catch (const Xapian::Error &error) {
1273 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg().c_str());
1274 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1278 if (rename (xapian_path, backup_path)) {
1279 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1280 xapian_path, backup_path, strerror (errno));
1281 ret = NOTMUCH_STATUS_FILE_ERROR;
1285 if (rename (compact_xapian_path, xapian_path)) {
1286 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
1287 compact_xapian_path, xapian_path, strerror (errno));
1288 ret = NOTMUCH_STATUS_FILE_ERROR;
1292 if (! keep_backup) {
1293 if (rmtree (backup_path)) {
1294 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
1295 backup_path, strerror (errno));
1296 ret = NOTMUCH_STATUS_FILE_ERROR;
1303 notmuch_status_t ret2;
1305 const char *str = notmuch_database_status_string (notmuch);
1306 if (status_cb && str)
1307 status_cb (str, closure);
1309 ret2 = notmuch_database_destroy (notmuch);
1311 /* don't clobber previous error status */
1312 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
1316 talloc_free (local);
1322 notmuch_database_destroy (notmuch_database_t *notmuch)
1324 notmuch_status_t status;
1326 status = notmuch_database_close (notmuch);
1327 talloc_free (notmuch);
1333 notmuch_database_get_path (notmuch_database_t *notmuch)
1335 return notmuch->path;
1339 notmuch_database_get_version (notmuch_database_t *notmuch)
1341 unsigned int version;
1342 string version_string;
1346 version_string = notmuch->xapian_db->get_metadata ("version");
1347 if (version_string.empty ())
1350 str = version_string.c_str ();
1351 if (str == NULL || *str == '\0')
1354 version = strtoul (str, &end, 10);
1356 INTERNAL_ERROR ("Malformed database version: %s", str);
1362 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
1364 return notmuch->mode == NOTMUCH_DATABASE_MODE_READ_WRITE &&
1365 ((NOTMUCH_FEATURES_CURRENT & ~notmuch->features) ||
1366 (notmuch_database_get_version (notmuch) < NOTMUCH_DATABASE_VERSION));
1369 static volatile sig_atomic_t do_progress_notify = 0;
1372 handle_sigalrm (unused (int signal))
1374 do_progress_notify = 1;
1377 /* Upgrade the current database.
1379 * After opening a database in read-write mode, the client should
1380 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
1381 * if so, upgrade with this function before making any modifications.
1383 * The optional progress_notify callback can be used by the caller to
1384 * provide progress indication to the user. If non-NULL it will be
1385 * called periodically with 'count' as the number of messages upgraded
1386 * so far and 'total' the overall number of messages that will be
1390 notmuch_database_upgrade (notmuch_database_t *notmuch,
1391 void (*progress_notify) (void *closure,
1395 void *local = talloc_new (NULL);
1396 Xapian::TermIterator t, t_end;
1397 Xapian::WritableDatabase *db;
1398 struct sigaction action;
1399 struct itimerval timerval;
1400 bool timer_is_active = false;
1401 enum _notmuch_features target_features, new_features;
1402 notmuch_status_t status;
1403 notmuch_private_status_t private_status;
1404 notmuch_query_t *query = NULL;
1405 unsigned int count = 0, total = 0;
1407 status = _notmuch_database_ensure_writable (notmuch);
1411 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1413 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
1414 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
1416 if (! notmuch_database_needs_upgrade (notmuch))
1417 return NOTMUCH_STATUS_SUCCESS;
1419 if (progress_notify) {
1420 /* Set up our handler for SIGALRM */
1421 memset (&action, 0, sizeof (struct sigaction));
1422 action.sa_handler = handle_sigalrm;
1423 sigemptyset (&action.sa_mask);
1424 action.sa_flags = SA_RESTART;
1425 sigaction (SIGALRM, &action, NULL);
1427 /* Then start a timer to send SIGALRM once per second. */
1428 timerval.it_interval.tv_sec = 1;
1429 timerval.it_interval.tv_usec = 0;
1430 timerval.it_value.tv_sec = 1;
1431 timerval.it_value.tv_usec = 0;
1432 setitimer (ITIMER_REAL, &timerval, NULL);
1434 timer_is_active = true;
1437 /* Figure out how much total work we need to do. */
1439 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1440 NOTMUCH_FEATURE_LAST_MOD)) {
1441 query = notmuch_query_create (notmuch, "");
1444 status = notmuch_query_count_messages (query, &msg_count);
1449 notmuch_query_destroy (query);
1452 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1453 t_end = db->allterms_end ("XTIMESTAMP");
1454 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
1457 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1458 /* The ghost message upgrade converts all thread_id_*
1459 * metadata values into ghost message documents. */
1460 t_end = db->metadata_keys_end ("thread_id_");
1461 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
1465 /* Perform the upgrade in a transaction. */
1466 db->begin_transaction (true);
1468 /* Set the target features so we write out changes in the desired
1470 notmuch->features = target_features;
1472 /* Perform per-message upgrades. */
1474 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
1475 NOTMUCH_FEATURE_LAST_MOD)) {
1476 notmuch_messages_t *messages;
1477 notmuch_message_t *message;
1480 query = notmuch_query_create (notmuch, "");
1482 status = notmuch_query_search_messages (query, &messages);
1486 notmuch_messages_valid (messages);
1487 notmuch_messages_move_to_next (messages))
1489 if (do_progress_notify) {
1490 progress_notify (closure, (double) count / total);
1491 do_progress_notify = 0;
1494 message = notmuch_messages_get (messages);
1496 /* Before version 1, each message document had its
1497 * filename in the data field. Copy that into the new
1498 * format by calling notmuch_message_add_filename.
1500 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
1501 filename = _notmuch_message_talloc_copy_data (message);
1502 if (filename && *filename != '\0') {
1503 _notmuch_message_add_filename (message, filename);
1504 _notmuch_message_clear_data (message);
1506 talloc_free (filename);
1509 /* Prior to version 2, the "folder:" prefix was
1510 * probabilistic and stemmed. Change it to the current
1511 * boolean prefix. Add "path:" prefixes while at it.
1513 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
1514 _notmuch_message_upgrade_folder (message);
1516 /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
1517 * track modification revisions. Give all messages the
1518 * next available revision; since we just started tracking
1519 * revisions for this database, that will be 1.
1521 if (new_features & NOTMUCH_FEATURE_LAST_MOD)
1522 _notmuch_message_upgrade_last_mod (message);
1524 _notmuch_message_sync (message);
1526 notmuch_message_destroy (message);
1531 notmuch_query_destroy (query);
1535 /* Perform per-directory upgrades. */
1537 /* Before version 1 we stored directory timestamps in
1538 * XTIMESTAMP documents instead of the current XDIRECTORY
1539 * documents. So copy those as well. */
1540 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
1541 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
1543 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
1547 Xapian::PostingIterator p, p_end;
1548 std::string term = *t;
1550 p_end = notmuch->xapian_db->postlist_end (term);
1552 for (p = notmuch->xapian_db->postlist_begin (term);
1556 Xapian::Document document;
1558 notmuch_directory_t *directory;
1560 if (do_progress_notify) {
1561 progress_notify (closure, (double) count / total);
1562 do_progress_notify = 0;
1565 document = find_document_for_doc_id (notmuch, *p);
1566 mtime = Xapian::sortable_unserialise (
1567 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1569 directory = _notmuch_directory_create (notmuch, term.c_str() + 10,
1570 NOTMUCH_FIND_CREATE, &status);
1571 notmuch_directory_set_mtime (directory, mtime);
1572 notmuch_directory_destroy (directory);
1574 db->delete_document (*p);
1581 /* Perform metadata upgrades. */
1583 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1584 * messages were stored as database metadata. Change these to
1587 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1588 notmuch_message_t *message;
1589 std::string message_id, thread_id;
1591 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1592 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1594 if (do_progress_notify) {
1595 progress_notify (closure, (double) count / total);
1596 do_progress_notify = 0;
1599 message_id = (*t).substr (
1600 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1601 thread_id = db->get_metadata (*t);
1603 /* Create ghost message */
1604 message = _notmuch_message_create_for_message_id (
1605 notmuch, message_id.c_str (), &private_status);
1606 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1607 /* Document already exists; ignore the stored thread ID */
1608 } else if (private_status ==
1609 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1610 private_status = _notmuch_message_initialize_ghost (
1611 message, thread_id.c_str ());
1612 if (! private_status)
1613 _notmuch_message_sync (message);
1616 if (private_status) {
1617 _notmuch_database_log (notmuch,
1618 "Upgrade failed while creating ghost messages.\n");
1619 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1623 /* Clear saved metadata thread ID */
1624 db->set_metadata (*t, "");
1630 status = NOTMUCH_STATUS_SUCCESS;
1631 db->set_metadata ("features", _print_features (local, notmuch->features));
1632 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1635 if (status == NOTMUCH_STATUS_SUCCESS)
1636 db->commit_transaction ();
1638 db->cancel_transaction ();
1640 if (timer_is_active) {
1641 /* Now stop the timer. */
1642 timerval.it_interval.tv_sec = 0;
1643 timerval.it_interval.tv_usec = 0;
1644 timerval.it_value.tv_sec = 0;
1645 timerval.it_value.tv_usec = 0;
1646 setitimer (ITIMER_REAL, &timerval, NULL);
1648 /* And disable the signal handler. */
1649 action.sa_handler = SIG_IGN;
1650 sigaction (SIGALRM, &action, NULL);
1654 notmuch_query_destroy (query);
1656 talloc_free (local);
1661 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1663 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1664 notmuch->atomic_nesting > 0)
1667 if (notmuch_database_needs_upgrade (notmuch))
1668 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1671 (static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db))->begin_transaction (false);
1672 } catch (const Xapian::Error &error) {
1673 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1674 error.get_msg().c_str());
1675 notmuch->exception_reported = true;
1676 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1680 notmuch->atomic_nesting++;
1681 return NOTMUCH_STATUS_SUCCESS;
1685 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1687 Xapian::WritableDatabase *db;
1689 if (notmuch->atomic_nesting == 0)
1690 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1692 if (notmuch->mode == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1693 notmuch->atomic_nesting > 1)
1696 db = static_cast <Xapian::WritableDatabase *> (notmuch->xapian_db);
1698 db->commit_transaction ();
1700 /* This is a hack for testing. Xapian never flushes on a
1701 * non-flushed commit, even if the flush threshold is 1.
1702 * However, we rely on flushing to test atomicity. */
1703 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1704 if (thresh && atoi (thresh) == 1)
1706 } catch (const Xapian::Error &error) {
1707 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1708 error.get_msg().c_str());
1709 notmuch->exception_reported = true;
1710 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1713 if (notmuch->atomic_dirty) {
1714 ++notmuch->revision;
1715 notmuch->atomic_dirty = false;
1719 notmuch->atomic_nesting--;
1720 return NOTMUCH_STATUS_SUCCESS;
1724 notmuch_database_get_revision (notmuch_database_t *notmuch,
1728 *uuid = notmuch->uuid;
1729 return notmuch->revision;
1732 /* We allow the user to use arbitrarily long paths for directories. But
1733 * we have a term-length limit. So if we exceed that, we'll use the
1734 * SHA-1 of the path for the database term.
1736 * Note: This function may return the original value of 'path'. If it
1737 * does not, then the caller is responsible to free() the returned
1741 _notmuch_database_get_directory_db_path (const char *path)
1743 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1745 if (term_len > NOTMUCH_TERM_MAX)
1746 return _notmuch_sha1_of_string (path);
1751 /* Given a path, split it into two parts: the directory part is all
1752 * components except for the last, and the basename is that last
1753 * component. Getting the return-value for either part is optional
1754 * (the caller can pass NULL).
1756 * The original 'path' can represent either a regular file or a
1757 * directory---the splitting will be carried out in the same way in
1758 * either case. Trailing slashes on 'path' will be ignored, and any
1759 * cases of multiple '/' characters appearing in series will be
1760 * treated as a single '/'.
1762 * Allocation (if any) will have 'ctx' as the talloc owner. But
1763 * pointers will be returned within the original path string whenever
1766 * Note: If 'path' is non-empty and contains no non-trailing slash,
1767 * (that is, consists of a filename with no parent directory), then
1768 * the directory returned will be an empty string. However, if 'path'
1769 * is an empty string, then both directory and basename will be
1773 _notmuch_database_split_path (void *ctx,
1775 const char **directory,
1776 const char **basename)
1780 if (path == NULL || *path == '\0') {
1785 return NOTMUCH_STATUS_SUCCESS;
1788 /* Find the last slash (not counting a trailing slash), if any. */
1790 slash = path + strlen (path) - 1;
1792 /* First, skip trailing slashes. */
1793 while (slash != path && *slash == '/')
1796 /* Then, find a slash. */
1797 while (slash != path && *slash != '/') {
1804 /* Finally, skip multiple slashes. */
1805 while (slash != path && *(slash - 1) == '/')
1808 if (slash == path) {
1810 *directory = talloc_strdup (ctx, "");
1815 *directory = talloc_strndup (ctx, path, slash - path);
1818 return NOTMUCH_STATUS_SUCCESS;
1821 /* Find the document ID of the specified directory.
1823 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1824 * created if one does not exist for 'path'. Otherwise, if the
1825 * directory document does not exist, this sets *directory_id to
1826 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1829 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1831 notmuch_find_flags_t flags,
1832 unsigned int *directory_id)
1834 notmuch_directory_t *directory;
1835 notmuch_status_t status;
1839 return NOTMUCH_STATUS_SUCCESS;
1842 directory = _notmuch_directory_create (notmuch, path, flags, &status);
1843 if (status || !directory) {
1848 *directory_id = _notmuch_directory_get_document_id (directory);
1850 notmuch_directory_destroy (directory);
1852 return NOTMUCH_STATUS_SUCCESS;
1856 _notmuch_database_get_directory_path (void *ctx,
1857 notmuch_database_t *notmuch,
1858 unsigned int doc_id)
1860 Xapian::Document document;
1862 document = find_document_for_doc_id (notmuch, doc_id);
1864 return talloc_strdup (ctx, document.get_data ().c_str ());
1867 /* Given a legal 'filename' for the database, (either relative to
1868 * database path or absolute with initial components identical to
1869 * database path), return a new string (with 'ctx' as the talloc
1870 * owner) suitable for use as a direntry term value.
1872 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1873 * will be created in the database as needed. Otherwise, if the
1874 * necessary directory documents do not exist, this sets
1875 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1878 _notmuch_database_filename_to_direntry (void *ctx,
1879 notmuch_database_t *notmuch,
1880 const char *filename,
1881 notmuch_find_flags_t flags,
1884 const char *relative, *directory, *basename;
1885 Xapian::docid directory_id;
1886 notmuch_status_t status;
1888 relative = _notmuch_database_relative_path (notmuch, filename);
1890 status = _notmuch_database_split_path (ctx, relative,
1891 &directory, &basename);
1895 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1897 if (status || directory_id == (unsigned int)-1) {
1902 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1904 return NOTMUCH_STATUS_SUCCESS;
1907 /* Given a legal 'path' for the database, return the relative path.
1909 * The return value will be a pointer to the original path contents,
1910 * and will be either the original string (if 'path' was relative) or
1911 * a portion of the string (if path was absolute and begins with the
1915 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1918 const char *db_path, *relative;
1919 unsigned int db_path_len;
1921 db_path = notmuch_database_get_path (notmuch);
1922 db_path_len = strlen (db_path);
1926 if (*relative == '/') {
1927 while (*relative == '/' && *(relative+1) == '/')
1930 if (strncmp (relative, db_path, db_path_len) == 0)
1932 relative += db_path_len;
1933 while (*relative == '/')
1942 notmuch_database_get_directory (notmuch_database_t *notmuch,
1944 notmuch_directory_t **directory)
1946 notmuch_status_t status;
1948 if (directory == NULL)
1949 return NOTMUCH_STATUS_NULL_POINTER;
1953 *directory = _notmuch_directory_create (notmuch, path,
1954 NOTMUCH_FIND_LOOKUP, &status);
1955 } catch (const Xapian::Error &error) {
1956 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1957 error.get_msg().c_str());
1958 notmuch->exception_reported = true;
1959 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1964 /* Allocate a document ID that satisfies the following criteria:
1966 * 1. The ID does not exist for any document in the Xapian database
1968 * 2. The ID was not previously returned from this function
1970 * 3. The ID is the smallest integer satisfying (1) and (2)
1972 * This function will trigger an internal error if these constraints
1973 * cannot all be satisfied, (that is, the pool of available document
1974 * IDs has been exhausted).
1977 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1979 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1981 notmuch->last_doc_id++;
1983 if (notmuch->last_doc_id == 0)
1984 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1986 return notmuch->last_doc_id;
1990 notmuch_database_remove_message (notmuch_database_t *notmuch,
1991 const char *filename)
1993 notmuch_status_t status;
1994 notmuch_message_t *message;
1996 status = notmuch_database_find_message_by_filename (notmuch, filename,
1999 if (status == NOTMUCH_STATUS_SUCCESS && message) {
2000 status = _notmuch_message_remove_filename (message, filename);
2001 if (status == NOTMUCH_STATUS_SUCCESS)
2002 _notmuch_message_delete (message);
2003 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
2004 _notmuch_message_sync (message);
2006 notmuch_message_destroy (message);
2013 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
2014 const char *filename,
2015 notmuch_message_t **message_ret)
2018 const char *prefix = _find_prefix ("file-direntry");
2019 char *direntry, *term;
2020 Xapian::PostingIterator i, end;
2021 notmuch_status_t status;
2023 if (message_ret == NULL)
2024 return NOTMUCH_STATUS_NULL_POINTER;
2026 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
2027 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
2029 /* return NULL on any failure */
2030 *message_ret = NULL;
2032 local = talloc_new (notmuch);
2035 status = _notmuch_database_filename_to_direntry (
2036 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
2037 if (status || !direntry)
2040 term = talloc_asprintf (local, "%s%s", prefix, direntry);
2042 find_doc_ids_for_term (notmuch, term, &i, &end);
2045 notmuch_private_status_t private_status;
2047 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
2049 if (*message_ret == NULL)
2050 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
2052 } catch (const Xapian::Error &error) {
2053 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
2054 error.get_msg().c_str());
2055 notmuch->exception_reported = true;
2056 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
2060 talloc_free (local);
2062 if (status && *message_ret) {
2063 notmuch_message_destroy (*message_ret);
2064 *message_ret = NULL;
2069 notmuch_string_list_t *
2070 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
2071 Xapian::TermIterator &end,
2074 int prefix_len = strlen (prefix);
2075 notmuch_string_list_t *list;
2077 list = _notmuch_string_list_create (ctx);
2078 if (unlikely (list == NULL))
2081 for (i.skip_to (prefix); i != end; i++) {
2082 /* Terminate loop at first term without desired prefix. */
2083 if (strncmp ((*i).c_str (), prefix, prefix_len))
2086 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
2093 notmuch_database_get_all_tags (notmuch_database_t *db)
2095 Xapian::TermIterator i, end;
2096 notmuch_string_list_t *tags;
2099 i = db->xapian_db->allterms_begin();
2100 end = db->xapian_db->allterms_end();
2101 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
2102 _find_prefix ("tag"));
2103 _notmuch_string_list_sort (tags);
2104 return _notmuch_tags_create (db, tags);
2105 } catch (const Xapian::Error &error) {
2106 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
2107 error.get_msg().c_str());
2108 db->exception_reported = true;
2114 notmuch_database_status_string (const notmuch_database_t *notmuch)
2116 return notmuch->status_string;