2 #include "database-private.h"
3 #include "parse-time-vrp.h"
5 #if HAVE_XAPIAN_DB_RETRY_LOCK
6 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
8 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
12 notmuch_database_open (const char *path,
13 notmuch_database_mode_t mode,
14 notmuch_database_t **database)
16 char *status_string = NULL;
17 notmuch_status_t status;
19 status = notmuch_database_open_verbose (path, mode, database,
23 fputs (status_string, stderr);
31 notmuch_database_open_verbose (const char *path,
32 notmuch_database_mode_t mode,
33 notmuch_database_t **database,
36 return notmuch_database_open_with_config (path, mode, "", NULL,
37 database, status_string);
42 const char *xdg_root_variable,
43 const char *xdg_prefix,
44 const char *profile_name)
46 const char *xdg_root = getenv (xdg_root_variable);
49 const char *home = getenv ("HOME");
51 if (! home) return NULL;
53 xdg_root = talloc_asprintf (ctx,
60 profile_name = getenv ("NOTMUCH_PROFILE");
63 profile_name = "default";
65 return talloc_asprintf (ctx,
71 static notmuch_status_t
72 _choose_hook_dir (notmuch_database_t *notmuch,
81 hook_dir = notmuch_config_get (notmuch, NOTMUCH_CONFIG_HOOK_DIR);
84 return NOTMUCH_STATUS_SUCCESS;
86 config = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
88 return NOTMUCH_STATUS_PATH_ERROR;
90 hook_dir = talloc_asprintf (notmuch, "%s/hooks", config);
92 err = stat (hook_dir, &st);
94 if (errno == ENOENT) {
95 const char *database_path = notmuch_database_get_path (notmuch);
96 hook_dir = talloc_asprintf (notmuch, "%s/.notmuch/hooks", database_path);
98 IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
99 hook_dir, strerror (errno)));
100 return NOTMUCH_STATUS_FILE_ERROR;
104 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_HOOK_DIR, hook_dir);
106 return NOTMUCH_STATUS_SUCCESS;
109 static notmuch_status_t
110 _load_key_file (const char *path,
114 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
115 void *local = talloc_new (NULL);
117 if (path && EMPTY_STRING (path))
121 path = getenv ("NOTMUCH_CONFIG");
124 const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
127 path = talloc_asprintf (local, "%s/config", dir);
128 if (access (path, R_OK) != 0)
134 const char *home = getenv ("HOME");
136 path = talloc_asprintf (local, "%s/.notmuch-config", home);
139 profile = getenv ("NOTMUCH_PROFILE");
142 path = talloc_asprintf (local, "%s.%s", path, profile);
145 *key_file = g_key_file_new ();
146 if (! g_key_file_load_from_file (*key_file, path, G_KEY_FILE_NONE, NULL)) {
147 status = NOTMUCH_STATUS_NO_CONFIG;
155 static notmuch_status_t
156 _db_dir_exists (const char *database_path, char **message)
161 err = stat (database_path, &st);
163 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: %s.\n",
164 database_path, strerror (errno)));
165 return NOTMUCH_STATUS_FILE_ERROR;
168 if (! S_ISDIR (st.st_mode)) {
169 IGNORE_RESULT (asprintf (message, "Error: Cannot open database at %s: "
170 "Not a directory.\n",
172 return NOTMUCH_STATUS_FILE_ERROR;
175 return NOTMUCH_STATUS_SUCCESS;
178 static notmuch_status_t
179 _choose_database_path (void *ctx,
180 const char *config_path,
183 const char **database_path,
186 notmuch_status_t status;
188 status = _load_key_file (config_path, profile, key_file);
190 *message = strdup ("Error: cannot load config file.\n");
194 if (! *database_path) {
195 *database_path = getenv ("NOTMUCH_DATABASE");
198 if (! *database_path && *key_file) {
199 char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
201 *database_path = talloc_strdup (ctx, path);
206 if (*database_path == NULL) {
207 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
208 return NOTMUCH_STATUS_NULL_POINTER;
211 if (*database_path[0] != '/') {
212 *message = strdup ("Error: Database path must be absolute.\n");
213 return NOTMUCH_STATUS_PATH_ERROR;
215 return NOTMUCH_STATUS_SUCCESS;
221 notmuch_database_t *notmuch;
223 notmuch = talloc_zero (NULL, notmuch_database_t);
227 notmuch->exception_reported = false;
228 notmuch->status_string = NULL;
229 notmuch->writable_xapian_db = NULL;
230 notmuch->atomic_nesting = 0;
235 static notmuch_status_t
236 _trial_open (const char *xapian_path, char **message_ptr)
239 Xapian::Database db (xapian_path);
240 } catch (const Xapian::DatabaseOpeningError &error) {
241 IGNORE_RESULT (asprintf (message_ptr,
242 "Cannot open Xapian database at %s: %s\n",
244 error.get_msg ().c_str ()));
245 return NOTMUCH_STATUS_PATH_ERROR;
246 } catch (const Xapian::Error &error) {
247 IGNORE_RESULT (asprintf (message_ptr,
248 "A Xapian exception occurred opening database: %s\n",
249 error.get_msg ().c_str ()));
250 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
252 return NOTMUCH_STATUS_SUCCESS;
255 static notmuch_status_t
256 _choose_xapian_path (void *ctx, const char *database_path, const char **xapian_path,
259 notmuch_status_t status;
260 const char *trial_path, *notmuch_path;
262 status = _db_dir_exists (database_path, message_ptr);
266 trial_path = talloc_asprintf (ctx, "%s/xapian", database_path);
267 status = _trial_open (trial_path, message_ptr);
268 if (status != NOTMUCH_STATUS_PATH_ERROR)
271 notmuch_path = talloc_asprintf (ctx, "%s/.notmuch", database_path);
272 status = _db_dir_exists (notmuch_path, message_ptr);
276 trial_path = talloc_asprintf (ctx, "%s/xapian", notmuch_path);
277 status = _trial_open (trial_path, message_ptr);
280 if (status == NOTMUCH_STATUS_SUCCESS)
281 *xapian_path = trial_path;
286 _set_database_path (notmuch_database_t *notmuch,
287 const char *database_path)
289 char *path = talloc_strdup (notmuch, database_path);
291 strip_trailing (path, '/');
293 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
300 static int initialized = 0;
302 /* Initialize the GLib type system and threads */
303 #if ! GLIB_CHECK_VERSION (2, 35, 1)
307 /* Initialize gmime */
314 static notmuch_status_t
315 _finish_open (notmuch_database_t *notmuch,
317 notmuch_database_mode_t mode,
321 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
322 char *incompat_features;
323 char *message = NULL;
324 unsigned int version;
325 const char *database_path = notmuch_database_get_path (notmuch);
328 std::string last_thread_id;
329 std::string last_mod;
331 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
332 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
334 notmuch->xapian_db = notmuch->writable_xapian_db;
336 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
339 /* Check version. As of database version 3, we represent
340 * changes in terms of features, so assume a version bump
341 * means a dramatically incompatible change. */
342 version = notmuch_database_get_version (notmuch);
343 if (version > NOTMUCH_DATABASE_VERSION) {
344 IGNORE_RESULT (asprintf (&message,
345 "Error: Notmuch database at %s\n"
346 " has a newer database format version (%u) than supported by this\n"
347 " version of notmuch (%u).\n",
348 database_path, version, NOTMUCH_DATABASE_VERSION));
349 notmuch_database_destroy (notmuch);
351 status = NOTMUCH_STATUS_FILE_ERROR;
355 /* Check features. */
356 incompat_features = NULL;
357 notmuch->features = _notmuch_database_parse_features (
358 notmuch, notmuch->xapian_db->get_metadata ("features").c_str (),
359 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
361 if (incompat_features) {
362 IGNORE_RESULT (asprintf (&message,
363 "Error: Notmuch database at %s\n"
364 " requires features (%s)\n"
365 " not supported by this version of notmuch.\n",
366 database_path, incompat_features));
367 notmuch_database_destroy (notmuch);
369 status = NOTMUCH_STATUS_FILE_ERROR;
373 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
374 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
375 if (last_thread_id.empty ()) {
376 notmuch->last_thread_id = 0;
381 str = last_thread_id.c_str ();
382 notmuch->last_thread_id = strtoull (str, &end, 16);
384 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
387 /* Get current highest revision number. */
388 last_mod = notmuch->xapian_db->get_value_upper_bound (
389 NOTMUCH_VALUE_LAST_MOD);
390 if (last_mod.empty ())
391 notmuch->revision = 0;
393 notmuch->revision = Xapian::sortable_unserialise (last_mod);
394 notmuch->uuid = talloc_strdup (
395 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
397 notmuch->query_parser = new Xapian::QueryParser;
398 notmuch->term_gen = new Xapian::TermGenerator;
399 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
400 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
401 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
403 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
405 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
406 notmuch->query_parser->set_database (*notmuch->xapian_db);
407 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
408 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
409 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
410 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
411 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
413 /* Configuration information is needed to set up query parser */
414 status = _notmuch_config_load_from_database (notmuch);
419 status = _notmuch_config_load_from_file (notmuch, key_file);
423 status = _choose_hook_dir (notmuch, profile, &message);
427 status = _notmuch_config_load_defaults (notmuch);
431 status = _notmuch_database_setup_standard_query_fields (notmuch);
435 status = _notmuch_database_setup_user_query_fields (notmuch);
439 } catch (const Xapian::Error &error) {
440 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
441 error.get_msg ().c_str ()));
442 notmuch_database_destroy (notmuch);
444 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
448 *message_ptr = message;
453 notmuch_database_open_with_config (const char *database_path,
454 notmuch_database_mode_t mode,
455 const char *config_path,
457 notmuch_database_t **database,
458 char **status_string)
460 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
461 void *local = talloc_new (NULL);
462 notmuch_database_t *notmuch = NULL;
463 char *message = NULL;
464 GKeyFile *key_file = NULL;
468 notmuch = _alloc_notmuch ();
470 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
474 if ((status = _choose_database_path (local, config_path, profile, &key_file, &database_path,
478 status = _db_dir_exists (database_path, &message);
482 _set_database_path (notmuch, database_path);
484 status = _choose_xapian_path (notmuch, database_path, ¬much->xapian_path, &message);
488 status = _finish_open (notmuch, profile, mode, key_file, &message);
494 g_key_file_free (key_file);
498 *status_string = message;
506 talloc_free (notmuch);
509 notmuch->open = true;
515 notmuch_database_create (const char *path, notmuch_database_t **database)
517 char *status_string = NULL;
518 notmuch_status_t status;
520 status = notmuch_database_create_verbose (path, database,
524 fputs (status_string, stderr);
525 free (status_string);
532 notmuch_database_create_verbose (const char *path,
533 notmuch_database_t **database,
534 char **status_string)
536 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
540 notmuch_database_create_with_config (const char *database_path,
541 const char *config_path,
543 notmuch_database_t **database,
544 char **status_string)
546 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
547 notmuch_database_t *notmuch = NULL;
548 const char *notmuch_path = NULL;
549 char *message = NULL;
550 GKeyFile *key_file = NULL;
551 void *local = talloc_new (NULL);
557 notmuch = _alloc_notmuch ();
559 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
565 if ((status = _choose_database_path (local, config_path, profile,
566 &key_file, &database_path, &message)))
569 status = _db_dir_exists (database_path, &message);
573 _set_database_path (notmuch, database_path);
575 if (key_file && ! split) {
576 char *mail_root = canonicalize_file_name (
577 g_key_file_get_value (key_file, "database", "mail_root", NULL));
578 char *db_path = canonicalize_file_name (database_path);
580 split = (mail_root && (0 != strcmp (mail_root, db_path)));
587 notmuch_path = database_path;
589 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
590 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
594 err = mkdir (notmuch_path, 0755);
596 if (errno == EEXIST) {
597 status = NOTMUCH_STATUS_DATABASE_EXISTS;
598 talloc_free (notmuch);
601 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
602 notmuch_path, strerror (errno)));
603 status = NOTMUCH_STATUS_FILE_ERROR;
609 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
610 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
614 status = _trial_open (notmuch->xapian_path, &message);
615 if (status == NOTMUCH_STATUS_SUCCESS) {
616 notmuch_database_destroy (notmuch);
618 status = NOTMUCH_STATUS_DATABASE_EXISTS;
622 status = _finish_open (notmuch,
624 NOTMUCH_DATABASE_MODE_READ_WRITE,
630 /* Upgrade doesn't add these feature to existing databases, but
631 * new databases have them. */
632 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
633 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
634 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
636 status = notmuch_database_upgrade (notmuch, NULL, NULL);
638 notmuch_database_close (notmuch);
646 g_key_file_free (key_file);
650 *status_string = message;
657 talloc_free (notmuch);
662 notmuch_database_reopen (notmuch_database_t *notmuch,
663 notmuch_database_mode_t new_mode)
665 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
667 if (notmuch->xapian_db == NULL) {
668 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
669 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
673 if (cur_mode == new_mode &&
674 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
675 notmuch->xapian_db->reopen ();
677 notmuch->xapian_db->close ();
679 delete notmuch->xapian_db;
680 notmuch->xapian_db = NULL;
681 /* no need to free the same object twice */
682 notmuch->writable_xapian_db = NULL;
684 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
685 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
687 notmuch->xapian_db = notmuch->writable_xapian_db;
689 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
693 } catch (const Xapian::Error &error) {
694 if (! notmuch->exception_reported) {
695 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
696 error.get_msg ().c_str ());
697 notmuch->exception_reported = true;
699 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
703 notmuch->open = true;
704 return NOTMUCH_STATUS_SUCCESS;