args.cpp raw
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 <sync.h>
11 #include <tinyformat.h>
12 #include <univalue.h>
13 #include <util/chaintype.h>
14 #include <util/check.h>
15 #include <util/fs.h>
16 #include <util/fs_helpers.h>
17 #include <util/log.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 static bool InterpretBool(const std::string& strValue)
58 {
59 if (strValue.empty())
60 return true;
61 return (LocaleIndependentAtoi<int>(strValue) != 0);
62 }
63
64 static std::string SettingName(const std::string& arg)
65 {
66 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 KeyInfo InterpretKey(std::string key)
78 {
79 KeyInfo result;
80 // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
81 size_t option_index = key.find('.');
82 if (option_index != std::string::npos) {
83 result.section = key.substr(0, option_index);
84 key.erase(0, option_index + 1);
85 }
86 if (key.starts_with("no")) {
87 key.erase(0, 2);
88 result.negated = true;
89 }
90 result.name = key;
91 return result;
92 }
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 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 if (key.negated) {
110 if (flags & ArgsManager::DISALLOW_NEGATION) {
111 error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
112 return std::nullopt;
113 }
114 // Double negatives like -nofoo=0 are supported (but discouraged)
115 if (value && !InterpretBool(*value)) {
116 LogWarning("Parsed potentially confusing double-negative -%s=%s", key.name, *value);
117 return true;
118 }
119 return false;
120 }
121 if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
122 error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
123 return std::nullopt;
124 }
125 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 ArgsManager::ArgsManager() = default;
132 ArgsManager::~ArgsManager() = default;
133
134 std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
135 {
136 std::set<std::string> unsuitables;
137
138 LOCK(cs_args);
139
140 // if there's no section selected, don't worry
141 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 if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
145
146 for (const auto& arg : m_network_only_args) {
147 if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
148 unsuitables.insert(arg);
149 }
150 }
151 return unsuitables;
152 }
153
154 std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
155 {
156 // Section names to be recognized in the config file.
157 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 };
164
165 LOCK(cs_args);
166 std::list<SectionInfo> unrecognized = m_config_sections;
167 unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.contains(appeared.m_name); });
168 return unrecognized;
169 }
170
171 void ArgsManager::SelectConfigNetwork(const std::string& network)
172 {
173 LOCK(cs_args);
174 m_network = network;
175 }
176
177 bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
178 {
179 LOCK(cs_args);
180 m_settings.command_line_options.clear();
181
182 for (int i = 1; i < argc; i++) {
183 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 if (key == "-") break; //bitcoin-tx using stdin
194 std::optional<std::string> val;
195 size_t is_index = key.find('=');
196 if (is_index != std::string::npos) {
197 val = key.substr(is_index + 1);
198 key.erase(is_index);
199 }
200 #ifdef WIN32
201 key = ToLower(key);
202 if (key[0] == '/')
203 key[0] = '-';
204 #endif
205
206 if (key[0] != '-') {
207 if (!m_accept_any_command && m_command.empty()) {
208 // The first non-dash arg is a registered command
209 std::optional<unsigned int> flags = GetArgFlags_(key);
210 if (!flags || !(*flags & ArgsManager::COMMAND)) {
211 error = strprintf("Invalid command '%s'", argv[i]);
212 return false;
213 }
214 }
215 m_command.push_back(key);
216 while (++i < argc) {
217 // The remaining args are command args
218 m_command.emplace_back(argv[i]);
219 }
220 break;
221 }
222
223 // Transform --foo to -foo
224 if (key.length() > 1 && key[1] == '-')
225 key.erase(0, 1);
226
227 // Transform -foo to foo
228 key.erase(0, 1);
229 KeyInfo keyinfo = InterpretKey(key);
230 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 if (!flags || !keyinfo.section.empty()) {
236 error = strprintf("Invalid parameter %s", argv[i]);
237 return false;
238 }
239
240 std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
241 if (!value) return false;
242
243 m_settings.command_line_options[keyinfo.name].push_back(*value);
244 }
245
246 // we do not allow -includeconf from command line, only -noincludeconf
247 if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
248 const common::SettingsSpan values{*includes};
249 // Range may be empty if -noincludeconf was passed
250 if (!values.empty()) {
251 error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
252 return false; // pick first value as example
253 }
254 }
255 return true;
256 }
257
258 std::optional<unsigned int> ArgsManager::GetArgFlags_(const std::string& name) const
259 {
260 AssertLockHeld(cs_args);
261 for (const auto& arg_map : m_available_args) {
262 const auto search = arg_map.second.find(name);
263 if (search != arg_map.second.end()) {
264 return search->second.m_flags;
265 }
266 }
267 return m_default_flags;
268 }
269
270 std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
271 {
272 LOCK(cs_args);
273 return GetArgFlags_(name);
274 }
275
276 void ArgsManager::SetDefaultFlags(std::optional<unsigned int> flags)
277 {
278 LOCK(cs_args);
279 m_default_flags = flags;
280 }
281
282 fs::path ArgsManager::GetPathArg_(std::string arg, const fs::path& default_value) const
283 {
284 AssertLockHeld(cs_args);
285 const auto value = GetSetting_(arg);
286 if (value.isFalse()) return {};
287 std::string path_str = SettingToString(value, "");
288 if (path_str.empty()) return default_value;
289 fs::path result = fs::PathFromString(path_str).lexically_normal();
290 // Remove trailing slash, if present.
291 return result.has_filename() ? result : result.parent_path();
292 }
293
294 fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
295 {
296 LOCK(cs_args);
297 return GetPathArg_(std::move(arg), default_value);
298 }
299
300 fs::path ArgsManager::GetBlocksDirPath() const
301 {
302 LOCK(cs_args);
303 fs::path& path = m_cached_blocks_path;
304
305 // Cache the path to avoid calling fs::create_directories on every call of
306 // this function
307 if (!path.empty()) return path;
308
309 if (!GetSetting_("-blocksdir").isNull()) {
310 path = fs::absolute(GetPathArg_("-blocksdir"));
311 if (!fs::is_directory(path)) {
312 path = "";
313 return path;
314 }
315 } else {
316 path = GetDataDir(/*net_specific=*/false);
317 }
318
319 path /= fs::PathFromString(BaseParams().DataDir());
320 path /= "blocks";
321 fs::create_directories(path);
322 return path;
323 }
324
325 fs::path ArgsManager::GetDataDirBase() const {
326 LOCK(cs_args);
327 return GetDataDir(/*net_specific=*/false);
328 }
329
330 fs::path ArgsManager::GetDataDirNet() const {
331 LOCK(cs_args);
332 return GetDataDir(/*net_specific=*/true);
333 }
334
335 fs::path ArgsManager::GetDataDir(bool net_specific) const
336 {
337 AssertLockHeld(cs_args);
338 fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
339
340 // Used cached path if available
341 if (!path.empty()) return path;
342
343 const fs::path datadir{GetPathArg_("-datadir")};
344 if (!datadir.empty()) {
345 path = fs::absolute(datadir);
346 if (!fs::is_directory(path)) {
347 path = "";
348 return path;
349 }
350 } else {
351 path = GetDefaultDataDir();
352 }
353
354 if (net_specific && !BaseParams().DataDir().empty()) {
355 path /= fs::PathFromString(BaseParams().DataDir());
356 }
357
358 return path;
359 }
360
361 void ArgsManager::ClearPathCache()
362 {
363 LOCK(cs_args);
364
365 m_cached_datadir_path = fs::path();
366 m_cached_network_datadir_path = fs::path();
367 m_cached_blocks_path = fs::path();
368 }
369
370 std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
371 {
372 Command ret;
373 LOCK(cs_args);
374 auto it = m_command.begin();
375 if (it == m_command.end()) {
376 // No command was passed
377 return std::nullopt;
378 }
379 if (!m_accept_any_command) {
380 // The registered command
381 ret.command = *(it++);
382 }
383 while (it != m_command.end()) {
384 // The unregistered command and args (if any)
385 ret.args.push_back(*(it++));
386 }
387 return ret;
388 }
389
390 bool ArgsManager::CheckCommandOptions(const std::string& command, std::vector<std::string>* errors) const
391 {
392 LOCK(cs_args);
393
394 auto command_options = m_available_args.find(OptionsCategory::COMMAND_OPTIONS);
395 if (command_options == m_available_args.end()) {
396 // There are no command-specific options at all, so everything is fine
397 return true;
398 }
399
400 const auto command_args = m_command_args.find(command);
401 auto is_valid_opt = [&](const auto& opt) EXCLUSIVE_LOCKS_REQUIRED(cs_args) -> bool {
402 if (command_args == m_command_args.end()) {
403 // Caller may not have checked that command actually exists
404 // before calling this function. In that case, treat it as
405 // having no valid command-specific options.
406 return false;
407 } else {
408 return command_args->second.contains(opt);
409 }
410 };
411
412 bool ok = true;
413 for (const auto& [arg, _] : command_options->second) {
414 if (!GetSetting_(arg).isNull() && !is_valid_opt(arg)) {
415 ok = false;
416 if (errors != nullptr) {
417 errors->emplace_back(strprintf("The %s option cannot be used with the '%s' command.", arg, command));
418 }
419 }
420 }
421 return ok;
422 }
423
424 std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
425 {
426 std::vector<std::string> result;
427 for (const common::SettingsValue& value : GetSettingsList(strArg)) {
428 result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
429 }
430 return result;
431 }
432
433 bool ArgsManager::IsArgSet(const std::string& strArg) const
434 {
435 return !GetSetting(strArg).isNull();
436 }
437
438 bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
439 {
440 fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
441 if (settings.empty()) {
442 return false;
443 }
444 if (backup) {
445 settings += ".bak";
446 }
447 if (filepath) {
448 *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
449 }
450 return true;
451 }
452
453 static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
454 {
455 for (const auto& error : errors) {
456 if (error_out) {
457 error_out->emplace_back(error);
458 } else {
459 LogWarning("%s", error);
460 }
461 }
462 }
463
464 bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
465 {
466 fs::path path;
467 if (!GetSettingsPath(&path, /* temp= */ false)) {
468 return true; // Do nothing if settings file disabled.
469 }
470
471 LOCK(cs_args);
472 m_settings.rw_settings.clear();
473 std::vector<std::string> read_errors;
474 if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
475 SaveErrors(read_errors, errors);
476 return false;
477 }
478 for (const auto& setting : m_settings.rw_settings) {
479 KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
480 if (!GetArgFlags_('-' + key.name)) {
481 LogWarning("Ignoring unknown rw_settings value %s", setting.first);
482 }
483 }
484 return true;
485 }
486
487 bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
488 {
489 fs::path path, path_tmp;
490 if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
491 throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
492 }
493
494 LOCK(cs_args);
495 std::vector<std::string> write_errors;
496 if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
497 SaveErrors(write_errors, errors);
498 return false;
499 }
500 if (!RenameOver(path_tmp, path)) {
501 SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
502 return false;
503 }
504 return true;
505 }
506
507 common::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const
508 {
509 LOCK(cs_args);
510 return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
511 /*ignore_nonpersistent=*/true, /*get_chain_type=*/false);
512 }
513
514 bool ArgsManager::IsArgNegated(const std::string& strArg) const
515 {
516 return GetSetting(strArg).isFalse();
517 }
518
519 std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
520 {
521 return GetArg(strArg).value_or(strDefault);
522 }
523
524 std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
525 {
526 const common::SettingsValue value = GetSetting(strArg);
527 return SettingToString(value);
528 }
529
530 std::optional<std::string> SettingToString(const common::SettingsValue& value)
531 {
532 if (value.isNull()) return std::nullopt;
533 if (value.isFalse()) return "0";
534 if (value.isTrue()) return "1";
535 if (value.isNum()) return value.getValStr();
536 return value.get_str();
537 }
538
539 std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault)
540 {
541 return SettingToString(value).value_or(strDefault);
542 }
543
544 template <std::integral Int>
545 Int ArgsManager::GetArg(const std::string& strArg, Int nDefault) const
546 {
547 return GetArg<Int>(strArg).value_or(nDefault);
548 }
549
550 template <std::integral Int>
551 std::optional<Int> ArgsManager::GetArg(const std::string& strArg) const
552 {
553 const common::SettingsValue value = GetSetting(strArg);
554 return SettingTo<Int>(value);
555 }
556
557 template <std::integral Int>
558 std::optional<Int> SettingTo(const common::SettingsValue& value)
559 {
560 if (value.isNull()) return std::nullopt;
561 if (value.isFalse()) return 0;
562 if (value.isTrue()) return 1;
563 if (value.isNum()) return value.getInt<Int>();
564 return LocaleIndependentAtoi<Int>(value.get_str());
565 }
566
567 template <std::integral Int>
568 Int SettingTo(const common::SettingsValue& value, Int nDefault)
569 {
570 return SettingTo<Int>(value).value_or(nDefault);
571 }
572
573 bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
574 {
575 return GetBoolArg(strArg).value_or(fDefault);
576 }
577
578 std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
579 {
580 const common::SettingsValue value = GetSetting(strArg);
581 return SettingToBool(value);
582 }
583
584 std::optional<bool> SettingToBool(const common::SettingsValue& value)
585 {
586 if (value.isNull()) return std::nullopt;
587 if (value.isBool()) return value.get_bool();
588 return InterpretBool(value.get_str());
589 }
590
591 bool SettingToBool(const common::SettingsValue& value, bool fDefault)
592 {
593 return SettingToBool(value).value_or(fDefault);
594 }
595
596 #define INSTANTIATE_INT_TYPE(Type) \
597 template Type ArgsManager::GetArg<Type>(const std::string&, Type) const; \
598 template std::optional<Type> ArgsManager::GetArg<Type>(const std::string&) const; \
599 template Type SettingTo<Type>(const common::SettingsValue&, Type); \
600 template std::optional<Type> SettingTo<Type>(const common::SettingsValue&)
601
602 INSTANTIATE_INT_TYPE(int8_t);
603 INSTANTIATE_INT_TYPE(uint8_t);
604 INSTANTIATE_INT_TYPE(int16_t);
605 INSTANTIATE_INT_TYPE(uint16_t);
606 INSTANTIATE_INT_TYPE(int32_t);
607 INSTANTIATE_INT_TYPE(uint32_t);
608 INSTANTIATE_INT_TYPE(int64_t);
609 INSTANTIATE_INT_TYPE(uint64_t);
610
611 #undef INSTANTIATE_INT_TYPE
612
613 bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
614 {
615 LOCK(cs_args);
616 if (!GetSetting_(strArg).isNull()) return false;
617 m_settings.forced_settings[SettingName(strArg)] = strValue;
618 return true;
619 }
620
621 bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
622 {
623 if (fValue)
624 return SoftSetArg(strArg, std::string("1"));
625 else
626 return SoftSetArg(strArg, std::string("0"));
627 }
628
629 void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
630 {
631 LOCK(cs_args);
632 m_settings.forced_settings[SettingName(strArg)] = strValue;
633 }
634
635 void ArgsManager::AddCommand(const std::string& cmd, const std::string& help, std::set<std::string> options)
636 {
637 Assert(cmd.find('=') == std::string::npos);
638 Assert(cmd.at(0) != '-');
639
640 LOCK(cs_args);
641 m_accept_any_command = false; // latch to false
642 std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
643 auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
644 if (!options.empty()) {
645 auto& cmdopts = m_available_args[OptionsCategory::COMMAND_OPTIONS];
646 bool command_has_all_options_defined = true;
647 for (const auto& opt : options) {
648 if (!cmdopts.contains(opt)) {
649 command_has_all_options_defined = false;
650 }
651 }
652 Assert(command_has_all_options_defined);
653
654 m_command_args.try_emplace(cmd, std::move(options));
655 }
656 Assert(ret.second); // Fail on duplicate commands
657 }
658
659 void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
660 {
661 Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
662
663 // Split arg name from its help param
664 size_t eq_index = name.find('=');
665 if (eq_index == std::string::npos) {
666 eq_index = name.size();
667 }
668 std::string arg_name = name.substr(0, eq_index);
669
670 LOCK(cs_args);
671
672 // Allow duplicates involving HIDDEN — it is used as a placeholder for args
673 // unavailable in this binary but tolerated for shared config files (see #13441).
674 for (const auto& arg_map : m_available_args) {
675 if (arg_map.first == OptionsCategory::HIDDEN || cat == OptionsCategory::HIDDEN) continue;
676 Assert(!arg_map.second.contains(arg_name));
677 }
678
679 std::map<std::string, Arg>& arg_map = m_available_args[cat];
680 auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
681 assert(ret.second); // Make sure an insertion actually happened
682
683 if (flags & ArgsManager::NETWORK_ONLY) {
684 m_network_only_args.emplace(arg_name);
685 }
686 }
687
688 void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
689 {
690 for (const std::string& name : names) {
691 AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
692 }
693 }
694
695 void ArgsManager::ClearArgs()
696 {
697 LOCK(cs_args);
698 m_settings = {};
699 m_available_args.clear();
700 m_command_args.clear();
701 m_network_only_args.clear();
702 m_config_sections.clear();
703 }
704
705 void ArgsManager::CheckMultipleCLIArgs() const
706 {
707 LOCK(cs_args);
708 std::vector<std::string> found{};
709 auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
710 if (cmds != m_available_args.end()) {
711 for (const auto& [cmd, argspec] : cmds->second) {
712 if (!GetSetting_(cmd).isNull()) {
713 found.push_back(cmd);
714 }
715 }
716 if (found.size() > 1) {
717 throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
718 }
719 }
720 }
721
722 std::string ArgsManager::GetHelpMessage() const
723 {
724 const bool show_debug = GetBoolArg("-help-debug", false);
725
726 std::string usage;
727 LOCK(cs_args);
728
729 const auto command_options = m_available_args.find(OptionsCategory::COMMAND_OPTIONS);
730 const auto for_matching_cmd_opts = [&](const std::set<std::string>& select, auto&& fn) EXCLUSIVE_LOCKS_REQUIRED(cs_args) {
731 if (select.empty()) return;
732 if (command_options == m_available_args.end()) return;
733 for (const auto& [name, info] : command_options->second) {
734 if (!show_debug && (info.m_flags & ArgsManager::DEBUG_ONLY)) continue;
735 if (!select.contains(name)) continue;
736 fn(name, info);
737 }
738 };
739
740 for (const auto& [category, category_args] : m_available_args) {
741 switch(category) {
742 case OptionsCategory::OPTIONS:
743 usage += HelpMessageGroup("Options:");
744 break;
745 case OptionsCategory::CONNECTION:
746 usage += HelpMessageGroup("Connection options:");
747 break;
748 case OptionsCategory::ZMQ:
749 usage += HelpMessageGroup("ZeroMQ notification options:");
750 break;
751 case OptionsCategory::DEBUG_TEST:
752 usage += HelpMessageGroup("Debugging/Testing options:");
753 break;
754 case OptionsCategory::NODE_RELAY:
755 usage += HelpMessageGroup("Node relay options:");
756 break;
757 case OptionsCategory::BLOCK_CREATION:
758 usage += HelpMessageGroup("Block creation options:");
759 break;
760 case OptionsCategory::RPC:
761 usage += HelpMessageGroup("RPC server options:");
762 break;
763 case OptionsCategory::IPC:
764 usage += HelpMessageGroup("IPC interprocess connection options:");
765 break;
766 case OptionsCategory::WALLET:
767 usage += HelpMessageGroup("Wallet options:");
768 break;
769 case OptionsCategory::WALLET_DEBUG_TEST:
770 if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
771 break;
772 case OptionsCategory::CHAINPARAMS:
773 usage += HelpMessageGroup("Chain selection options:");
774 break;
775 case OptionsCategory::GUI:
776 usage += HelpMessageGroup("UI Options:");
777 break;
778 case OptionsCategory::COMMANDS:
779 usage += HelpMessageGroup("Commands:");
780 break;
781 case OptionsCategory::REGISTER_COMMANDS:
782 usage += HelpMessageGroup("Register Commands:");
783 break;
784 case OptionsCategory::CLI_COMMANDS:
785 usage += HelpMessageGroup("CLI Commands:");
786 break;
787 case OptionsCategory::COMMAND_OPTIONS:
788 case OptionsCategory::HIDDEN:
789 break;
790 } // no default case, so the compiler can warn about missing cases
791
792 if (category == OptionsCategory::COMMAND_OPTIONS) continue;
793
794 // When we get to the hidden options, stop
795 if (category == OptionsCategory::HIDDEN) break;
796
797 for (const auto& [arg_name, arg_info] : category_args) {
798 if (show_debug || !(arg_info.m_flags & ArgsManager::DEBUG_ONLY)) {
799 usage += HelpMessageOpt(arg_name, arg_info.m_help_param, arg_info.m_help_text);
800
801 if (category == OptionsCategory::COMMANDS) {
802 const auto cmd_args = m_command_args.find(arg_name);
803 if (cmd_args == m_command_args.end()) continue;
804 for_matching_cmd_opts(cmd_args->second, [&](const auto& cmdopt_name, const auto& cmdopt_info) {
805 usage += HelpMessageOpt(cmdopt_name, cmdopt_info.m_help_param, cmdopt_info.m_help_text, /*subopt=*/true);
806 });
807 }
808 }
809 }
810 }
811 return usage;
812 }
813
814 bool HelpRequested(const ArgsManager& args)
815 {
816 return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
817 }
818
819 void SetupHelpOptions(ArgsManager& args)
820 {
821 args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
822 args.AddHiddenArgs({"-h", "-?"});
823 }
824
825 std::string HelpMessageGroup(const std::string &message) {
826 return std::string(message) + std::string("\n\n");
827 }
828
829 std::string HelpMessageOpt(std::string_view option, std::string_view help_param, std::string_view message, bool subopt)
830 {
831 constexpr int screen_width = 79;
832 int opt_indent = 2;
833 int msg_indent = 7;
834
835 if (subopt) {
836 int bump = msg_indent - opt_indent;
837 opt_indent += bump; // opt_indent now at the old msg_indent level
838 msg_indent += bump; // indent by the same amount
839 }
840 int msg_width = screen_width - msg_indent;
841
842 return strprintf("%*s%s%s\n%*s%s\n\n",
843 opt_indent, "", option, help_param,
844 msg_indent, "", FormatParagraph(message, msg_width, msg_indent));
845 }
846
847 const std::vector<std::string> TEST_OPTIONS_DOC{
848 "addrman (use deterministic addrman)",
849 "reindex_after_failure_noninteractive_yes (When asked for a reindex after failure interactively, simulate as-if answered with 'yes')",
850 "bip94 (enforce BIP94 consensus rules)",
851 };
852
853 bool HasTestOption(const ArgsManager& args, const std::string& test_option)
854 {
855 const auto options = args.GetArgs("-test");
856 return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
857 return option == test_option;
858 });
859 }
860
861 fs::path GetDefaultDataDir()
862 {
863 // Windows:
864 // old: C:\Users\Username\AppData\Roaming\Bitcoin
865 // new: C:\Users\Username\AppData\Local\Bitcoin
866 // macOS: ~/Library/Application Support/Bitcoin
867 // Unix-like: ~/.bitcoin
868 #ifdef WIN32
869 // Windows
870 // Check for existence of datadir in old location and keep it there
871 fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
872 if (fs::exists(legacy_path)) return legacy_path;
873
874 // Otherwise, fresh installs can start in the new, "proper" location
875 return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) / "Bitcoin";
876 #else
877 fs::path pathRet;
878 char* pszHome = getenv("HOME");
879 if (pszHome == nullptr || strlen(pszHome) == 0)
880 pathRet = fs::path("/");
881 else
882 pathRet = fs::path(pszHome);
883 #ifdef __APPLE__
884 // macOS
885 return pathRet / "Library/Application Support/Bitcoin";
886 #else
887 // Unix-like
888 return pathRet / ".bitcoin";
889 #endif
890 #endif
891 }
892
893 bool CheckDataDirOption(const ArgsManager& args)
894 {
895 const fs::path datadir{args.GetPathArg("-datadir")};
896 return datadir.empty() || fs::is_directory(fs::absolute(datadir));
897 }
898
899 fs::path ArgsManager::GetConfigFilePath() const
900 {
901 LOCK(cs_args);
902 return *Assert(m_config_path);
903 }
904
905 void ArgsManager::SetConfigFilePath(fs::path path)
906 {
907 LOCK(cs_args);
908 assert(!m_config_path);
909 m_config_path = path;
910 }
911
912 ChainType ArgsManager::GetChainType() const
913 {
914 std::variant<ChainType, std::string> arg = GetChainArg();
915 if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed;
916 throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg)));
917 }
918
919 std::string ArgsManager::GetChainTypeString() const
920 {
921 auto arg = GetChainArg();
922 if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
923 return std::get<std::string>(arg);
924 }
925
926 std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
927 {
928 auto get_net = [&](const std::string& arg) {
929 LOCK(cs_args);
930 common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
931 /* ignore_default_section_config= */ false,
932 /*ignore_nonpersistent=*/false,
933 /* get_chain_type= */ true);
934 return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
935 };
936
937 const bool fRegTest = get_net("-regtest");
938 const bool fSigNet = get_net("-signet");
939 const bool fTestNet = get_net("-testnet");
940 const bool fTestNet4 = get_net("-testnet4");
941 const auto chain_arg = GetArg("-chain");
942
943 if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
944 throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
945 }
946 if (chain_arg) {
947 if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
948 // Not a known string, so return original string
949 return *chain_arg;
950 }
951 if (fRegTest) return ChainType::REGTEST;
952 if (fSigNet) return ChainType::SIGNET;
953 if (fTestNet) return ChainType::TESTNET;
954 if (fTestNet4) return ChainType::TESTNET4;
955 return ChainType::MAIN;
956 }
957
958 bool ArgsManager::UseDefaultSection(const std::string& arg) const
959 {
960 AssertLockHeld(cs_args);
961 return m_network == ChainTypeToString(ChainType::MAIN) || !m_network_only_args.contains(arg);
962 }
963
964 common::SettingsValue ArgsManager::GetSetting_(const std::string& arg) const
965 {
966 AssertLockHeld(cs_args);
967 return common::GetSetting(
968 m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
969 /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
970 }
971
972 common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
973 {
974 LOCK(cs_args);
975 return GetSetting_(arg);
976 }
977
978 std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
979 {
980 LOCK(cs_args);
981 return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
982 }
983
984 void ArgsManager::logArgsPrefix(
985 const std::string& prefix,
986 const std::string& section,
987 const std::map<std::string, std::vector<common::SettingsValue>>& args) const
988 {
989 AssertLockHeld(cs_args);
990 std::string section_str = section.empty() ? "" : "[" + section + "] ";
991 for (const auto& arg : args) {
992 for (const auto& value : arg.second) {
993 std::optional<unsigned int> flags = GetArgFlags_('-' + arg.first);
994 if (flags) {
995 std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
996 LogInfo("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
997 }
998 }
999 }
1000 }
1001
1002 void ArgsManager::LogArgs() const
1003 {
1004 LOCK(cs_args);
1005 for (const auto& section : m_settings.ro_config) {
1006 logArgsPrefix("Config file arg:", section.first, section.second);
1007 }
1008 for (const auto& setting : m_settings.rw_settings) {
1009 LogInfo("Setting file arg: %s = %s\n", setting.first, setting.second.write());
1010 }
1011 logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
1012 }
1013