4 #include "database-private.h"
5 #include "parse-time-vrp.h"
7 #if HAVE_XAPIAN_DB_RETRY_LOCK
8 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
10 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
14 notmuch_database_open (const char *path,
15 notmuch_database_mode_t mode,
16 notmuch_database_t **database)
18 char *status_string = NULL;
19 notmuch_status_t status;
21 status = notmuch_database_open_verbose (path, mode, database,
25 fputs (status_string, stderr);
33 notmuch_database_open_verbose (const char *path,
34 notmuch_database_mode_t mode,
35 notmuch_database_t **database,
38 return notmuch_database_open_with_config (path, mode, "", NULL,
39 database, status_string);
44 const char *xdg_root_variable,
45 const char *xdg_prefix,
46 const char *profile_name)
48 const char *xdg_root = getenv (xdg_root_variable);
51 const char *home = getenv ("HOME");
53 if (! home) return NULL;
55 xdg_root = talloc_asprintf (ctx,
62 profile_name = getenv ("NOTMUCH_PROFILE");
65 profile_name = "default";
67 return talloc_asprintf (ctx,
73 static notmuch_status_t
74 _choose_dir (notmuch_database_t *notmuch,
76 notmuch_config_key_t key,
78 const char *xdg_subdir,
80 char **message = NULL)
87 dir = notmuch_config_get (notmuch, key);
90 return NOTMUCH_STATUS_SUCCESS;
92 parent = _xdg_dir (notmuch, xdg_var, xdg_subdir, profile);
94 return NOTMUCH_STATUS_PATH_ERROR;
96 dir = talloc_asprintf (notmuch, "%s/%s", parent, subdir);
98 err = stat (dir, &st);
100 if (errno == ENOENT) {
101 char *notmuch_path = dirname (talloc_strdup (notmuch, notmuch->xapian_path));
102 dir = talloc_asprintf (notmuch, "%s/%s", notmuch_path, subdir);
104 IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
105 dir, strerror (errno)));
106 return NOTMUCH_STATUS_FILE_ERROR;
110 _notmuch_config_cache (notmuch, key, dir);
112 return NOTMUCH_STATUS_SUCCESS;
115 static notmuch_status_t
116 _load_key_file (const char *path,
120 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
121 void *local = talloc_new (NULL);
123 if (path && EMPTY_STRING (path))
127 path = getenv ("NOTMUCH_CONFIG");
130 const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
133 path = talloc_asprintf (local, "%s/config", dir);
134 if (access (path, R_OK) != 0)
140 const char *home = getenv ("HOME");
142 path = talloc_asprintf (local, "%s/.notmuch-config", home);
145 profile = getenv ("NOTMUCH_PROFILE");
148 path = talloc_asprintf (local, "%s.%s", path, profile);
151 *key_file = g_key_file_new ();
152 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
153 status = NOTMUCH_STATUS_NO_CONFIG;
161 static notmuch_status_t
162 _db_dir_exists (const char *database_path, char **message)
167 err = stat (database_path, &st);
169 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
170 database_path, strerror (errno)));
171 return NOTMUCH_STATUS_FILE_ERROR;
174 if (! S_ISDIR (st.st_mode)) {
175 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
176 "Not a directory.\n",
178 return NOTMUCH_STATUS_FILE_ERROR;
181 return NOTMUCH_STATUS_SUCCESS;
184 static notmuch_status_t
185 _choose_database_path (void *ctx,
186 const char *config_path,
189 const char **database_path,
193 notmuch_status_t status;
195 status = _load_key_file (config_path, profile, key_file);
197 *message = strdup ("Error: cannot load config file.\n");
201 if (! *database_path) {
202 *database_path = getenv ("NOTMUCH_DATABASE");
205 if (! *database_path && *key_file) {
206 char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
208 *database_path = talloc_strdup (ctx, path);
213 if (! *database_path) {
214 *database_path = _xdg_dir (ctx, "XDG_DATA_HOME", ".local/share", profile);
218 if (*database_path == NULL) {
219 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
220 return NOTMUCH_STATUS_NULL_POINTER;
223 if (*database_path[0] != '/') {
224 *message = strdup ("Error: Database path must be absolute.\n");
225 return NOTMUCH_STATUS_PATH_ERROR;
227 return NOTMUCH_STATUS_SUCCESS;
233 notmuch_database_t *notmuch;
235 notmuch = talloc_zero (NULL, notmuch_database_t);
239 notmuch->exception_reported = false;
240 notmuch->status_string = NULL;
241 notmuch->writable_xapian_db = NULL;
242 notmuch->atomic_nesting = 0;
247 static notmuch_status_t
248 _trial_open (const char *xapian_path, char **message_ptr)
251 Xapian::Database db (xapian_path);
252 } catch (const Xapian::DatabaseOpeningError &error) {
253 IGNORE_RESULT (asprintf (message_ptr,
254 "Cannot open Xapian database at %s: %s\n",
256 error.get_msg ().c_str ()));
257 return NOTMUCH_STATUS_PATH_ERROR;
258 } catch (const Xapian::Error &error) {
259 IGNORE_RESULT (asprintf (message_ptr,
260 "A Xapian exception occurred opening database: %s\n",
261 error.get_msg ().c_str ()));
262 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
264 return NOTMUCH_STATUS_SUCCESS;
268 _notmuch_choose_xapian_path (void *ctx, const char *database_path,
269 const char **xapian_path, char **message_ptr)
271 notmuch_status_t status;
272 const char *trial_path, *notmuch_path;
274 status = _db_dir_exists (database_path, message_ptr);
278 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
279 status = _trial_open (trial_path, message_ptr);
280 if (status != NOTMUCH_STATUS_PATH_ERROR)
286 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
287 status = _db_dir_exists (notmuch_path, message_ptr);
291 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
292 status = _trial_open (trial_path, message_ptr);
295 if (status == NOTMUCH_STATUS_SUCCESS)
296 *xapian_path = trial_path;
301 _set_database_path (notmuch_database_t *notmuch,
302 const char *database_path)
304 char *path = talloc_strdup (notmuch, database_path);
306 strip_trailing (path, '/');
308 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
315 static int initialized = 0;
317 /* Initialize the GLib type system and threads */
318 #if ! GLIB_CHECK_VERSION (2, 35, 1)
322 /* Initialize gmime */
329 static notmuch_status_t
330 _finish_open (notmuch_database_t *notmuch,
332 notmuch_database_mode_t mode,
336 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
337 char *incompat_features;
338 char *message = NULL;
339 unsigned int version;
340 const char *database_path = notmuch_database_get_path (notmuch);
343 std::string last_thread_id;
344 std::string last_mod;
346 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
347 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
349 notmuch->xapian_db = notmuch->writable_xapian_db;
351 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
354 /* Check version. As of database version 3, we represent
355 * changes in terms of features, so assume a version bump
356 * means a dramatically incompatible change. */
357 version = notmuch_database_get_version (notmuch);
358 if (version > NOTMUCH_DATABASE_VERSION) {
359 IGNORE_RESULT (asprintf (&message,
360 "Error: Notmuch database at %s\n"
361 " has a newer database format version (%u) than supported by this\n"
362 " version of notmuch (%u).\n",
363 database_path, version, NOTMUCH_DATABASE_VERSION));
364 notmuch_database_destroy (notmuch);
366 status = NOTMUCH_STATUS_FILE_ERROR;
370 /* Check features. */
371 incompat_features = NULL;
372 notmuch->features = _notmuch_database_parse_features (
373 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
374 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
376 if (incompat_features) {
377 IGNORE_RESULT (asprintf (&message,
378 "Error: Notmuch database at %s\n"
379 " requires features (%s)\n"
380 " not supported by this version of notmuch.\n",
381 database_path, incompat_features));
382 notmuch_database_destroy (notmuch);
384 status = NOTMUCH_STATUS_FILE_ERROR;
388 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
389 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
390 if (last_thread_id.empty ()) {
391 notmuch->last_thread_id = 0;
396 str = last_thread_id.c_str ();
397 notmuch->last_thread_id = strtoull (str, &end, 16);
399 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
402 /* Get current highest revision number. */
403 last_mod = notmuch->xapian_db->get_value_upper_bound (
404 NOTMUCH_VALUE_LAST_MOD);
405 if (last_mod.empty ())
406 notmuch->revision = 0;
408 notmuch->revision = Xapian::sortable_unserialise (last_mod);
409 notmuch->uuid = talloc_strdup (
410 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
412 notmuch->query_parser = new Xapian::QueryParser;
413 notmuch->term_gen = new Xapian::TermGenerator;
414 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
415 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
416 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
418 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
420 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
421 notmuch->query_parser->set_database (*notmuch->xapian_db);
422 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
423 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
424 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
425 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
426 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
428 /* Configuration information is needed to set up query parser */
429 status = _notmuch_config_load_from_database (notmuch);
434 status = _notmuch_config_load_from_file (notmuch, key_file);
438 status = _choose_dir (notmuch, profile,
439 NOTMUCH_CONFIG_HOOK_DIR,
447 status = _choose_dir (notmuch, profile,
448 NOTMUCH_CONFIG_BACKUP_DIR,
455 status = _notmuch_config_load_defaults (notmuch);
459 status = _notmuch_database_setup_standard_query_fields (notmuch);
463 status = _notmuch_database_setup_user_query_fields (notmuch);
467 } catch (const Xapian::Error &error) {
468 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
469 error.get_msg ().c_str ()));
470 notmuch_database_destroy (notmuch);
472 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
476 *message_ptr = message;
481 notmuch_database_open_with_config (const char *database_path,
482 notmuch_database_mode_t mode,
483 const char *config_path,
485 notmuch_database_t **database,
486 char **status_string)
488 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
489 void *local = talloc_new (NULL);
490 notmuch_database_t *notmuch = NULL;
491 char *message = NULL;
492 GKeyFile *key_file = NULL;
497 notmuch = _alloc_notmuch ();
499 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
503 if ((status = _choose_database_path (local, config_path, profile,
504 &key_file, &database_path, &split,
508 status = _db_dir_exists (database_path, &message);
512 _set_database_path (notmuch, database_path);
514 status = _notmuch_choose_xapian_path (notmuch, database_path,
515 ¬much->xapian_path, &message);
519 status = _finish_open (notmuch, profile, mode, key_file, &message);
525 g_key_file_free (key_file);
529 *status_string = message;
537 talloc_free (notmuch);
540 notmuch->open = true;
546 notmuch_database_create (const char *path, notmuch_database_t **database)
548 char *status_string = NULL;
549 notmuch_status_t status;
551 status = notmuch_database_create_verbose (path, database,
555 fputs (status_string, stderr);
556 free (status_string);
563 notmuch_database_create_verbose (const char *path,
564 notmuch_database_t **database,
565 char **status_string)
567 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
571 notmuch_database_create_with_config (const char *database_path,
572 const char *config_path,
574 notmuch_database_t **database,
575 char **status_string)
577 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
578 notmuch_database_t *notmuch = NULL;
579 const char *notmuch_path = NULL;
580 char *message = NULL;
581 GKeyFile *key_file = NULL;
582 void *local = talloc_new (NULL);
588 notmuch = _alloc_notmuch ();
590 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
596 if ((status = _choose_database_path (local, config_path, profile,
597 &key_file, &database_path, &split,
601 status = _db_dir_exists (database_path, &message);
605 _set_database_path (notmuch, database_path);
607 if (key_file && ! split) {
608 char *mail_root = canonicalize_file_name (
609 g_key_file_get_value (key_file, "database", "mail_root", NULL));
610 char *db_path = canonicalize_file_name (database_path);
612 split = (mail_root && (0 != strcmp (mail_root, db_path)));
619 notmuch_path = database_path;
621 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
622 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
626 err = mkdir (notmuch_path, 0755);
628 if (errno == EEXIST) {
629 status = NOTMUCH_STATUS_DATABASE_EXISTS;
630 talloc_free (notmuch);
633 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
634 notmuch_path, strerror (errno)));
635 status = NOTMUCH_STATUS_FILE_ERROR;
641 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
642 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
646 status = _trial_open (notmuch->xapian_path, &message);
647 if (status == NOTMUCH_STATUS_SUCCESS) {
648 notmuch_database_destroy (notmuch);
650 status = NOTMUCH_STATUS_DATABASE_EXISTS;
657 status = _finish_open (notmuch,
659 NOTMUCH_DATABASE_MODE_READ_WRITE,
665 /* Upgrade doesn't add these feature to existing databases, but
666 * new databases have them. */
667 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
668 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
669 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
671 status = notmuch_database_upgrade (notmuch, NULL, NULL);
673 notmuch_database_close (notmuch);
681 g_key_file_free (key_file);
685 *status_string = message;
692 talloc_free (notmuch);
697 notmuch_database_reopen (notmuch_database_t *notmuch,
698 notmuch_database_mode_t new_mode)
700 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
702 if (notmuch->xapian_db == NULL) {
703 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
704 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
708 if (cur_mode == new_mode &&
709 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
710 notmuch->xapian_db->reopen ();
712 notmuch->xapian_db->close ();
714 delete notmuch->xapian_db;
715 notmuch->xapian_db = NULL;
716 /* no need to free the same object twice */
717 notmuch->writable_xapian_db = NULL;
719 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
720 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
722 notmuch->xapian_db = notmuch->writable_xapian_db;
724 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
728 } catch (const Xapian::Error &error) {
729 if (! notmuch->exception_reported) {
730 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
731 error.get_msg ().c_str ());
732 notmuch->exception_reported = true;
734 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
738 notmuch->open = true;
739 return NOTMUCH_STATUS_SUCCESS;