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 _choose_database_path (void *ctx,
157 const char *config_path,
160 const char **database_path,
163 notmuch_status_t status;
165 status = _load_key_file (config_path, profile, key_file);
167 *message = strdup ("Error: cannot load config file.\n");
171 if (! *database_path) {
172 *database_path = getenv ("NOTMUCH_DATABASE");
175 if (! *database_path && *key_file) {
176 char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
178 *database_path = talloc_strdup (ctx, path);
183 if (*database_path == NULL) {
184 *message = strdup ("Error: Cannot open a database for a NULL path.\n");
185 return NOTMUCH_STATUS_NULL_POINTER;
188 if (*database_path[0] != '/') {
189 *message = strdup ("Error: Database path must be absolute.\n");
190 return NOTMUCH_STATUS_PATH_ERROR;
192 return NOTMUCH_STATUS_SUCCESS;
198 notmuch_database_t *notmuch;
200 notmuch = talloc_zero (NULL, notmuch_database_t);
204 notmuch->exception_reported = false;
205 notmuch->status_string = NULL;
206 notmuch->writable_xapian_db = NULL;
207 notmuch->atomic_nesting = 0;
213 _set_database_path (notmuch_database_t *notmuch,
214 const char *database_path)
216 char *path = talloc_strdup (notmuch, database_path);
218 strip_trailing (path, '/');
220 _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
224 notmuch_database_open_with_config (const char *database_path,
225 notmuch_database_mode_t mode,
226 const char *config_path,
228 notmuch_database_t **database,
229 char **status_string)
231 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
232 void *local = talloc_new (NULL);
233 notmuch_database_t *notmuch = NULL;
234 char *notmuch_path, *incompat_features;
235 char *message = NULL;
238 unsigned int version;
239 GKeyFile *key_file = NULL;
240 static int initialized = 0;
242 notmuch = _alloc_notmuch ();
244 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
248 if ((status = _choose_database_path (local, config_path, profile,
249 &key_file, &database_path, &message)))
252 _set_database_path (notmuch, database_path);
254 if (! (notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch"))) {
255 message = strdup ("Out of memory\n");
256 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
260 err = stat (notmuch_path, &st);
262 IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
263 notmuch_path, strerror (errno)));
264 status = NOTMUCH_STATUS_FILE_ERROR;
268 if (! (notmuch->xapian_path = talloc_asprintf (notmuch, "%s/%s", notmuch_path, "xapian"))) {
269 message = strdup ("Out of memory\n");
270 status = NOTMUCH_STATUS_OUT_OF_MEMORY;
274 /* Initialize the GLib type system and threads */
275 #if ! GLIB_CHECK_VERSION (2, 35, 1)
279 /* Initialize gmime */
286 std::string last_thread_id;
287 std::string last_mod;
289 if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
290 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
292 notmuch->xapian_db = notmuch->writable_xapian_db;
294 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
297 /* Check version. As of database version 3, we represent
298 * changes in terms of features, so assume a version bump
299 * means a dramatically incompatible change. */
300 version = notmuch_database_get_version (notmuch);
301 if (version > NOTMUCH_DATABASE_VERSION) {
302 IGNORE_RESULT (asprintf (&message,
303 "Error: Notmuch database at %s\n"
304 " has a newer database format version (%u) than supported by this\n"
305 " version of notmuch (%u).\n",
306 notmuch_path, version, NOTMUCH_DATABASE_VERSION));
307 notmuch_database_destroy (notmuch);
309 status = NOTMUCH_STATUS_FILE_ERROR;
313 /* Check features. */
314 incompat_features = NULL;
315 notmuch->features = _notmuch_database_parse_features (
316 local, notmuch->xapian_db->get_metadata ("features").c_str (),
317 version, mode == NOTMUCH_DATABASE_MODE_READ_WRITE ? 'w' : 'r',
319 if (incompat_features) {
320 IGNORE_RESULT (asprintf (&message,
321 "Error: Notmuch database at %s\n"
322 " requires features (%s)\n"
323 " not supported by this version of notmuch.\n",
324 notmuch_path, incompat_features));
325 notmuch_database_destroy (notmuch);
327 status = NOTMUCH_STATUS_FILE_ERROR;
331 notmuch->last_doc_id = notmuch->xapian_db->get_lastdocid ();
332 last_thread_id = notmuch->xapian_db->get_metadata ("last_thread_id");
333 if (last_thread_id.empty ()) {
334 notmuch->last_thread_id = 0;
339 str = last_thread_id.c_str ();
340 notmuch->last_thread_id = strtoull (str, &end, 16);
342 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
345 /* Get current highest revision number. */
346 last_mod = notmuch->xapian_db->get_value_upper_bound (
347 NOTMUCH_VALUE_LAST_MOD);
348 if (last_mod.empty ())
349 notmuch->revision = 0;
351 notmuch->revision = Xapian::sortable_unserialise (last_mod);
352 notmuch->uuid = talloc_strdup (
353 notmuch, notmuch->xapian_db->get_uuid ().c_str ());
355 notmuch->query_parser = new Xapian::QueryParser;
356 notmuch->term_gen = new Xapian::TermGenerator;
357 notmuch->term_gen->set_stemmer (Xapian::Stem ("english"));
358 notmuch->value_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_TIMESTAMP);
359 notmuch->date_range_processor = new ParseTimeRangeProcessor (NOTMUCH_VALUE_TIMESTAMP,
361 notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
363 notmuch->query_parser->set_default_op (Xapian::Query::OP_AND);
364 notmuch->query_parser->set_database (*notmuch->xapian_db);
365 notmuch->query_parser->set_stemmer (Xapian::Stem ("english"));
366 notmuch->query_parser->set_stemming_strategy (Xapian::QueryParser::STEM_SOME);
367 notmuch->query_parser->add_rangeprocessor (notmuch->value_range_processor);
368 notmuch->query_parser->add_rangeprocessor (notmuch->date_range_processor);
369 notmuch->query_parser->add_rangeprocessor (notmuch->last_mod_range_processor);
371 /* Configuration information is needed to set up query parser */
372 status = _notmuch_config_load_from_database (notmuch);
377 status = _notmuch_config_load_from_file (notmuch, key_file);
381 status = _choose_hook_dir (notmuch, profile, &message);
385 status = _notmuch_config_load_defaults (notmuch);
389 status = _notmuch_database_setup_standard_query_fields (notmuch);
393 status = _notmuch_database_setup_user_query_fields (notmuch);
397 } catch (const Xapian::Error &error) {
398 IGNORE_RESULT (asprintf (&message, "A Xapian exception occurred opening database: %s\n",
399 error.get_msg ().c_str ()));
400 notmuch_database_destroy (notmuch);
402 status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
409 g_key_file_free (key_file);
413 *status_string = message;
421 talloc_free (notmuch);
424 notmuch->open = true;
430 notmuch_database_create (const char *path, notmuch_database_t **database)
432 char *status_string = NULL;
433 notmuch_status_t status;
435 status = notmuch_database_create_verbose (path, database,
439 fputs (status_string, stderr);
440 free (status_string);
447 notmuch_database_create_verbose (const char *path,
448 notmuch_database_t **database,
449 char **status_string)
451 return notmuch_database_create_with_config (path, "", NULL, database, status_string);
455 notmuch_database_create_with_config (const char *database_path,
456 const char *config_path,
458 notmuch_database_t **database,
459 char **status_string)
461 notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
462 notmuch_database_t *notmuch = NULL;
463 char *notmuch_path = NULL;
464 char *message = NULL;
465 GKeyFile *key_file = NULL;
468 void *local = talloc_new (NULL);
470 if ((status = _choose_database_path (local, config_path, profile,
471 &key_file, &database_path, &message)))
474 err = stat (database_path, &st);
476 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
477 database_path, strerror (errno)));
478 status = NOTMUCH_STATUS_FILE_ERROR;
482 if (! S_ISDIR (st.st_mode)) {
483 IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
484 "Not a directory.\n",
486 status = NOTMUCH_STATUS_FILE_ERROR;
490 notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
492 err = mkdir (notmuch_path, 0755);
494 if (errno == EEXIST) {
495 status = NOTMUCH_STATUS_DATABASE_EXISTS;
497 IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
498 notmuch_path, strerror (errno)));
499 status = NOTMUCH_STATUS_FILE_ERROR;
504 /* XXX this reads the config file twice, which is a bit wasteful */
505 status = notmuch_database_open_with_config (database_path,
506 NOTMUCH_DATABASE_MODE_READ_WRITE,
513 /* Upgrade doesn't add these feature to existing databases, but
514 * new databases have them. */
515 notmuch->features |= NOTMUCH_FEATURE_FROM_SUBJECT_ID_VALUES;
516 notmuch->features |= NOTMUCH_FEATURE_INDEXED_MIMETYPES;
517 notmuch->features |= NOTMUCH_FEATURE_UNPREFIX_BODY_ONLY;
519 status = notmuch_database_upgrade (notmuch, NULL, NULL);
521 notmuch_database_close (notmuch);
529 g_key_file_free (key_file);
533 *status_string = message;
540 talloc_free (notmuch);
545 notmuch_database_reopen (notmuch_database_t *notmuch,
546 notmuch_database_mode_t new_mode)
548 notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
550 if (notmuch->xapian_db == NULL) {
551 _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
552 return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
556 if (cur_mode == new_mode &&
557 new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
558 notmuch->xapian_db->reopen ();
560 notmuch->xapian_db->close ();
562 delete notmuch->xapian_db;
563 notmuch->xapian_db = NULL;
564 /* no need to free the same object twice */
565 notmuch->writable_xapian_db = NULL;
567 if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
568 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
570 notmuch->xapian_db = notmuch->writable_xapian_db;
572 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
576 } catch (const Xapian::Error &error) {
577 if (! notmuch->exception_reported) {
578 _notmuch_database_log (notmuch, "Error: A Xapian exception reopening database: %s\n",
579 error.get_msg ().c_str ());
580 notmuch->exception_reported = true;
582 return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
586 notmuch->open = true;
587 return NOTMUCH_STATUS_SUCCESS;