Branch data Line data Source code
1 : : // Copyright (c) 2009-2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <common/args.h>
7 : :
8 : : #include <chainparamsbase.h>
9 : : #include <common/settings.h>
10 : : #include <logging.h>
11 : : #include <sync.h>
12 : : #include <tinyformat.h>
13 : : #include <univalue.h>
14 : : #include <util/chaintype.h>
15 : : #include <util/check.h>
16 : : #include <util/fs.h>
17 : : #include <util/fs_helpers.h>
18 : : #include <util/strencodings.h>
19 : : #include <util/string.h>
20 : :
21 : : #ifdef WIN32
22 : : #include <shlobj.h>
23 : : #endif
24 : :
25 : : #include <algorithm>
26 : : #include <cassert>
27 : : #include <cstdint>
28 : : #include <cstdlib>
29 : : #include <cstring>
30 : : #include <map>
31 : : #include <optional>
32 : : #include <stdexcept>
33 : : #include <string>
34 : : #include <utility>
35 : : #include <variant>
36 : :
37 : : const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
38 : : const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
39 : :
40 : : ArgsManager gArgs;
41 : :
42 : : /**
43 : : * Interpret a string argument as a boolean.
44 : : *
45 : : * The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values
46 : : * like "foo", return 0. This means that if a user unintentionally supplies a
47 : : * non-integer argument here, the return value is always false. This means that
48 : : * -foo=false does what the user probably expects, but -foo=true is well defined
49 : : * but does not do what they probably expected.
50 : : *
51 : : * The return value of LocaleIndependentAtoi<int>(...) is zero when given input not
52 : : * representable as an int.
53 : : *
54 : : * For a more extensive discussion of this topic (and a wide range of opinions
55 : : * on the Right Way to change this code), see PR12713.
56 : : */
57 : 339862 : static bool InterpretBool(const std::string& strValue)
58 : : {
59 [ + + ]: 339862 : if (strValue.empty())
60 : : return true;
61 [ - + ]: 331536 : return (LocaleIndependentAtoi<int>(strValue) != 0);
62 : : }
63 : :
64 : 1413227 : static std::string SettingName(const std::string& arg)
65 : : {
66 [ - + + - : 1414448 : return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
+ + ]
67 : : }
68 : :
69 : : /**
70 : : * Parse "name", "section.name", "noname", "section.noname" settings keys.
71 : : *
72 : : * @note Where an option was negated can be later checked using the
73 : : * IsArgNegated() method. One use case for this is to have a way to disable
74 : : * options that are not normally boolean (e.g. using -nodebuglogfile to request
75 : : * that debug log output is not sent to any file at all).
76 : : */
77 : 385640 : KeyInfo InterpretKey(std::string key)
78 : : {
79 [ + + ]: 385640 : KeyInfo result;
80 : : // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
81 : 385640 : size_t option_index = key.find('.');
82 [ + + ]: 385640 : if (option_index != std::string::npos) {
83 [ + - ]: 138313 : result.section = key.substr(0, option_index);
84 [ + - ]: 138313 : key.erase(0, option_index + 1);
85 : : }
86 [ - + + + ]: 385640 : if (key.starts_with("no")) {
87 [ + - ]: 105613 : key.erase(0, 2);
88 : 105613 : result.negated = true;
89 : : }
90 [ + - ]: 385640 : result.name = key;
91 : 385640 : return result;
92 : 0 : }
93 : :
94 : : /**
95 : : * Interpret settings value based on registered flags.
96 : : *
97 : : * @param[in] key key information to know if key was negated
98 : : * @param[in] value string value of setting to be parsed
99 : : * @param[in] flags ArgsManager registered argument flags
100 : : * @param[out] error Error description if settings value is not valid
101 : : *
102 : : * @return parsed settings value if it is valid, otherwise nullopt accompanied
103 : : * by a descriptive error string
104 : : */
105 : 364330 : std::optional<common::SettingsValue> InterpretValue(const KeyInfo& key, const std::string* value,
106 : : unsigned int flags, std::string& error)
107 : : {
108 : : // Return negated settings as false values.
109 [ + + ]: 364330 : if (key.negated) {
110 [ - + ]: 105612 : if (flags & ArgsManager::DISALLOW_NEGATION) {
111 : 0 : error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
112 : 0 : return std::nullopt;
113 : : }
114 : : // Double negatives like -nofoo=0 are supported (but discouraged)
115 [ + + + + ]: 105612 : if (value && !InterpretBool(*value)) {
116 : 11 : LogPrintf("Warning: parsed potentially confusing double-negative -%s=%s\n", key.name, *value);
117 : 11 : return true;
118 : : }
119 : 105601 : return false;
120 : : }
121 [ + + + + ]: 258718 : if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
122 : 1 : error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
123 : 1 : return std::nullopt;
124 : : }
125 [ + - ]: 258717 : return value ? *value : "";
126 : : }
127 : :
128 : : // Define default constructor and destructor that are not inline, so code instantiating this class doesn't need to
129 : : // #include class definitions for all members.
130 : : // For example, m_settings has an internal dependency on univalue.
131 : 52099 : ArgsManager::ArgsManager() = default;
132 [ + + ]: 260490 : ArgsManager::~ArgsManager() = default;
133 : :
134 : 49265 : std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
135 : : {
136 [ + - ]: 49265 : std::set<std::string> unsuitables;
137 : :
138 [ + - ]: 49265 : LOCK(cs_args);
139 : :
140 : : // if there's no section selected, don't worry
141 [ - + ]: 49265 : if (m_network.empty()) return std::set<std::string> {};
142 : :
143 : : // if it's okay to use the default section for this network, don't worry
144 [ + - + + ]: 49265 : if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
145 : :
146 [ + + ]: 64566 : for (const auto& arg : m_network_only_args) {
147 [ + - + - : 27712 : if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
+ + ]
148 [ + - ]: 1753 : unsuitables.insert(arg);
149 : : }
150 : : }
151 : 36854 : return unsuitables;
152 : 49265 : }
153 : :
154 : 1776 : std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
155 : : {
156 : : // Section names to be recognized in the config file.
157 : 1776 : static const std::set<std::string> available_sections{
158 : : ChainTypeToString(ChainType::REGTEST),
159 : : ChainTypeToString(ChainType::SIGNET),
160 : : ChainTypeToString(ChainType::TESTNET),
161 : : ChainTypeToString(ChainType::TESTNET4),
162 : : ChainTypeToString(ChainType::MAIN),
163 [ + + + - : 9366 : };
- + + + -
- ]
164 : :
165 : 1776 : LOCK(cs_args);
166 [ + - ]: 1776 : std::list<SectionInfo> unrecognized = m_config_sections;
167 : 2922 : unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.find(appeared.m_name) != available_sections.end(); });
168 [ + - ]: 1776 : return unrecognized;
169 [ + - + - : 3041 : }
+ - + - +
- - - ]
170 : :
171 : 3424 : void ArgsManager::SelectConfigNetwork(const std::string& network)
172 : : {
173 : 3424 : LOCK(cs_args);
174 [ + - + - ]: 6848 : m_network = network;
175 : 3424 : }
176 : :
177 : 52027 : bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
178 : : {
179 : 52027 : LOCK(cs_args);
180 : 52027 : m_settings.command_line_options.clear();
181 : :
182 [ + + ]: 202985 : for (int i = 1; i < argc; i++) {
183 [ + - ]: 152475 : std::string key(argv[i]);
184 : :
185 : : #ifdef __APPLE__
186 : : // At the first time when a user gets the "App downloaded from the
187 : : // internet" warning, and clicks the Open button, macOS passes
188 : : // a unique process serial number (PSN) as -psn_... command-line
189 : : // argument, which we filter out.
190 : : if (key.starts_with("-psn_")) continue;
191 : : #endif
192 : :
193 [ + + ]: 152475 : if (key == "-") break; //bitcoin-tx using stdin
194 : 152463 : std::optional<std::string> val;
195 : 152463 : size_t is_index = key.find('=');
196 [ + + ]: 152463 : if (is_index != std::string::npos) {
197 [ + - ]: 139351 : val = key.substr(is_index + 1);
198 [ + - ]: 139351 : key.erase(is_index);
199 : : }
200 : : #ifdef WIN32
201 : : key = ToLower(key);
202 : : if (key[0] == '/')
203 : : key[0] = '-';
204 : : #endif
205 : :
206 [ + + ]: 152463 : if (key[0] != '-') {
207 [ + + + - ]: 1494 : if (!m_accept_any_command && m_command.empty()) {
208 : : // The first non-dash arg is a registered command
209 [ + - ]: 40 : std::optional<unsigned int> flags = GetArgFlags(key);
210 [ + + - + ]: 40 : if (!flags || !(*flags & ArgsManager::COMMAND)) {
211 [ + - ]: 4 : error = strprintf("Invalid command '%s'", argv[i]);
212 : 4 : return false;
213 : : }
214 : : }
215 [ + - ]: 1490 : m_command.push_back(key);
216 [ + + ]: 2546 : while (++i < argc) {
217 : : // The remaining args are command args
218 [ + - ]: 1056 : m_command.emplace_back(argv[i]);
219 : : }
220 : 1490 : break;
221 : : }
222 : :
223 : : // Transform --foo to -foo
224 [ - + + - : 150969 : if (key.length() > 1 && key[1] == '-')
+ + ]
225 [ + - ]: 6 : key.erase(0, 1);
226 : :
227 : : // Transform -foo to foo
228 [ + - ]: 150969 : key.erase(0, 1);
229 [ - + + - ]: 301938 : KeyInfo keyinfo = InterpretKey(key);
230 [ + - + - ]: 150969 : std::optional<unsigned int> flags = GetArgFlags('-' + keyinfo.name);
231 : :
232 : : // Unknown command line options and command line options with dot
233 : : // characters (which are returned from InterpretKey with nonempty
234 : : // section strings) are not valid.
235 [ + + + + ]: 150969 : if (!flags || !keyinfo.section.empty()) {
236 [ + - ]: 10 : error = strprintf("Invalid parameter %s", argv[i]);
237 : 10 : return false;
238 : : }
239 : :
240 [ + + + - ]: 162655 : std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
241 [ + + ]: 150959 : if (!value) return false;
242 : :
243 [ + - + - ]: 150958 : m_settings.command_line_options[keyinfo.name].push_back(*value);
244 : 304935 : }
245 : :
246 : : // we do not allow -includeconf from command line, only -noincludeconf
247 [ + - + + ]: 52012 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
248 : 5 : const common::SettingsSpan values{*includes};
249 : : // Range may be empty if -noincludeconf was passed
250 [ + - + + ]: 5 : if (!values.empty()) {
251 [ + - + - : 4 : error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
+ - ]
252 : 4 : return false; // pick first value as example
253 : : }
254 : : }
255 : : return true;
256 : 52027 : }
257 : :
258 : 426104 : std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
259 : : {
260 : 426104 : LOCK(cs_args);
261 [ + + ]: 869586 : for (const auto& arg_map : m_available_args) {
262 : 848405 : const auto search = arg_map.second.find(name);
263 [ + + ]: 848405 : if (search != arg_map.second.end()) {
264 : 404923 : return search->second.m_flags;
265 : : }
266 : : }
267 : 21181 : return m_default_flags;
268 : 426104 : }
269 : :
270 : 0 : void ArgsManager::SetDefaultFlags(std::optional<unsigned int> flags)
271 : : {
272 : 0 : LOCK(cs_args);
273 [ # # ]: 0 : m_default_flags = flags;
274 : 0 : }
275 : :
276 : 29896 : fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
277 : : {
278 [ + + ]: 29896 : if (IsArgNegated(arg)) return fs::path{};
279 [ + - ]: 29886 : std::string path_str = GetArg(arg, "");
280 [ + + + - ]: 42939 : if (path_str.empty()) return default_value;
281 [ + - + - ]: 39159 : fs::path result = fs::PathFromString(path_str).lexically_normal();
282 : : // Remove trailing slash, if present.
283 [ + + + - : 39159 : return result.has_filename() ? result : result.parent_path();
+ - ]
284 : 42939 : }
285 : :
286 : 8486 : fs::path ArgsManager::GetBlocksDirPath() const
287 : : {
288 : 8486 : LOCK(cs_args);
289 : 8486 : fs::path& path = m_cached_blocks_path;
290 : :
291 : : // Cache the path to avoid calling fs::create_directories on every call of
292 : : // this function
293 [ + + + - ]: 8486 : if (!path.empty()) return path;
294 : :
295 [ + - + - : 1957 : if (IsArgSet("-blocksdir")) {
+ + ]
296 [ + - + - : 12 : path = fs::absolute(GetPathArg("-blocksdir"));
+ - ]
297 [ + - + + ]: 3 : if (!fs::is_directory(path)) {
298 [ + - ]: 1 : path = "";
299 [ + - ]: 1 : return path;
300 : : }
301 : : } else {
302 [ + - ]: 3908 : path = GetDataDirBase();
303 : : }
304 : :
305 [ + - + - ]: 3912 : path /= fs::PathFromString(BaseParams().DataDir());
306 [ + - ]: 1956 : path /= "blocks";
307 [ + - ]: 1956 : fs::create_directories(path);
308 [ + - + - ]: 8486 : return path;
309 : 8486 : }
310 : :
311 : 42279 : fs::path ArgsManager::GetDataDir(bool net_specific) const
312 : : {
313 : 42279 : LOCK(cs_args);
314 [ + + ]: 42279 : fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
315 : :
316 : : // Used cached path if available
317 [ + + + - : 49586 : if (!path.empty()) return path;
+ - ]
318 : :
319 [ + - + - ]: 14614 : const fs::path datadir{GetPathArg("-datadir")};
320 [ + + ]: 7307 : if (!datadir.empty()) {
321 [ + - ]: 14604 : path = fs::absolute(datadir);
322 [ + - - + ]: 7302 : if (!fs::is_directory(path)) {
323 [ # # ]: 0 : path = "";
324 [ # # ]: 0 : return path;
325 : : }
326 : : } else {
327 [ + - ]: 15 : path = GetDefaultDataDir();
328 : : }
329 : :
330 [ + + + - : 7307 : if (net_specific && !BaseParams().DataDir().empty()) {
+ + ]
331 [ + - + - ]: 7224 : path /= fs::PathFromString(BaseParams().DataDir());
332 : : }
333 : :
334 [ + - ]: 7307 : return path;
335 : 49586 : }
336 : :
337 : 2861 : void ArgsManager::ClearPathCache()
338 : : {
339 : 2861 : LOCK(cs_args);
340 : :
341 : 2861 : m_cached_datadir_path = fs::path();
342 : 2861 : m_cached_network_datadir_path = fs::path();
343 [ + - ]: 5722 : m_cached_blocks_path = fs::path();
344 : 2861 : }
345 : :
346 : 37 : std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
347 : : {
348 [ + - ]: 37 : Command ret;
349 [ + - ]: 37 : LOCK(cs_args);
350 [ + + ]: 37 : auto it = m_command.begin();
351 [ + + ]: 37 : if (it == m_command.end()) {
352 : : // No command was passed
353 : 1 : return std::nullopt;
354 : : }
355 [ + - ]: 36 : if (!m_accept_any_command) {
356 : : // The registered command
357 [ + - ]: 36 : ret.command = *(it++);
358 : : }
359 [ + + ]: 46 : while (it != m_command.end()) {
360 : : // The unregistered command and args (if any)
361 [ + - ]: 10 : ret.args.push_back(*(it++));
362 : : }
363 : 36 : return ret;
364 : 74 : }
365 : :
366 : 175451 : std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
367 : : {
368 : 175451 : std::vector<std::string> result;
369 [ + - + + ]: 271295 : for (const common::SettingsValue& value : GetSettingsList(strArg)) {
370 [ - + - - : 287528 : result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
+ + + - +
- - + +
- ]
371 : : }
372 : 175451 : return result;
373 : 0 : }
374 : :
375 : 131525 : bool ArgsManager::IsArgSet(const std::string& strArg) const
376 : : {
377 : 131525 : return !GetSetting(strArg).isNull();
378 : : }
379 : :
380 : 5022 : bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
381 : : {
382 [ + - + - ]: 10044 : fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
383 [ + + ]: 5022 : if (settings.empty()) {
384 : : return false;
385 : : }
386 [ - + ]: 5019 : if (backup) {
387 [ # # ]: 0 : settings += ".bak";
388 : : }
389 [ + + ]: 5019 : if (filepath) {
390 [ + + + - : 25860 : *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
+ - + - +
+ - - ]
391 : : }
392 : : return true;
393 : 5022 : }
394 : :
395 : 4 : static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
396 : : {
397 [ + + ]: 8 : for (const auto& error : errors) {
398 [ + + ]: 4 : if (error_out) {
399 : 3 : error_out->emplace_back(error);
400 : : } else {
401 : 1 : LogPrintf("%s\n", error);
402 : : }
403 : : }
404 : 4 : }
405 : :
406 : 1160 : bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
407 : : {
408 : 1160 : fs::path path;
409 [ + - + - ]: 1160 : if (!GetSettingsPath(&path, /* temp= */ false)) {
410 : : return true; // Do nothing if settings file disabled.
411 : : }
412 : :
413 [ + - ]: 1160 : LOCK(cs_args);
414 : 1160 : m_settings.rw_settings.clear();
415 : 1160 : std::vector<std::string> read_errors;
416 [ + - + + ]: 1160 : if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
417 [ + - + - ]: 3 : SaveErrors(read_errors, errors);
418 : 3 : return false;
419 : : }
420 [ + + ]: 1294 : for (const auto& setting : m_settings.rw_settings) {
421 [ - + + - ]: 274 : KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
422 [ + - + - : 137 : if (!GetArgFlags('-' + key.name)) {
+ + ]
423 [ + - ]: 7 : LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
424 : : }
425 : 137 : }
426 : : return true;
427 [ + - ]: 3480 : }
428 : :
429 : 1350 : bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
430 : : {
431 : 1350 : fs::path path, path_tmp;
432 [ + - + - : 1350 : if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
+ - - + ]
433 [ # # ]: 0 : throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
434 : : }
435 : :
436 [ + - ]: 1350 : LOCK(cs_args);
437 : 1350 : std::vector<std::string> write_errors;
438 [ + - - + ]: 1350 : if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
439 [ # # # # ]: 0 : SaveErrors(write_errors, errors);
440 : 0 : return false;
441 : : }
442 [ + - + - : 4050 : if (!RenameOver(path_tmp, path)) {
+ - + + ]
443 [ - + + - : 4 : SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
+ - + + -
- ]
444 : 1 : return false;
445 : : }
446 : : return true;
447 [ - + + - : 5402 : }
+ - ]
448 : :
449 : 0 : common::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const
450 : : {
451 : 0 : LOCK(cs_args);
452 [ # # # # : 0 : return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
# # ]
453 [ # # ]: 0 : /*ignore_nonpersistent=*/true, /*get_chain_type=*/false);
454 : 0 : }
455 : :
456 : 82569 : bool ArgsManager::IsArgNegated(const std::string& strArg) const
457 : : {
458 : 82569 : return GetSetting(strArg).isFalse();
459 : : }
460 : :
461 : 91831 : std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
462 : : {
463 [ + - ]: 183660 : return GetArg(strArg).value_or(strDefault);
464 : : }
465 : :
466 : 169334 : std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
467 : : {
468 : 169334 : const common::SettingsValue value = GetSetting(strArg);
469 [ + + ]: 338666 : return SettingToString(value);
470 : 169334 : }
471 : :
472 : 169334 : std::optional<std::string> SettingToString(const common::SettingsValue& value)
473 : : {
474 [ + + ]: 169334 : if (value.isNull()) return std::nullopt;
475 [ + + ]: 65350 : if (value.isFalse()) return "0";
476 [ + + ]: 53638 : if (value.isTrue()) return "1";
477 [ + + - + ]: 53633 : if (value.isNum()) return value.getValStr();
478 [ - + ]: 107252 : return value.get_str();
479 : : }
480 : :
481 : 0 : std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault)
482 : : {
483 [ # # ]: 0 : return SettingToString(value).value_or(strDefault);
484 : : }
485 : :
486 : 172534 : int64_t ArgsManager::GetIntArg(const std::string& strArg, int64_t nDefault) const
487 : : {
488 [ + + ]: 172534 : return GetIntArg(strArg).value_or(nDefault);
489 : : }
490 : :
491 : 204916 : std::optional<int64_t> ArgsManager::GetIntArg(const std::string& strArg) const
492 : : {
493 : 204916 : const common::SettingsValue value = GetSetting(strArg);
494 [ + + ]: 409829 : return SettingToInt(value);
495 : 204916 : }
496 : :
497 : 204916 : std::optional<int64_t> SettingToInt(const common::SettingsValue& value)
498 : : {
499 [ + + ]: 204916 : if (value.isNull()) return std::nullopt;
500 [ + + ]: 13010 : if (value.isFalse()) return 0;
501 [ + + ]: 13005 : if (value.isTrue()) return 1;
502 [ + + ]: 13002 : if (value.isNum()) return value.getInt<int64_t>();
503 [ - + ]: 12999 : return LocaleIndependentAtoi<int64_t>(value.get_str());
504 : : }
505 : :
506 : 0 : int64_t SettingToInt(const common::SettingsValue& value, int64_t nDefault)
507 : : {
508 [ # # ]: 0 : return SettingToInt(value).value_or(nDefault);
509 : : }
510 : :
511 : 510183 : bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
512 : : {
513 [ + + ]: 510183 : return GetBoolArg(strArg).value_or(fDefault);
514 : : }
515 : :
516 : 529547 : std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
517 : : {
518 : 529547 : const common::SettingsValue value = GetSetting(strArg);
519 [ + + ]: 1059084 : return SettingToBool(value);
520 : 529547 : }
521 : :
522 : 529547 : std::optional<bool> SettingToBool(const common::SettingsValue& value)
523 : : {
524 [ + + ]: 529547 : if (value.isNull()) return std::nullopt;
525 [ + + ]: 228313 : if (value.isBool()) return value.get_bool();
526 : 226702 : return InterpretBool(value.get_str());
527 : : }
528 : :
529 : 0 : bool SettingToBool(const common::SettingsValue& value, bool fDefault)
530 : : {
531 [ # # ]: 0 : return SettingToBool(value).value_or(fDefault);
532 : : }
533 : :
534 : 52260 : bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
535 : : {
536 : 52260 : LOCK(cs_args);
537 [ + - + + ]: 52260 : if (IsArgSet(strArg)) return false;
538 [ + - ]: 1952 : ForceSetArg(strArg, strValue);
539 : : return true;
540 : 52260 : }
541 : :
542 : 4764 : bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
543 : : {
544 [ + + ]: 4764 : if (fValue)
545 [ + - ]: 2284 : return SoftSetArg(strArg, std::string("1"));
546 : : else
547 [ + - ]: 2480 : return SoftSetArg(strArg, std::string("0"));
548 : : }
549 : :
550 : 51359 : void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
551 : : {
552 : 51359 : LOCK(cs_args);
553 [ + - + - : 51359 : m_settings.forced_settings[SettingName(strArg)] = strValue;
+ - + - ]
554 : 51359 : }
555 : :
556 : 147 : void ArgsManager::AddCommand(const std::string& cmd, const std::string& help)
557 : : {
558 : 147 : Assert(cmd.find('=') == std::string::npos);
559 : 147 : Assert(cmd.at(0) != '-');
560 : :
561 : 147 : LOCK(cs_args);
562 : 147 : m_accept_any_command = false; // latch to false
563 [ + - ]: 147 : std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
564 [ + - - + : 294 : auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
+ - ]
565 [ + - ]: 147 : Assert(ret.second); // Fail on duplicate commands
566 : 147 : }
567 : :
568 : 437138 : void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
569 : : {
570 : 437138 : Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
571 : :
572 : : // Split arg name from its help param
573 : 437138 : size_t eq_index = name.find('=');
574 [ + + ]: 437138 : if (eq_index == std::string::npos) {
575 [ - + ]: 225670 : eq_index = name.size();
576 : : }
577 : 437138 : std::string arg_name = name.substr(0, eq_index);
578 : :
579 [ + - ]: 437138 : LOCK(cs_args);
580 [ + - ]: 437138 : std::map<std::string, Arg>& arg_map = m_available_args[cat];
581 [ - + + - : 874276 : auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
- + + - ]
582 [ - + ]: 437138 : assert(ret.second); // Make sure an insertion actually happened
583 : :
584 [ + + ]: 437138 : if (flags & ArgsManager::NETWORK_ONLY) {
585 [ + - ]: 15645 : m_network_only_args.emplace(arg_name);
586 : : }
587 : 437138 : }
588 : :
589 : 4844 : void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
590 : : {
591 [ + + ]: 25446 : for (const std::string& name : names) {
592 [ + - ]: 41204 : AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
593 : : }
594 : 4844 : }
595 : :
596 : 625 : void ArgsManager::ClearArgs()
597 : : {
598 : 625 : LOCK(cs_args);
599 : 625 : m_settings = {};
600 : 625 : m_available_args.clear();
601 [ + - ]: 625 : m_network_only_args.clear();
602 : 625 : }
603 : :
604 : 1058 : void ArgsManager::CheckMultipleCLIArgs() const
605 : : {
606 : 1058 : LOCK(cs_args);
607 : 1058 : std::vector<std::string> found{};
608 : 1058 : auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
609 [ + - ]: 1058 : if (cmds != m_available_args.end()) {
610 [ + - + + ]: 5290 : for (const auto& [cmd, argspec] : cmds->second) {
611 [ + - + + ]: 4232 : if (IsArgSet(cmd)) {
612 [ + - ]: 42 : found.push_back(cmd);
613 : : }
614 : : }
615 [ - + + + ]: 1058 : if (found.size() > 1) {
616 [ + - + - : 2 : throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
+ - ]
617 : : }
618 : : }
619 [ + - ]: 2115 : }
620 : :
621 : 1 : std::string ArgsManager::GetHelpMessage() const
622 : : {
623 [ + - ]: 1 : const bool show_debug = GetBoolArg("-help-debug", false);
624 : :
625 [ + - ]: 1 : std::string usage;
626 [ + - ]: 1 : LOCK(cs_args);
627 [ + - ]: 11 : for (const auto& arg_map : m_available_args) {
628 [ + + + + : 11 : switch(arg_map.first) {
+ + + - +
+ + - - -
- + ]
629 : 1 : case OptionsCategory::OPTIONS:
630 [ + - + - ]: 2 : usage += HelpMessageGroup("Options:");
631 : 1 : break;
632 : 1 : case OptionsCategory::CONNECTION:
633 [ + - + - ]: 2 : usage += HelpMessageGroup("Connection options:");
634 : 1 : break;
635 : 1 : case OptionsCategory::ZMQ:
636 [ + - + - ]: 2 : usage += HelpMessageGroup("ZeroMQ notification options:");
637 : 1 : break;
638 : 1 : case OptionsCategory::DEBUG_TEST:
639 [ + - + - ]: 2 : usage += HelpMessageGroup("Debugging/Testing options:");
640 : 1 : break;
641 : 1 : case OptionsCategory::NODE_RELAY:
642 [ + - + - ]: 2 : usage += HelpMessageGroup("Node relay options:");
643 : 1 : break;
644 : 1 : case OptionsCategory::BLOCK_CREATION:
645 [ + - + - ]: 2 : usage += HelpMessageGroup("Block creation options:");
646 : 1 : break;
647 : 1 : case OptionsCategory::RPC:
648 [ + - + - ]: 2 : usage += HelpMessageGroup("RPC server options:");
649 : 1 : break;
650 : 0 : case OptionsCategory::IPC:
651 [ # # # # ]: 0 : usage += HelpMessageGroup("IPC interprocess connection options:");
652 : 0 : break;
653 : 1 : case OptionsCategory::WALLET:
654 [ + - + - ]: 2 : usage += HelpMessageGroup("Wallet options:");
655 : 1 : break;
656 : 1 : case OptionsCategory::WALLET_DEBUG_TEST:
657 [ - + - - : 1 : if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
- - ]
658 : : break;
659 : 1 : case OptionsCategory::CHAINPARAMS:
660 [ + - + - ]: 2 : usage += HelpMessageGroup("Chain selection options:");
661 : 1 : break;
662 : 0 : case OptionsCategory::GUI:
663 [ # # # # ]: 0 : usage += HelpMessageGroup("UI Options:");
664 : 0 : break;
665 : 0 : case OptionsCategory::COMMANDS:
666 [ # # # # ]: 0 : usage += HelpMessageGroup("Commands:");
667 : 0 : break;
668 : 0 : case OptionsCategory::REGISTER_COMMANDS:
669 [ # # # # ]: 0 : usage += HelpMessageGroup("Register Commands:");
670 : 0 : break;
671 : 0 : case OptionsCategory::CLI_COMMANDS:
672 [ # # # # ]: 0 : usage += HelpMessageGroup("CLI Commands:");
673 : 0 : break;
674 : : default:
675 : : break;
676 : : }
677 : :
678 : : // When we get to the hidden options, stop
679 [ + + ]: 11 : if (arg_map.first == OptionsCategory::HIDDEN) break;
680 : :
681 [ + + ]: 190 : for (const auto& arg : arg_map.second) {
682 [ + - + + ]: 180 : if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
683 [ + + ]: 139 : std::string name;
684 [ + + ]: 139 : if (arg.second.m_help_param.empty()) {
685 [ + - ]: 57 : name = arg.first;
686 : : } else {
687 [ + - ]: 82 : name = arg.first + arg.second.m_help_param;
688 : : }
689 [ + - ]: 278 : usage += HelpMessageOpt(name, arg.second.m_help_text);
690 : 139 : }
691 : : }
692 : : }
693 [ + - ]: 1 : return usage;
694 : 1 : }
695 : :
696 : 2357 : bool HelpRequested(const ArgsManager& args)
697 : : {
698 [ + - + - : 11783 : return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
+ - + - +
- + + + -
+ - + - +
- + - + -
+ + + - -
- - - -
- ]
699 : : }
700 : :
701 : 3025 : void SetupHelpOptions(ArgsManager& args)
702 : : {
703 [ + - + - ]: 6050 : args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
704 [ + - ]: 3025 : args.AddHiddenArgs({"-h", "-?"});
705 : 3025 : }
706 : :
707 : : static const int screenWidth = 79;
708 : : static const int optIndent = 2;
709 : : static const int msgIndent = 7;
710 : :
711 : 9 : std::string HelpMessageGroup(const std::string &message) {
712 [ + - ]: 27 : return std::string(message) + std::string("\n\n");
713 : : }
714 : :
715 : 139 : std::string HelpMessageOpt(const std::string &option, const std::string &message) {
716 [ + - + - ]: 278 : return std::string(optIndent,' ') + std::string(option) +
717 [ + - + - : 556 : std::string("\n") + std::string(msgIndent,' ') +
+ - ]
718 [ + - + - ]: 417 : FormatParagraph(message, screenWidth - msgIndent, msgIndent) +
719 [ + - ]: 417 : std::string("\n\n");
720 : : }
721 : :
722 : : const std::vector<std::string> TEST_OPTIONS_DOC{
723 : : "addrman (use deterministic addrman)",
724 : : "reindex_after_failure_noninteractive_yes (When asked for a reindex after failure interactively, simulate as-if answered with 'yes')",
725 : : "bip94 (enforce BIP94 consensus rules)",
726 : : };
727 : :
728 : 4279 : bool HasTestOption(const ArgsManager& args, const std::string& test_option)
729 : : {
730 [ + - ]: 4279 : const auto options = args.GetArgs("-test");
731 [ - + - + : 51348 : return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
- + + - -
+ + - - +
+ - - + +
- ]
732 [ + + ]: 25 : return option == test_option;
733 : 4279 : });
734 : 4279 : }
735 : :
736 : 1129 : fs::path GetDefaultDataDir()
737 : : {
738 : : // Windows:
739 : : // old: C:\Users\Username\AppData\Roaming\Bitcoin
740 : : // new: C:\Users\Username\AppData\Local\Bitcoin
741 : : // macOS: ~/Library/Application Support/Bitcoin
742 : : // Unix-like: ~/.bitcoin
743 : : #ifdef WIN32
744 : : // Windows
745 : : // Check for existence of datadir in old location and keep it there
746 : : fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
747 : : if (fs::exists(legacy_path)) return legacy_path;
748 : :
749 : : // Otherwise, fresh installs can start in the new, "proper" location
750 : : return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) / "Bitcoin";
751 : : #else
752 : 1129 : fs::path pathRet;
753 : 1129 : char* pszHome = getenv("HOME");
754 [ + - - + ]: 1129 : if (pszHome == nullptr || strlen(pszHome) == 0)
755 [ # # ]: 0 : pathRet = fs::path("/");
756 : : else
757 [ + - ]: 2258 : pathRet = fs::path(pszHome);
758 : : #ifdef __APPLE__
759 : : // macOS
760 : : return pathRet / "Library/Application Support/Bitcoin";
761 : : #else
762 : : // Unix-like
763 [ + - + - ]: 3387 : return pathRet / ".bitcoin";
764 : : #endif
765 : : #endif
766 : 1129 : }
767 : :
768 : 4503 : bool CheckDataDirOption(const ArgsManager& args)
769 : : {
770 [ + - + - ]: 9006 : const fs::path datadir{args.GetPathArg("-datadir")};
771 [ + + + - : 9001 : return datadir.empty() || fs::is_directory(fs::absolute(datadir));
+ - + + ]
772 : 4503 : }
773 : :
774 : 3368 : fs::path ArgsManager::GetConfigFilePath() const
775 : : {
776 : 3368 : LOCK(cs_args);
777 [ + - + - : 3368 : return *Assert(m_config_path);
+ - ]
778 : 3368 : }
779 : :
780 : 1 : void ArgsManager::SetConfigFilePath(fs::path path)
781 : : {
782 : 1 : LOCK(cs_args);
783 [ - + ]: 1 : assert(!m_config_path);
784 [ + - ]: 1 : m_config_path = path;
785 : 1 : }
786 : :
787 : 4148 : ChainType ArgsManager::GetChainType() const
788 : : {
789 : 4148 : std::variant<ChainType, std::string> arg = GetChainArg();
790 [ + - ]: 4148 : if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed;
791 [ # # # # : 0 : throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg)));
# # ]
792 : 4148 : }
793 : :
794 : 5859 : std::string ArgsManager::GetChainTypeString() const
795 : : {
796 : 5859 : auto arg = GetChainArg();
797 [ + - + - ]: 5672 : if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
798 [ - - - - ]: 5672 : return std::get<std::string>(arg);
799 : 5672 : }
800 : :
801 : 10007 : std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
802 : : {
803 : 50035 : auto get_net = [&](const std::string& arg) {
804 : 40028 : LOCK(cs_args);
805 [ + - + - ]: 80056 : common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
806 : : /* ignore_default_section_config= */ false,
807 : : /*ignore_nonpersistent=*/false,
808 [ + - ]: 40028 : /* get_chain_type= */ true);
809 [ + + - + : 40028 : return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
- - + - +
- ]
810 [ + - ]: 80056 : };
811 : :
812 [ + - ]: 10007 : const bool fRegTest = get_net("-regtest");
813 [ + - ]: 10007 : const bool fSigNet = get_net("-signet");
814 [ + - ]: 10007 : const bool fTestNet = get_net("-testnet");
815 [ + - ]: 10007 : const bool fTestNet4 = get_net("-testnet4");
816 [ + - ]: 10007 : const auto chain_arg = GetArg("-chain");
817 : :
818 [ + + ]: 10007 : if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
819 [ + - ]: 187 : throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
820 : : }
821 [ + + ]: 9820 : if (chain_arg) {
822 [ - + + - : 28 : if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
+ - ]
823 : : // Not a known string, so return original string
824 [ # # ]: 0 : return *chain_arg;
825 : : }
826 [ + + ]: 9792 : if (fRegTest) return ChainType::REGTEST;
827 [ + + ]: 1777 : if (fSigNet) return ChainType::SIGNET;
828 [ + + ]: 1650 : if (fTestNet) return ChainType::TESTNET;
829 [ + + ]: 1642 : if (fTestNet4) return ChainType::TESTNET4;
830 : 1304 : return ChainType::MAIN;
831 : 9820 : }
832 : :
833 : 1294128 : bool ArgsManager::UseDefaultSection(const std::string& arg) const
834 : : {
835 [ + + + + ]: 1294128 : return m_network == ChainTypeToString(ChainType::MAIN) || m_network_only_args.count(arg) == 0;
836 : : }
837 : :
838 : 1117917 : common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
839 : : {
840 : 1117917 : LOCK(cs_args);
841 : 1117917 : return common::GetSetting(
842 [ + - + - ]: 2235834 : m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
843 [ + - + - ]: 1117917 : /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
844 : 1117917 : }
845 : :
846 : 176211 : std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
847 : : {
848 : 176211 : LOCK(cs_args);
849 [ + - + - : 352422 : return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
+ - + - ]
850 : 176211 : }
851 : :
852 : 3365 : void ArgsManager::logArgsPrefix(
853 : : const std::string& prefix,
854 : : const std::string& section,
855 : : const std::map<std::string, std::vector<common::SettingsValue>>& args) const
856 : : {
857 [ + + + - ]: 4484 : std::string section_str = section.empty() ? "" : "[" + section + "] ";
858 [ + + ]: 41370 : for (const auto& arg : args) {
859 [ + + ]: 78429 : for (const auto& value : arg.second) {
860 [ + - + - ]: 40424 : std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
861 [ + - ]: 40424 : if (flags) {
862 [ + + + - : 40424 : std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
+ - ]
863 [ + - ]: 40424 : LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
864 : 40424 : }
865 : : }
866 : : }
867 : 3365 : }
868 : :
869 : 1125 : void ArgsManager::LogArgs() const
870 : : {
871 : 1125 : LOCK(cs_args);
872 [ + + ]: 3365 : for (const auto& section : m_settings.ro_config) {
873 [ + - + - ]: 4480 : logArgsPrefix("Config file arg:", section.first, section.second);
874 : : }
875 [ + + ]: 1257 : for (const auto& setting : m_settings.rw_settings) {
876 [ + - + - ]: 264 : LogPrintf("Setting file arg: %s = %s\n", setting.first, setting.second.write());
877 : : }
878 [ + - + - : 2250 : logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
+ - + - ]
879 : 1125 : }
|
