git.notmuchmail.org Git - notmuch/blob - lib/open.cc

   1 #include <unistd.h>
   2 #include "database-private.h"
   3 #include "parse-time-vrp.h"
   4
   5 #if HAVE_XAPIAN_DB_RETRY_LOCK
   6 #define DB_ACTION (Xapian::DB_CREATE_OR_OPEN | Xapian::DB_RETRY_LOCK)
   7 #else
   8 #define DB_ACTION Xapian::DB_CREATE_OR_OPEN
   9 #endif
  10
  11 notmuch_status_t
  12 notmuch_database_open (const char *path,
  13                        notmuch_database_mode_t mode,
  14                        notmuch_database_t **database)
  15 {
  16     char *status_string = NULL;
  17     notmuch_status_t status;
  18
  19     status = notmuch_database_open_verbose (path, mode, database,
  20                                             &status_string);
  21
  22     if (status_string) {
  23         fputs (status_string, stderr);
  24         free (status_string);
  25     }
  26
  27     return status;
  28 }
  29
  30 notmuch_status_t
  31 notmuch_database_open_verbose (const char *path,
  32                                notmuch_database_mode_t mode,
  33                                notmuch_database_t **database,
  34                                char **status_string)
  35 {
  36     return notmuch_database_open_with_config (path, mode, "", NULL,
  37                                               database, status_string);
  38 }
  39
  40 static const char *
  41 _xdg_dir (void *ctx,
  42           const char *xdg_root_variable,
  43           const char *xdg_prefix,
  44           const char *profile_name)
  45 {
  46     const char *xdg_root = getenv (xdg_root_variable);
  47
  48     if (! xdg_root) {
  49         const char *home = getenv ("HOME");
  50
  51         if (! home) return NULL;
  52
  53         xdg_root = talloc_asprintf (ctx,
  54                                     "%s/%s",
  55                                     home,
  56                                     xdg_prefix);
  57     }
  58
  59     if (! profile_name)
  60         profile_name = getenv ("NOTMUCH_PROFILE");
  61
  62     if (! profile_name)
  63         profile_name = "default";
  64
  65     return talloc_asprintf (ctx,
  66                             "%s/notmuch/%s",
  67                             xdg_root,
  68                             profile_name);
  69 }
  70
  71 static notmuch_status_t
  72 _choose_hook_dir (notmuch_database_t *notmuch,
  73                   const char *profile,
  74                   char **message)
  75 {
  76     const char *config;
  77     const char *hook_dir;
  78     struct stat st;
  79     int err;
  80
  81     hook_dir = notmuch_config_get (notmuch, NOTMUCH_CONFIG_HOOK_DIR);
  82
  83     if (hook_dir)
  84         return NOTMUCH_STATUS_SUCCESS;
  85
  86     config = _xdg_dir (notmuch, "XDG_CONFIG_HOME", ".config", profile);
  87     if (! config)
  88         return NOTMUCH_STATUS_PATH_ERROR;
  89
  90     hook_dir = talloc_asprintf (notmuch, "%s/hooks", config);
  91
  92     err = stat (hook_dir, &st);
  93     if (err) {
  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);
  97         } else {
  98             IGNORE_RESULT (asprintf (message, "Error: Cannot stat %s: %s.\n",
  99                                      hook_dir, strerror (errno)));
 100             return NOTMUCH_STATUS_FILE_ERROR;
 101         }
 102     }
 103
 104     _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_HOOK_DIR, hook_dir);
 105
 106     return NOTMUCH_STATUS_SUCCESS;
 107 }
 108
 109 static notmuch_status_t
 110 _load_key_file (const char *path,
 111                 const char *profile,
 112                 GKeyFile **key_file)
 113 {
 114     notmuch_status_t status = NOTMUCH_STATUS_SUCCESS;
 115     void *local = talloc_new (NULL);
 116
 117     if (path && EMPTY_STRING (path))
 118         goto DONE;
 119
 120     if (! path)
 121         path = getenv ("NOTMUCH_CONFIG");
 122
 123     if (! path) {
 124         const char *dir = _xdg_dir (local, "XDG_CONFIG_HOME", ".config", profile);
 125
 126         if (dir) {
 127             path = talloc_asprintf (local, "%s/config", dir);
 128             if (access (path, R_OK) != 0)
 129                 path = NULL;
 130         }
 131     }
 132
 133     if (! path) {
 134         const char *home = getenv ("HOME");
 135
 136         path = talloc_asprintf (local, "%s/.notmuch-config", home);
 137
 138         if (! profile)
 139             profile = getenv ("NOTMUCH_PROFILE");
 140
 141         if (profile)
 142             path = talloc_asprintf (local, "%s.%s", path, profile);
 143     }
 144
 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;
 148     }
 149
 150   DONE:
 151     talloc_free (local);
 152     return status;
 153 }
 154
 155 static notmuch_status_t
 156 _choose_database_path (void *ctx,
 157                        const char *config_path,
 158                        const char *profile,
 159                        GKeyFile **key_file,
 160                        const char **database_path,
 161                        char **message)
 162 {
 163     notmuch_status_t status;
 164
 165     status = _load_key_file (config_path, profile, key_file);
 166     if (status) {
 167         *message = strdup ("Error: cannot load config file.\n");
 168         return status;
 169     }
 170
 171     if (! *database_path) {
 172         *database_path = getenv ("NOTMUCH_DATABASE");
 173     }
 174
 175     if (! *database_path && *key_file) {
 176         char *path = g_key_file_get_value (*key_file, "database", "path", NULL);
 177         if (path) {
 178             *database_path = talloc_strdup (ctx, path);
 179             g_free (path);
 180         }
 181     }
 182
 183     if (*database_path == NULL) {
 184         *message = strdup ("Error: Cannot open a database for a NULL path.\n");
 185         return NOTMUCH_STATUS_NULL_POINTER;
 186     }
 187
 188     if (*database_path[0] != '/') {
 189         *message = strdup ("Error: Database path must be absolute.\n");
 190         return NOTMUCH_STATUS_PATH_ERROR;
 191     }
 192     return NOTMUCH_STATUS_SUCCESS;
 193 }
 194
 195 notmuch_database_t *
 196 _alloc_notmuch ()
 197 {
 198     notmuch_database_t *notmuch;
 199
 200     notmuch = talloc_zero (NULL, notmuch_database_t);
 201     if (! notmuch)
 202         return NULL;
 203
 204     notmuch->exception_reported = false;
 205     notmuch->status_string = NULL;
 206     notmuch->writable_xapian_db = NULL;
 207     notmuch->atomic_nesting = 0;
 208     notmuch->view = 1;
 209     return notmuch;
 210 }
 211
 212 static void
 213 _set_database_path (notmuch_database_t *notmuch,
 214                     const char *database_path)
 215 {
 216     char *path = talloc_strdup (notmuch, database_path);
 217
 218     strip_trailing (path, '/');
 219
 220     _notmuch_config_cache (notmuch, NOTMUCH_CONFIG_DATABASE_PATH, path);
 221 }
 222
 223 notmuch_status_t
 224 notmuch_database_open_with_config (const char *database_path,
 225                                    notmuch_database_mode_t mode,
 226                                    const char *config_path,
 227                                    const char *profile,
 228                                    notmuch_database_t **database,
 229                                    char **status_string)
 230 {
 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;
 236     struct stat st;
 237     int err;
 238     unsigned int version;
 239     GKeyFile *key_file = NULL;
 240     static int initialized = 0;
 241
 242     notmuch = _alloc_notmuch ();
 243     if (! notmuch) {
 244         status = NOTMUCH_STATUS_OUT_OF_MEMORY;
 245         goto DONE;
 246     }
 247
 248     if ((status = _choose_database_path (local, config_path, profile,
 249                                          &key_file, &database_path, &message)))
 250         goto DONE;
 251
 252     _set_database_path (notmuch, database_path);
 253
 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;
 257         goto DONE;
 258     }
 259
 260     err = stat (notmuch_path, &st);
 261     if (err) {
 262         IGNORE_RESULT (asprintf (&message, "Error opening database at %s: %s\n",
 263                                  notmuch_path, strerror (errno)));
 264         status = NOTMUCH_STATUS_FILE_ERROR;
 265         goto DONE;
 266     }
 267
 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;
 271         goto DONE;
 272     }
 273
 274     /* Initialize the GLib type system and threads */
 275 #if ! GLIB_CHECK_VERSION (2, 35, 1)
 276     g_type_init ();
 277 #endif
 278
 279     /* Initialize gmime */
 280     if (! initialized) {
 281         g_mime_init ();
 282         initialized = 1;
 283     }
 284
 285     try {
 286         std::string last_thread_id;
 287         std::string last_mod;
 288
 289         if (mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
 290             notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
 291                                                                         DB_ACTION);
 292             notmuch->xapian_db = notmuch->writable_xapian_db;
 293         } else {
 294             notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path);
 295         }
 296
 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);
 308             notmuch = NULL;
 309             status = NOTMUCH_STATUS_FILE_ERROR;
 310             goto DONE;
 311         }
 312
 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',
 318             &incompat_features);
 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);
 326             notmuch = NULL;
 327             status = NOTMUCH_STATUS_FILE_ERROR;
 328             goto DONE;
 329         }
 330
 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;
 335         } else {
 336             const char *str;
 337             char *end;
 338
 339             str = last_thread_id.c_str ();
 340             notmuch->last_thread_id = strtoull (str, &end, 16);
 341             if (*end != '\0')
 342                 INTERNAL_ERROR ("Malformed database last_thread_id: %s", str);
 343         }
 344
 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;
 350         else
 351             notmuch->revision = Xapian::sortable_unserialise (last_mod);
 352         notmuch->uuid = talloc_strdup (
 353             notmuch, notmuch->xapian_db->get_uuid ().c_str ());
 354
 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,
 360                                                                      "date:");
 361         notmuch->last_mod_range_processor = new Xapian::NumberRangeProcessor (NOTMUCH_VALUE_LAST_MOD,
 362                                                                               "lastmod:");
 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);
 370
 371         /* Configuration information is needed to set up query parser */
 372         status = _notmuch_config_load_from_database (notmuch);
 373         if (status)
 374             goto DONE;
 375
 376         if (key_file)
 377             status = _notmuch_config_load_from_file (notmuch, key_file);
 378         if (status)
 379             goto DONE;
 380
 381         status = _choose_hook_dir (notmuch, profile, &message);
 382         if (status)
 383             goto DONE;
 384
 385         status = _notmuch_config_load_defaults (notmuch);
 386         if (status)
 387             goto DONE;
 388
 389         status = _notmuch_database_setup_standard_query_fields (notmuch);
 390         if (status)
 391             goto DONE;
 392
 393         status = _notmuch_database_setup_user_query_fields (notmuch);
 394         if (status)
 395             goto DONE;
 396
 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);
 401         notmuch = NULL;
 402         status = NOTMUCH_STATUS_XAPIAN_EXCEPTION;
 403     }
 404
 405   DONE:
 406     talloc_free (local);
 407
 408     if (key_file)
 409         g_key_file_free (key_file);
 410
 411     if (message) {
 412         if (status_string)
 413             *status_string = message;
 414         else
 415             free (message);
 416     }
 417
 418     if (database)
 419         *database = notmuch;
 420     else
 421         talloc_free (notmuch);
 422
 423     if (notmuch)
 424         notmuch->open = true;
 425
 426     return status;
 427 }
 428
 429 notmuch_status_t
 430 notmuch_database_create (const char *path, notmuch_database_t **database)
 431 {
 432     char *status_string = NULL;
 433     notmuch_status_t status;
 434
 435     status = notmuch_database_create_verbose (path, database,
 436                                               &status_string);
 437
 438     if (status_string) {
 439         fputs (status_string, stderr);
 440         free (status_string);
 441     }
 442
 443     return status;
 444 }
 445
 446 notmuch_status_t
 447 notmuch_database_create_verbose (const char *path,
 448                                  notmuch_database_t **database,
 449                                  char **status_string)
 450 {
 451     return notmuch_database_create_with_config (path, "", NULL, database, status_string);
 452 }
 453
 454 notmuch_status_t
 455 notmuch_database_create_with_config (const char *database_path,
 456                                      const char *config_path,
 457                                      const char *profile,
 458                                      notmuch_database_t **database,
 459                                      char **status_string)
 460 {
 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;
 466     struct stat st;
 467     int err;
 468     void *local = talloc_new (NULL);
 469
 470     if ((status = _choose_database_path (local, config_path, profile,
 471                                          &key_file, &database_path, &message)))
 472         goto DONE;
 473
 474     err = stat (database_path, &st);
 475     if (err) {
 476         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: %s.\n",
 477                                  database_path, strerror (errno)));
 478         status = NOTMUCH_STATUS_FILE_ERROR;
 479         goto DONE;
 480     }
 481
 482     if (! S_ISDIR (st.st_mode)) {
 483         IGNORE_RESULT (asprintf (&message, "Error: Cannot create database at %s: "
 484                                  "Not a directory.\n",
 485                                  database_path));
 486         status = NOTMUCH_STATUS_FILE_ERROR;
 487         goto DONE;
 488     }
 489
 490     notmuch_path = talloc_asprintf (local, "%s/%s", database_path, ".notmuch");
 491
 492     err = mkdir (notmuch_path, 0755);
 493     if (err) {
 494         if (errno == EEXIST) {
 495             status = NOTMUCH_STATUS_DATABASE_EXISTS;
 496         } else {
 497             IGNORE_RESULT (asprintf (&message, "Error: Cannot create directory %s: %s.\n",
 498                                      notmuch_path, strerror (errno)));
 499             status = NOTMUCH_STATUS_FILE_ERROR;
 500         }
 501         goto DONE;
 502     }
 503
 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,
 507                                                 config_path,
 508                                                 profile,
 509                                                 &notmuch, &message);
 510     if (status)
 511         goto DONE;
 512
 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;
 518
 519     status = notmuch_database_upgrade (notmuch, NULL, NULL);
 520     if (status) {
 521         notmuch_database_close (notmuch);
 522         notmuch = NULL;
 523     }
 524
 525   DONE:
 526     talloc_free (local);
 527
 528     if (key_file)
 529         g_key_file_free (key_file);
 530
 531     if (message) {
 532         if (status_string)
 533             *status_string = message;
 534         else
 535             free (message);
 536     }
 537     if (database)
 538         *database = notmuch;
 539     else
 540         talloc_free (notmuch);
 541     return status;
 542 }
 543
 544 notmuch_status_t
 545 notmuch_database_reopen (notmuch_database_t *notmuch,
 546                          notmuch_database_mode_t new_mode)
 547 {
 548     notmuch_database_mode_t cur_mode = _notmuch_database_mode (notmuch);
 549
 550     if (notmuch->xapian_db == NULL) {
 551         _notmuch_database_log (notmuch, "Cannot reopen closed or nonexistent database\n");
 552         return NOTMUCH_STATUS_ILLEGAL_ARGUMENT;
 553     }
 554
 555     try {
 556         if (cur_mode == new_mode &&
 557             new_mode == NOTMUCH_DATABASE_MODE_READ_ONLY) {
 558             notmuch->xapian_db->reopen ();
 559         } else {
 560             notmuch->xapian_db->close ();
 561
 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;
 566
 567             if (new_mode == NOTMUCH_DATABASE_MODE_READ_WRITE) {
 568                 notmuch->writable_xapian_db = new Xapian::WritableDatabase (notmuch->xapian_path,
 569                                                                             DB_ACTION);
 570                 notmuch->xapian_db = notmuch->writable_xapian_db;
 571             } else {
 572                 notmuch->xapian_db = new Xapian::Database (notmuch->xapian_path,
 573                                                            DB_ACTION);
 574             }
 575         }
 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;
 581         }
 582         return NOTMUCH_STATUS_XAPIAN_EXCEPTION;
 583     }
 584
 585     notmuch->view++;
 586     notmuch->open = true;
 587     return NOTMUCH_STATUS_SUCCESS;
 588 }