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 : 26555 : static bool InterpretBool(const std::string& strValue)
58 : : {
59 [ + + ]: 26555 : if (strValue.empty())
60 : : return true;
61 [ - + ]: 22574 : return (LocaleIndependentAtoi<int>(strValue) != 0);
62 : : }
63 : :
64 : 1079368 : static std::string SettingName(const std::string& arg)
65 : : {
66 [ - + + + : 1169502 : 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 : 115851 : KeyInfo InterpretKey(std::string key)
78 : : {
79 [ + + ]: 115851 : KeyInfo result;
80 : : // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
81 : 115851 : size_t option_index = key.find('.');
82 [ + + ]: 115851 : if (option_index != std::string::npos) {
83 [ + - ]: 2731 : result.section = key.substr(0, option_index);
84 [ + - ]: 2731 : key.erase(0, option_index + 1);
85 : : }
86 [ - + + + ]: 115851 : if (key.starts_with("no")) {
87 [ + - ]: 32471 : key.erase(0, 2);
88 : 32471 : result.negated = true;
89 : : }
90 [ + - ]: 115851 : result.name = key;
91 : 115851 : 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 : 101094 : 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 [ + + ]: 101094 : if (key.negated) {
110 [ + + ]: 29085 : if (flags & ArgsManager::DISALLOW_NEGATION) {
111 : 683 : error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
112 : 683 : return std::nullopt;
113 : : }
114 : : // Double negatives like -nofoo=0 are supported (but discouraged)
115 [ + + + + ]: 28402 : if (value && !InterpretBool(*value)) {
116 : 6951 : LogPrintf("Warning: parsed potentially confusing double-negative -%s=%s\n", key.name, *value);
117 : 6951 : return true;
118 : : }
119 : 21451 : return false;
120 : : }
121 [ + + + + ]: 72009 : if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
122 : 1026 : error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
123 : 1026 : return std::nullopt;
124 : : }
125 [ + - ]: 70983 : 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 : 1908 : ArgsManager::ArgsManager() = default;
132 [ - + ]: 9540 : ArgsManager::~ArgsManager() = default;
133 : :
134 : 1676 : std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
135 : : {
136 [ + - ]: 1676 : std::set<std::string> unsuitables;
137 : :
138 [ + - ]: 1676 : LOCK(cs_args);
139 : :
140 : : // if there's no section selected, don't worry
141 [ + + ]: 1676 : 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 [ + - + + ]: 1296 : if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
145 : :
146 [ + + ]: 12375 : for (const auto& arg : m_network_only_args) {
147 [ + - + - : 11093 : if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
- + ]
148 [ # # ]: 0 : unsuitables.insert(arg);
149 : : }
150 : : }
151 : 1282 : return unsuitables;
152 : 1676 : }
153 : :
154 : 1676 : std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
155 : : {
156 : : // Section names to be recognized in the config file.
157 : 1676 : 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 [ + + + - : 2192 : };
- + + + -
- ]
164 : :
165 : 1676 : LOCK(cs_args);
166 [ + - ]: 1676 : std::list<SectionInfo> unrecognized = m_config_sections;
167 : 1676 : unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.find(appeared.m_name) != available_sections.end(); });
168 [ + - ]: 1676 : return unrecognized;
169 [ + - + - : 1762 : }
+ - + - +
- - - ]
170 : :
171 : 2705 : void ArgsManager::SelectConfigNetwork(const std::string& network)
172 : : {
173 : 2705 : LOCK(cs_args);
174 [ + - + - ]: 5410 : m_network = network;
175 : 2705 : }
176 : :
177 : 112953 : bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
178 : : {
179 : 112953 : LOCK(cs_args);
180 : 112953 : m_settings.command_line_options.clear();
181 : :
182 [ + + ]: 212338 : for (int i = 1; i < argc; i++) {
183 [ + - ]: 192710 : 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 [ + + ]: 192710 : if (key == "-") break; //bitcoin-tx using stdin
194 : 191045 : std::optional<std::string> val;
195 : 191045 : size_t is_index = key.find('=');
196 [ + + ]: 191045 : if (is_index != std::string::npos) {
197 [ + - ]: 50579 : val = key.substr(is_index + 1);
198 [ + - ]: 50579 : key.erase(is_index);
199 : : }
200 : : #ifdef WIN32
201 : : key = ToLower(key);
202 : : if (key[0] == '/')
203 : : key[0] = '-';
204 : : #endif
205 : :
206 [ + + ]: 191045 : if (key[0] != '-') {
207 [ - + - - ]: 75194 : if (!m_accept_any_command && m_command.empty()) {
208 : : // The first non-dash arg is a registered command
209 [ # # ]: 0 : std::optional<unsigned int> flags = GetArgFlags(key);
210 [ # # # # ]: 0 : if (!flags || !(*flags & ArgsManager::COMMAND)) {
211 [ # # ]: 0 : error = strprintf("Invalid command '%s'", argv[i]);
212 : 0 : return false;
213 : : }
214 : : }
215 [ + - ]: 75194 : m_command.push_back(key);
216 [ + + ]: 369956 : while (++i < argc) {
217 : : // The remaining args are command args
218 [ + - ]: 294762 : m_command.emplace_back(argv[i]);
219 : : }
220 : 75194 : break;
221 : : }
222 : :
223 : : // Transform --foo to -foo
224 [ - + + + : 115851 : if (key.length() > 1 && key[1] == '-')
+ + ]
225 [ + - ]: 11528 : key.erase(0, 1);
226 : :
227 : : // Transform -foo to foo
228 [ + - ]: 115851 : key.erase(0, 1);
229 [ - + + - ]: 231702 : KeyInfo keyinfo = InterpretKey(key);
230 [ + - + - ]: 115851 : 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 [ + + + + ]: 115851 : if (!flags || !keyinfo.section.empty()) {
236 [ + - ]: 14757 : error = strprintf("Invalid parameter %s", argv[i]);
237 : 14757 : return false;
238 : : }
239 : :
240 [ + + + - ]: 159063 : std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
241 [ + + ]: 101094 : if (!value) return false;
242 : :
243 [ + - + - ]: 99385 : m_settings.command_line_options[keyinfo.name].push_back(*value);
244 : 385464 : }
245 : :
246 : : // we do not allow -includeconf from command line, only -noincludeconf
247 [ + - + + ]: 96487 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
248 : 5834 : const common::SettingsSpan values{*includes};
249 : : // Range may be empty if -noincludeconf was passed
250 [ + - + + ]: 5834 : if (!values.empty()) {
251 [ + - + - : 5379 : error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
+ - ]
252 : 5379 : return false; // pick first value as example
253 : : }
254 : : }
255 : : return true;
256 : 112953 : }
257 : :
258 : 225351 : std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
259 : : {
260 : 225351 : LOCK(cs_args);
261 [ + + ]: 562970 : for (const auto& arg_map : m_available_args) {
262 : 467931 : const auto search = arg_map.second.find(name);
263 [ + + ]: 467931 : if (search != arg_map.second.end()) {
264 : 130312 : return search->second.m_flags;
265 : : }
266 : : }
267 : 95039 : return m_default_flags;
268 : 225351 : }
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 : 5470 : fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
277 : : {
278 [ + + ]: 5470 : if (IsArgNegated(arg)) return fs::path{};
279 [ + - ]: 5383 : std::string path_str = GetArg(arg, "");
280 [ + + + - ]: 9735 : if (path_str.empty()) return default_value;
281 [ + - + - ]: 13056 : fs::path result = fs::PathFromString(path_str).lexically_normal();
282 : : // Remove trailing slash, if present.
283 [ + - + - : 13056 : return result.has_filename() ? result : result.parent_path();
- - ]
284 : 9735 : }
285 : :
286 : 3924 : fs::path ArgsManager::GetBlocksDirPath() const
287 : : {
288 : 3924 : LOCK(cs_args);
289 : 3924 : 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 [ + + + - ]: 3924 : if (!path.empty()) return path;
294 : :
295 [ + - + - : 2176 : if (IsArgSet("-blocksdir")) {
- + ]
296 [ # # # # : 0 : path = fs::absolute(GetPathArg("-blocksdir"));
# # ]
297 [ # # # # ]: 0 : if (!fs::is_directory(path)) {
298 [ # # ]: 0 : path = "";
299 [ # # ]: 0 : return path;
300 : : }
301 : : } else {
302 [ + - ]: 4352 : path = GetDataDirBase();
303 : : }
304 : :
305 [ + - + - ]: 4352 : path /= fs::PathFromString(BaseParams().DataDir());
306 [ + - ]: 2176 : path /= "blocks";
307 [ + - ]: 2176 : fs::create_directories(path);
308 [ + - + - ]: 3924 : return path;
309 : 3924 : }
310 : :
311 : 38626 : fs::path ArgsManager::GetDataDir(bool net_specific) const
312 : : {
313 : 38626 : LOCK(cs_args);
314 [ + + ]: 38626 : fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
315 : :
316 : : // Used cached path if available
317 [ + + + - : 42978 : if (!path.empty()) return path;
+ - ]
318 : :
319 [ + - + - ]: 8704 : const fs::path datadir{GetPathArg("-datadir")};
320 [ + - ]: 4352 : if (!datadir.empty()) {
321 [ + - ]: 8704 : path = fs::absolute(datadir);
322 [ + - - + ]: 4352 : if (!fs::is_directory(path)) {
323 [ # # ]: 0 : path = "";
324 [ # # ]: 0 : return path;
325 : : }
326 : : } else {
327 [ # # ]: 0 : path = GetDefaultDataDir();
328 : : }
329 : :
330 [ + + + - : 4352 : if (net_specific && !BaseParams().DataDir().empty()) {
+ + ]
331 [ + - + - ]: 6507 : path /= fs::PathFromString(BaseParams().DataDir());
332 : : }
333 : :
334 [ + - ]: 4352 : return path;
335 : 42978 : }
336 : :
337 : 1118 : void ArgsManager::ClearPathCache()
338 : : {
339 : 1118 : LOCK(cs_args);
340 : :
341 : 1118 : m_cached_datadir_path = fs::path();
342 : 1118 : m_cached_network_datadir_path = fs::path();
343 [ + - ]: 2236 : m_cached_blocks_path = fs::path();
344 : 1118 : }
345 : :
346 : 0 : std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
347 : : {
348 [ # # ]: 0 : Command ret;
349 [ # # ]: 0 : LOCK(cs_args);
350 [ # # ]: 0 : auto it = m_command.begin();
351 [ # # ]: 0 : if (it == m_command.end()) {
352 : : // No command was passed
353 : 0 : return std::nullopt;
354 : : }
355 [ # # ]: 0 : if (!m_accept_any_command) {
356 : : // The registered command
357 [ # # ]: 0 : ret.command = *(it++);
358 : : }
359 [ # # ]: 0 : while (it != m_command.end()) {
360 : : // The unregistered command and args (if any)
361 [ # # ]: 0 : ret.args.push_back(*(it++));
362 : : }
363 : 0 : return ret;
364 : 0 : }
365 : :
366 : 207337 : std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
367 : : {
368 : 207337 : std::vector<std::string> result;
369 [ + - + + ]: 213286 : for (const common::SettingsValue& value : GetSettingsList(strArg)) {
370 [ - + - - : 17694 : result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
+ + + - +
- - + +
- ]
371 : : }
372 : 207337 : return result;
373 : 0 : }
374 : :
375 : 77071 : bool ArgsManager::IsArgSet(const std::string& strArg) const
376 : : {
377 : 77071 : return !GetSetting(strArg).isNull();
378 : : }
379 : :
380 : 0 : bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
381 : : {
382 [ # # # # ]: 0 : fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
383 [ # # ]: 0 : if (settings.empty()) {
384 : : return false;
385 : : }
386 [ # # ]: 0 : if (backup) {
387 [ # # ]: 0 : settings += ".bak";
388 : : }
389 [ # # ]: 0 : if (filepath) {
390 [ # # # # : 0 : *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
# # # # #
# # # ]
391 : : }
392 : : return true;
393 : 0 : }
394 : :
395 : 0 : static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
396 : : {
397 [ # # ]: 0 : for (const auto& error : errors) {
398 [ # # ]: 0 : if (error_out) {
399 : 0 : error_out->emplace_back(error);
400 : : } else {
401 : 0 : LogPrintf("%s\n", error);
402 : : }
403 : : }
404 : 0 : }
405 : :
406 : 0 : bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
407 : : {
408 : 0 : fs::path path;
409 [ # # # # ]: 0 : if (!GetSettingsPath(&path, /* temp= */ false)) {
410 : : return true; // Do nothing if settings file disabled.
411 : : }
412 : :
413 [ # # ]: 0 : LOCK(cs_args);
414 : 0 : m_settings.rw_settings.clear();
415 : 0 : std::vector<std::string> read_errors;
416 [ # # # # ]: 0 : if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
417 [ # # # # ]: 0 : SaveErrors(read_errors, errors);
418 : 0 : return false;
419 : : }
420 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
421 [ # # # # ]: 0 : KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
422 [ # # # # : 0 : if (!GetArgFlags('-' + key.name)) {
# # ]
423 [ # # ]: 0 : LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
424 : : }
425 : 0 : }
426 : : return true;
427 [ # # ]: 0 : }
428 : :
429 : 0 : bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
430 : : {
431 : 0 : fs::path path, path_tmp;
432 [ # # # # : 0 : 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 [ # # ]: 0 : LOCK(cs_args);
437 : 0 : std::vector<std::string> write_errors;
438 [ # # # # ]: 0 : if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
439 [ # # # # ]: 0 : SaveErrors(write_errors, errors);
440 : 0 : return false;
441 : : }
442 [ # # # # : 0 : if (!RenameOver(path_tmp, path)) {
# # # # ]
443 [ # # # # : 0 : SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
# # # # #
# ]
444 : 0 : return false;
445 : : }
446 : : return true;
447 [ # # # # : 0 : }
# # ]
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 : 7146 : bool ArgsManager::IsArgNegated(const std::string& strArg) const
457 : : {
458 : 7146 : return GetSetting(strArg).isFalse();
459 : : }
460 : :
461 : 37429 : std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
462 : : {
463 [ + - ]: 74858 : return GetArg(strArg).value_or(strDefault);
464 : : }
465 : :
466 : 91858 : std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
467 : : {
468 : 91858 : const common::SettingsValue value = GetSetting(strArg);
469 [ + - ]: 183716 : return SettingToString(value);
470 : 91858 : }
471 : :
472 : 91858 : std::optional<std::string> SettingToString(const common::SettingsValue& value)
473 : : {
474 [ + + ]: 91858 : if (value.isNull()) return std::nullopt;
475 [ + + ]: 4672 : if (value.isFalse()) return "0";
476 [ + + ]: 4649 : if (value.isTrue()) return "1";
477 [ - + - - ]: 4627 : if (value.isNum()) return value.getValStr();
478 [ - + ]: 9254 : 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 : 318349 : int64_t ArgsManager::GetIntArg(const std::string& strArg, int64_t nDefault) const
487 : : {
488 [ + + ]: 318349 : return GetIntArg(strArg).value_or(nDefault);
489 : : }
490 : :
491 : 391999 : std::optional<int64_t> ArgsManager::GetIntArg(const std::string& strArg) const
492 : : {
493 : 391999 : const common::SettingsValue value = GetSetting(strArg);
494 [ + - ]: 783998 : return SettingToInt(value);
495 : 391999 : }
496 : :
497 : 391999 : std::optional<int64_t> SettingToInt(const common::SettingsValue& value)
498 : : {
499 [ + + ]: 391999 : if (value.isNull()) return std::nullopt;
500 [ + + ]: 38013 : if (value.isFalse()) return 0;
501 [ + + ]: 37992 : if (value.isTrue()) return 1;
502 [ - + ]: 37972 : if (value.isNum()) return value.getInt<int64_t>();
503 [ - + ]: 37972 : 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 : 199156 : bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
512 : : {
513 [ + + ]: 199156 : return GetBoolArg(strArg).value_or(fDefault);
514 : : }
515 : :
516 : 205946 : std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
517 : : {
518 : 205946 : const common::SettingsValue value = GetSetting(strArg);
519 [ + - ]: 411892 : return SettingToBool(value);
520 : 205946 : }
521 : :
522 : 205946 : std::optional<bool> SettingToBool(const common::SettingsValue& value)
523 : : {
524 [ + + ]: 205946 : if (value.isNull()) return std::nullopt;
525 [ + + ]: 5080 : if (value.isBool()) return value.get_bool();
526 : 5037 : 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 : 65751 : bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
535 : : {
536 : 65751 : LOCK(cs_args);
537 [ + - + + ]: 65751 : if (IsArgSet(strArg)) return false;
538 [ + - ]: 35149 : ForceSetArg(strArg, strValue);
539 : : return true;
540 : 65751 : }
541 : :
542 : 47904 : bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
543 : : {
544 [ + + ]: 47904 : if (fValue)
545 [ + - ]: 37580 : return SoftSetArg(strArg, std::string("1"));
546 : : else
547 [ + - ]: 10324 : return SoftSetArg(strArg, std::string("0"));
548 : : }
549 : :
550 : 80214 : void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
551 : : {
552 : 80214 : LOCK(cs_args);
553 [ + - + - : 80214 : m_settings.forced_settings[SettingName(strArg)] = strValue;
+ - + - ]
554 : 80214 : }
555 : :
556 : 0 : void ArgsManager::AddCommand(const std::string& cmd, const std::string& help)
557 : : {
558 : 0 : Assert(cmd.find('=') == std::string::npos);
559 : 0 : Assert(cmd.at(0) != '-');
560 : :
561 : 0 : LOCK(cs_args);
562 : 0 : m_accept_any_command = false; // latch to false
563 [ # # ]: 0 : std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
564 [ # # # # : 0 : auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
# # ]
565 [ # # ]: 0 : Assert(ret.second); // Fail on duplicate commands
566 : 0 : }
567 : :
568 : 280353 : void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
569 : : {
570 : 280353 : Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
571 : :
572 : : // Split arg name from its help param
573 : 280353 : size_t eq_index = name.find('=');
574 [ + + ]: 280353 : if (eq_index == std::string::npos) {
575 [ - + ]: 161845 : eq_index = name.size();
576 : : }
577 : 280353 : std::string arg_name = name.substr(0, eq_index);
578 : :
579 [ + - ]: 280353 : LOCK(cs_args);
580 [ + - ]: 280353 : std::map<std::string, Arg>& arg_map = m_available_args[cat];
581 [ - + + - : 560706 : auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
- + + - ]
582 [ - + ]: 280353 : assert(ret.second); // Make sure an insertion actually happened
583 : :
584 [ + + ]: 280353 : if (flags & ArgsManager::NETWORK_ONLY) {
585 [ + - ]: 19870 : m_network_only_args.emplace(arg_name);
586 : : }
587 : 280353 : }
588 : :
589 : 14781 : void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
590 : : {
591 [ + + ]: 87044 : for (const std::string& name : names) {
592 [ + - ]: 144526 : AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
593 : : }
594 : 14781 : }
595 : :
596 : 10993 : void ArgsManager::ClearArgs()
597 : : {
598 : 10993 : LOCK(cs_args);
599 : 10993 : m_settings = {};
600 : 10993 : m_available_args.clear();
601 [ + - ]: 10993 : m_network_only_args.clear();
602 : 10993 : }
603 : :
604 : 0 : void ArgsManager::CheckMultipleCLIArgs() const
605 : : {
606 : 0 : LOCK(cs_args);
607 : 0 : std::vector<std::string> found{};
608 : 0 : auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
609 [ # # ]: 0 : if (cmds != m_available_args.end()) {
610 [ # # # # ]: 0 : for (const auto& [cmd, argspec] : cmds->second) {
611 [ # # # # ]: 0 : if (IsArgSet(cmd)) {
612 [ # # ]: 0 : found.push_back(cmd);
613 : : }
614 : : }
615 [ # # # # ]: 0 : if (found.size() > 1) {
616 [ # # # # : 0 : throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
# # ]
617 : : }
618 : : }
619 [ # # ]: 0 : }
620 : :
621 : 558 : std::string ArgsManager::GetHelpMessage() const
622 : : {
623 [ + - ]: 558 : const bool show_debug = GetBoolArg("-help-debug", false);
624 : :
625 [ + - ]: 558 : std::string usage;
626 [ + - ]: 558 : LOCK(cs_args);
627 [ + + ]: 1510 : for (const auto& arg_map : m_available_args) {
628 [ + + + + : 1393 : switch(arg_map.first) {
+ + + + +
+ + + + +
+ + ]
629 : 371 : case OptionsCategory::OPTIONS:
630 [ + - + - ]: 742 : usage += HelpMessageGroup("Options:");
631 : 371 : break;
632 : 36 : case OptionsCategory::CONNECTION:
633 [ + - + - ]: 72 : usage += HelpMessageGroup("Connection options:");
634 : 36 : break;
635 : 37 : case OptionsCategory::ZMQ:
636 [ + - + - ]: 74 : usage += HelpMessageGroup("ZeroMQ notification options:");
637 : 37 : break;
638 : 43 : case OptionsCategory::DEBUG_TEST:
639 [ + - + - ]: 86 : usage += HelpMessageGroup("Debugging/Testing options:");
640 : 43 : break;
641 : 23 : case OptionsCategory::NODE_RELAY:
642 [ + - + - ]: 46 : usage += HelpMessageGroup("Node relay options:");
643 : 23 : break;
644 : 20 : case OptionsCategory::BLOCK_CREATION:
645 [ + - + - ]: 40 : usage += HelpMessageGroup("Block creation options:");
646 : 20 : break;
647 : 42 : case OptionsCategory::RPC:
648 [ + - + - ]: 84 : usage += HelpMessageGroup("RPC server options:");
649 : 42 : break;
650 : 13 : case OptionsCategory::IPC:
651 [ + - + - ]: 26 : usage += HelpMessageGroup("IPC interprocess connection options:");
652 : 13 : break;
653 : 45 : case OptionsCategory::WALLET:
654 [ + - + - ]: 90 : usage += HelpMessageGroup("Wallet options:");
655 : 45 : break;
656 : 55 : case OptionsCategory::WALLET_DEBUG_TEST:
657 [ + + + - : 75 : if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
+ - ]
658 : : break;
659 : 32 : case OptionsCategory::CHAINPARAMS:
660 [ + - + - ]: 64 : usage += HelpMessageGroup("Chain selection options:");
661 : 32 : break;
662 : 23 : case OptionsCategory::GUI:
663 [ + - + - ]: 46 : usage += HelpMessageGroup("UI Options:");
664 : 23 : break;
665 : 59 : case OptionsCategory::COMMANDS:
666 [ + - + - ]: 118 : usage += HelpMessageGroup("Commands:");
667 : 59 : break;
668 : 64 : case OptionsCategory::REGISTER_COMMANDS:
669 [ + - + - ]: 128 : usage += HelpMessageGroup("Register Commands:");
670 : 64 : break;
671 : 89 : case OptionsCategory::CLI_COMMANDS:
672 [ + - + - ]: 178 : usage += HelpMessageGroup("CLI Commands:");
673 : 89 : break;
674 : : default:
675 : : break;
676 : : }
677 : :
678 : : // When we get to the hidden options, stop
679 [ + + ]: 1393 : if (arg_map.first == OptionsCategory::HIDDEN) break;
680 : :
681 [ + + ]: 4867 : for (const auto& arg : arg_map.second) {
682 [ + + + + ]: 3915 : if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
683 [ + - ]: 2634 : std::string name;
684 [ + - ]: 2634 : if (arg.second.m_help_param.empty()) {
685 [ + - ]: 2634 : name = arg.first;
686 : : } else {
687 [ # # ]: 0 : name = arg.first + arg.second.m_help_param;
688 : : }
689 [ + - ]: 5268 : usage += HelpMessageOpt(name, arg.second.m_help_text);
690 : 2634 : }
691 : : }
692 : : }
693 [ + - ]: 558 : return usage;
694 : 558 : }
695 : :
696 : 558 : bool HelpRequested(const ArgsManager& args)
697 : : {
698 [ + - + - : 2414 : return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
+ + + - +
- + + + -
+ - + + +
- + - + +
+ + + + -
- - - -
- ]
699 : : }
700 : :
701 : 1537 : void SetupHelpOptions(ArgsManager& args)
702 : : {
703 [ + - + - ]: 3074 : args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
704 [ + - ]: 1537 : args.AddHiddenArgs({"-h", "-?"});
705 : 1537 : }
706 : :
707 : : static const int screenWidth = 79;
708 : : static const int optIndent = 2;
709 : : static const int msgIndent = 7;
710 : :
711 : 1902 : std::string HelpMessageGroup(const std::string &message) {
712 [ + - ]: 5706 : return std::string(message) + std::string("\n\n");
713 : : }
714 : :
715 : 3619 : std::string HelpMessageOpt(const std::string &option, const std::string &message) {
716 [ + - + - ]: 7238 : return std::string(optIndent,' ') + std::string(option) +
717 [ + - + - : 14476 : std::string("\n") + std::string(msgIndent,' ') +
+ - ]
718 [ + - + - ]: 10857 : FormatParagraph(message, screenWidth - msgIndent, msgIndent) +
719 [ + - ]: 10857 : 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 : 2246 : bool HasTestOption(const ArgsManager& args, const std::string& test_option)
729 : : {
730 [ + - ]: 2246 : const auto options = args.GetArgs("-test");
731 [ - + - + : 26952 : return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
- + + - -
+ + - - +
+ - - + +
- ]
732 [ # # ]: 0 : return option == test_option;
733 : 2246 : });
734 : 2246 : }
735 : :
736 : 0 : 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 : 0 : fs::path pathRet;
753 : 0 : char* pszHome = getenv("HOME");
754 [ # # # # ]: 0 : if (pszHome == nullptr || strlen(pszHome) == 0)
755 [ # # ]: 0 : pathRet = fs::path("/");
756 : : else
757 [ # # ]: 0 : pathRet = fs::path(pszHome);
758 : : #ifdef __APPLE__
759 : : // macOS
760 : : return pathRet / "Library/Application Support/Bitcoin";
761 : : #else
762 : : // Unix-like
763 [ # # # # ]: 0 : return pathRet / ".bitcoin";
764 : : #endif
765 : : #endif
766 : 0 : }
767 : :
768 : 0 : bool CheckDataDirOption(const ArgsManager& args)
769 : : {
770 [ # # # # ]: 0 : const fs::path datadir{args.GetPathArg("-datadir")};
771 [ # # # # : 0 : return datadir.empty() || fs::is_directory(fs::absolute(datadir));
# # # # ]
772 : 0 : }
773 : :
774 : 0 : fs::path ArgsManager::GetConfigFilePath() const
775 : : {
776 : 0 : LOCK(cs_args);
777 [ # # # # : 0 : return *Assert(m_config_path);
# # ]
778 : 0 : }
779 : :
780 : 0 : void ArgsManager::SetConfigFilePath(fs::path path)
781 : : {
782 : 0 : LOCK(cs_args);
783 [ # # ]: 0 : assert(!m_config_path);
784 [ # # ]: 0 : m_config_path = path;
785 : 0 : }
786 : :
787 : 1118 : ChainType ArgsManager::GetChainType() const
788 : : {
789 : 1118 : std::variant<ChainType, std::string> arg = GetChainArg();
790 [ + - ]: 1118 : 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 : 1118 : }
793 : :
794 : 558 : std::string ArgsManager::GetChainTypeString() const
795 : : {
796 : 558 : auto arg = GetChainArg();
797 [ + + + - ]: 547 : if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
798 [ - + - + ]: 565 : return std::get<std::string>(arg);
799 : 547 : }
800 : :
801 : 1676 : std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
802 : : {
803 : 8380 : auto get_net = [&](const std::string& arg) {
804 : 6704 : LOCK(cs_args);
805 [ + - + - ]: 13408 : common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
806 : : /* ignore_default_section_config= */ false,
807 : : /*ignore_nonpersistent=*/false,
808 [ + - ]: 6704 : /* get_chain_type= */ true);
809 [ + + + + : 6704 : return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
+ - + - +
- ]
810 [ + - ]: 13408 : };
811 : :
812 [ + - ]: 1676 : const bool fRegTest = get_net("-regtest");
813 [ + - ]: 1676 : const bool fSigNet = get_net("-signet");
814 [ + - ]: 1676 : const bool fTestNet = get_net("-testnet");
815 [ + - ]: 1676 : const bool fTestNet4 = get_net("-testnet4");
816 [ + - ]: 1676 : const auto chain_arg = GetArg("-chain");
817 : :
818 [ + + ]: 1676 : if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
819 [ + - ]: 11 : throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
820 : : }
821 [ + + ]: 1665 : if (chain_arg) {
822 [ - + + - : 26 : if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
+ + ]
823 : : // Not a known string, so return original string
824 [ - + ]: 36 : return *chain_arg;
825 : : }
826 [ + + ]: 1639 : if (fRegTest) return ChainType::REGTEST;
827 [ + + ]: 1632 : if (fSigNet) return ChainType::SIGNET;
828 [ + + ]: 1628 : if (fTestNet) return ChainType::TESTNET;
829 [ + + ]: 1626 : if (fTestNet4) return ChainType::TESTNET4;
830 : 1623 : return ChainType::MAIN;
831 : 1665 : }
832 : :
833 : 981357 : bool ArgsManager::UseDefaultSection(const std::string& arg) const
834 : : {
835 [ + + + + ]: 981357 : return m_network == ChainTypeToString(ChainType::MAIN) || m_network_only_args.count(arg) == 0;
836 : : }
837 : :
838 : 774020 : common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
839 : : {
840 : 774020 : LOCK(cs_args);
841 : 774020 : return common::GetSetting(
842 [ + - + - ]: 1548040 : m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
843 [ + - + - ]: 774020 : /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
844 : 774020 : }
845 : :
846 : 207337 : std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
847 : : {
848 : 207337 : LOCK(cs_args);
849 [ + - + - : 414674 : return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
+ - + - ]
850 : 207337 : }
851 : :
852 : 0 : 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 [ # # # # ]: 0 : std::string section_str = section.empty() ? "" : "[" + section + "] ";
858 [ # # ]: 0 : for (const auto& arg : args) {
859 [ # # ]: 0 : for (const auto& value : arg.second) {
860 [ # # # # ]: 0 : std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
861 [ # # ]: 0 : if (flags) {
862 [ # # # # : 0 : std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
# # ]
863 [ # # ]: 0 : LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
864 : 0 : }
865 : : }
866 : : }
867 : 0 : }
868 : :
869 : 0 : void ArgsManager::LogArgs() const
870 : : {
871 : 0 : LOCK(cs_args);
872 [ # # ]: 0 : for (const auto& section : m_settings.ro_config) {
873 [ # # # # ]: 0 : logArgsPrefix("Config file arg:", section.first, section.second);
874 : : }
875 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
876 [ # # # # ]: 0 : LogPrintf("Setting file arg: %s = %s\n", setting.first, setting.second.write());
877 : : }
878 [ # # # # : 0 : logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
# # # # ]
879 : 0 : }
|
