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)
54 _notmuch_database_log (notmuch,
55 "A Xapian exception occurred at %s: %s\n",
57 error.get_msg ().c_str ());
58 notmuch->exception_reported = true;
61 notmuch_database_mode_t
62 _notmuch_database_mode (notmuch_database_t *notmuch)
64 if (notmuch->writable_xapian_db)
65 return NOTMUCH_DATABASE_MODE_READ_WRITE;
67 return NOTMUCH_DATABASE_MODE_READ_ONLY;
70 /* Here's the current schema for our database (for NOTMUCH_DATABASE_VERSION):
72 * We currently have three different types of documents (mail, ghost,
73 * and directory) and also some metadata.
75 * There are two kinds of prefixes used in notmuch. There are the
76 * human friendly 'prefix names' like "thread:", which are also used
77 * in the query parser, and the actual prefix terms in the database
78 * (e.g. "G"). The correspondence is maintained in the file scope data
79 * structure 'prefix_table'.
83 * A mail document is associated with a particular email message. It
84 * is stored in one or more files on disk and is uniquely identified
85 * by its "id" field (which is generally the message ID). It is
86 * indexed with the following prefixed terms which the database uses
87 * to construct threads, etc.:
89 * Single terms of given prefix:
93 * id: Unique ID of mail. This is from the Message-ID header
94 * if present and not too long (see NOTMUCH_MESSAGE_ID_MAX).
95 * If it's present and too long, then we use
96 * "notmuch-sha1-<sha1_sum_of_message_id>".
97 * If this header is not present, we use
98 * "notmuch-sha1-<sha1_sum_of_entire_file>".
100 * thread: The ID of the thread to which the mail belongs
102 * replyto: The ID from the In-Reply-To header of the mail (if any).
104 * Multiple terms of given prefix:
106 * reference: All message IDs from In-Reply-To and References
107 * headers in the message.
109 * tag: Any tags associated with this message by the user.
111 * file-direntry: A colon-separated pair of values
112 * (INTEGER:STRING), where INTEGER is the
113 * document ID of a directory document, and
114 * STRING is the name of a file within that
115 * directory for this mail message.
117 * property: Has a property with key=value
118 * FIXME: if no = is present, should match on any value
120 * A mail document also has four values:
122 * TIMESTAMP: The time_t value corresponding to the message's
125 * MESSAGE_ID: The unique ID of the mail mess (see "id" above)
127 * FROM: The value of the "From" header
129 * SUBJECT: The value of the "Subject" header
131 * LAST_MOD: The revision number as of the last tag or
134 * The prefixed terms described above are also searchable without an
135 * explicit field name, but as of notmuch 0.29 this is due to
136 * query-parser setup, not extra terms in the database. In addition,
137 * terms from the content of the message are added without a prefix
138 * for use by the user in searching. Note that the prefix name "body"
139 * is used to refer to the empty prefix string in the database.
141 * The path of the containing folder is added with the "folder" prefix
142 * (see _notmuch_message_add_folder_terms). Sub-paths of the the path
143 * of the mail message are added with the "path" prefix.
145 * The data portion of a mail document is empty.
147 * Ghost mail document [if NOTMUCH_FEATURE_GHOSTS]
148 * -----------------------------------------------
149 * A ghost mail document is like a mail document, but where we don't
150 * have the message content. These are used to track thread reference
151 * information for messages we haven't received.
153 * A ghost mail document has type: ghost; id and thread fields that
154 * are identical to the mail document fields; and a MESSAGE_ID value.
158 * A directory document is used by a client of the notmuch library to
159 * maintain data necessary to allow for efficient polling of mail
162 * All directory documents contain one term:
164 * directory: The directory path (relative to the database path)
165 * Or the SHA1 sum of the directory path (if the
166 * path itself is too long to fit in a Xapian
169 * And all directory documents for directories other than top-level
170 * directories also contain the following term:
172 * directory-direntry: A colon-separated pair of values
173 * (INTEGER:STRING), where INTEGER is the
174 * document ID of the parent directory
175 * document, and STRING is the name of this
176 * directory within that parent.
178 * All directory documents have a single value:
180 * TIMESTAMP: The mtime of the directory (at last scan)
182 * The data portion of a directory document contains the path of the
183 * directory (relative to the database path).
187 * Xapian allows us to store arbitrary name-value pairs as
188 * "metadata". We currently use the following metadata names with the
191 * version The database schema version, (which is distinct
192 * from both the notmuch package version (see
193 * notmuch --version) and the libnotmuch library
194 * version. The version is stored as an base-10
195 * ASCII integer. The initial database version
196 * was 1, (though a schema existed before that
197 * were no "version" database value existed at
198 * all). Successive versions are allocated as
199 * changes are made to the database (such as by
200 * indexing new fields).
202 * features The set of features supported by this
203 * database. This consists of a set of
204 * '\n'-separated lines, where each is a feature
205 * name, a '\t', and compatibility flags. If the
206 * compatibility flags contain 'w', then the
207 * opener must support this feature to safely
208 * write this database. If the compatibility
209 * flags contain 'r', then the opener must
210 * support this feature to read this database.
211 * Introduced in database version 3.
213 * last_thread_id The last thread ID generated. This is stored
214 * as a 16-byte hexadecimal ASCII representation
215 * of a 64-bit unsigned integer. The first ID
216 * generated is 1 and the value will be
217 * incremented for each thread ID.
219 * C* metadata keys starting with C indicate
220 * configuration data. It can be managed with the
221 * n_database_*config* API. There is a convention
222 * of hierarchical keys separated by '.' (e.g.
223 * query.notmuch stores the value for the named
224 * query 'notmuch'), but it is not enforced by the
230 * If ! NOTMUCH_FEATURE_GHOSTS, there are no ghost mail documents.
231 * Instead, the database has the following additional database
234 * thread_id_* A pre-allocated thread ID for a particular
235 * message. This is actually an arbitrarily large
236 * family of metadata name. Any particular name is
237 * formed by concatenating "thread_id_" with a message
238 * ID (or the SHA1 sum of a message ID if it is very
239 * long---see description of 'id' in the mail
240 * document). The value stored is a thread ID.
242 * These thread ID metadata values are stored
243 * whenever a message references a parent message
244 * that does not yet exist in the database. A
245 * thread ID will be allocated and stored, and if
246 * the message is later added, the stored thread
247 * ID will be used (and the metadata value will
250 * Even before a message is added, it's
251 * pre-allocated thread ID is useful so that all
252 * descendant messages that reference this common
253 * parent can be recognized as belonging to the
258 notmuch_string_map_iterator_t *
259 _notmuch_database_user_headers (notmuch_database_t *notmuch)
261 return _notmuch_string_map_iterator_create (notmuch->user_header, "", false);
265 notmuch_status_to_string (notmuch_status_t status)
268 case NOTMUCH_STATUS_SUCCESS:
269 return "No error occurred";
270 case NOTMUCH_STATUS_OUT_OF_MEMORY:
271 return "Out of memory";
272 case NOTMUCH_STATUS_READ_ONLY_DATABASE:
273 return "Attempt to write to a read-only database";
274 case NOTMUCH_STATUS_XAPIAN_EXCEPTION:
275 return "A Xapian exception occurred";
276 case NOTMUCH_STATUS_FILE_ERROR:
277 return "Something went wrong trying to read or write a file";
278 case NOTMUCH_STATUS_FILE_NOT_EMAIL:
279 return "File is not an email";
280 case NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID:
281 return "Message ID is identical to a message in database";
282 case NOTMUCH_STATUS_NULL_POINTER:
283 return "Erroneous NULL pointer";
284 case NOTMUCH_STATUS_TAG_TOO_LONG:
285 return "Tag value is too long (exceeds NOTMUCH_TAG_MAX)";
286 case NOTMUCH_STATUS_UNBALANCED_FREEZE_THAW:
287 return "Unbalanced number of calls to notmuch_message_freeze/thaw";
288 case NOTMUCH_STATUS_UNBALANCED_ATOMIC:
289 return "Unbalanced number of calls to notmuch_database_begin_atomic/end_atomic";
290 case NOTMUCH_STATUS_UNSUPPORTED_OPERATION:
291 return "Unsupported operation";
292 case NOTMUCH_STATUS_UPGRADE_REQUIRED:
293 return "Operation requires a database upgrade";
294 case NOTMUCH_STATUS_PATH_ERROR:
295 return "Path supplied is illegal for this function";
296 case NOTMUCH_STATUS_IGNORED:
297 return "Argument was ignored";
298 case NOTMUCH_STATUS_ILLEGAL_ARGUMENT:
299 return "Illegal argument for function";
300 case NOTMUCH_STATUS_MALFORMED_CRYPTO_PROTOCOL:
301 return "Crypto protocol missing, malformed, or unintelligible";
302 case NOTMUCH_STATUS_FAILED_CRYPTO_CONTEXT_CREATION:
303 return "Crypto engine initialization failure";
304 case NOTMUCH_STATUS_UNKNOWN_CRYPTO_PROTOCOL:
305 return "Unknown crypto protocol";
306 case NOTMUCH_STATUS_NO_CONFIG:
307 return "No configuration file found";
308 case NOTMUCH_STATUS_NO_DATABASE:
309 return "No database found";
310 case NOTMUCH_STATUS_DATABASE_EXISTS:
311 return "Database exists, not recreated";
312 case NOTMUCH_STATUS_BAD_QUERY_SYNTAX:
313 return "Syntax error in query";
314 case NOTMUCH_STATUS_NO_MAIL_ROOT:
315 return "No mail root found";
317 case NOTMUCH_STATUS_LAST_STATUS:
318 return "Unknown error status value";
323 _notmuch_database_log (notmuch_database_t *notmuch,
329 va_start (va_args, format);
331 if (notmuch->status_string)
332 talloc_free (notmuch->status_string);
334 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
339 _notmuch_database_log_append (notmuch_database_t *notmuch,
345 va_start (va_args, format);
347 if (notmuch->status_string)
348 notmuch->status_string = talloc_vasprintf_append (notmuch->status_string, format, va_args);
350 notmuch->status_string = talloc_vasprintf (notmuch, format, va_args);
356 find_doc_ids_for_term (notmuch_database_t *notmuch,
358 Xapian::PostingIterator *begin,
359 Xapian::PostingIterator *end)
361 *begin = notmuch->xapian_db->postlist_begin (term);
363 *end = notmuch->xapian_db->postlist_end (term);
367 _notmuch_database_find_doc_ids (notmuch_database_t *notmuch,
368 const char *prefix_name,
370 Xapian::PostingIterator *begin,
371 Xapian::PostingIterator *end)
375 term = talloc_asprintf (notmuch, "%s%s",
376 _find_prefix (prefix_name), value);
378 find_doc_ids_for_term (notmuch, term, begin, end);
383 notmuch_private_status_t
384 _notmuch_database_find_unique_doc_id (notmuch_database_t *notmuch,
385 const char *prefix_name,
387 unsigned int *doc_id)
389 Xapian::PostingIterator i, end;
391 _notmuch_database_find_doc_ids (notmuch, prefix_name, value, &i, &end);
395 return NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND;
400 #if DEBUG_DATABASE_SANITY
404 INTERNAL_ERROR ("Term %s:%s is not unique as expected.\n",
408 return NOTMUCH_PRIVATE_STATUS_SUCCESS;
411 static Xapian::Document
412 find_document_for_doc_id (notmuch_database_t *notmuch, unsigned doc_id)
414 return notmuch->xapian_db->get_document (doc_id);
417 /* Generate a compressed version of 'message_id' of the form:
419 * notmuch-sha1-<sha1_sum_of_message_id>
422 _notmuch_message_id_compressed (void *ctx, const char *message_id)
424 char *sha1, *compressed;
426 sha1 = _notmuch_sha1_of_string (message_id);
428 compressed = talloc_asprintf (ctx, "notmuch-sha1-%s", sha1);
435 notmuch_database_find_message (notmuch_database_t *notmuch,
436 const char *message_id,
437 notmuch_message_t **message_ret)
439 notmuch_private_status_t status;
442 if (message_ret == NULL)
443 return NOTMUCH_STATUS_NULL_POINTER;
445 if (strlen (message_id) > NOTMUCH_MESSAGE_ID_MAX)
446 message_id = _notmuch_message_id_compressed (notmuch, message_id);
449 status = _notmuch_database_find_unique_doc_id (notmuch, "id",
450 message_id, &doc_id);
452 if (status == NOTMUCH_PRIVATE_STATUS_NO_DOCUMENT_FOUND)
455 *message_ret = _notmuch_message_create (notmuch, notmuch, doc_id,
457 if (*message_ret == NULL)
458 return NOTMUCH_STATUS_OUT_OF_MEMORY;
461 return NOTMUCH_STATUS_SUCCESS;
462 } catch (const Xapian::Error &error) {
463 _notmuch_database_log (notmuch, "A Xapian exception occurred finding message: %s.\n",
464 error.get_msg ().c_str ());
465 notmuch->exception_reported = true;
467 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
472 _notmuch_database_ensure_writable (notmuch_database_t *notmuch)
474 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY) {
475 _notmuch_database_log (notmuch, "Cannot write to a read-only database.\n");
476 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
479 if (! notmuch->open) {
480 _notmuch_database_log (notmuch, "Cannot write to a closed database.\n");
481 return NOTMUCH_STATUS_CLOSED_DATABASE;
484 return NOTMUCH_STATUS_SUCCESS;
487 /* Allocate a revision number for the next change. */
489 _notmuch_database_new_revision (notmuch_database_t *notmuch)
491 unsigned long new_revision = notmuch->revision + 1;
493 /* If we're in an atomic section, hold off on updating the
494 * committed revision number until we commit the atomic section.
496 if (notmuch->atomic_nesting)
497 notmuch->atomic_dirty = true;
499 notmuch->revision = new_revision;
505 notmuch_database_close (notmuch_database_t *notmuch)
507 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
509 /* Many Xapian objects (and thus notmuch objects) hold references to
510 * the database, so merely deleting the database may not suffice to
511 * close it. Thus, we explicitly close it here. */
514 /* Close the database. This implicitly flushes
515 * outstanding changes. If there is an open (non-flushed)
516 * transaction, ALL pending changes will be discarded */
517 notmuch->xapian_db->close ();
518 } catch (const Xapian::Error &error) {
519 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
520 if (! notmuch->exception_reported) {
521 _notmuch_database_log (notmuch,
522 "Error: A Xapian exception occurred closing database: %s\n",
523 error.get_msg ().c_str ());
527 notmuch->open = false;
532 unlink_cb (const char *path,
533 unused (const struct stat *sb),
535 unused (struct FTW *ftw))
537 return remove (path);
541 rmtree (const char *path)
543 return nftw (path, unlink_cb, 64, FTW_DEPTH | FTW_PHYS);
546 class NotmuchCompactor : public Xapian::Compactor
548 notmuch_compact_status_cb_t status_cb;
549 void *status_closure;
552 NotmuchCompactor(notmuch_compact_status_cb_t cb, void *closure) :
553 status_cb (cb), status_closure (closure)
558 set_status (const std::string &table, const std::string &status)
562 if (status_cb == NULL)
565 if (status.length () == 0)
566 msg = talloc_asprintf (NULL, "compacting table %s", table.c_str ());
568 msg = talloc_asprintf (NULL, " %s", status.c_str ());
574 status_cb (msg, status_closure);
579 /* Compacts the given database, optionally saving the original database
580 * in backup_path. Additionally, a callback function can be provided to
581 * give the user feedback on the progress of the (likely long-lived)
582 * compaction process.
584 * The backup path must point to a directory on the same volume as the
585 * original database. Passing a NULL backup_path will result in the
586 * uncompacted database being deleted after compaction has finished.
587 * Note that the database write lock will be held during the
588 * compaction process to protect data integrity.
591 notmuch_database_compact (const char *path,
592 const char *backup_path,
593 notmuch_compact_status_cb_t status_cb,
596 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
597 notmuch_database_t *notmuch = NULL;
598 char *message = NULL;
600 ret = notmuch_database_open_with_config (path,
601 NOTMUCH_DATABASE_MODE_READ_WRITE,
607 if (status_cb) status_cb (message, closure);
611 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
613 return notmuch_database_compact_db (notmuch,
620 notmuch_database_compact_db (notmuch_database_t *notmuch,
621 const char *backup_path,
622 notmuch_compact_status_cb_t status_cb,
626 const char *xapian_path, *compact_xapian_path;
628 notmuch_status_t ret = NOTMUCH_STATUS_SUCCESS;
633 ret = _notmuch_database_ensure_writable (notmuch);
637 path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
639 return NOTMUCH_STATUS_PATH_ERROR;
641 local = talloc_new (NULL);
643 return NOTMUCH_STATUS_OUT_OF_MEMORY;
645 ret = _notmuch_choose_xapian_path (local, path, &xapian_path, &message);
649 if (! (compact_xapian_path = talloc_asprintf (local, "%s.compact", xapian_path))) {
650 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
654 if (backup_path == NULL) {
655 if (! (backup_path = talloc_asprintf (local, "%s.old", xapian_path))) {
656 ret = NOTMUCH_STATUS_OUT_OF_MEMORY;
664 if (stat (backup_path, &statbuf) != -1) {
665 _notmuch_database_log (notmuch, "Path already exists: %s\n", backup_path);
666 ret = NOTMUCH_STATUS_FILE_ERROR;
669 if (errno != ENOENT) {
670 _notmuch_database_log (notmuch, "Unknown error while stat()ing path: %s\n",
672 ret = NOTMUCH_STATUS_FILE_ERROR;
676 /* Unconditionally attempt to remove old work-in-progress database (if
677 * any). This is "protected" by database lock. If this fails due to write
678 * errors (etc), the following code will fail and provide error message.
680 (void) rmtree (compact_xapian_path);
683 NotmuchCompactor compactor (status_cb, closure);
684 notmuch->xapian_db->compact (compact_xapian_path, Xapian::DBCOMPACT_NO_RENUMBER, 0,
686 } catch (const Xapian::Error &error) {
687 _notmuch_database_log (notmuch, "Error while compacting: %s\n", error.get_msg ().c_str ());
688 ret = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
692 if (rename (xapian_path, backup_path)) {
693 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
694 xapian_path, backup_path, strerror (errno));
695 ret = NOTMUCH_STATUS_FILE_ERROR;
699 if (rename (compact_xapian_path, xapian_path)) {
700 _notmuch_database_log (notmuch, "Error moving %s to %s: %s\n",
701 compact_xapian_path, xapian_path, strerror (errno));
702 ret = NOTMUCH_STATUS_FILE_ERROR;
707 if (rmtree (backup_path)) {
708 _notmuch_database_log (notmuch, "Error removing old database %s: %s\n",
709 backup_path, strerror (errno));
710 ret = NOTMUCH_STATUS_FILE_ERROR;
717 notmuch_status_t ret2;
719 const char *str = notmuch_database_status_string (notmuch);
720 if (status_cb && str)
721 status_cb (str, closure);
723 ret2 = notmuch_database_destroy (notmuch);
725 /* don't clobber previous error status */
726 if (ret == NOTMUCH_STATUS_SUCCESS && ret2 != NOTMUCH_STATUS_SUCCESS)
736 notmuch_database_destroy (notmuch_database_t *notmuch)
738 notmuch_status_t status;
739 const char *talloc_report;
741 talloc_report = getenv ("NOTMUCH_TALLOC_REPORT");
742 if (talloc_report && strcmp (talloc_report, "") != 0) {
743 FILE *report = fopen (talloc_report, "a");
745 talloc_report_full (notmuch, report);
749 status = notmuch_database_close (notmuch);
751 delete notmuch->term_gen;
752 notmuch->term_gen = NULL;
753 delete notmuch->query_parser;
754 notmuch->query_parser = NULL;
755 delete notmuch->xapian_db;
756 notmuch->xapian_db = NULL;
757 delete notmuch->value_range_processor;
758 notmuch->value_range_processor = NULL;
759 delete notmuch->date_range_processor;
760 notmuch->date_range_processor = NULL;
761 delete notmuch->last_mod_range_processor;
762 notmuch->last_mod_range_processor = NULL;
763 delete notmuch->stemmer;
764 notmuch->stemmer = NULL;
766 talloc_free (notmuch);
772 notmuch_database_get_path (notmuch_database_t *notmuch)
774 return notmuch_config_get (notmuch, NOTMUCH_CONFIG_DATABASE_PATH);
778 notmuch_database_get_version (notmuch_database_t *notmuch)
780 unsigned int version;
781 string version_string;
786 version_string = notmuch->xapian_db->get_metadata ("version");
787 } catch (const Xapian::Error &error) {
788 LOG_XAPIAN_EXCEPTION (notmuch, error);
792 if (version_string.empty ())
795 str = version_string.c_str ();
796 if (str == NULL || *str == '\0')
799 version = strtoul (str, &end, 10);
801 INTERNAL_ERROR ("Malformed database version: %s", str);
807 notmuch_database_needs_upgrade (notmuch_database_t *notmuch)
809 unsigned int version;
811 if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
814 if (NOTMUCH_FEATURES_CURRENT & ~notmuch->features)
817 version = notmuch_database_get_version (notmuch);
819 return (version > 0 && version < NOTMUCH_DATABASE_VERSION);
822 static volatile sig_atomic_t do_progress_notify = 0;
825 handle_sigalrm (unused (int signal))
827 do_progress_notify = 1;
830 /* Upgrade the current database.
832 * After opening a database in read-write mode, the client should
833 * check if an upgrade is needed (notmuch_database_needs_upgrade) and
834 * if so, upgrade with this function before making any modifications.
836 * The optional progress_notify callback can be used by the caller to
837 * provide progress indication to the user. If non-NULL it will be
838 * called periodically with 'count' as the number of messages upgraded
839 * so far and 'total' the overall number of messages that will be
843 notmuch_database_upgrade (notmuch_database_t *notmuch,
844 void (*progress_notify)(void *closure,
848 void *local = talloc_new (NULL);
849 Xapian::TermIterator t, t_end;
850 Xapian::WritableDatabase *db;
851 struct sigaction action;
852 struct itimerval timerval;
853 bool timer_is_active = false;
854 enum _notmuch_features target_features, new_features;
855 notmuch_status_t status;
856 notmuch_private_status_t private_status;
857 notmuch_query_t *query = NULL;
858 unsigned int count = 0, total = 0;
860 if (_notmuch_database_mode (notmuch) != NOTMUCH_DATABASE_MODE_READ_WRITE)
861 return NOTMUCH_STATUS_READ_ONLY_DATABASE;
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,
1069 "Unexpected status from _notmuch_message_initialize_ghost");
1073 /* Clear saved metadata thread ID */
1074 db->set_metadata (*t, "");
1080 status = NOTMUCH_STATUS_SUCCESS;
1081 db->set_metadata ("features", _notmuch_database_print_features (local, notmuch->features));
1082 db->set_metadata ("version", STRINGIFY (NOTMUCH_DATABASE_VERSION));
1085 if (status == NOTMUCH_STATUS_SUCCESS)
1086 db->commit_transaction ();
1088 db->cancel_transaction ();
1090 if (timer_is_active) {
1091 /* Now stop the timer. */
1092 timerval.it_interval.tv_sec = 0;
1093 timerval.it_interval.tv_usec = 0;
1094 timerval.it_value.tv_sec = 0;
1095 timerval.it_value.tv_usec = 0;
1096 setitimer (ITIMER_REAL, &timerval, NULL);
1098 /* And disable the signal handler. */
1099 action.sa_handler = SIG_IGN;
1100 sigaction (SIGALRM, &action, NULL);
1104 notmuch_query_destroy (query);
1106 talloc_free (local);
1111 notmuch_database_begin_atomic (notmuch_database_t *notmuch)
1113 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1114 notmuch->atomic_nesting > 0)
1117 if (notmuch_database_needs_upgrade (notmuch))
1118 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1121 notmuch->writable_xapian_db->begin_transaction (false);
1122 } catch (const Xapian::Error &error) {
1123 _notmuch_database_log (notmuch, "A Xapian exception occurred beginning transaction: %s.\n",
1124 error.get_msg ().c_str ());
1125 notmuch->exception_reported = true;
1126 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1130 notmuch->atomic_nesting++;
1131 return NOTMUCH_STATUS_SUCCESS;
1135 notmuch_database_end_atomic (notmuch_database_t *notmuch)
1137 Xapian::WritableDatabase *db;
1139 if (notmuch->atomic_nesting == 0)
1140 return NOTMUCH_STATUS_UNBALANCED_ATOMIC;
1142 if (_notmuch_database_mode (notmuch) == NOTMUCH_DATABASE_MODE_READ_ONLY ||
1143 notmuch->atomic_nesting > 1)
1146 db = notmuch->writable_xapian_db;
1148 db->commit_transaction ();
1149 notmuch->transaction_count++;
1151 /* Xapian never flushes on a non-flushed commit, even if the
1152 * flush threshold is 1. However, we rely on flushing to test
1153 * atomicity. On the other hand, we can't straight replace
1154 * XAPIAN_FLUSH_THRESHOLD with our autocommit counter, because
1155 * the former also applies outside notmuch atomic
1156 * commits. Hence the follow complicated test */
1157 const char *thresh = getenv ("XAPIAN_FLUSH_THRESHOLD");
1158 if ((notmuch->transaction_threshold > 0 &&
1159 notmuch->transaction_count >= notmuch->transaction_threshold) ||
1160 (thresh && atoi (thresh) == 1)) {
1162 notmuch->transaction_count = 0;
1164 } catch (const Xapian::Error &error) {
1165 _notmuch_database_log (notmuch, "A Xapian exception occurred committing transaction: %s.\n",
1166 error.get_msg ().c_str ());
1167 notmuch->exception_reported = true;
1168 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1171 if (notmuch->atomic_dirty) {
1172 ++notmuch->revision;
1173 notmuch->atomic_dirty = false;
1177 notmuch->atomic_nesting--;
1178 return NOTMUCH_STATUS_SUCCESS;
1182 notmuch_database_get_revision (notmuch_database_t *notmuch,
1186 *uuid = notmuch->uuid;
1187 return notmuch->revision;
1190 /* We allow the user to use arbitrarily long paths for directories. But
1191 * we have a term-length limit. So if we exceed that, we'll use the
1192 * SHA-1 of the path for the database term.
1194 * Note: This function may return the original value of 'path'. If it
1195 * does not, then the caller is responsible to free() the returned
1199 _notmuch_database_get_directory_db_path (const char *path)
1201 int term_len = strlen (_find_prefix ("directory")) + strlen (path);
1203 if (term_len > NOTMUCH_TERM_MAX)
1204 return _notmuch_sha1_of_string (path);
1209 /* Given a path, split it into two parts: the directory part is all
1210 * components except for the last, and the basename is that last
1211 * component. Getting the return-value for either part is optional
1212 * (the caller can pass NULL).
1214 * The original 'path' can represent either a regular file or a
1215 * directory---the splitting will be carried out in the same way in
1216 * either case. Trailing slashes on 'path' will be ignored, and any
1217 * cases of multiple '/' characters appearing in series will be
1218 * treated as a single '/'.
1220 * Allocation (if any) will have 'ctx' as the talloc owner. But
1221 * pointers will be returned within the original path string whenever
1224 * Note: If 'path' is non-empty and contains no non-trailing slash,
1225 * (that is, consists of a filename with no parent directory), then
1226 * the directory returned will be an empty string. However, if 'path'
1227 * is an empty string, then both directory and basename will be
1231 _notmuch_database_split_path (void *ctx,
1233 const char **directory,
1234 const char **basename)
1238 if (path == NULL || *path == '\0') {
1243 return NOTMUCH_STATUS_SUCCESS;
1246 /* Find the last slash (not counting a trailing slash), if any. */
1248 slash = path + strlen (path) - 1;
1250 /* First, skip trailing slashes. */
1251 while (slash != path && *slash == '/')
1254 /* Then, find a slash. */
1255 while (slash != path && *slash != '/') {
1262 /* Finally, skip multiple slashes. */
1263 while (slash != path && *(slash - 1) == '/')
1266 if (slash == path) {
1268 *directory = talloc_strdup (ctx, "");
1273 *directory = talloc_strndup (ctx, path, slash - path);
1276 return NOTMUCH_STATUS_SUCCESS;
1279 /* Find the document ID of the specified directory.
1281 * If (flags & NOTMUCH_FIND_CREATE), a new directory document will be
1282 * created if one does not exist for 'path'. Otherwise, if the
1283 * directory document does not exist, this sets *directory_id to
1284 * ((unsigned int)-1) and returns NOTMUCH_STATUS_SUCCESS.
1287 _notmuch_database_find_directory_id (notmuch_database_t *notmuch,
1289 notmuch_find_flags_t flags,
1290 unsigned int *directory_id)
1292 notmuch_directory_t *directory;
1293 notmuch_status_t status;
1297 return NOTMUCH_STATUS_SUCCESS;
1300 directory = _notmuch_directory_find_or_create (notmuch, path, flags, &status);
1301 if (status || ! directory) {
1306 *directory_id = _notmuch_directory_get_document_id (directory);
1308 notmuch_directory_destroy (directory);
1310 return NOTMUCH_STATUS_SUCCESS;
1314 _notmuch_database_get_directory_path (void *ctx,
1315 notmuch_database_t *notmuch,
1316 unsigned int doc_id)
1318 Xapian::Document document;
1320 document = find_document_for_doc_id (notmuch, doc_id);
1322 return talloc_strdup (ctx, document.get_data ().c_str ());
1325 /* Given a legal 'filename' for the database, (either relative to
1326 * database path or absolute with initial components identical to
1327 * database path), return a new string (with 'ctx' as the talloc
1328 * owner) suitable for use as a direntry term value.
1330 * If (flags & NOTMUCH_FIND_CREATE), the necessary directory documents
1331 * will be created in the database as needed. Otherwise, if the
1332 * necessary directory documents do not exist, this sets
1333 * *direntry to NULL and returns NOTMUCH_STATUS_SUCCESS.
1336 _notmuch_database_filename_to_direntry (void *ctx,
1337 notmuch_database_t *notmuch,
1338 const char *filename,
1339 notmuch_find_flags_t flags,
1342 const char *relative, *directory, *basename;
1343 Xapian::docid directory_id;
1344 notmuch_status_t status;
1346 relative = _notmuch_database_relative_path (notmuch, filename);
1348 status = _notmuch_database_split_path (ctx, relative,
1349 &directory, &basename);
1353 status = _notmuch_database_find_directory_id (notmuch, directory, flags,
1355 if (status || directory_id == (unsigned int) -1) {
1360 *direntry = talloc_asprintf (ctx, "%u:%s", directory_id, basename);
1362 return NOTMUCH_STATUS_SUCCESS;
1365 /* Given a legal 'path' for the database, return the relative path.
1367 * The return value will be a pointer to the original path contents,
1368 * and will be either the original string (if 'path' was relative) or
1369 * a portion of the string (if path was absolute and begins with the
1373 _notmuch_database_relative_path (notmuch_database_t *notmuch,
1376 const char *db_path, *relative;
1377 unsigned int db_path_len;
1379 db_path = notmuch_config_get (notmuch, NOTMUCH_CONFIG_MAIL_ROOT);
1380 db_path_len = strlen (db_path);
1384 if (*relative == '/') {
1385 while (*relative == '/' && *(relative + 1) == '/')
1388 if (strncmp (relative, db_path, db_path_len) == 0) {
1389 relative += db_path_len;
1390 while (*relative == '/')
1399 notmuch_database_get_directory (notmuch_database_t *notmuch,
1401 notmuch_directory_t **directory)
1403 notmuch_status_t status;
1405 if (directory == NULL)
1406 return NOTMUCH_STATUS_NULL_POINTER;
1410 *directory = _notmuch_directory_find_or_create (notmuch, path,
1411 NOTMUCH_FIND_LOOKUP, &status);
1412 } catch (const Xapian::Error &error) {
1413 _notmuch_database_log (notmuch, "A Xapian exception occurred getting directory: %s.\n",
1414 error.get_msg ().c_str ());
1415 notmuch->exception_reported = true;
1416 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1421 /* Allocate a document ID that satisfies the following criteria:
1423 * 1. The ID does not exist for any document in the Xapian database
1425 * 2. The ID was not previously returned from this function
1427 * 3. The ID is the smallest integer satisfying (1) and (2)
1429 * This function will trigger an internal error if these constraints
1430 * cannot all be satisfied, (that is, the pool of available document
1431 * IDs has been exhausted).
1434 _notmuch_database_generate_doc_id (notmuch_database_t *notmuch)
1436 assert (notmuch->last_doc_id >= notmuch->xapian_db->get_lastdocid ());
1438 notmuch->last_doc_id++;
1440 if (notmuch->last_doc_id == 0)
1441 INTERNAL_ERROR ("Xapian document IDs are exhausted.\n");
1443 return notmuch->last_doc_id;
1447 notmuch_database_remove_message (notmuch_database_t *notmuch,
1448 const char *filename)
1450 notmuch_status_t status;
1451 notmuch_message_t *message;
1453 status = notmuch_database_find_message_by_filename (notmuch, filename,
1456 if (status == NOTMUCH_STATUS_SUCCESS && message) {
1457 if (notmuch_message_count_files (message) > 1) {
1458 status = _notmuch_message_remove_filename (message, filename);
1460 if (status == NOTMUCH_STATUS_SUCCESS)
1461 status = _notmuch_message_delete (message);
1462 else if (status == NOTMUCH_STATUS_DUPLICATE_MESSAGE_ID)
1463 _notmuch_message_sync (message);
1465 notmuch_message_destroy (message);
1472 notmuch_database_find_message_by_filename (notmuch_database_t *notmuch,
1473 const char *filename,
1474 notmuch_message_t **message_ret)
1477 const char *prefix = _find_prefix ("file-direntry");
1478 char *direntry, *term;
1479 Xapian::PostingIterator i, end;
1480 notmuch_status_t status;
1482 if (message_ret == NULL)
1483 return NOTMUCH_STATUS_NULL_POINTER;
1485 if (! (notmuch->features & NOTMUCH_FEATURE_FILE_TERMS))
1486 return NOTMUCH_STATUS_UPGRADE_REQUIRED;
1488 /* return NULL on any failure */
1489 *message_ret = NULL;
1491 local = talloc_new (notmuch);
1494 status = _notmuch_database_filename_to_direntry (
1495 local, notmuch, filename, NOTMUCH_FIND_LOOKUP, &direntry);
1496 if (status || ! direntry)
1499 term = talloc_asprintf (local, "%s%s", prefix, direntry);
1501 find_doc_ids_for_term (notmuch, term, &i, &end);
1504 notmuch_private_status_t private_status;
1506 *message_ret = _notmuch_message_create (notmuch, notmuch, *i,
1508 if (*message_ret == NULL)
1509 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
1511 } catch (const Xapian::Error &error) {
1512 _notmuch_database_log (notmuch,
1513 "Error: A Xapian exception occurred finding message by filename: %s\n",
1514 error.get_msg ().c_str ());
1515 notmuch->exception_reported = true;
1516 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
1520 talloc_free (local);
1522 if (status && *message_ret) {
1523 notmuch_message_destroy (*message_ret);
1524 *message_ret = NULL;
1529 notmuch_string_list_t *
1530 _notmuch_database_get_terms_with_prefix (void *ctx, Xapian::TermIterator &i,
1531 Xapian::TermIterator &end,
1534 int prefix_len = strlen (prefix);
1535 notmuch_string_list_t *list;
1537 list = _notmuch_string_list_create (ctx);
1538 if (unlikely (list == NULL))
1541 for (i.skip_to (prefix); i != end; i++) {
1542 /* Terminate loop at first term without desired prefix. */
1543 if (strncmp ((*i).c_str (), prefix, prefix_len))
1546 _notmuch_string_list_append (list, (*i).c_str () + prefix_len);
1553 notmuch_database_get_all_tags (notmuch_database_t *db)
1555 Xapian::TermIterator i, end;
1556 notmuch_string_list_t *tags;
1559 i = db->xapian_db->allterms_begin ();
1560 end = db->xapian_db->allterms_end ();
1561 tags = _notmuch_database_get_terms_with_prefix (db, i, end,
1562 _find_prefix ("tag"));
1563 _notmuch_string_list_sort (tags);
1564 return _notmuch_tags_create (db, tags);
1565 } catch (const Xapian::Error &error) {
1566 _notmuch_database_log (db, "A Xapian exception occurred getting tags: %s.\n",
1567 error.get_msg ().c_str ());
1568 db->exception_reported = true;
1574 notmuch_database_status_string (const notmuch_database_t *notmuch)
1576 return notmuch->status_string;
1580 _notmuch_database_indexable_as_text (notmuch_database_t *notmuch, const char *mime_string)
1582 for (size_t i = 0; i < notmuch->index_as_text_length; i++) {
1583 if (regexec (¬much->index_as_text[i], mime_string, 0, NULL, 0) == 0) {