Bitcoin Core  26.99.0
P2P Digital Currency
init.cpp
Go to the documentation of this file.
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 std::optional<ConfigError> InitConfig(ArgsManager& args, SettingsAbortFn settings_abort_fn)
19 {
20  try {
21  if (!CheckDataDirOption(args)) {
22  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  // 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  const fs::path orig_datadir_path{args.GetDataDirBase()};
35  const fs::path orig_config_path{AbsPathForConfigVal(args, args.GetPathArg("-conf", BITCOIN_CONF_FILENAME), /*net_specific=*/false)};
36 
37  std::string error;
38  if (!args.ReadConfigFiles(error, true)) {
39  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)
44 
45  // Create datadir if it does not exist.
46  const auto base_path{args.GetDataDirBase()};
47  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  fs::create_directories(base_path / "wallets");
59  }
60  const auto net_path{args.GetDataDirNet()};
61  if (!fs::exists(net_path)) {
62  fs::create_directories(net_path / "wallets");
63  }
64 
65  // Show an error or warning if there is a bitcoin.conf file in the
66  // datadir that is being ignored.
67  const fs::path base_config_path = base_path / BITCOIN_CONF_FILENAME;
68  if (fs::exists(base_config_path) && !fs::equivalent(orig_config_path, base_config_path)) {
69  const std::string cli_config_path = args.GetArg("-conf", "");
70  const std::string config_source = cli_config_path.empty()
71  ? strprintf("data directory %s", fs::quoted(fs::PathToString(orig_datadir_path)))
72  : strprintf("command line argument %s", fs::quoted("-conf=" + cli_config_path));
73  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  fs::quoted(fs::PathToString(base_path)),
82  fs::quoted(fs::PathToString(orig_config_path)),
83  config_source);
84  if (args.GetBoolArg("-allowignoredconf", false)) {
85  LogPrintf("Warning: %s\n", error);
86  } else {
88  }
89  }
90 
91  // Create settings.json if -nosettings was not specified.
92  if (args.GetSettingsPath()) {
93  std::vector<std::string> details;
94  if (!args.ReadSettingsFile(&details)) {
95  const bilingual_str& message = _("Settings file could not be read");
96  if (!settings_abort_fn) {
97  return ConfigError{ConfigStatus::FAILED, message, details};
98  } else if (settings_abort_fn(message, details)) {
99  return ConfigError{ConfigStatus::ABORTED, message, details};
100  } else {
101  details.clear(); // User chose to ignore the error and proceed.
102  }
103  }
104  if (!args.WriteSettingsFile(&details)) {
105  const bilingual_str& message = _("Settings file could not be written");
106  return ConfigError{ConfigStatus::FAILED_WRITE, message, details};
107  }
108  }
109  } catch (const std::exception& e) {
110  return ConfigError{ConfigStatus::FAILED, Untranslated(e.what())};
111  }
112  return {};
113 }
114 } // namespace common
bool CheckDataDirOption(const ArgsManager &args)
Definition: args.cpp:710
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:38
fs::path AbsPathForConfigVal(const ArgsManager &args, const fs::path &path, bool net_specific=true)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
Definition: config.cpp:211
ArgsManager & args
Definition: bitcoind.cpp:268
void SelectParams(const ChainType chain)
Sets the params returned by Params() to those for the given chain type.
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
Definition: args.cpp:400
ChainType GetChainType() const
Returns the appropriate chain type from the program arguments.
Definition: args.cpp:729
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:232
bool GetSettingsPath(fs::path *filepath=nullptr, bool temp=false, bool backup=false) const
Get settings file path, or return false if read-write settings were disabled with -nosettings.
Definition: args.cpp:374
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
Definition: args.cpp:423
fs::path GetDataDirBase() const
Get data directory path.
Definition: args.h:225
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:455
bool ReadConfigFiles(std::string &error, bool ignore_invalid_keys=false)
Definition: config.cpp:118
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:505
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:270
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:33
bool error(const char *fmt, const Args &... args)
Definition: logging.h:267
#define LogPrintf(...)
Definition: logging.h:245
Definition: args.cpp:821
@ ABORTED
Aborted by user.
@ FAILED_WRITE
Failed to write settings.json.
@ FAILED
Failed generically.
std::function< bool(const bilingual_str &message, const std::vector< std::string > &details)> SettingsAbortFn
Callback function to let the user decide whether to abort loading if settings.json file exists and ca...
Definition: init.h:33
std::optional< ConfigError > InitConfig(ArgsManager &args, SettingsAbortFn settings_abort_fn)
Definition: init.cpp:18
static bool create_directories(const std::filesystem::path &p)
Create directory (and if necessary its parents), unless the leaf directory already exists or is a sym...
Definition: fs.h:190
static auto quoted(const std::string &s)
Definition: fs.h:95
static bool exists(const path &p)
Definition: fs.h:89
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
Bilingual messages:
Definition: translation.h:18
void clear()
Definition: translation.h:34
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1162
bilingual_str _(const char *psz)
Translation function.
Definition: translation.h:74
bilingual_str Untranslated(std::string original)
Mark a bilingual_str as untranslated.
Definition: translation.h:48