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 "string-util.h"
31 #include <glib.h> /* g_free, GPtrArray, GHashTable */
32 #include <glib-object.h> /* g_type_init */
34 #include <gmime/gmime.h> /* g_mime_init */
41 notmuch_field_flag_t flags;
44 #define NOTMUCH_DATABASE_VERSION 3
46 #define STRINGIFY(s) _SUB_STRINGIFY (s)
47 #define _SUB_STRINGIFY(s) #s
49 #define LOG_XAPIAN_EXCEPTION(message, error) _log_xapian_exception (__location__, message, error)
52 _log_xapian_exception (const char *where, notmuch_database_t *notmuch, const Xapian::Error error) {
53 _notmuch_database_log (notmuch,
54 "A Xapian exception occurred at %s: %s\n",
56 error.get_msg ().c_str ());
57 notmuch->exception_reported = true;
60 notmuch_database_mode_t
61 _notmuch_database_mode (notmuch_database_t *notmuch)
63 if (notmuch->writable_xapian_db)
64 return NOTMUCH_DATABASE_MODE_READ_WRITE;
66 return NOTMUCH_DATABASE_MODE_READ_ONLY;
69 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
71 * We currently have three different types of documents (mail, ghost,
72 * and directory) and also some metadata.
74 * There are two kinds of prefixes used in notmuch. There are the
75 * human friendly 'prefix names' like "thread:", which are also used
76 * in the query parser, and the actual prefix terms in the database
77 * (e.g. "G"). The correspondence is maintained in the file scope data
78 * structure 'prefix_table'.
82 * A mail document is associated with a particular email message. It
83 * is stored in one or more files on disk and is uniquely identified
84 * by its "id" field (which is generally the message ID). It is
85 * indexed with the following prefixed terms which the database uses
86 * to construct threads, etc.:
88 * Single terms of given prefix:
92 * id: Unique ID of mail. This is from the Message-ID header
93 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
94 * If it's present and too long, then we use
95 * "notmuch-sha1-<sha1_sum_of_message_id>".
96 * If this header is not present, we use
97 * "notmuch-sha1-<sha1_sum_of_entire_file>".
99 * thread: The ID of the thread to which the mail belongs
101 * replyto: The ID from the In-Reply-To header of the mail (if any).
103 * Multiple terms of given prefix:
105 * reference: All message IDs from In-Reply-To and References
106 * headers in the message.
108 * tag: Any tags associated with this message by the user.
110 * file-direntry: A colon-separated pair of values
111 * (INTEGER:STRING), where INTEGER is the
112 * document ID of a directory document, and
113 * STRING is the name of a file within that
114 * directory for this mail message.
116 * property: Has a property with key=value
117 * FIXME: if no = is present, should match on any value
119 * A mail document also has four values:
121 * TIMESTAMP: The time_t value corresponding to the message's
124 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
126 * FROM: The value of the "From" header
128 * SUBJECT: The value of the "Subject" header
130 * LAST_MOD: The revision number as of the last tag or
133 * The prefixed terms described above are also searchable without an
134 * explicit field name, but as of notmuch 0.29 this is due to
135 * query-parser setup, not extra terms in the database. In addition,
136 * terms from the content of the message are added without a prefix
137 * for use by the user in searching. Note that the prefix name "body"
138 * is used to refer to the empty prefix string in the database.
140 * The path of the containing folder is added with the "folder" prefix
141 * (see _notmuch_message_add_folder_terms). Sub-paths of the the path
142 * of the mail message are added with the "path" prefix.
144 * The data portion of a mail document is empty.
146 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
147 * -----------------------------------------------
148 * A ghost mail document is like a mail document, but where we don't
149 * have the message content. These are used to track thread reference
150 * information for messages we haven't received.
152 * A ghost mail document has type: ghost; id and thread fields that
153 * are identical to the mail document fields; and a MESSAGE_ID value.
157 * A directory document is used by a client of the notmuch library to
158 * maintain data necessary to allow for efficient polling of mail
161 * All directory documents contain one term:
163 * directory: The directory path (relative to the database path)
164 * Or the SHA1 sum of the directory path (if the
165 * path itself is too long to fit in a Xapian
168 * And all directory documents for directories other than top-level
169 * directories also contain the following term:
171 * directory-direntry: A colon-separated pair of values
172 * (INTEGER:STRING), where INTEGER is the
173 * document ID of the parent directory
174 * document, and STRING is the name of this
175 * directory within that parent.
177 * All directory documents have a single value:
179 * TIMESTAMP: The mtime of the directory (at last scan)
181 * The data portion of a directory document contains the path of the
182 * directory (relative to the database path).
186 * Xapian allows us to store arbitrary name-value pairs as
187 * "metadata". We currently use the following metadata names with the
190 * version The database schema version, (which is distinct
191 * from both the notmuch package version (see
192 * notmuch --version) and the libnotmuch library
193 * version. The version is stored as an base-10
194 * ASCII integer. The initial database version
195 * was 1, (though a schema existed before that
196 * were no "version" database value existed at
197 * all). Successive versions are allocated as
198 * changes are made to the database (such as by
199 * indexing new fields).
201 * features The set of features supported by this
202 * database. This consists of a set of
203 * '\n'-separated lines, where each is a feature
204 * name, a '\t', and compatibility flags. If the
205 * compatibility flags contain 'w', then the
206 * opener must support this feature to safely
207 * write this database. If the compatibility
208 * flags contain 'r', then the opener must
209 * support this feature to read this database.
210 * Introduced in database version 3.
212 * last_thread_id The last thread ID generated. This is stored
213 * as a 16-byte hexadecimal ASCII representation
214 * of a 64-bit unsigned integer. The first ID
215 * generated is 1 and the value will be
216 * incremented for each thread ID.
218 * C* metadata keys starting with C indicate
219 * configuration data. It can be managed with the
220 * n_database_*config* API. There is a convention
221 * of hierarchical keys separated by '.' (e.g.
222 * query.notmuch stores the value for the named
223 * query 'notmuch'), but it is not enforced by the
229 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
230 * Instead, the database has the following additional database
233 * thread_id_* A pre-allocated thread ID for a particular
234 * message. This is actually an arbitrarily large
235 * family of metadata name. Any particular name is
236 * formed by concatenating "thread_id_" with a message
237 * ID (or the SHA1 sum of a message ID if it is very
238 * long---see description of 'id' in the mail
239 * document). The value stored is a thread ID.
241 * These thread ID metadata values are stored
242 * whenever a message references a parent message
243 * that does not yet exist in the database. A
244 * thread ID will be allocated and stored, and if
245 * the message is later added, the stored thread
246 * ID will be used (and the metadata value will
249 * Even before a message is added, it's
250 * pre-allocated thread ID is useful so that all
251 * descendant messages that reference this common
252 * parent can be recognized as belonging to the
257 notmuch_string_map_iterator_t *
258 _notmuch_database_user_headers (notmuch_database_t *notmuch)
260 return _notmuch_string_map_iterator_create (notmuch->user_header, "", false);
264 notmuch_status_to_string (notmuch_status_t status)
267 case NOTMUCH_STATUS_SUCCESS:
268 return "No error occurred";
269 case NOTMUCH_STATUS_OUT_OF_MEMORY:
270 return "Out of memory";
271 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
272 return "Attempt to write to a read-only database";
273 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
274 return "A Xapian exception occurred";
275 case NOTMUCH_STATUS_FILE_ERROR:
276 return "Something went wrong trying to read or write a file";
277 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
278 return "File is not an email";
279 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
280 return "Message ID is identical to a message in database";
281 case NOTMUCH_STATUS_NULL_POINTER:
282 return "Erroneous NULL pointer";
283 case NOTMUCH_STATUS_TAG_TOO_LONG:
284 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
285 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
286 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
287 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
288 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
289 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
290 return "Unsupported operation";
291 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
292 return "Operation requires a database upgrade";
293 case NOTMUCH_STATUS_PATH_ERROR:
294 return "Path supplied is illegal for this function";
295 case NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL:
296 return "Crypto protocol missing, malformed, or unintelligible";
297 case NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION:
298 return "Crypto engine initialization failure";
299 case NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL:
300 return "Unknown crypto protocol";
302 case NOTMUCH_STATUS_LAST_STATUS:
303 return "Unknown error status value";
308 _notmuch_database_log (notmuch_database_t *notmuch,
314 va_start (va_args, format);
316 if (notmuch->status_string)
317 talloc_free (notmuch->status_string);
319 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
324 _notmuch_database_log_append (notmuch_database_t *notmuch,
330 va_start (va_args, format);
332 if (notmuch->status_string)
333 notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
335 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
341 find_doc_ids_for_term (notmuch_database_t *notmuch,
343 Xapian::PostingIterator *begin,
344 Xapian::PostingIterator *end)
346 *begin = notmuch->xapian_db->postlist_begin (term);
348 *end = notmuch->xapian_db->postlist_end (term);
352 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
353 const char *prefix_name,
355 Xapian::PostingIterator *begin,
356 Xapian::PostingIterator *end)
360 term = talloc_asprintf (notmuch, "%s%s",
361 _find_prefix (prefix_name), value);
363 find_doc_ids_for_term (notmuch, term, begin, end);
368 notmuch_private_status_t
369 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
370 const char *prefix_name,
372 unsigned int *doc_id)
374 Xapian::PostingIterator i, end;
376 _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
380 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
385 #if DEBUG_DATABASE_SANITY
389 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
393 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
396 static Xapian::Document
397 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
399 return notmuch->xapian_db->get_document (doc_id);
402 /* Generate a compressed version of 'message_id' of the form:
404 * notmuch-sha1-<sha1_sum_of_message_id>
407 _notmuch_message_id_compressed (void *ctx, const char *message_id)
409 char *sha1, *compressed;
411 sha1 = _notmuch_sha1_of_string (message_id);
413 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
420 notmuch_database_find_message (notmuch_database_t *notmuch,
421 const char *message_id,
422 notmuch_message_t **message_ret)
424 notmuch_private_status_t status;
427 if (message_ret == NULL)
428 return NOTMUCH_STATUS_NULL_POINTER;
430 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
431 message_id = _notmuch_message_id_compressed (notmuch, message_id);
434 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
435 message_id, &doc_id);
437 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
440 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
442 if (*message_ret == NULL)
443 return NOTMUCH_STATUS_OUT_OF_MEMORY;
446 return NOTMUCH_STATUS_SUCCESS;
447 } catch (const Xapian::Error &error) {
448 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
449 error.get_msg ().c_str ());
450 notmuch->exception_reported = true;
452 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
457 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
459 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY) {
460 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
461 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
464 return NOTMUCH_STATUS_SUCCESS;
467 /* Allocate a revision number for the next change. */
469 _notmuch_database_new_revision (notmuch_database_t *notmuch)
471 unsigned long new_revision = notmuch->revision + 1;
473 /* If we're in an atomic section, hold off on updating the
474 * committed revision number until we commit the atomic section.
476 if (notmuch->atomic_nesting)
477 notmuch->atomic_dirty = true;
479 notmuch->revision = new_revision;
485 notmuch_database_close (notmuch_database_t *notmuch)
487 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
489 /* Many Xapian objects (and thus notmuch objects) hold references to
490 * the database, so merely deleting the database may not suffice to
491 * close it. Thus, we explicitly close it here. */
494 /* If there's an outstanding transaction, it's unclear if
495 * closing the Xapian database commits everything up to
496 * that transaction, or may discard committed (but
497 * unflushed) transactions. To be certain, explicitly
498 * cancel any outstanding transaction before closing. */
499 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_WRITE &&
500 notmuch->atomic_nesting)
501 notmuch->writable_xapian_db->cancel_transaction ();
503 /* Close the database. This implicitly flushes
504 * outstanding changes. */
505 notmuch->xapian_db->close ();
506 } catch (const Xapian::Error &error) {
507 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
508 if (! notmuch->exception_reported) {
509 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred closing database: %s\n",
510 error.get_msg ().c_str ());
514 notmuch->open = false;
519 _notmuch_database_reopen (notmuch_database_t *notmuch)
521 if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_ONLY)
522 return NOTMUCH_STATUS_UNSUPPORTED_OPERATION;
525 notmuch->xapian_db->reopen ();
526 } catch (const Xapian::Error &error) {
527 if (! notmuch->exception_reported) {
528 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
529 error.get_msg ().c_str ());
530 notmuch->exception_reported = true;
532 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
537 return NOTMUCH_STATUS_SUCCESS;
541 unlink_cb (const char *path,
542 unused (const struct stat *sb),
544 unused (struct FTW *ftw))
546 return remove (path);
550 rmtree (const char *path)
552 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
555 class NotmuchCompactor : public Xapian::Compactor
557 notmuch_compact_status_cb_t status_cb;
558 void *status_closure;
561 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
562 status_cb (cb), status_closure (closure)
567 set_status (const std::string &table, const std::string &status)
571 if (status_cb == NULL)
574 if (status.length () == 0)
575 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str ());
577 msg = talloc_asprintf (NULL, " %s", status.c_str ());
583 status_cb (msg, status_closure);
588 /* Compacts the given database, optionally saving the original database
589 * in backup_path. Additionally, a callback function can be provided to
590 * give the user feedback on the progress of the (likely long-lived)
591 * compaction process.
593 * The backup path must point to a directory on the same volume as the
594 * original database. Passing a NULL backup_path will result in the
595 * uncompacted database being deleted after compaction has finished.
596 * Note that the database write lock will be held during the
597 * compaction process to protect data integrity.
600 notmuch_database_compact (const char *path,
601 const char *backup_path,
602 notmuch_compact_status_cb_t status_cb,
605 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
606 notmuch_database_t *notmuch = NULL;
607 char *message = NULL;
609 ret = notmuch_database_open_verbose (path,
610 NOTMUCH_DATABASE_MODE_READ_WRITE,
614 if (status_cb) status_cb (message, closure);
618 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
620 return notmuch_database_compact_db (notmuch,
627 notmuch_database_compact_db (notmuch_database_t *notmuch,
628 const char *backup_path,
629 notmuch_compact_status_cb_t status_cb,
632 char *notmuch_path, *xapian_path, *compact_xapian_path;
634 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
638 ret = _notmuch_database_ensure_writable (notmuch);
642 path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
644 return NOTMUCH_STATUS_PATH_ERROR;
646 local = talloc_new (NULL);
648 return NOTMUCH_STATUS_OUT_OF_MEMORY;
650 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", path, ".notmuch"))) {
651 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
655 if (! (xapian_path = talloc_asprintf (local, "%s/%s", notmuch_path, "xapian"))) {
656 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
660 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
661 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
665 if (backup_path == NULL) {
666 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
667 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
675 if (stat (backup_path, &statbuf) != -1) {
676 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
677 ret = NOTMUCH_STATUS_FILE_ERROR;
680 if (errno != ENOENT) {
681 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
683 ret = NOTMUCH_STATUS_FILE_ERROR;
687 /* Unconditionally attempt to remove old work-in-progress database (if
688 * any). This is "protected" by database lock. If this fails due to write
689 * errors (etc), the following code will fail and provide error message.
691 (void) rmtree (compact_xapian_path);
694 NotmuchCompactor compactor (status_cb, closure);
695 notmuch->xapian_db->compact (compact_xapian_path, Xapian::DBCOMPACT_NO_RENUMBER, 0, compactor);
696 } catch (const Xapian::Error &error) {
697 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg ().c_str ());
698 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
702 if (rename (xapian_path, backup_path)) {
703 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
704 xapian_path, backup_path, strerror (errno));
705 ret = NOTMUCH_STATUS_FILE_ERROR;
709 if (rename (compact_xapian_path, xapian_path)) {
710 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
711 compact_xapian_path, xapian_path, strerror (errno));
712 ret = NOTMUCH_STATUS_FILE_ERROR;
717 if (rmtree (backup_path)) {
718 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
719 backup_path, strerror (errno));
720 ret = NOTMUCH_STATUS_FILE_ERROR;
727 notmuch_status_t ret2;
729 const char *str = notmuch_database_status_string (notmuch);
730 if (status_cb && str)
731 status_cb (str, closure);
733 ret2 = notmuch_database_destroy (notmuch);
735 /* don't clobber previous error status */
736 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
746 notmuch_database_destroy (notmuch_database_t *notmuch)
748 notmuch_status_t status;
750 status = notmuch_database_close (notmuch);
752 delete notmuch->term_gen;
753 notmuch->term_gen = NULL;
754 delete notmuch->query_parser;
755 notmuch->query_parser = NULL;
756 delete notmuch->xapian_db;
757 notmuch->xapian_db = NULL;
758 delete notmuch->value_range_processor;
759 notmuch->value_range_processor = NULL;
760 delete notmuch->date_range_processor;
761 notmuch->date_range_processor = NULL;
762 delete notmuch->last_mod_range_processor;
763 notmuch->last_mod_range_processor = NULL;
765 talloc_free (notmuch);
771 notmuch_database_get_path (notmuch_database_t *notmuch)
773 return notmuch->path;
777 notmuch_database_get_version (notmuch_database_t *notmuch)
779 unsigned int version;
780 string version_string;
785 version_string = notmuch->xapian_db->get_metadata ("version");
786 } catch (const Xapian::Error &error) {
787 LOG_XAPIAN_EXCEPTION (notmuch, error);
791 if (version_string.empty ())
794 str = version_string.c_str ();
795 if (str == NULL || *str == '\0')
798 version = strtoul (str, &end, 10);
800 INTERNAL_ERROR ("Malformed database version: %s", str);
806 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
808 unsigned int version;
810 if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
813 if (NOTMUCH_FEATURES_CURRENT & ~notmuch->features)
816 version = notmuch_database_get_version (notmuch);
818 return (version > 0 && version < NOTMUCH_DATABASE_VERSION);
821 static volatile sig_atomic_t do_progress_notify = 0;
824 handle_sigalrm (unused (int signal))
826 do_progress_notify = 1;
829 /* Upgrade the current database.
831 * After opening a database in read-write mode, the client should
832 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
833 * if so, upgrade with this function before making any modifications.
835 * The optional progress_notify callback can be used by the caller to
836 * provide progress indication to the user. If non-NULL it will be
837 * called periodically with 'count' as the number of messages upgraded
838 * so far and 'total' the overall number of messages that will be
842 notmuch_database_upgrade (notmuch_database_t *notmuch,
843 void (*progress_notify) (void *closure,
847 void *local = talloc_new (NULL);
848 Xapian::TermIterator t, t_end;
849 Xapian::WritableDatabase *db;
850 struct sigaction action;
851 struct itimerval timerval;
852 bool timer_is_active = false;
853 enum _notmuch_features target_features, new_features;
854 notmuch_status_t status;
855 notmuch_private_status_t private_status;
856 notmuch_query_t *query = NULL;
857 unsigned int count = 0, total = 0;
859 status = _notmuch_database_ensure_writable (notmuch);
863 db = notmuch->writable_xapian_db;
865 target_features = notmuch->features | NOTMUCH_FEATURES_CURRENT;
866 new_features = NOTMUCH_FEATURES_CURRENT & ~notmuch->features;
868 if (! notmuch_database_needs_upgrade (notmuch))
869 return NOTMUCH_STATUS_SUCCESS;
871 if (progress_notify) {
872 /* Set up our handler for SIGALRM */
873 memset (&action, 0, sizeof (struct sigaction));
874 action.sa_handler = handle_sigalrm;
875 sigemptyset (&action.sa_mask);
876 action.sa_flags = SA_RESTART;
877 sigaction (SIGALRM, &action, NULL);
879 /* Then start a timer to send SIGALRM once per second. */
880 timerval.it_interval.tv_sec = 1;
881 timerval.it_interval.tv_usec = 0;
882 timerval.it_value.tv_sec = 1;
883 timerval.it_value.tv_usec = 0;
884 setitimer (ITIMER_REAL, &timerval, NULL);
886 timer_is_active = true;
889 /* Figure out how much total work we need to do. */
891 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
892 NOTMUCH_FEATURE_LAST_MOD)) {
893 query = notmuch_query_create (notmuch, "");
896 status = notmuch_query_count_messages (query, &msg_count);
901 notmuch_query_destroy (query);
904 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
905 t_end = db->allterms_end ("XTIMESTAMP");
906 for (t = db->allterms_begin ("XTIMESTAMP"); t != t_end; t++)
909 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
910 /* The ghost message upgrade converts all thread_id_*
911 * metadata values into ghost message documents. */
912 t_end = db->metadata_keys_end ("thread_id_");
913 for (t = db->metadata_keys_begin ("thread_id_"); t != t_end; ++t)
917 /* Perform the upgrade in a transaction. */
918 db->begin_transaction (true);
920 /* Set the target features so we write out changes in the desired
922 notmuch->features = target_features;
924 /* Perform per-message upgrades. */
926 (NOTMUCH_FEATURE_FILE_TERMS | NOTMUCH_FEATURE_BOOL_FOLDER |
927 NOTMUCH_FEATURE_LAST_MOD)) {
928 notmuch_messages_t *messages;
929 notmuch_message_t *message;
932 query = notmuch_query_create (notmuch, "");
934 status = notmuch_query_search_messages (query, &messages);
938 notmuch_messages_valid (messages);
939 notmuch_messages_move_to_next (messages)) {
940 if (do_progress_notify) {
941 progress_notify (closure, (double) count / total);
942 do_progress_notify = 0;
945 message = notmuch_messages_get (messages);
947 /* Before version 1, each message document had its
948 * filename in the data field. Copy that into the new
949 * format by calling notmuch_message_add_filename.
951 if (new_features & NOTMUCH_FEATURE_FILE_TERMS) {
952 filename = _notmuch_message_talloc_copy_data (message);
953 if (filename && *filename != '\0') {
954 _notmuch_message_add_filename (message, filename);
955 _notmuch_message_clear_data (message);
957 talloc_free (filename);
960 /* Prior to version 2, the "folder:" prefix was
961 * probabilistic and stemmed. Change it to the current
962 * boolean prefix. Add "path:" prefixes while at it.
964 if (new_features & NOTMUCH_FEATURE_BOOL_FOLDER)
965 _notmuch_message_upgrade_folder (message);
967 /* Prior to NOTMUCH_FEATURE_LAST_MOD, messages did not
968 * track modification revisions. Give all messages the
969 * next available revision; since we just started tracking
970 * revisions for this database, that will be 1.
972 if (new_features & NOTMUCH_FEATURE_LAST_MOD)
973 _notmuch_message_upgrade_last_mod (message);
975 _notmuch_message_sync (message);
977 notmuch_message_destroy (message);
982 notmuch_query_destroy (query);
986 /* Perform per-directory upgrades. */
988 /* Before version 1 we stored directory timestamps in
989 * XTIMESTAMP documents instead of the current XDIRECTORY
990 * documents. So copy those as well. */
991 if (new_features & NOTMUCH_FEATURE_DIRECTORY_DOCS) {
992 t_end = notmuch->xapian_db->allterms_end ("XTIMESTAMP");
994 for (t = notmuch->xapian_db->allterms_begin ("XTIMESTAMP");
997 Xapian::PostingIterator p, p_end;
998 std::string term = *t;
1000 p_end = notmuch->xapian_db->postlist_end (term);
1002 for (p = notmuch->xapian_db->postlist_begin (term);
1005 Xapian::Document document;
1007 notmuch_directory_t *directory;
1009 if (do_progress_notify) {
1010 progress_notify (closure, (double) count / total);
1011 do_progress_notify = 0;
1014 document = find_document_for_doc_id (notmuch, *p);
1015 mtime = Xapian::sortable_unserialise (
1016 document.get_value (NOTMUCH_VALUE_TIMESTAMP));
1018 directory = _notmuch_directory_find_or_create (notmuch, term.c_str () + 10,
1019 NOTMUCH_FIND_CREATE, &status);
1020 notmuch_directory_set_mtime (directory, mtime);
1021 notmuch_directory_destroy (directory);
1023 db->delete_document (*p);
1030 /* Perform metadata upgrades. */
1032 /* Prior to NOTMUCH_FEATURE_GHOSTS, thread IDs for missing
1033 * messages were stored as database metadata. Change these to
1036 if (new_features & NOTMUCH_FEATURE_GHOSTS) {
1037 notmuch_message_t *message;
1038 std::string message_id, thread_id;
1040 t_end = db->metadata_keys_end (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1041 for (t = db->metadata_keys_begin (NOTMUCH_METADATA_THREAD_ID_PREFIX);
1043 if (do_progress_notify) {
1044 progress_notify (closure, (double) count / total);
1045 do_progress_notify = 0;
1048 message_id = (*t).substr (
1049 strlen (NOTMUCH_METADATA_THREAD_ID_PREFIX));
1050 thread_id = db->get_metadata (*t);
1052 /* Create ghost message */
1053 message = _notmuch_message_create_for_message_id (
1054 notmuch, message_id.c_str (), &private_status);
1055 if (private_status == NOTMUCH_PRIVATE_STATUS_SUCCESS) {
1056 /* Document already exists; ignore the stored thread ID */
1057 } else if (private_status ==
1058 NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND) {
1059 private_status = _notmuch_message_initialize_ghost (
1060 message, thread_id.c_str ());
1061 if (! private_status)
1062 _notmuch_message_sync (message);
1065 if (private_status) {
1066 _notmuch_database_log (notmuch,
1067 "Upgrade failed while creating ghost messages.\n");
1068 status = COERCE_STATUS (private_status, "Unexpected status from _notmuch_message_initialize_ghost");
1072 /* Clear saved metadata thread ID */
1073 db->set_metadata (*t, "");
1079 status = NOTMUCH_STATUS_SUCCESS;
1080 db->set_metadata ("features", _notmuch_database_print_features (local, notmuch->features));
1081 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1084 if (status == NOTMUCH_STATUS_SUCCESS)
1085 db->commit_transaction ();
1087 db->cancel_transaction ();
1089 if (timer_is_active) {
1090 /* Now stop the timer. */
1091 timerval.it_interval.tv_sec = 0;
1092 timerval.it_interval.tv_usec = 0;
1093 timerval.it_value.tv_sec = 0;
1094 timerval.it_value.tv_usec = 0;
1095 setitimer (ITIMER_REAL, &timerval, NULL);
1097 /* And disable the signal handler. */
1098 action.sa_handler = SIG_IGN;
1099 sigaction (SIGALRM, &action, NULL);
1103 notmuch_query_destroy (query);
1105 talloc_free (local);
1110 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1112 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1113 notmuch->atomic_nesting > 0)
1116 if (notmuch_database_needs_upgrade (notmuch))
1117 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1120 notmuch->writable_xapian_db->begin_transaction (false);
1121 } catch (const Xapian::Error &error) {
1122 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1123 error.get_msg ().c_str ());
1124 notmuch->exception_reported = true;
1125 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1129 notmuch->atomic_nesting++;
1130 return NOTMUCH_STATUS_SUCCESS;
1134 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1136 Xapian::WritableDatabase *db;
1138 if (notmuch->atomic_nesting == 0)
1139 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1141 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1142 notmuch->atomic_nesting > 1)
1145 db = notmuch->writable_xapian_db;
1147 db->commit_transaction ();
1149 /* This is a hack for testing. Xapian never flushes on a
1150 * non-flushed commit, even if the flush threshold is 1.
1151 * However, we rely on flushing to test atomicity. */
1152 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1153 if (thresh && atoi (thresh) == 1)
1155 } catch (const Xapian::Error &error) {
1156 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1157 error.get_msg ().c_str ());
1158 notmuch->exception_reported = true;
1159 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1162 if (notmuch->atomic_dirty) {
1163 ++notmuch->revision;
1164 notmuch->atomic_dirty = false;
1168 notmuch->atomic_nesting--;
1169 return NOTMUCH_STATUS_SUCCESS;
1173 notmuch_database_get_revision (notmuch_database_t *notmuch,
1177 *uuid = notmuch->uuid;
1178 return notmuch->revision;
1181 /* We allow the user to use arbitrarily long paths for directories. But
1182 * we have a term-length limit. So if we exceed that, we'll use the
1183 * SHA-1 of the path for the database term.
1185 * Note: This function may return the original value of 'path'. If it
1186 * does not, then the caller is responsible to free() the returned
1190 _notmuch_database_get_directory_db_path (const char *path)
1192 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1194 if (term_len > NOTMUCH_TERM_MAX)
1195 return _notmuch_sha1_of_string (path);
1200 /* Given a path, split it into two parts: the directory part is all
1201 * components except for the last, and the basename is that last
1202 * component. Getting the return-value for either part is optional
1203 * (the caller can pass NULL).
1205 * The original 'path' can represent either a regular file or a
1206 * directory---the splitting will be carried out in the same way in
1207 * either case. Trailing slashes on 'path' will be ignored, and any
1208 * cases of multiple '/' characters appearing in series will be
1209 * treated as a single '/'.
1211 * Allocation (if any) will have 'ctx' as the talloc owner. But
1212 * pointers will be returned within the original path string whenever
1215 * Note: If 'path' is non-empty and contains no non-trailing slash,
1216 * (that is, consists of a filename with no parent directory), then
1217 * the directory returned will be an empty string. However, if 'path'
1218 * is an empty string, then both directory and basename will be
1222 _notmuch_database_split_path (void *ctx,
1224 const char **directory,
1225 const char **basename)
1229 if (path == NULL || *path == '\0') {
1234 return NOTMUCH_STATUS_SUCCESS;
1237 /* Find the last slash (not counting a trailing slash), if any. */
1239 slash = path + strlen (path) - 1;
1241 /* First, skip trailing slashes. */
1242 while (slash != path && *slash == '/')
1245 /* Then, find a slash. */
1246 while (slash != path && *slash != '/') {
1253 /* Finally, skip multiple slashes. */
1254 while (slash != path && *(slash - 1) == '/')
1257 if (slash == path) {
1259 *directory = talloc_strdup (ctx, "");
1264 *directory = talloc_strndup (ctx, path, slash - path);
1267 return NOTMUCH_STATUS_SUCCESS;
1270 /* Find the document ID of the specified directory.
1272 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1273 * created if one does not exist for 'path'. Otherwise, if the
1274 * directory document does not exist, this sets *directory_id to
1275 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1278 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1280 notmuch_find_flags_t flags,
1281 unsigned int *directory_id)
1283 notmuch_directory_t *directory;
1284 notmuch_status_t status;
1288 return NOTMUCH_STATUS_SUCCESS;
1291 directory = _notmuch_directory_find_or_create (notmuch, path, flags, &status);
1292 if (status || ! directory) {
1297 *directory_id = _notmuch_directory_get_document_id (directory);
1299 notmuch_directory_destroy (directory);
1301 return NOTMUCH_STATUS_SUCCESS;
1305 _notmuch_database_get_directory_path (void *ctx,
1306 notmuch_database_t *notmuch,
1307 unsigned int doc_id)
1309 Xapian::Document document;
1311 document = find_document_for_doc_id (notmuch, doc_id);
1313 return talloc_strdup (ctx, document.get_data ().c_str ());
1316 /* Given a legal 'filename' for the database, (either relative to
1317 * database path or absolute with initial components identical to
1318 * database path), return a new string (with 'ctx' as the talloc
1319 * owner) suitable for use as a direntry term value.
1321 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1322 * will be created in the database as needed. Otherwise, if the
1323 * necessary directory documents do not exist, this sets
1324 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1327 _notmuch_database_filename_to_direntry (void *ctx,
1328 notmuch_database_t *notmuch,
1329 const char *filename,
1330 notmuch_find_flags_t flags,
1333 const char *relative, *directory, *basename;
1334 Xapian::docid directory_id;
1335 notmuch_status_t status;
1337 relative = _notmuch_database_relative_path (notmuch, filename);
1339 status = _notmuch_database_split_path (ctx, relative,
1340 &directory, &basename);
1344 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1346 if (status || directory_id == (unsigned int) -1) {
1351 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1353 return NOTMUCH_STATUS_SUCCESS;
1356 /* Given a legal 'path' for the database, return the relative path.
1358 * The return value will be a pointer to the original path contents,
1359 * and will be either the original string (if 'path' was relative) or
1360 * a portion of the string (if path was absolute and begins with the
1364 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1367 const char *db_path, *relative;
1368 unsigned int db_path_len;
1370 db_path = notmuch_database_get_path (notmuch);
1371 db_path_len = strlen (db_path);
1375 if (*relative == '/') {
1376 while (*relative == '/' && *(relative + 1) == '/')
1379 if (strncmp (relative, db_path, db_path_len) == 0) {
1380 relative += db_path_len;
1381 while (*relative == '/')
1390 notmuch_database_get_directory (notmuch_database_t *notmuch,
1392 notmuch_directory_t **directory)
1394 notmuch_status_t status;
1396 if (directory == NULL)
1397 return NOTMUCH_STATUS_NULL_POINTER;
1401 *directory = _notmuch_directory_find_or_create (notmuch, path,
1402 NOTMUCH_FIND_LOOKUP, &status);
1403 } catch (const Xapian::Error &error) {
1404 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1405 error.get_msg ().c_str ());
1406 notmuch->exception_reported = true;
1407 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1412 /* Allocate a document ID that satisfies the following criteria:
1414 * 1. The ID does not exist for any document in the Xapian database
1416 * 2. The ID was not previously returned from this function
1418 * 3. The ID is the smallest integer satisfying (1) and (2)
1420 * This function will trigger an internal error if these constraints
1421 * cannot all be satisfied, (that is, the pool of available document
1422 * IDs has been exhausted).
1425 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1427 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1429 notmuch->last_doc_id++;
1431 if (notmuch->last_doc_id == 0)
1432 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1434 return notmuch->last_doc_id;
1438 notmuch_database_remove_message (notmuch_database_t *notmuch,
1439 const char *filename)
1441 notmuch_status_t status;
1442 notmuch_message_t *message;
1444 status = notmuch_database_find_message_by_filename (notmuch, filename,
1447 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1448 status = _notmuch_message_remove_filename (message, filename);
1449 if (status == NOTMUCH_STATUS_SUCCESS)
1450 _notmuch_message_delete (message);
1451 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1452 _notmuch_message_sync (message);
1454 notmuch_message_destroy (message);
1461 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1462 const char *filename,
1463 notmuch_message_t **message_ret)
1466 const char *prefix = _find_prefix ("file-direntry");
1467 char *direntry, *term;
1468 Xapian::PostingIterator i, end;
1469 notmuch_status_t status;
1471 if (message_ret == NULL)
1472 return NOTMUCH_STATUS_NULL_POINTER;
1474 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
1475 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1477 /* return NULL on any failure */
1478 *message_ret = NULL;
1480 local = talloc_new (notmuch);
1483 status = _notmuch_database_filename_to_direntry (
1484 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
1485 if (status || ! direntry)
1488 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1490 find_doc_ids_for_term (notmuch, term, &i, &end);
1493 notmuch_private_status_t private_status;
1495 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1497 if (*message_ret == NULL)
1498 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1500 } catch (const Xapian::Error &error) {
1501 _notmuch_database_log (notmuch, "Error: A Xapian exception occurred finding message by filename: %s\n",
1502 error.get_msg ().c_str ());
1503 notmuch->exception_reported = true;
1504 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1508 talloc_free (local);
1510 if (status && *message_ret) {
1511 notmuch_message_destroy (*message_ret);
1512 *message_ret = NULL;
1517 notmuch_string_list_t *
1518 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1519 Xapian::TermIterator &end,
1522 int prefix_len = strlen (prefix);
1523 notmuch_string_list_t *list;
1525 list = _notmuch_string_list_create (ctx);
1526 if (unlikely (list == NULL))
1529 for (i.skip_to (prefix); i != end; i++) {
1530 /* Terminate loop at first term without desired prefix. */
1531 if (strncmp ((*i).c_str (), prefix, prefix_len))
1534 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1541 notmuch_database_get_all_tags (notmuch_database_t *db)
1543 Xapian::TermIterator i, end;
1544 notmuch_string_list_t *tags;
1547 i = db->xapian_db->allterms_begin ();
1548 end = db->xapian_db->allterms_end ();
1549 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1550 _find_prefix ("tag"));
1551 _notmuch_string_list_sort (tags);
1552 return _notmuch_tags_create (db, tags);
1553 } catch (const Xapian::Error &error) {
1554 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
1555 error.get_msg ().c_str ());
1556 db->exception_reported = true;
1562 notmuch_database_status_string (const notmuch_database_t *notmuch)
1564 return notmuch->status_string;