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