62 return (LocaleIndependentAtoi<int>(strValue) != 0);
67 return arg.size() > 0 && arg[0] ==
'-' ? arg.substr(1) : arg;
82 size_t option_index = key.find(
'.');
83 if (option_index != std::string::npos) {
84 result.
section = key.substr(0, option_index);
85 key.erase(0, option_index + 1);
87 if (key.substr(0, 2) ==
"no") {
107 unsigned int flags, std::string& error)
112 error =
strprintf(
"Negating of -%s is meaningless and therefore forbidden", key.
name);
117 LogPrintf(
"Warning: parsed potentially confusing double-negative -%s=%s\n", key.
name, *value);
123 error =
strprintf(
"Can not set -%s with no value. Please specify value with -%s=value.", key.
name, key.
name);
126 return value ? *value :
"";
137 std::set<std::string> unsuitables;
142 if (m_network.empty())
return std::set<std::string> {};
147 for (
const auto& arg : m_network_only_args) {
149 unsuitables.insert(arg);
158 static const std::set<std::string> available_sections{
166 std::list<SectionInfo> unrecognized = m_config_sections;
167 unrecognized.remove_if([](
const SectionInfo& appeared){
return available_sections.find(appeared.
m_name) != available_sections.end(); });
180 m_settings.command_line_options.clear();
182 for (
int i = 1; i < argc; i++) {
183 std::string key(argv[i]);
190 if (key.substr(0, 5) ==
"-psn_")
continue;
193 if (key ==
"-")
break;
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);
207 if (!m_accept_any_command &&
m_command.empty()) {
211 error =
strprintf(
"Invalid command '%s'", argv[i]);
224 if (key.length() > 1 && key[1] ==
'-')
236 error =
strprintf(
"Invalid parameter %s", argv[i]);
240 std::optional<common::SettingsValue> value =
InterpretValue(keyinfo, val ? &*val :
nullptr, *
flags, error);
241 if (!value)
return false;
243 m_settings.command_line_options[keyinfo.
name].push_back(*value);
247 if (
auto* includes =
common::FindKey(m_settings.command_line_options,
"includeconf")) {
251 error =
"-includeconf cannot be used from commandline; -includeconf=" +
values.begin()->write();
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;
273 std::string path_str =
GetArg(arg,
"");
274 if (path_str.empty())
return default_value;
277 return result.has_filename() ? result : result.parent_path();
283 fs::path& path = m_cached_blocks_path;
287 if (!path.empty())
return path;
291 if (!fs::is_directory(path)) {
308 fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
311 if (!path.empty())
return path;
314 if (!datadir.empty()) {
316 if (!fs::is_directory(path)) {
324 if (net_specific && !
BaseParams().DataDir().empty()) {
336 m_cached_network_datadir_path =
fs::path();
349 if (!m_accept_any_command) {
351 ret.command = *(it++);
355 ret.args.push_back(*(it++));
362 std::vector<std::string> result;
364 result.push_back(value.isFalse() ?
"0" : value.isTrue() ?
"1" : value.get_str());
377 if (settings.empty()) {
389 static void SaveErrors(
const std::vector<std::string> errors, std::vector<std::string>* error_out)
391 for (
const auto& error : errors) {
393 error_out->emplace_back(error);
408 m_settings.rw_settings.clear();
409 std::vector<std::string> read_errors;
414 for (
const auto& setting : m_settings.rw_settings) {
417 LogPrintf(
"Ignoring unknown rw_settings value %s\n", setting.first);
427 throw std::logic_error(
"Attempt to write settings file when dynamic settings are disabled.");
431 std::vector<std::string> write_errors;
457 return GetArg(strArg).value_or(strDefault);
468 if (value.
isNull())
return std::nullopt;
469 if (value.
isFalse())
return "0";
470 if (value.
isTrue())
return "1";
482 return GetIntArg(strArg).value_or(nDefault);
493 if (value.
isNull())
return std::nullopt;
495 if (value.
isTrue())
return 1;
497 return LocaleIndependentAtoi<int64_t>(value.
get_str());
518 if (value.
isNull())
return std::nullopt;
547 m_settings.forced_settings[
SettingName(strArg)] = strValue;
552 Assert(
cmd.find(
'=') == std::string::npos);
556 m_accept_any_command =
false;
567 size_t eq_index =
name.find(
'=');
568 if (eq_index == std::string::npos) {
569 eq_index =
name.size();
571 std::string arg_name =
name.substr(0, eq_index);
574 std::map<std::string, Arg>& arg_map = m_available_args[cat];
579 m_network_only_args.emplace(arg_name);
585 for (
const std::string&
name : names) {
592 const bool show_debug =
GetBoolArg(
"-help-debug",
false);
596 for (
const auto& arg_map : m_available_args) {
597 switch(arg_map.first) {
623 if (show_debug) usage +=
HelpMessageGroup(
"Wallet debugging/testing options:");
644 for (
const auto& arg : arg_map.second) {
647 if (arg.second.m_help_param.empty()) {
650 name = arg.first + arg.second.m_help_param;
675 return std::string(message) + std::string(
"\n\n");
678 std::string
HelpMessageOpt(
const std::string &option,
const std::string &message) {
679 return std::string(
optIndent,
' ') + std::string(option) +
680 std::string(
"\n") + std::string(
msgIndent,
' ') +
686 "addrman (use deterministic addrman)",
692 return std::any_of(options.begin(), options.end(), [test_option](
const auto& option) {
693 return option == test_option;
704 return GetSpecialFolderPath(CSIDL_APPDATA) /
"Bitcoin";
707 char* pszHome = getenv(
"HOME");
708 if (pszHome ==
nullptr || strlen(pszHome) == 0)
714 return pathRet /
"Library/Application Support/Bitcoin";
717 return pathRet /
".bitcoin";
725 return datadir.empty() || fs::is_directory(
fs::absolute(datadir));
731 return *
Assert(m_config_path);
738 m_config_path = path;
743 std::variant<ChainType, std::string> arg =
GetChainArg();
744 if (
auto* parsed = std::get_if<ChainType>(&arg))
return *parsed;
745 throw std::runtime_error(
strprintf(
"Unknown chain %s.", std::get<std::string>(arg)));
751 if (
auto* parsed = std::get_if<ChainType>(&arg))
return ChainTypeToString(*parsed);
752 return std::get<std::string>(arg);
757 auto get_net = [&](
const std::string& arg) {
766 const bool fRegTest = get_net(
"-regtest");
767 const bool fSigNet = get_net(
"-signet");
768 const bool fTestNet = get_net(
"-testnet");
769 const auto chain_arg =
GetArg(
"-chain");
771 if ((
int)chain_arg.has_value() + (
int)fRegTest + (
int)fSigNet + (
int)fTestNet > 1) {
772 throw std::runtime_error(
"Invalid combination of -regtest, -signet, -testnet and -chain. Can use at most one.");
805 const std::string&
prefix,
806 const std::string& section,
807 const std::map<std::string, std::vector<common::SettingsValue>>&
args)
const
809 std::string section_str = section.empty() ?
"" :
"[" + section +
"] ";
810 for (
const auto& arg :
args) {
811 for (
const auto& value : arg.second) {
814 std::string value_str = (*
flags &
SENSITIVE) ?
"****" : value.write();
824 for (
const auto& section : m_settings.ro_config) {
825 logArgsPrefix(
"Config file arg:", section.first, section.second);
827 for (
const auto& setting : m_settings.rw_settings) {
828 LogPrintf(
"Setting file arg: %s = %s\n", setting.first, setting.second.write());
830 logArgsPrefix(
"Command-line arg:",
"", m_settings.command_line_options);
835 WinCmdLineArgs::WinCmdLineArgs()
837 wchar_t** wargv = CommandLineToArgvW(GetCommandLineW(), &argc);
838 std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>,
wchar_t> utf8_cvt;
839 argv =
new char*[argc];
841 for (
int i = 0; i < argc; i++) {
842 args[i] = utf8_cvt.to_bytes(wargv[i]);
843 argv[i] = &*
args[i].begin();
848 WinCmdLineArgs::~WinCmdLineArgs()
853 std::pair<int, char**> WinCmdLineArgs::get()
855 return std::make_pair(argc, argv);
const std::vector< std::string > TEST_OPTIONS_DOC
bool HelpRequested(const ArgsManager &args)
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
fs::path GetDefaultDataDir()
static const int msgIndent
static void SaveErrors(const std::vector< std::string > errors, std::vector< std::string > *error_out)
const char *const BITCOIN_SETTINGS_FILENAME
std::optional< common::SettingsValue > InterpretValue(const KeyInfo &key, const std::string *value, unsigned int flags, std::string &error)
Interpret settings value based on registered flags.
std::optional< int64_t > SettingToInt(const common::SettingsValue &value)
std::optional< std::string > SettingToString(const common::SettingsValue &value)
bool CheckDataDirOption(const ArgsManager &args)
static const int screenWidth
bool HasTestOption(const ArgsManager &args, const std::string &test_option)
Checks if a particular test option is present in -test command-line arg options.
static std::string SettingName(const std::string &arg)
std::string HelpMessageGroup(const std::string &message)
Format a string to be used as group of options in help messages.
KeyInfo InterpretKey(std::string key)
Parse "name", "section.name", "noname", "section.noname" settings keys.
const char *const BITCOIN_CONF_FILENAME
std::optional< bool > SettingToBool(const common::SettingsValue &value)
static bool InterpretBool(const std::string &strValue)
Interpret a string argument as a boolean.
static const int optIndent
std::string HelpMessageOpt(const std::string &option, const std::string &message)
Format a string to be used as option description in help messages.
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::optional< ChainType > ChainTypeFromString(std::string_view chain)
std::string ChainTypeToString(ChainType chain)
#define Assert(val)
Identity function.
std::set< std::string > GetUnsuitableSectionOnlyArgs() const
Log warnings for options in m_section_only_args when they are specified in the default section but no...
std::optional< const Command > GetCommand() const
Get the command and command args (returns std::nullopt if no command provided)
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
@ ALLOW_ANY
disable validation
@ DISALLOW_NEGATION
disallow -nofoo syntax
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
common::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
ChainType GetChainType() const
Returns the appropriate chain type from the program arguments.
void ForceSetArg(const std::string &strArg, const std::string &strValue)
std::string GetChainTypeString() const
Returns the appropriate chain type string from the program arguments.
bool ParseParameters(int argc, const char *const argv[], std::string &error)
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
void SetConfigFilePath(fs::path)
bool GetSettingsPath(fs::path *filepath=nullptr, bool temp=false, bool backup=false) const
Get settings file path, or return false if read-write settings were disabled with -nosettings.
bool SoftSetArg(const std::string &strArg, const std::string &strValue)
Set an argument if it doesn't already have a value.
void SelectConfigNetwork(const std::string &network)
Select the network in use.
std::string GetHelpMessage() const
Get the help string.
void ClearPathCache()
Clear cached directory paths.
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
void logArgsPrefix(const std::string &prefix, const std::string §ion, const std::map< std::string, std::vector< common::SettingsValue >> &args) const
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
fs::path GetDataDirBase() const
Get data directory path.
fs::path GetBlocksDirPath() const
Get blocks directory path.
fs::path GetConfigFilePath() const
Return config file path (read-only)
std::vector< common::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
void AddCommand(const std::string &cmd, const std::string &help)
Add subcommand.
std::variant< ChainType, std::string > GetChainArg() const
Return -regtest/-signet/-testnet/-chain= setting as a ChainType enum if a recognized chain type was s...
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
fs::path GetDataDir(bool net_specific) const
Get data directory path.
common::SettingsValue GetPersistentSetting(const std::string &name) const
Get current setting from config file or read/write settings file, ignoring nonpersistent command line...
bool UseDefaultSection(const std::string &arg) const EXCLUSIVE_LOCKS_REQUIRED(cs_args)
Returns true if settings values from the default section should be used, depending on the current net...
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
const std::string & get_str() const
const std::string & getValStr() const
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
SettingsValue GetSetting(const Settings &settings, const std::string §ion, const std::string &name, bool ignore_default_section_config, bool ignore_nonpersistent, bool get_chain_type)
Get settings value from combined sources: forced settings, command line arguments,...
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
std::vector< SettingsValue > GetSettingsList(const Settings &settings, const std::string §ion, const std::string &name, bool ignore_default_section_config)
Get combined setting value similar to GetSetting(), except if setting was specified multiple times,...
bool OnlyHasDefaultSectionSetting(const Settings &settings, const std::string §ion, const std::string &name)
Return true if a setting is set in the default config file section, and not overridden by a higher pr...
static path absolute(const path &p)
static bool create_directories(const std::filesystem::path &p)
Create directory (and if necessary its parents), unless the leaf directory already exists or is a sym...
static std::string PathToString(const path &path)
Convert path object to a byte string.
static path PathFromString(const std::string &string)
Convert byte string to path object.
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
Accessor for list of settings that skips negated values when iterated over.
std::string FormatParagraph(std::string_view in, size_t width, size_t indent)
Format a paragraph of text to a fixed width, adding spaces for indentation to any added line.
std::string ToLower(std::string_view str)
Returns the lowercase equivalent of the given string.