Bitcoin ABC 0.32.11
P2P Digital Currency
args.cpp
Go to the documentation of this file.
1// Copyright (c) 2009-2010 Satoshi Nakamoto
2// Copyright (c) 2009-2022 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 <logging.h>
10#include <sync.h>
11#include <tinyformat.h>
12#include <univalue.h>
13#include <util/chaintype.h>
14#include <util/fs.h>
15#include <util/fs_helpers.h>
16#include <util/settings.h>
17#include <util/strencodings.h>
18
19#ifdef WIN32
20#include <codecvt> /* for codecvt_utf8_utf16 */
21#include <shellapi.h> /* for CommandLineToArgvW */
22#include <shlobj.h> /* for CSIDL_APPDATA */
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 <variant>
35
36const char *const BITCOIN_CONF_FILENAME = "bitcoin.conf";
37const char *const BITCOIN_SETTINGS_FILENAME = "settings.json";
38
40
58static bool InterpretBool(const std::string &strValue) {
59 if (strValue.empty()) {
60 return true;
61 }
62 return (LocaleIndependentAtoi<int>(strValue) != 0);
63}
64
65static std::string SettingName(const std::string &arg) {
66 return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
67}
68
77KeyInfo InterpretKey(std::string key) {
78 KeyInfo result;
79 // Split section name from key name for keys like "testnet.foo" or
80 // "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.substr(0, 2) == "no") {
87 key.erase(0, 2);
88 result.negated = true;
89 }
90 result.name = key;
91 return result;
92}
93
105std::optional<util::SettingsValue>
106InterpretValue(const KeyInfo &key, const std::optional<std::string> &value,
107 unsigned int flags, std::string &error) {
108 // Return negated settings as false values.
109 if (key.negated) {
111 error = strprintf(
112 "Negating of -%s is meaningless and therefore forbidden",
113 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 "
119 "-%s=%s\n",
120 key.name, *value);
121 return true;
122 }
123 return false;
124 }
125 if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
126 error = strprintf("Can not set -%s with no value. Please specify value "
127 "with -%s=value.",
128 key.name, key.name);
129 return std::nullopt;
130 }
131 return value.value_or("");
132}
133
134// Define default constructor and destructor that are not inline, so code
135// instantiating this class doesn't need to #include class definitions for all
136// members. For example, m_settings has an internal dependency on univalue.
137ArgsManager::ArgsManager() = default;
138ArgsManager::~ArgsManager() = default;
139
140std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const {
141 std::set<std::string> unsuitables;
142
143 LOCK(cs_args);
144
145 // if there's no section selected, don't worry
146 if (m_network.empty()) {
147 return std::set<std::string>{};
148 }
149
150 // if it's okay to use the default section for this network, don't worry
151 if (m_network == ChainTypeToString(ChainType::MAIN)) {
152 return std::set<std::string>{};
153 }
154
155 for (const auto &arg : m_network_only_args) {
156 if (OnlyHasDefaultSectionSetting(m_settings, m_network,
157 SettingName(arg))) {
158 unsuitables.insert(arg);
159 }
160 }
161 return unsuitables;
162}
163
164std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const {
165 // Section names to be recognized in the config file.
166 static const std::set<std::string> available_sections{
170 };
171
172 LOCK(cs_args);
173 std::list<SectionInfo> unrecognized = m_config_sections;
174 unrecognized.remove_if([](const SectionInfo &appeared) {
175 return available_sections.find(appeared.m_name) !=
176 available_sections.end();
177 });
178 return unrecognized;
179}
180
181void ArgsManager::SelectConfigNetwork(const std::string &network) {
182 LOCK(cs_args);
183 m_network = network;
184}
185
186bool ParseKeyValue(std::string &key, std::optional<std::string> &val) {
187 size_t is_index = key.find('=');
188 if (is_index != std::string::npos) {
189 val = key.substr(is_index + 1);
190 key.erase(is_index);
191 }
192#ifdef WIN32
193 key = ToLower(key);
194 if (key[0] == '/') {
195 key[0] = '-';
196 }
197#endif
198
199 if (key[0] != '-') {
200 return false;
201 }
202
203 // Transform --foo to -foo
204 if (key.length() > 1 && key[1] == '-') {
205 key.erase(0, 1);
206 }
207 return true;
208}
209
210bool ArgsManager::ParseParameters(int argc, const char *const argv[],
211 std::string &error) {
212 LOCK(cs_args);
213 m_settings.command_line_options.clear();
214
215 for (int i = 1; i < argc; i++) {
216 std::string key(argv[i]);
217
218#ifdef MAC_OSX
219 // At the first time when a user gets the "App downloaded from the
220 // internet" warning, and clicks the Open button, macOS passes
221 // a unique process serial number (PSN) as -psn_... command-line
222 // argument, which we filter out.
223 if (key.substr(0, 5) == "-psn_") {
224 continue;
225 }
226#endif
227
228 if (key == "-") {
229 // bitcoin-tx using stdin
230 break;
231 }
232 std::optional<std::string> val;
233 if (!ParseKeyValue(key, val)) {
234 break;
235 }
236
237 // Transform -foo to foo
238 key.erase(0, 1);
239 KeyInfo keyinfo = InterpretKey(key);
240 std::optional<unsigned int> flags = GetArgFlags('-' + keyinfo.name);
241
242 // Unknown command line options and command line options with dot
243 // characters (which are returned from InterpretKey with nonempty
244 // section strings) are not valid.
245 if (!flags || !keyinfo.section.empty()) {
246 error = strprintf("Invalid parameter %s", argv[i]);
247 return false;
248 }
249
250 std::optional<util::SettingsValue> value =
251 InterpretValue(keyinfo, val, *flags, error);
252 if (!value) {
253 return false;
254 }
255
256 m_settings.command_line_options[keyinfo.name].push_back(*value);
257 }
258
259 // we do not allow -includeconf from command line
260 bool success = true;
261 if (auto *includes =
262 util::FindKey(m_settings.command_line_options, "includeconf")) {
263 for (const auto &include : util::SettingsSpan(*includes)) {
264 error +=
265 "-includeconf cannot be used from commandline; -includeconf=" +
266 include.get_str() + "\n";
267 success = false;
268 }
269 }
270 return success;
271}
272
273std::optional<unsigned int>
274ArgsManager::GetArgFlags(const std::string &name) const {
275 LOCK(cs_args);
276 for (const auto &arg_map : m_available_args) {
277 const auto search = arg_map.second.find(name);
278 if (search != arg_map.second.end()) {
279 return search->second.m_flags;
280 }
281 }
282 return std::nullopt;
283}
284
286 const fs::path &default_value) const {
287 if (IsArgNegated(arg)) {
288 return fs::path{};
289 }
290 std::string path_str = GetArg(arg, "");
291 if (path_str.empty()) {
292 return default_value;
293 }
294 fs::path result = fs::PathFromString(path_str).lexically_normal();
295 // Remove trailing slash, if present.
296 return result.has_filename() ? result : result.parent_path();
297}
298
300 LOCK(cs_args);
301 fs::path &path = m_cached_blocks_path;
302
303 // Cache the path to avoid calling fs::create_directories on every call of
304 // this function
305 if (!path.empty()) {
306 return path;
307 }
308
309 if (IsArgSet("-blocksdir")) {
310 path = fs::absolute(GetPathArg("-blocksdir"));
311 if (!fs::is_directory(path)) {
312 path = "";
313 return path;
314 }
315 } else {
316 path = GetDataDirBase();
317 }
318
319 path /= fs::PathFromString(BaseParams().DataDir());
320 path /= "blocks";
322 return path;
323}
324
325fs::path ArgsManager::GetDataDir(bool net_specific) const {
326 LOCK(cs_args);
327 fs::path &path =
328 net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
329
330 // Used cached path if available
331 if (!path.empty()) {
332 return path;
333 }
334
335 const fs::path datadir{GetPathArg("-datadir")};
336 if (!datadir.empty()) {
337 path = fs::absolute(datadir);
338 if (!fs::is_directory(path)) {
339 path = "";
340 return path;
341 }
342 } else {
343 path = GetDefaultDataDir();
344 }
345
346 if (net_specific && !BaseParams().DataDir().empty()) {
347 path /= fs::PathFromString(BaseParams().DataDir());
348 }
349
350 return path;
351}
352
354 LOCK(cs_args);
355
356 m_cached_datadir_path = fs::path();
357 m_cached_network_datadir_path = fs::path();
358 m_cached_blocks_path = fs::path();
359}
360
361std::vector<std::string> ArgsManager::GetArgs(const std::string &strArg) const {
362 std::vector<std::string> result;
363 for (const util::SettingsValue &value : GetSettingsList(strArg)) {
364 result.push_back(value.isFalse() ? "0"
365 : value.isTrue() ? "1"
366 : value.get_str());
367 }
368 return result;
369}
370
371bool ArgsManager::IsArgSet(const std::string &strArg) const {
372 return !GetSetting(strArg).isNull();
373}
374
375bool ArgsManager::GetSettingsPath(fs::path *filepath, bool temp,
376 bool backup) const {
377 fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
378 if (settings.empty()) {
379 return false;
380 }
381 if (backup) {
382 settings += ".bak";
383 }
384 if (filepath) {
386 temp ? settings + ".tmp" : settings);
387 }
388 return true;
389}
390
391static void SaveErrors(const std::vector<std::string> errors,
392 std::vector<std::string> *error_out) {
393 for (const auto &error : errors) {
394 if (error_out) {
395 error_out->emplace_back(error);
396 } else {
397 LogPrintf("%s\n", error);
398 }
399 }
400}
401
402bool ArgsManager::ReadSettingsFile(std::vector<std::string> *errors) {
403 fs::path path;
404 if (!GetSettingsPath(&path, /* temp= */ false)) {
405 return true; // Do nothing if settings file disabled.
406 }
407
408 LOCK(cs_args);
409 m_settings.rw_settings.clear();
410 std::vector<std::string> read_errors;
411 if (!util::ReadSettings(path, m_settings.rw_settings, read_errors)) {
412 SaveErrors(read_errors, errors);
413 return false;
414 }
415 for (const auto &setting : m_settings.rw_settings) {
416 // Split setting key into section and argname
417 KeyInfo key = InterpretKey(setting.first);
418 if (!GetArgFlags('-' + key.name)) {
419 LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
420 }
421 }
422 return true;
423}
424
425bool ArgsManager::WriteSettingsFile(std::vector<std::string> *errors,
426 bool backup) const {
427 fs::path path, path_tmp;
428 if (!GetSettingsPath(&path, /*temp=*/false, backup) ||
429 !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
430 throw std::logic_error("Attempt to write settings file when dynamic "
431 "settings are disabled.");
432 }
433
434 LOCK(cs_args);
435 std::vector<std::string> write_errors;
436 if (!util::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
437 SaveErrors(write_errors, errors);
438 return false;
439 }
440 if (!RenameOver(path_tmp, path)) {
442 {strprintf("Failed renaming settings file %s to %s\n",
443 fs::PathToString(path_tmp), fs::PathToString(path))},
444 errors);
445 return false;
446 }
447 return true;
448}
449
451ArgsManager::GetPersistentSetting(const std::string &name) const {
452 LOCK(cs_args);
453 return util::GetSetting(
454 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 return GetSetting(strArg).isFalse();
460}
461
462std::string ArgsManager::GetArg(const std::string &strArg,
463 const std::string &strDefault) const {
464 return GetArg(strArg).value_or(strDefault);
465}
466
467std::optional<std::string>
468ArgsManager::GetArg(const std::string &strArg) const {
469 const util::SettingsValue value = GetSetting(strArg);
470 return SettingToString(value);
471}
472
473std::optional<std::string> SettingToString(const util::SettingsValue &value) {
474 if (value.isNull()) {
475 return std::nullopt;
476 }
477 if (value.isFalse()) {
478 return "0";
479 }
480 if (value.isTrue()) {
481 return "1";
482 }
483 if (value.isNum()) {
484 return value.getValStr();
485 }
486 return value.get_str();
487}
488
489std::string SettingToString(const util::SettingsValue &value,
490 const std::string &strDefault) {
491 return SettingToString(value).value_or(strDefault);
492}
493
494int64_t ArgsManager::GetIntArg(const std::string &strArg,
495 int64_t nDefault) const {
496 return GetIntArg(strArg).value_or(nDefault);
497}
498
499std::optional<int64_t> ArgsManager::GetIntArg(const std::string &strArg) const {
500 const util::SettingsValue value = GetSetting(strArg);
501 return SettingToInt(value);
502}
503
504std::optional<int64_t> SettingToInt(const util::SettingsValue &value) {
505 if (value.isNull()) {
506 return std::nullopt;
507 }
508 if (value.isFalse()) {
509 return 0;
510 }
511 if (value.isTrue()) {
512 return 1;
513 }
514 if (value.isNum()) {
515 return value.getInt<int64_t>();
516 }
517 return LocaleIndependentAtoi<int64_t>(value.get_str());
518}
519
520int64_t SettingToInt(const util::SettingsValue &value, int64_t nDefault) {
521 return SettingToInt(value).value_or(nDefault);
522}
523
524bool ArgsManager::GetBoolArg(const std::string &strArg, bool fDefault) const {
525 return GetBoolArg(strArg).value_or(fDefault);
526}
527
528std::optional<bool> ArgsManager::GetBoolArg(const std::string &strArg) const {
529 const util::SettingsValue value = GetSetting(strArg);
530 return SettingToBool(value);
531}
532
533std::optional<bool> SettingToBool(const util::SettingsValue &value) {
534 if (value.isNull()) {
535 return std::nullopt;
536 }
537 if (value.isBool()) {
538 return value.get_bool();
539 }
540 return InterpretBool(value.get_str());
541}
542
543bool SettingToBool(const util::SettingsValue &value, bool fDefault) {
544 return SettingToBool(value).value_or(fDefault);
545}
546
547bool ArgsManager::SoftSetArg(const std::string &strArg,
548 const std::string &strValue) {
549 LOCK(cs_args);
550 if (IsArgSet(strArg)) {
551 return false;
552 }
553 ForceSetArg(strArg, strValue);
554 return true;
555}
556
557bool ArgsManager::SoftSetBoolArg(const std::string &strArg, bool fValue) {
558 if (fValue) {
559 return SoftSetArg(strArg, std::string("1"));
560 } else {
561 return SoftSetArg(strArg, std::string("0"));
562 }
563}
564
565void ArgsManager::ForceSetArg(const std::string &strArg,
566 const std::string &strValue) {
567 LOCK(cs_args);
568 m_settings.forced_settings[SettingName(strArg)] = strValue;
569}
570
576void ArgsManager::ForceSetMultiArg(const std::string &strArg,
577 const std::vector<std::string> &values) {
578 LOCK(cs_args);
580 value.setArray();
581 for (const std::string &s : values) {
582 value.push_back(s);
583 }
584
585 m_settings.forced_settings[SettingName(strArg)] = value;
586}
587
588void ArgsManager::AddArg(const std::string &name, const std::string &help,
589 unsigned int flags, const OptionsCategory &cat) {
590 // Split arg name from its help param
591 size_t eq_index = name.find('=');
592 if (eq_index == std::string::npos) {
593 eq_index = name.size();
594 }
595 std::string arg_name = name.substr(0, eq_index);
596
597 LOCK(cs_args);
598 std::map<std::string, Arg> &arg_map = m_available_args[cat];
599 auto ret = arg_map.emplace(
600 arg_name,
601 Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
602 // Make sure an insertion actually happened.
603 assert(ret.second);
604
606 m_network_only_args.emplace(arg_name);
607 }
608}
609
610void ArgsManager::AddHiddenArgs(const std::vector<std::string> &names) {
611 for (const std::string &name : names) {
613 }
614}
615
616void ArgsManager::ClearForcedArg(const std::string &strArg) {
617 LOCK(cs_args);
618 m_settings.forced_settings.erase(SettingName(strArg));
619}
620
621std::string ArgsManager::GetHelpMessage() const {
622 const bool show_debug = GetBoolArg("-help-debug", false);
623
624 std::string usage = "";
625 LOCK(cs_args);
626 for (const auto &arg_map : m_available_args) {
627 switch (arg_map.first) {
629 usage += HelpMessageGroup("Options:");
630 break;
632 usage += HelpMessageGroup("Connection options:");
633 break;
635 usage += HelpMessageGroup("ZeroMQ notification options:");
636 break;
638 usage += HelpMessageGroup("Debugging/Testing options:");
639 break;
641 usage += HelpMessageGroup("Node relay options:");
642 break;
644 usage += HelpMessageGroup("Block creation options:");
645 break;
647 usage += HelpMessageGroup("RPC server options:");
648 break;
650 usage += HelpMessageGroup("Wallet options:");
651 break;
653 if (show_debug) {
654 usage +=
655 HelpMessageGroup("Wallet debugging/testing options:");
656 }
657 break;
659 usage += HelpMessageGroup("Chain selection options:");
660 break;
662 usage += HelpMessageGroup("UI Options:");
663 break;
665 usage += HelpMessageGroup("Commands:");
666 break;
668 usage += HelpMessageGroup("Register Commands:");
669 break;
671 usage += HelpMessageGroup("Avalanche options:");
672 break;
674 usage += HelpMessageGroup("Chronik options:");
675 break;
676 default:
677 break;
678 }
679
680 // When we get to the hidden options, stop
681 if (arg_map.first == OptionsCategory::HIDDEN) {
682 break;
683 }
684
685 for (const auto &arg : arg_map.second) {
686 if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
687 std::string name;
688 if (arg.second.m_help_param.empty()) {
689 name = arg.first;
690 } else {
691 name = arg.first + arg.second.m_help_param;
692 }
693 usage += HelpMessageOpt(name, arg.second.m_help_text);
694 }
695 }
696 }
697 return usage;
698}
699
700bool HelpRequested(const ArgsManager &args) {
701 return args.IsArgSet("-?") || args.IsArgSet("-h") ||
702 args.IsArgSet("-help") || args.IsArgSet("-help-debug");
703}
704
706 args.AddArg("-?", "Print this help message and exit", false,
708 args.AddHiddenArgs({"-h", "-help"});
709}
710
711static const int screenWidth = 79;
712static const int optIndent = 2;
713static const int msgIndent = 7;
714
715std::string HelpMessageGroup(const std::string &message) {
716 return std::string(message) + std::string("\n\n");
717}
718
719std::string HelpMessageOpt(const std::string &option,
720 const std::string &message) {
721 return std::string(optIndent, ' ') + std::string(option) +
722 std::string("\n") + std::string(msgIndent, ' ') +
724 std::string("\n\n");
725}
726
728 // Windows: C:\Users\Username\AppData\Roaming\Bitcoin
729 // macOS: ~/Library/Application Support/Bitcoin
730 // Unix-like: ~/.bitcoin
731#ifdef WIN32
732 // Windows
733 return GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
734#else
735 fs::path pathRet;
736 char *pszHome = getenv("HOME");
737 if (pszHome == nullptr || strlen(pszHome) == 0) {
738 pathRet = fs::path("/");
739 } else {
740 pathRet = fs::path(pszHome);
741 }
742#ifdef MAC_OSX
743 // macOS
744 return pathRet / "Library/Application Support/Bitcoin";
745#else
746 // Unix-like
747 return pathRet / ".bitcoin";
748#endif
749#endif
750}
751
753 const fs::path datadir{args.GetPathArg("-datadir")};
754 return datadir.empty() || fs::is_directory(fs::absolute(datadir));
755}
756
758 return GetConfigFile(*this, GetPathArg("-conf", BITCOIN_CONF_FILENAME));
759}
760
762 std::variant<ChainType, std::string> arg = GetChainArg();
763 if (auto *parsed = std::get_if<ChainType>(&arg)) {
764 return *parsed;
765 }
766 throw std::runtime_error(
767 strprintf("Unknown chain %s.", std::get<std::string>(arg)));
768}
769
771 auto arg = GetChainArg();
772 if (auto *parsed = std::get_if<ChainType>(&arg)) {
773 return ChainTypeToString(*parsed);
774 }
775 return std::get<std::string>(arg);
776}
777
778std::variant<ChainType, std::string> ArgsManager::GetChainArg() const {
779 auto get_net = [&](const std::string &arg) {
780 LOCK(cs_args);
781 util::SettingsValue value =
782 util::GetSetting(m_settings, /*section=*/"", SettingName(arg),
783 /*ignore_default_section_config=*/false,
784 /*ignore_nonpersistent=*/false,
785 /*get_chain_type=*/true);
786 return value.isNull() ? false
787 : value.isBool() ? value.get_bool()
788 : InterpretBool(value.get_str());
789 };
790
791 const bool fRegTest = get_net("-regtest");
792 const bool fTestNet = get_net("-testnet");
793 const auto chain_arg = GetArg("-chain");
794
795 if (int(chain_arg.has_value()) + int(fRegTest) + int(fTestNet) > 1) {
796 throw std::runtime_error("Invalid combination of -regtest, -testnet "
797 "and -chain. Can use at most one.");
798 }
799 if (chain_arg) {
800 if (auto parsed = ChainTypeFromString(*chain_arg)) {
801 return *parsed;
802 }
803 // Not a known string, so return original string
804 return *chain_arg;
805 }
806 if (fRegTest) {
807 return ChainType::REGTEST;
808 }
809 if (fTestNet) {
810 return ChainType::TESTNET;
811 }
812 return ChainType::MAIN;
813}
814
815bool ArgsManager::UseDefaultSection(const std::string &arg) const {
816 return m_network == ChainTypeToString(ChainType::MAIN) ||
817 m_network_only_args.count(arg) == 0;
818}
819
820util::SettingsValue ArgsManager::GetSetting(const std::string &arg) const {
821 LOCK(cs_args);
822 return util::GetSetting(m_settings, m_network, SettingName(arg),
823 !UseDefaultSection(arg),
824 /*ignore_nonpersistent=*/false,
825 /*get_chain_type=*/false);
826}
827
828std::vector<util::SettingsValue>
829ArgsManager::GetSettingsList(const std::string &arg) const {
830 LOCK(cs_args);
831 return util::GetSettingsList(m_settings, m_network, SettingName(arg),
832 !UseDefaultSection(arg));
833}
834
836 const std::string &prefix, const std::string &section,
837 const std::map<std::string, std::vector<util::SettingsValue>> &args) const {
838 std::string section_str = section.empty() ? "" : "[" + section + "] ";
839 for (const auto &arg : args) {
840 for (const auto &value : arg.second) {
841 std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
842 if (flags) {
843 std::string value_str =
844 (*flags & SENSITIVE) ? "****" : value.write();
845 LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first,
846 value_str);
847 }
848 }
849 }
850}
851
853 LOCK(cs_args);
854 for (const auto &section : m_settings.ro_config) {
855 logArgsPrefix("Config file arg:", section.first, section.second);
856 }
857 for (const auto &setting : m_settings.rw_settings) {
858 LogPrintf("Setting file arg: %s = %s\n", setting.first,
859 setting.second.write());
860 }
861 logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
862}
863
864namespace common {
865#ifdef WIN32
866WinCmdLineArgs::WinCmdLineArgs() {
867 wchar_t **wargv = CommandLineToArgvW(GetCommandLineW(), &argc);
868 std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>, wchar_t> utf8_cvt;
869 argv = new char *[argc];
870 args.resize(argc);
871 for (int i = 0; i < argc; i++) {
872 args[i] = utf8_cvt.to_bytes(wargv[i]);
873 argv[i] = &*args[i].begin();
874 }
875 LocalFree(wargv);
876}
877
878WinCmdLineArgs::~WinCmdLineArgs() {
879 delete[] argv;
880}
881
882std::pair<int, char **> WinCmdLineArgs::get() {
883 return std::make_pair(argc, argv);
884}
885#endif
886} // namespace common
bool HelpRequested(const ArgsManager &args)
Definition: args.cpp:700
void SetupHelpOptions(ArgsManager &args)
Add help options to the args manager.
Definition: args.cpp:705
fs::path GetDefaultDataDir()
Definition: args.cpp:727
static const int msgIndent
Definition: args.cpp:713
static void SaveErrors(const std::vector< std::string > errors, std::vector< std::string > *error_out)
Definition: args.cpp:391
std::optional< std::string > SettingToString(const util::SettingsValue &value)
Definition: args.cpp:473
const char *const BITCOIN_SETTINGS_FILENAME
Definition: args.cpp:37
std::optional< bool > SettingToBool(const util::SettingsValue &value)
Definition: args.cpp:533
bool CheckDataDirOption(const ArgsManager &args)
Definition: args.cpp:752
static const int screenWidth
Definition: args.cpp:711
std::optional< util::SettingsValue > InterpretValue(const KeyInfo &key, const std::optional< std::string > &value, unsigned int flags, std::string &error)
Interpret settings value based on registered flags.
Definition: args.cpp:106
ArgsManager gArgs
Definition: args.cpp:39
static std::string SettingName(const std::string &arg)
Definition: args.cpp:65
std::string HelpMessageGroup(const std::string &message)
Format a string to be used as group of options in help messages.
Definition: args.cpp:715
KeyInfo InterpretKey(std::string key)
Parse "name", "section.name", "noname", "section.noname" settings keys.
Definition: args.cpp:77
bool ParseKeyValue(std::string &key, std::optional< std::string > &val)
Definition: args.cpp:186
const char *const BITCOIN_CONF_FILENAME
Definition: args.cpp:36
static bool InterpretBool(const std::string &strValue)
Interpret a string argument as a boolean.
Definition: args.cpp:58
static const int optIndent
Definition: args.cpp:712
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:719
std::optional< int64_t > SettingToInt(const util::SettingsValue &value)
Definition: args.cpp:504
OptionsCategory
Definition: args.h:58
fs::path GetConfigFile(const ArgsManager &args, const fs::path &configuration_file_path)
Definition: configfile.cpp:30
int flags
Definition: bitcoin-tx.cpp:542
const CBaseChainParams & BaseParams()
Return the currently selected parameters.
std::optional< ChainType > ChainTypeFromString(std::string_view chain)
Definition: chaintype.cpp:23
std::string ChainTypeToString(ChainType chain)
Definition: chaintype.cpp:11
ChainType
Definition: chaintype.h:11
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:140
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
std::list< SectionInfo > GetUnrecognizedSections() const
Log warnings for unrecognized section names in the config file.
Definition: args.cpp:164
@ NETWORK_ONLY
Definition: args.h:134
@ ALLOW_ANY
disable validation
Definition: args.h:114
@ DISALLOW_NEGATION
unimplemented, draft implementation in #16545
Definition: args.h:124
@ DISALLOW_ELISION
disallow -foo syntax that doesn't assign any value
Definition: args.h:126
@ DEBUG_ONLY
Definition: args.h:128
@ SENSITIVE
Definition: args.h:136
bool ReadSettingsFile(std::vector< std::string > *errors=nullptr)
Read settings file.
Definition: args.cpp:402
ChainType GetChainType() const
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.
Definition: args.cpp:761
void ForceSetArg(const std::string &strArg, const std::string &strValue)
Definition: args.cpp:565
std::string GetChainTypeString() const
Returns the appropriate chain name string from the program arguments.
Definition: args.cpp:770
bool ParseParameters(int argc, const char *const argv[], std::string &error)
Definition: args.cpp:210
std::vector< std::string > GetArgs(const std::string &strArg) const
Return a vector of strings of the given argument.
Definition: args.cpp:361
util::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
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition: args.h:239
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
Definition: args.cpp:274
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:375
bool SoftSetArg(const std::string &strArg, const std::string &strValue)
Set an argument if it doesn't already have a value.
Definition: args.cpp:547
void SelectConfigNetwork(const std::string &network)
Select the network in use.
Definition: args.cpp:181
std::string GetHelpMessage() const
Get the help string.
Definition: args.cpp:621
void ForceSetMultiArg(const std::string &strArg, const std::vector< std::string > &values)
This function is only used for testing purpose so so we should not worry about element uniqueness and...
Definition: args.cpp:576
void ClearPathCache()
Clear cached directory paths.
Definition: args.cpp:353
bool IsArgSet(const std::string &strArg) const
Return true if the given argument has been manually set.
Definition: args.cpp:371
bool WriteSettingsFile(std::vector< std::string > *errors=nullptr, bool backup=false) const
Write settings file or backup settings file.
Definition: args.cpp:425
int64_t GetIntArg(const std::string &strArg, int64_t nDefault) const
Return integer argument or default value.
Definition: args.cpp:494
fs::path GetDataDirBase() const
Get data directory path.
Definition: args.h:230
fs::path GetBlocksDirPath() const
Get blocks directory path.
Definition: args.cpp:299
void logArgsPrefix(const std::string &prefix, const std::string &section, const std::map< std::string, std::vector< util::SettingsValue > > &args) const
Definition: args.cpp:835
fs::path GetConfigFilePath() const
Return config file path (read-only)
Definition: args.cpp:757
void ClearForcedArg(const std::string &strArg)
Remove a forced arg setting, used only in testing.
Definition: args.cpp:616
std::vector< util::SettingsValue > GetSettingsList(const std::string &arg) const
Get list of setting values.
Definition: args.cpp:829
std::variant< ChainType, std::string > GetChainArg() const
Return -regtest/–testnet/-chain= setting as a ChainType enum if a recognized chain name was set,...
Definition: args.cpp:778
void LogArgs() const
Log the config file options and the command line arguments, useful for troubleshooting.
Definition: args.cpp:852
fs::path GetDataDir(bool net_specific) const
Get data directory path.
Definition: args.cpp:325
RecursiveMutex cs_args
Definition: args.h:146
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:815
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition: args.cpp:462
util::SettingsValue GetSetting(const std::string &arg) const
Get setting value.
Definition: args.cpp:820
bool SoftSetBoolArg(const std::string &strArg, bool fValue)
Set a boolean argument if it doesn't already have a value.
Definition: args.cpp:557
bool GetBoolArg(const std::string &strArg, bool fDefault) const
Return boolean argument or default value.
Definition: args.cpp:524
void AddHiddenArgs(const std::vector< std::string > &args)
Add many hidden arguments.
Definition: args.cpp:610
void AddArg(const std::string &name, const std::string &help, unsigned int flags, const OptionsCategory &cat)
Add argument.
Definition: args.cpp:588
fs::path GetPathArg(std::string arg, const fs::path &default_value={}) const
Return path argument or default value.
Definition: args.cpp:285
void push_back(UniValue val)
Definition: univalue.cpp:96
const std::string & get_str() const
bool isTrue() const
Definition: univalue.h:105
void setArray()
Definition: univalue.cpp:86
bool isNull() const
Definition: univalue.h:104
const std::string & getValStr() const
Definition: univalue.h:89
bool isBool() const
Definition: univalue.h:107
Int getInt() const
Definition: univalue.h:157
bool isNum() const
Definition: univalue.h:109
bool isFalse() const
Definition: univalue.h:106
bool get_bool() const
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition: fs.h:30
bool RenameOver(fs::path src, fs::path dest)
Rename src to dest.
Definition: fs_helpers.cpp:258
#define LogPrintf(...)
Definition: logging.h:424
Definition: args.cpp:864
static path absolute(const path &p)
Definition: fs.h:101
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:185
static std::string PathToString(const path &path)
Convert path object to byte string.
Definition: fs.h:147
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition: fs.h:170
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
Definition: fs.cpp:39
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:209
bool ReadSettings(const fs::path &path, std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Read settings file.
Definition: settings.cpp:67
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:261
bool WriteSettings(const fs::path &path, const std::map< std::string, SettingsValue > &values, std::vector< std::string > &errors)
Write settings file.
Definition: settings.cpp:122
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:142
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition: settings.h:115
const char * prefix
Definition: rest.cpp:812
const char * name
Definition: rest.cpp:46
static RPCHelpMan help()
Definition: server.cpp:183
Definition: args.h:79
std::string name
Definition: args.h:80
bool negated
Definition: args.h:82
std::string section
Definition: args.h:81
std::string m_name
Definition: args.h:92
Accessor for list of settings that skips negated values when iterated over.
Definition: settings.h:91
#define LOCK(cs)
Definition: sync.h:306
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
Definition: tinyformat.h:1202
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())