args.cpp
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 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 std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const 391 { 392 std::vector<std::string> result; 393 for (const common::SettingsValue& value : GetSettingsList(strArg)) { 394 result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str()); 395 } 396 return result; 397 } 398 399 bool ArgsManager::IsArgSet(const std::string& strArg) const 400 { 401 return !GetSetting(strArg).isNull(); 402 } 403 404 bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const 405 { 406 fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME); 407 if (settings.empty()) { 408 return false; 409 } 410 if (backup) { 411 settings += ".bak"; 412 } 413 if (filepath) { 414 *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings); 415 } 416 return true; 417 } 418 419 static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out) 420 { 421 for (const auto& error : errors) { 422 if (error_out) { 423 error_out->emplace_back(error); 424 } else { 425 LogWarning("%s", error); 426 } 427 } 428 } 429 430 bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors) 431 { 432 fs::path path; 433 if (!GetSettingsPath(&path, /* temp= */ false)) { 434 return true; // Do nothing if settings file disabled. 435 } 436 437 LOCK(cs_args); 438 m_settings.rw_settings.clear(); 439 std::vector<std::string> read_errors; 440 if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) { 441 SaveErrors(read_errors, errors); 442 return false; 443 } 444 for (const auto& setting : m_settings.rw_settings) { 445 KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname 446 if (!GetArgFlags_('-' + key.name)) { 447 LogWarning("Ignoring unknown rw_settings value %s", setting.first); 448 } 449 } 450 return true; 451 } 452 453 bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const 454 { 455 fs::path path, path_tmp; 456 if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) { 457 throw std::logic_error("Attempt to write settings file when dynamic settings are disabled."); 458 } 459 460 LOCK(cs_args); 461 std::vector<std::string> write_errors; 462 if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) { 463 SaveErrors(write_errors, errors); 464 return false; 465 } 466 if (!RenameOver(path_tmp, path)) { 467 SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors); 468 return false; 469 } 470 return true; 471 } 472 473 common::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const 474 { 475 LOCK(cs_args); 476 return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name), 477 /*ignore_nonpersistent=*/true, /*get_chain_type=*/false); 478 } 479 480 bool ArgsManager::IsArgNegated(const std::string& strArg) const 481 { 482 return GetSetting(strArg).isFalse(); 483 } 484 485 std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const 486 { 487 return GetArg(strArg).value_or(strDefault); 488 } 489 490 std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const 491 { 492 const common::SettingsValue value = GetSetting(strArg); 493 return SettingToString(value); 494 } 495 496 std::optional<std::string> SettingToString(const common::SettingsValue& value) 497 { 498 if (value.isNull()) return std::nullopt; 499 if (value.isFalse()) return "0"; 500 if (value.isTrue()) return "1"; 501 if (value.isNum()) return value.getValStr(); 502 return value.get_str(); 503 } 504 505 std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault) 506 { 507 return SettingToString(value).value_or(strDefault); 508 } 509 510 template <std::integral Int> 511 Int ArgsManager::GetArg(const std::string& strArg, Int nDefault) const 512 { 513 return GetArg<Int>(strArg).value_or(nDefault); 514 } 515 516 template <std::integral Int> 517 std::optional<Int> ArgsManager::GetArg(const std::string& strArg) const 518 { 519 const common::SettingsValue value = GetSetting(strArg); 520 return SettingTo<Int>(value); 521 } 522 523 template <std::integral Int> 524 std::optional<Int> SettingTo(const common::SettingsValue& value) 525 { 526 if (value.isNull()) return std::nullopt; 527 if (value.isFalse()) return 0; 528 if (value.isTrue()) return 1; 529 if (value.isNum()) return value.getInt<Int>(); 530 return LocaleIndependentAtoi<Int>(value.get_str()); 531 } 532 533 template <std::integral Int> 534 Int SettingTo(const common::SettingsValue& value, Int nDefault) 535 { 536 return SettingTo<Int>(value).value_or(nDefault); 537 } 538 539 bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const 540 { 541 return GetBoolArg(strArg).value_or(fDefault); 542 } 543 544 std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const 545 { 546 const common::SettingsValue value = GetSetting(strArg); 547 return SettingToBool(value); 548 } 549 550 std::optional<bool> SettingToBool(const common::SettingsValue& value) 551 { 552 if (value.isNull()) return std::nullopt; 553 if (value.isBool()) return value.get_bool(); 554 return InterpretBool(value.get_str()); 555 } 556 557 bool SettingToBool(const common::SettingsValue& value, bool fDefault) 558 { 559 return SettingToBool(value).value_or(fDefault); 560 } 561 562 #define INSTANTIATE_INT_TYPE(Type) \ 563 template Type ArgsManager::GetArg<Type>(const std::string&, Type) const; \ 564 template std::optional<Type> ArgsManager::GetArg<Type>(const std::string&) const; \ 565 template Type SettingTo<Type>(const common::SettingsValue&, Type); \ 566 template std::optional<Type> SettingTo<Type>(const common::SettingsValue&) 567 568 INSTANTIATE_INT_TYPE(int8_t); 569 INSTANTIATE_INT_TYPE(uint8_t); 570 INSTANTIATE_INT_TYPE(int16_t); 571 INSTANTIATE_INT_TYPE(uint16_t); 572 INSTANTIATE_INT_TYPE(int32_t); 573 INSTANTIATE_INT_TYPE(uint32_t); 574 INSTANTIATE_INT_TYPE(int64_t); 575 INSTANTIATE_INT_TYPE(uint64_t); 576 577 #undef INSTANTIATE_INT_TYPE 578 579 bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue) 580 { 581 LOCK(cs_args); 582 if (!GetSetting_(strArg).isNull()) return false; 583 m_settings.forced_settings[SettingName(strArg)] = strValue; 584 return true; 585 } 586 587 bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue) 588 { 589 if (fValue) 590 return SoftSetArg(strArg, std::string("1")); 591 else 592 return SoftSetArg(strArg, std::string("0")); 593 } 594 595 void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue) 596 { 597 LOCK(cs_args); 598 m_settings.forced_settings[SettingName(strArg)] = strValue; 599 } 600 601 void ArgsManager::AddCommand(const std::string& cmd, const std::string& help) 602 { 603 Assert(cmd.find('=') == std::string::npos); 604 Assert(cmd.at(0) != '-'); 605 606 LOCK(cs_args); 607 m_accept_any_command = false; // latch to false 608 std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS]; 609 auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND}); 610 Assert(ret.second); // Fail on duplicate commands 611 } 612 613 void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat) 614 { 615 Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand 616 617 // Split arg name from its help param 618 size_t eq_index = name.find('='); 619 if (eq_index == std::string::npos) { 620 eq_index = name.size(); 621 } 622 std::string arg_name = name.substr(0, eq_index); 623 624 LOCK(cs_args); 625 std::map<std::string, Arg>& arg_map = m_available_args[cat]; 626 auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags}); 627 assert(ret.second); // Make sure an insertion actually happened 628 629 if (flags & ArgsManager::NETWORK_ONLY) { 630 m_network_only_args.emplace(arg_name); 631 } 632 } 633 634 void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names) 635 { 636 for (const std::string& name : names) { 637 AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN); 638 } 639 } 640 641 void ArgsManager::ClearArgs() 642 { 643 LOCK(cs_args); 644 m_settings = {}; 645 m_available_args.clear(); 646 m_network_only_args.clear(); 647 m_config_sections.clear(); 648 } 649 650 void ArgsManager::CheckMultipleCLIArgs() const 651 { 652 LOCK(cs_args); 653 std::vector<std::string> found{}; 654 auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS); 655 if (cmds != m_available_args.end()) { 656 for (const auto& [cmd, argspec] : cmds->second) { 657 if (!GetSetting_(cmd).isNull()) { 658 found.push_back(cmd); 659 } 660 } 661 if (found.size() > 1) { 662 throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", "))); 663 } 664 } 665 } 666 667 std::string ArgsManager::GetHelpMessage() const 668 { 669 const bool show_debug = GetBoolArg("-help-debug", false); 670 671 std::string usage; 672 LOCK(cs_args); 673 for (const auto& arg_map : m_available_args) { 674 switch(arg_map.first) { 675 case OptionsCategory::OPTIONS: 676 usage += HelpMessageGroup("Options:"); 677 break; 678 case OptionsCategory::CONNECTION: 679 usage += HelpMessageGroup("Connection options:"); 680 break; 681 case OptionsCategory::ZMQ: 682 usage += HelpMessageGroup("ZeroMQ notification options:"); 683 break; 684 case OptionsCategory::DEBUG_TEST: 685 usage += HelpMessageGroup("Debugging/Testing options:"); 686 break; 687 case OptionsCategory::NODE_RELAY: 688 usage += HelpMessageGroup("Node relay options:"); 689 break; 690 case OptionsCategory::BLOCK_CREATION: 691 usage += HelpMessageGroup("Block creation options:"); 692 break; 693 case OptionsCategory::RPC: 694 usage += HelpMessageGroup("RPC server options:"); 695 break; 696 case OptionsCategory::IPC: 697 usage += HelpMessageGroup("IPC interprocess connection options:"); 698 break; 699 case OptionsCategory::WALLET: 700 usage += HelpMessageGroup("Wallet options:"); 701 break; 702 case OptionsCategory::WALLET_DEBUG_TEST: 703 if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:"); 704 break; 705 case OptionsCategory::CHAINPARAMS: 706 usage += HelpMessageGroup("Chain selection options:"); 707 break; 708 case OptionsCategory::GUI: 709 usage += HelpMessageGroup("UI Options:"); 710 break; 711 case OptionsCategory::COMMANDS: 712 usage += HelpMessageGroup("Commands:"); 713 break; 714 case OptionsCategory::REGISTER_COMMANDS: 715 usage += HelpMessageGroup("Register Commands:"); 716 break; 717 case OptionsCategory::CLI_COMMANDS: 718 usage += HelpMessageGroup("CLI Commands:"); 719 break; 720 default: 721 break; 722 } 723 724 // When we get to the hidden options, stop 725 if (arg_map.first == OptionsCategory::HIDDEN) break; 726 727 for (const auto& arg : arg_map.second) { 728 if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) { 729 std::string name; 730 if (arg.second.m_help_param.empty()) { 731 name = arg.first; 732 } else { 733 name = arg.first + arg.second.m_help_param; 734 } 735 usage += HelpMessageOpt(name, arg.second.m_help_text); 736 } 737 } 738 } 739 return usage; 740 } 741 742 bool HelpRequested(const ArgsManager& args) 743 { 744 return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug"); 745 } 746 747 void SetupHelpOptions(ArgsManager& args) 748 { 749 args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS); 750 args.AddHiddenArgs({"-h", "-?"}); 751 } 752 753 static const int screenWidth = 79; 754 static const int optIndent = 2; 755 static const int msgIndent = 7; 756 757 std::string HelpMessageGroup(const std::string &message) { 758 return std::string(message) + std::string("\n\n"); 759 } 760 761 std::string HelpMessageOpt(const std::string &option, const std::string &message) { 762 return std::string(optIndent,' ') + std::string(option) + 763 std::string("\n") + std::string(msgIndent,' ') + 764 FormatParagraph(message, screenWidth - msgIndent, msgIndent) + 765 std::string("\n\n"); 766 } 767 768 const std::vector<std::string> TEST_OPTIONS_DOC{ 769 "addrman (use deterministic addrman)", 770 "reindex_after_failure_noninteractive_yes (When asked for a reindex after failure interactively, simulate as-if answered with 'yes')", 771 "bip94 (enforce BIP94 consensus rules)", 772 }; 773 774 bool HasTestOption(const ArgsManager& args, const std::string& test_option) 775 { 776 const auto options = args.GetArgs("-test"); 777 return std::any_of(options.begin(), options.end(), [test_option](const auto& option) { 778 return option == test_option; 779 }); 780 } 781 782 fs::path GetDefaultDataDir() 783 { 784 // Windows: 785 // old: C:\Users\Username\AppData\Roaming\Bitcoin 786 // new: C:\Users\Username\AppData\Local\Bitcoin 787 // macOS: ~/Library/Application Support/Bitcoin 788 // Unix-like: ~/.bitcoin 789 #ifdef WIN32 790 // Windows 791 // Check for existence of datadir in old location and keep it there 792 fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin"; 793 if (fs::exists(legacy_path)) return legacy_path; 794 795 // Otherwise, fresh installs can start in the new, "proper" location 796 return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) / "Bitcoin"; 797 #else 798 fs::path pathRet; 799 char* pszHome = getenv("HOME"); 800 if (pszHome == nullptr || strlen(pszHome) == 0) 801 pathRet = fs::path("/"); 802 else 803 pathRet = fs::path(pszHome); 804 #ifdef __APPLE__ 805 // macOS 806 return pathRet / "Library/Application Support/Bitcoin"; 807 #else 808 // Unix-like 809 return pathRet / ".bitcoin"; 810 #endif 811 #endif 812 } 813 814 bool CheckDataDirOption(const ArgsManager& args) 815 { 816 const fs::path datadir{args.GetPathArg("-datadir")}; 817 return datadir.empty() || fs::is_directory(fs::absolute(datadir)); 818 } 819 820 fs::path ArgsManager::GetConfigFilePath() const 821 { 822 LOCK(cs_args); 823 return *Assert(m_config_path); 824 } 825 826 void ArgsManager::SetConfigFilePath(fs::path path) 827 { 828 LOCK(cs_args); 829 assert(!m_config_path); 830 m_config_path = path; 831 } 832 833 ChainType ArgsManager::GetChainType() const 834 { 835 std::variant<ChainType, std::string> arg = GetChainArg(); 836 if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed; 837 throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg))); 838 } 839 840 std::string ArgsManager::GetChainTypeString() const 841 { 842 auto arg = GetChainArg(); 843 if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed); 844 return std::get<std::string>(arg); 845 } 846 847 std::variant<ChainType, std::string> ArgsManager::GetChainArg() const 848 { 849 auto get_net = [&](const std::string& arg) { 850 LOCK(cs_args); 851 common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg), 852 /* ignore_default_section_config= */ false, 853 /*ignore_nonpersistent=*/false, 854 /* get_chain_type= */ true); 855 return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str()); 856 }; 857 858 const bool fRegTest = get_net("-regtest"); 859 const bool fSigNet = get_net("-signet"); 860 const bool fTestNet = get_net("-testnet"); 861 const bool fTestNet4 = get_net("-testnet4"); 862 const auto chain_arg = GetArg("-chain"); 863 864 if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) { 865 throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one."); 866 } 867 if (chain_arg) { 868 if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed; 869 // Not a known string, so return original string 870 return *chain_arg; 871 } 872 if (fRegTest) return ChainType::REGTEST; 873 if (fSigNet) return ChainType::SIGNET; 874 if (fTestNet) return ChainType::TESTNET; 875 if (fTestNet4) return ChainType::TESTNET4; 876 return ChainType::MAIN; 877 } 878 879 bool ArgsManager::UseDefaultSection(const std::string& arg) const 880 { 881 AssertLockHeld(cs_args); 882 return m_network == ChainTypeToString(ChainType::MAIN) || !m_network_only_args.contains(arg); 883 } 884 885 common::SettingsValue ArgsManager::GetSetting_(const std::string& arg) const 886 { 887 AssertLockHeld(cs_args); 888 return common::GetSetting( 889 m_settings, m_network, SettingName(arg), !UseDefaultSection(arg), 890 /*ignore_nonpersistent=*/false, /*get_chain_type=*/false); 891 } 892 893 common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const 894 { 895 LOCK(cs_args); 896 return GetSetting_(arg); 897 } 898 899 std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const 900 { 901 LOCK(cs_args); 902 return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg)); 903 } 904 905 void ArgsManager::logArgsPrefix( 906 const std::string& prefix, 907 const std::string& section, 908 const std::map<std::string, std::vector<common::SettingsValue>>& args) const 909 { 910 AssertLockHeld(cs_args); 911 std::string section_str = section.empty() ? "" : "[" + section + "] "; 912 for (const auto& arg : args) { 913 for (const auto& value : arg.second) { 914 std::optional<unsigned int> flags = GetArgFlags_('-' + arg.first); 915 if (flags) { 916 std::string value_str = (*flags & SENSITIVE) ? "****" : value.write(); 917 LogInfo("%s %s%s=%s\n", prefix, section_str, arg.first, value_str); 918 } 919 } 920 } 921 } 922 923 void ArgsManager::LogArgs() const 924 { 925 LOCK(cs_args); 926 for (const auto& section : m_settings.ro_config) { 927 logArgsPrefix("Config file arg:", section.first, section.second); 928 } 929 for (const auto& setting : m_settings.rw_settings) { 930 LogInfo("Setting file arg: %s = %s\n", setting.first, setting.second.write()); 931 } 932 logArgsPrefix("Command-line arg:", "", m_settings.command_line_options); 933 }