Bitcoin Core 30.99.0
P2P Digital Currency
args.cpp
Go to the documentation of this file.
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
39const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
40const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
41
43
59static bool InterpretBool(const std::string& strValue)
60{
61 if (strValue.empty())
62 return true;
63 return (LocaleIndependentAtoi<int>(strValue) != 0);
64}
65
66static std::string SettingName(const std::string& arg)
67{
68 return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
69}
70
79KeyInfo InterpretKey(std::string key)
80{
81 KeyInfo result;
82 // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
83 size_t option_index = key.find('.');
84 if (option_index != std::string::npos) {
85 result.section = key.substr(0, option_index);
86 key.erase(0, option_index + 1);
87 }
88 if (key.starts_with("no")) {
89 key.erase(0, 2);
90 result.negated = true;
91 }
92 result.name = key;
93 return result;
94}
95
107std::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 if (key.negated) {
113 error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
114 return std::nullopt;
115 }
116 // Double negatives like -nofoo=0 are supported (but discouraged)
117 if (value && !InterpretBool(*value)) {
118 LogPrintf("Warning: parsed potentially confusing double-negative -%s=%s\n", key.name, *value);
119 return true;
120 }
121 return false;
122 }
123 if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
124 error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
125 return std::nullopt;
126 }
127 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.
133ArgsManager::ArgsManager() = default;
134ArgsManager::~ArgsManager() = default;
135
136std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
137{
138 std::set<std::string> unsuitables;
139
140 LOCK(cs_args);
141
142 // if there's no section selected, don't worry
143 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 if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
147
148 for (const auto& arg : m_network_only_args) {
149 if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
150 unsuitables.insert(arg);
151 }
152 }
153 return unsuitables;
154}
155
156std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
157{
158 // Section names to be recognized in the config file.
159 static const std::set<std::string> available_sections{
165 };
166
167 LOCK(cs_args);
168 std::list<SectionInfo> unrecognized = m_config_sections;
169 unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.find(appeared.m_name) != available_sections.end(); });
170 return unrecognized;
171}
172
173void ArgsManager::SelectConfigNetwork(const std::string& network)
174{
175 LOCK(cs_args);
176 m_network = network;
177}
178
179bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
180{
181 LOCK(cs_args);
182 m_settings.command_line_options.clear();
183
184 for (int i = 1; i < argc; i++) {
185 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 if (key == "-") break; //bitcoin-tx using stdin
196 std::optional<std::string> val;
197 size_t is_index = key.find('=');
198 if (is_index != std::string::npos) {
199 val = key.substr(is_index + 1);
200 key.erase(is_index);
201 }
202#ifdef WIN32
203 key = ToLower(key);
204 if (key[0] == '/')
205 key[0] = '-';
206#endif
207
208 if (key[0] != '-') {
209 if (!m_accept_any_command && m_command.empty()) {
210 // The first non-dash arg is a registered command
211 std::optional<unsigned int> flags = GetArgFlags(key);
212 if (!flags || !(*flags & ArgsManager::COMMAND)) {
213 error = strprintf("Invalid command '%s'", argv[i]);
214 return false;
215 }
216 }
217 m_command.push_back(key);
218 while (++i < argc) {
219 // The remaining args are command args
220 m_command.emplace_back(argv[i]);
221 }
222 break;
223 }
224
225 // Transform --foo to -foo
226 if (key.length() > 1 && key[1] == '-')
227 key.erase(0, 1);
228
229 // Transform -foo to foo
230 key.erase(0, 1);
231 KeyInfo keyinfo = InterpretKey(key);
232 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 if (!flags || !keyinfo.section.empty()) {
238 error = strprintf("Invalid parameter %s", argv[i]);
239 return false;
240 }
241
242 std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
243 if (!value) return false;
244
245 m_settings.command_line_options[keyinfo.name].push_back(*value);
246 }
247
248 // we do not allow -includeconf from command line, only -noincludeconf
249 if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
250 const common::SettingsSpan values{*includes};
251 // Range may be empty if -noincludeconf was passed
252 if (!values.empty()) {
253 error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
254 return false; // pick first value as example
255 }
256 }
257 return true;
258}
259
260std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
261{
262 LOCK(cs_args);
263 for (const auto& arg_map : m_available_args) {
264 const auto search = arg_map.second.find(name);
265 if (search != arg_map.second.end()) {
266 return search->second.m_flags;
267 }
268 }
269 return m_default_flags;
270}
271
272void ArgsManager::SetDefaultFlags(std::optional<unsigned int> flags)
273{
274 LOCK(cs_args);
275 m_default_flags = flags;
276}
277
278fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
279{
280 if (IsArgNegated(arg)) return fs::path{};
281 std::string path_str = GetArg(arg, "");
282 if (path_str.empty()) return default_value;
283 fs::path result = fs::PathFromString(path_str).lexically_normal();
284 // Remove trailing slash, if present.
285 return result.has_filename() ? result : result.parent_path();
286}
287
289{
290 LOCK(cs_args);
291 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 if (!path.empty()) return path;
296
297 if (IsArgSet("-blocksdir")) {
298 path = fs::absolute(GetPathArg("-blocksdir"));
299 if (!fs::is_directory(path)) {
300 path = "";
301 return path;
302 }
303 } else {
304 path = GetDataDirBase();
305 }
306
307 path /= fs::PathFromString(BaseParams().DataDir());
308 path /= "blocks";
310 return path;
311}
312
313fs::path ArgsManager::GetDataDir(bool net_specific) const
314{
315 LOCK(cs_args);
316 fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
317
318 // Used cached path if available
319 if (!path.empty()) return path;
320
321 const fs::path datadir{GetPathArg("-datadir")};
322 if (!datadir.empty()) {
323 path = fs::absolute(datadir);
324 if (!fs::is_directory(path)) {
325 path = "";
326 return path;
327 }
328 } else {
329 path = GetDefaultDataDir();
330 }
331
332 if (net_specific && !BaseParams().DataDir().empty()) {
333 path /= fs::PathFromString(BaseParams().DataDir());
334 }
335
336 return path;
337}
338
340{
341 LOCK(cs_args);
342
343 m_cached_datadir_path = fs::path();
344 m_cached_network_datadir_path = fs::path();
345 m_cached_blocks_path = fs::path();
346}
347
348std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
349{
350 Command ret;
351 LOCK(cs_args);
352 auto it = m_command.begin();
353 if (it == m_command.end()) {
354 // No command was passed
355 return std::nullopt;
356 }
357 if (!m_accept_any_command) {
358 // The registered command
359 ret.command = *(it++);
360 }
361 while (it != m_command.end()) {
362 // The unregistered command and args (if any)
363 ret.args.push_back(*(it++));
364 }
365 return ret;
366}
367
368std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
369{
370 std::vector<std::string> result;
371 for (const common::SettingsValue& value : GetSettingsList(strArg)) {
372 result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
373 }
374 return result;
375}
376
377bool ArgsManager::IsArgSet(const std::string& strArg) const
378{
379 return !GetSetting(strArg).isNull();
380}
381
382bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
383{
384 fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
385 if (settings.empty()) {
386 return false;
387 }
388 if (backup) {
389 settings += ".bak";
390 }
391 if (filepath) {
392 *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
393 }
394 return true;
395}
396
397static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
398{
399 for (const auto& error : errors) {
400 if (error_out) {
401 error_out->emplace_back(error);
402 } else {
403 LogPrintf("%s\n", error);
404 }
405 }
406}
407
408bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
409{
410 fs::path path;
411 if (!GetSettingsPath(&path, /* temp= */ false)) {
412 return true; // Do nothing if settings file disabled.
413 }
414
415 LOCK(cs_args);
416 m_settings.rw_settings.clear();
417 std::vector<std::string> read_errors;
418 if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
419 SaveErrors(read_errors, errors);
420 return false;
421 }
422 for (const auto& setting : m_settings.rw_settings) {
423 KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
424 if (!GetArgFlags('-' + key.name)) {
425 LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
426 }
427 }
428 return true;
429}
430
431bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
432{
433 fs::path path, path_tmp;
434 if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
435 throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
436 }
437
438 LOCK(cs_args);
439 std::vector<std::string> write_errors;
440 if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
441 SaveErrors(write_errors, errors);
442 return false;
443 }
444 if (!RenameOver(path_tmp, path)) {
445 SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
446 return false;
447 }
448 return true;
449}
450
452{
453 LOCK(cs_args);
454 return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
455 /*ignore_nonpersistent=*/true, /*get_chain_type=*/false);
456}
457
458bool ArgsManager::IsArgNegated(const std::string& strArg) const
459{
460 return GetSetting(strArg).isFalse();
461}
462
463std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
464{
465 return GetArg(strArg).value_or(strDefault);
466}
467
468std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
469{
470 const common::SettingsValue value = GetSetting(strArg);
471 return SettingToString(value);
472}
473
474std::optional<std::string> SettingToString(const common::SettingsValue& value)
475{
476 if (value.isNull()) return std::nullopt;
477 if (value.isFalse()) return "0";
478 if (value.isTrue()) return "1";
479 if (value.isNum()) return value.getValStr();
480 return value.get_str();
481}
482
483std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault)
484{
485 return SettingToString(value).value_or(strDefault);
486}
487
488int64_t ArgsManager::GetIntArg(const std::string& strArg, int64_t nDefault) const
489{
490 return GetIntArg(strArg).value_or(nDefault);
491}
492
493std::optional<int64_t> ArgsManager::GetIntArg(const std::string& strArg) const
494{
495 const common::SettingsValue value = GetSetting(strArg);
496 return SettingToInt(value);
497}
498
499std::optional<int64_t> SettingToInt(const common::SettingsValue& value)
500{
501 if (value.isNull()) return std::nullopt;
502 if (value.isFalse()) return 0;
503 if (value.isTrue()) return 1;
504 if (value.isNum()) return value.getInt<int64_t>();
505 return LocaleIndependentAtoi<int64_t>(value.get_str());
506}
507
508int64_t SettingToInt(const common::SettingsValue& value, int64_t nDefault)
509{
510 return SettingToInt(value).value_or(nDefault);
511}
512
513bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
514{
515 return GetBoolArg(strArg).value_or(fDefault);
516}
517
518std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
519{
520 const common::SettingsValue value = GetSetting(strArg);
521 return SettingToBool(value);
522}
523
524std::optional<bool> SettingToBool(const common::SettingsValue& value)
525{
526 if (value.isNull()) return std::nullopt;
527 if (value.isBool()) return value.get_bool();
528 return InterpretBool(value.get_str());
529}
530
531bool SettingToBool(const common::SettingsValue& value, bool fDefault)
532{
533 return SettingToBool(value).value_or(fDefault);
534}
535
536bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
537{
538 LOCK(cs_args);
539 if (IsArgSet(strArg)) return false;
540 ForceSetArg(strArg, strValue);
541 return true;
542}
543
544bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
545{
546 if (fValue)
547 return SoftSetArg(strArg, std::string("1"));
548 else
549 return SoftSetArg(strArg, std::string("0"));
550}
551
552void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
553{
554 LOCK(cs_args);
555 m_settings.forced_settings[SettingName(strArg)] = strValue;
556}
557
558void ArgsManager::AddCommand(const std::string& cmd, const std::string& help)
559{
560 Assert(cmd.find('=') == std::string::npos);
561 Assert(cmd.at(0) != '-');
562
563 LOCK(cs_args);
564 m_accept_any_command = false; // latch to false
565 std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
566 auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
567 Assert(ret.second); // Fail on duplicate commands
568}
569
570void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
571{
572 Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
573
574 // Split arg name from its help param
575 size_t eq_index = name.find('=');
576 if (eq_index == std::string::npos) {
577 eq_index = name.size();
578 }
579 std::string arg_name = name.substr(0, eq_index);
580
581 LOCK(cs_args);
582 std::map<std::string, Arg>& arg_map = m_available_args[cat];
583 auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
584 assert(ret.second); // Make sure an insertion actually happened
585
587 m_network_only_args.emplace(arg_name);
588 }
589}
590
591void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
592{
593 for (const std::string& name : names) {
595 }
596}
597
599{
600 LOCK(cs_args);
601 m_settings = {};
602 m_available_args.clear();
603 m_network_only_args.clear();
604}
605
607{
608 LOCK(cs_args);
609 std::vector<std::string> found{};
610 auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
611 if (cmds != m_available_args.end()) {
612 for (const auto& [cmd, argspec] : cmds->second) {
613 if (IsArgSet(cmd)) {
614 found.push_back(cmd);
615 }
616 }
617 if (found.size() > 1) {
618 throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
619 }
620 }
621}
622
624{
625 const bool show_debug = GetBoolArg("-help-debug", false);
626
627 std::string usage;
628 LOCK(cs_args);
629 for (const auto& arg_map : m_available_args) {
630 switch(arg_map.first) {
632 usage += HelpMessageGroup("Options:");
633 break;
635 usage += HelpMessageGroup("Connection options:");
636 break;
638 usage += HelpMessageGroup("ZeroMQ notification options:");
639 break;
641 usage += HelpMessageGroup("Debugging/Testing options:");
642 break;
644 usage += HelpMessageGroup("Node relay options:");
645 break;
647 usage += HelpMessageGroup("Block creation options:");
648 break;
650 usage += HelpMessageGroup("RPC server options:");
651 break;
653 usage += HelpMessageGroup("IPC interprocess connection options:");
654 break;
656 usage += HelpMessageGroup("Wallet options:");
657 break;
659 if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
660 break;
662 usage += HelpMessageGroup("Chain selection options:");
663 break;
665 usage += HelpMessageGroup("UI Options:");
666 break;
668 usage += HelpMessageGroup("Commands:");
669 break;
671 usage += HelpMessageGroup("Register Commands:");
672 break;
674 usage += HelpMessageGroup("CLI Commands:");
675 break;
676 default:
677 break;
678 }
679
680 // When we get to the hidden options, stop
681 if (arg_map.first == OptionsCategory::HIDDEN) break;
682
683 for (const auto& arg : arg_map.second) {
684 if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
685 std::string name;
686 if (arg.second.m_help_param.empty()) {
687 name = arg.first;
688 } else {
689 name = arg.first + arg.second.m_help_param;
690 }
691 usage += HelpMessageOpt(name, arg.second.m_help_text);
692 }
693 }
694 }
695 return usage;
696}
697
699{
700 return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
701}
702
704{
705 args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
706 args.AddHiddenArgs({"-h", "-?"});
707}
708
709static const int screenWidth = 79;
710static const int optIndent = 2;
711static const int msgIndent = 7;
712
713std::string HelpMessageGroup(const std::string &message) {
714 return std::string(message) + std::string("\n\n");
715}
716
717std::string HelpMessageOpt(const std::string &option, const std::string &message) {
718 return std::string(optIndent,' ') + std::string(option) +
719 std::string("\n") + std::string(msgIndent,' ') +
721 std::string("\n\n");
722}
723
724const 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
730bool HasTestOption(const ArgsManager& args, const std::string& test_option)
731{
732 const auto options = args.GetArgs("-test");
733 return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
734 return option == test_option;
735 });
736}
737
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 fs::path pathRet;
755 char* pszHome = getenv("HOME");
756 if (pszHome == nullptr || strlen(pszHome) == 0)
757 pathRet = fs::path("/");
758 else
759 pathRet = fs::path(pszHome);
760#ifdef __APPLE__
761 // macOS
762 return pathRet / "Library/Application Support/Bitcoin";
763#else
764 // Unix-like
765 return pathRet / ".bitcoin";
766#endif
767#endif
768}
769
771{
772 const fs::path datadir{args.GetPathArg("-datadir")};
773 return datadir.empty() || fs::is_directory(fs::absolute(datadir));
774}
775
777{
778 LOCK(cs_args);
779 return *Assert(m_config_path);
780}
781
783{
784 LOCK(cs_args);
785 assert(!m_config_path);
786 m_config_path = path;
787}
788
790{
791 std::variant<ChainType, std::string> arg = GetChainArg();
792 if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed;
793 throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg)));
794}
795
797{
798 auto arg = GetChainArg();
799 if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
800 return std::get<std::string>(arg);
801}
802
803std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
804{
805 auto get_net = [&](const std::string& arg) {
806 LOCK(cs_args);
807 common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
808 /* ignore_default_section_config= */ false,
809 /*ignore_nonpersistent=*/false,
810 /* get_chain_type= */ true);
811 return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
812 };
813
814 const bool fRegTest = get_net("-regtest");
815 const bool fSigNet = get_net("-signet");
816 const bool fTestNet = get_net("-testnet");
817 const bool fTestNet4 = get_net("-testnet4");
818 const auto chain_arg = GetArg("-chain");
819
820 if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
821 throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
822 }
823 if (chain_arg) {
824 if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
825 // Not a known string, so return original string
826 return *chain_arg;
827 }
828 if (fRegTest) return ChainType::REGTEST;
829 if (fSigNet) return ChainType::SIGNET;
830 if (fTestNet) return ChainType::TESTNET;
831 if (fTestNet4) return ChainType::TESTNET4;
832 return ChainType::MAIN;
833}
834
835bool ArgsManager::UseDefaultSection(const std::string& arg) const
836{
837 return m_network == ChainTypeToString(ChainType::MAIN) || m_network_only_args.count(arg) == 0;
838}
839
841{
842 LOCK(cs_args);
843 return common::GetSetting(
844 m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
845 /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
846}
847
848std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
849{
850 LOCK(cs_args);
851 return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
852}
853
855 const std::string& prefix,
856 const std::string& section,
857 const std::map<std::string, std::vector<common::SettingsValue>>& args) const
858{
859 std::string section_str = section.empty() ? "" : "[" + section + "] ";
860 for (const auto& arg : args) {
861 for (const auto& value : arg.second) {
862 std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
863 if (flags) {
864 std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
865 LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
866 }
867 }
868 }
869}
870
872{
873 LOCK(cs_args);
874 for (const auto& section : m_settings.ro_config) {
875 logArgsPrefix("Config file arg:", section.first, section.second);
876 }
877 for (const auto& setting : m_settings.rw_settings) {
878 LogPrintf("Setting file arg: %s = %s\n", setting.first, setting.second.write());
879 }
880 logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
881}
882
883namespace common {
884#ifdef WIN32
885WinCmdLineArgs::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
898WinCmdLineArgs::~WinCmdLineArgs()
899{
900 delete[] argv;
901}
902
903std::pair<int, char**> WinCmdLineArgs::get()
904{
905 return std::make_pair(argc, argv);
906}
907#endif
908} // namespace common
const std::vector< std::string > TEST_OPTIONS_DOC
Definition: args.cpp:724
bool HelpRequested(const ArgsManager &args)
Definition: args.cpp:698
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: args.cpp:703
fs::path GetDefaultDataDir()
Definition: args.cpp:738
static const int msgIndent
Definition: args.cpp:711
static void SaveErrors(const std::vector< std::string > errors, std::vector< std::string > *error_out)
Definition: args.cpp:397
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.
Definition: args.cpp:107
const char *const BITCOIN_SETTINGS_FILENAME
Definition: args.cpp:40
bool CheckDataDirOption(const ArgsManager &args)
Definition: args.cpp:770
std::optional< bool > SettingToBool(const common::SettingsValue &value)
Definition: args.cpp:524
std::optional< std::string > SettingToString(const common::SettingsValue &value)
Definition: args.cpp:474
static const int screenWidth
Definition: args.cpp:709
ArgsManager gArgs
Definition: args.cpp:42
bool HasTestOption(const ArgsManager &args, const std::string &test_option)
Checks if a particular test option is present in -test command-line arg options.
Definition: args.cpp:730
static std::string SettingName(const std::string &arg)
Definition: args.cpp:66
std::string HelpMessageGroup(const std::string &message)
Format a string to be used as group of options in help messages.
Definition: args.cpp:713
KeyInfo InterpretKey(std::string key)
Parse "name", "section.name", "noname", "section.noname" settings keys.
Definition: args.cpp:79
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:39
std::optional< int64_t > SettingToInt(const common::SettingsValue &value)
Definition: args.cpp:499
static bool InterpretBool(const std::string &strValue)
Interpret a string argument as a boolean.
Definition: args.cpp:59
static const int optIndent
Definition: args.cpp:710
std::string HelpMessageOpt(const std::string &option, const std::string &message)
Format a string to be used as option description in help messages.
Definition: args.cpp:717
OptionsCategory
Definition: args.h:52
int ret
int flags
Definition: bitcoin-tx.cpp:529
const auto cmd
ArgsManager & args
Definition: bitcoind.cpp:282
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::optional< ChainType > ChainTypeFromString(std::string_view chain)
Definition: chaintype.cpp:28
std::string ChainTypeToString(ChainType chain)
Definition: chaintype.cpp:11
ChainType
Definition: chaintype.h:11
#define Assert(val)
Identity function.
Definition: check.h:106
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...
Definition: args.cpp:136
std::optional< const Command > GetCommand() const
Get the command and command args (returns std::nullopt if no command provided)
Definition: args.cpp:348
bool IsArgNegated(const std::string &strArg) const
Return true if the argument was originally passed as a negated option, i.e.
Definition: args.cpp:458
void logArgsPrefix(const std::string &prefix, const std::string &section, const std::map< std::string, std::vector< common::SettingsValue > > &args) const
Definition: args.cpp:854
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
Definition: args.cpp:156
@ NETWORK_ONLY
Definition: args.h:120
@ ALLOW_ANY
disable validation
Definition: args.h:106
@ DISALLOW_NEGATION
disallow -nofoo syntax
Definition: args.h:111
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition: args.h:112
@ DEBUG_ONLY
Definition: args.h:114
@ COMMAND
Definition: args.h:123
@ SENSITIVE
Definition: args.h:122
common::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
Definition: args.cpp:840
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
Definition: args.cpp:408
ChainType GetChainType() const
Returns the appropriate chain type from the program arguments.
Definition: args.cpp:789
void ForceSetArg(const std::string &strArg, const std::string &strValue)
Definition: args.cpp:552
std::string GetChainTypeString() const
Returns the appropriate chain type string from the program arguments.
Definition: args.cpp:796
bool ParseParameters(int argc, const char *const argv[], std::string &error)
Definition: args.cpp:179
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:368
void CheckMultipleCLIArgs() const
Check CLI command args.
Definition: args.cpp:606
void SetDefaultFlags(std::optional< unsigned int >)
Set default flags to return for an unknown arg.
Definition: args.cpp:272
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:235
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
Definition: args.cpp:260
void SetConfigFilePath(fs::path)
Definition: args.cpp:782
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.
Definition: args.cpp:382
bool SoftSetArg(const std::string &strArg, const std::string &strValue)
Set an argument if it doesn't already have a value.
Definition: args.cpp:536
void SelectConfigNetwork(const std::string &network)
Select the network in use.
Definition: args.cpp:173
std::string GetHelpMessage() const
Get the help string.
Definition: args.cpp:623
void ClearPathCache()
Clear cached directory paths.
Definition: args.cpp:339
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: args.cpp:377
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
Definition: args.cpp:431
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:488
void ClearArgs()
Clear available arguments.
Definition: args.cpp:598
fs::path GetDataDirBase() const
Get data directory path.
Definition: args.h:228
fs::path GetBlocksDirPath() const
Get blocks directory path.
Definition: args.cpp:288
fs::path GetConfigFilePath() const
Return config file path (read-only)
Definition: args.cpp:776
std::vector< common::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
Definition: args.cpp:848
void AddCommand(const std::string &cmd, const std::string &help)
Add subcommand.
Definition: args.cpp:558
std::variant< ChainType, std::string > GetChainArg() const
Return -regtest/-signet/-testnet/-testnet4/-chain= setting as a ChainType enum if a recognized chain ...
Definition: args.cpp:803
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
Definition: args.cpp:871
fs::path GetDataDir(bool net_specific) const
Get data directory path.
Definition: args.cpp:313
RecursiveMutex cs_args
Definition: args.h:134
common::SettingsValue GetPersistentSetting(const std::string &name) const
Get current setting from config file or read/write settings file, ignoring nonpersistent command line...
Definition: args.cpp:451
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...
Definition: args.cpp:835
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:463
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:544
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:513
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: args.cpp:591
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:570
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:278
const std::string & get_str() const
bool isTrue() const
Definition: univalue.h:82
bool isNull() const
Definition: univalue.h:81
const std::string & getValStr() const
Definition: univalue.h:68
bool isBool() const
Definition: univalue.h:84
Int getInt() const
Definition: univalue.h:140
bool isNum() const
Definition: univalue.h:86
bool isFalse() const
Definition: univalue.h:83
bool get_bool() const
static path absolute(const path &p)
Definition: fs.h:82
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...
Definition: fs.h:190
static bool exists(const path &p)
Definition: fs.h:89
static std::string PathToString(const path &path)
Convert path object to a byte string.
Definition: fs.h:151
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:174
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
Definition: fs_helpers.cpp:243
#define LogPrintf(...)
Definition: logging.h:361
Definition: args.cpp:883
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
Definition: settings.cpp:123
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
Definition: settings.cpp:72
SettingsValue GetSetting(const Settings &settings, const std::string &section, 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,...
Definition: settings.cpp:146
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:107
std::vector< SettingsValue > GetSettingsList(const Settings &settings, const std::string &section, const std::string &name, bool ignore_default_section_config)
Get combined setting value similar to GetSetting(), except if setting was specified multiple times,...
Definition: settings.cpp:203
bool OnlyHasDefaultSectionSetting(const Settings &settings, const std::string &section, const std::string &name)
Return true if a setting is set in the default config file section, and not overridden by a higher pr...
Definition: settings.cpp:248
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
Definition: fs.cpp:36
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:204
CRPCCommand m_command
Definition: interfaces.cpp:538
const char * prefix
Definition: rest.cpp:1117
const char * name
Definition: rest.cpp:50
static const int64_t values[]
A selection of numbers that do not trigger int64_t overflow when added/subtracted.
static RPCHelpMan help()
Definition: server.cpp:118
Definition: args.h:72
std::string name
Definition: args.h:73
bool negated
Definition: args.h:75
std::string section
Definition: args.h:74
std::string m_name
Definition: args.h:84
Accessor for list of settings that skips negated values when iterated over.
Definition: settings.h:90
#define LOCK(cs)
Definition: sync.h:259
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1172
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.
assert(!tx.IsCoinBase())