Branch data     Line data    Source code

       1                 :            : // Copyright (c) 2023 The Bitcoin Core developers
       2                 :            : // Distributed under the MIT software license, see the accompanying
       3                 :            : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
       4                 :            : 
       5                 :            : #include <chainparams.h>
       6                 :            : #include <common/args.h>
       7                 :            : #include <common/init.h>
       8                 :            : #include <logging.h>
       9                 :            : #include <tinyformat.h>
      10                 :            : #include <util/fs.h>
      11                 :            : #include <util/translation.h>
      12                 :            : 
      13                 :            : #include <algorithm>
      14                 :            : #include <exception>
      15                 :            : #include <optional>
      16                 :            : 
      17                 :            : namespace common {
      18                 :          0 : std::optional<ConfigError> InitConfig(ArgsManager& args, SettingsAbortFn settings_abort_fn)
      19                 :            : {
      20                 :            :     try {
      21                 :          0 :         if (!CheckDataDirOption(args)) {
      22                 :          0 :             return ConfigError{ConfigStatus::FAILED, strprintf(_("Specified data directory \"%s\" does not exist."), args.GetArg("-datadir", ""))};
      23                 :            :         }
      24                 :            : 
      25                 :            :         // Record original datadir and config paths before parsing the config
      26                 :            :         // file. It is possible for the config file to contain a datadir= line
      27                 :          0 :         // that changes the datadir path after it is parsed. This is useful for
      28                 :            :         // CLI tools to let them use a different data storage location without
      29                 :            :         // needing to pass it every time on the command line. (It is not
      30                 :            :         // possible for the config file to cause another configuration to be
      31                 :            :         // used, though. Specifying a conf= option in the config file causes a
      32                 :            :         // parse error, and specifying a datadir= location containing another
      33                 :            :         // bitcoin.conf file just ignores the other file.)
      34                 :          0 :         const fs::path orig_datadir_path{args.GetDataDirBase()};
      35                 :          0 :         const fs::path orig_config_path{AbsPathForConfigVal(args, args.GetPathArg("-conf", BITCOIN_CONF_FILENAME), /*net_specific=*/false)};
      36                 :            : 
      37                 :          0 :         std::string error;
      38                 :          0 :         if (!args.ReadConfigFiles(error, true)) {
      39                 :          0 :             return ConfigError{ConfigStatus::FAILED, strprintf(_("Error reading configuration file: %s"), error)};
      40                 :            :         }
      41                 :            : 
      42                 :            :         // Check for chain settings (Params() calls are only valid after this clause)
      43                 :          0 :         SelectParams(args.GetChainType());
      44                 :            : 
      45                 :            :         // Create datadir if it does not exist.
      46                 :          0 :         const auto base_path{args.GetDataDirBase()};
      47                 :          0 :         if (!fs::exists(base_path)) {
      48                 :            :             // When creating a *new* datadir, also create a "wallets" subdirectory,
      49                 :            :             // whether or not the wallet is enabled now, so if the wallet is enabled
      50                 :            :             // in the future, it will use the "wallets" subdirectory for creating
      51                 :            :             // and listing wallets, rather than the top-level directory where
      52                 :            :             // wallets could be mixed up with other files. For backwards
      53                 :            :             // compatibility, wallet code will use the "wallets" subdirectory only
      54                 :            :             // if it already exists, but never create it itself. There is discussion
      55                 :            :             // in https://github.com/bitcoin/bitcoin/issues/16220 about ways to
      56                 :            :             // change wallet code so it would no longer be necessary to create
      57                 :            :             // "wallets" subdirectories here.
      58                 :          0 :             fs::create_directories(base_path / "wallets");
      59                 :          0 :         }
      60                 :          0 :         const auto net_path{args.GetDataDirNet()};
      61                 :          0 :         if (!fs::exists(net_path)) {
      62                 :          0 :             fs::create_directories(net_path / "wallets");
      63                 :          0 :         }
      64                 :            : 
      65                 :            :         // Show an error or warning if there is a bitcoin.conf file in the
      66                 :            :         // datadir that is being ignored.
      67                 :          0 :         const fs::path base_config_path = base_path / BITCOIN_CONF_FILENAME;
      68                 :          0 :         if (fs::exists(base_config_path) && !fs::equivalent(orig_config_path, base_config_path)) {
      69                 :          0 :             const std::string cli_config_path = args.GetArg("-conf", "");
      70                 :          0 :             const std::string config_source = cli_config_path.empty()
      71                 :          0 :                 ? strprintf("data directory %s", fs::quoted(fs::PathToString(orig_datadir_path)))
      72                 :          0 :                 : strprintf("command line argument %s", fs::quoted("-conf=" + cli_config_path));
      73                 :          0 :             const std::string error = strprintf(
      74                 :            :                 "Data directory %1$s contains a %2$s file which is ignored, because a different configuration file "
      75                 :            :                 "%3$s from %4$s is being used instead. Possible ways to address this would be to:\n"
      76                 :            :                 "- Delete or rename the %2$s file in data directory %1$s.\n"
      77                 :            :                 "- Change datadir= or conf= options to specify one configuration file, not two, and use "
      78                 :            :                 "includeconf= to include any other configuration files.\n"
      79                 :            :                 "- Set allowignoredconf=1 option to treat this condition as a warning, not an error.",
      80                 :          0 :                 fs::quoted(fs::PathToString(base_path)),
      81                 :          0 :                 fs::quoted(BITCOIN_CONF_FILENAME),
      82                 :          0 :                 fs::quoted(fs::PathToString(orig_config_path)),
      83                 :            :                 config_source);
      84                 :          0 :             if (args.GetBoolArg("-allowignoredconf", false)) {
      85                 :          0 :                 LogPrintf("Warning: %s\n", error);
      86                 :          0 :             } else {
      87                 :          0 :                 return ConfigError{ConfigStatus::FAILED, Untranslated(error)};
      88                 :            :             }
      89                 :          0 :         }
      90                 :            : 
      91                 :            :         // Create settings.json if -nosettings was not specified.
      92                 :          0 :         if (args.GetSettingsPath()) {
      93                 :          0 :             std::vector<std::string> details;
      94                 :          0 :             if (!args.ReadSettingsFile(&details)) {
      95                 :          0 :                 const bilingual_str& message = _("Settings file could not be read");
      96                 :          0 :                 if (!settings_abort_fn) {
      97                 :          0 :                     return ConfigError{ConfigStatus::FAILED, message, details};
      98                 :          0 :                 } else if (settings_abort_fn(message, details)) {
      99                 :          0 :                     return ConfigError{ConfigStatus::ABORTED, message, details};
     100                 :            :                 } else {
     101                 :          0 :                     details.clear(); // User chose to ignore the error and proceed.
     102                 :            :                 }
     103                 :          0 :             }
     104                 :          0 :             if (!args.WriteSettingsFile(&details)) {
     105                 :          0 :                 const bilingual_str& message = _("Settings file could not be written");
     106                 :          0 :                 return ConfigError{ConfigStatus::FAILED_WRITE, message, details};
     107                 :          0 :             }
     108                 :          0 :         }
     109                 :          0 :     } catch (const std::exception& e) {
     110                 :          0 :         return ConfigError{ConfigStatus::FAILED, Untranslated(e.what())};
     111                 :          0 :     }
     112                 :          0 :     return {};
     113                 :          0 : }
     114                 :            : } // namespace common