Branch data Line data Source code
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 <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> /* for codecvt_utf8_utf16 */
23 : : #include <shellapi.h> /* for CommandLineToArgvW */
24 : : #include <shlobj.h> /* for CSIDL_APPDATA */
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 : :
39 : : const char * const BITCOIN_CONF_FILENAME = "bitcoin.conf";
40 : : const char * const BITCOIN_SETTINGS_FILENAME = "settings.json";
41 : :
42 : : ArgsManager gArgs;
43 : :
44 : : /**
45 : : * Interpret a string argument as a boolean.
46 : : *
47 : : * The definition of LocaleIndependentAtoi<int>() requires that non-numeric string values
48 : : * like "foo", return 0. This means that if a user unintentionally supplies a
49 : : * non-integer argument here, the return value is always false. This means that
50 : : * -foo=false does what the user probably expects, but -foo=true is well defined
51 : : * but does not do what they probably expected.
52 : : *
53 : : * The return value of LocaleIndependentAtoi<int>(...) is zero when given input not
54 : : * representable as an int.
55 : : *
56 : : * For a more extensive discussion of this topic (and a wide range of opinions
57 : : * on the Right Way to change this code), see PR12713.
58 : : */
59 : 31960 : static bool InterpretBool(const std::string& strValue)
60 : : {
61 [ + + ]: 31960 : if (strValue.empty())
62 : : return true;
63 : 27713 : return (LocaleIndependentAtoi<int>(strValue) != 0);
64 : : }
65 : :
66 : 1535303 : static std::string SettingName(const std::string& arg)
67 : : {
68 [ + + + + ]: 1535303 : return arg.size() > 0 && arg[0] == '-' ? arg.substr(1) : arg;
69 : : }
70 : :
71 : : /**
72 : : * Parse "name", "section.name", "noname", "section.noname" settings keys.
73 : : *
74 : : * @note Where an option was negated can be later checked using the
75 : : * IsArgNegated() method. One use case for this is to have a way to disable
76 : : * options that are not normally boolean (e.g. using -nodebuglogfile to request
77 : : * that debug log output is not sent to any file at all).
78 : : */
79 : 101374 : KeyInfo InterpretKey(std::string key)
80 : : {
81 [ + + ]: 101374 : KeyInfo result;
82 : : // Split section name from key name for keys like "testnet.foo" or "regtest.bar"
83 : 101374 : size_t option_index = key.find('.');
84 [ + + ]: 101374 : if (option_index != std::string::npos) {
85 [ + - ]: 1847 : result.section = key.substr(0, option_index);
86 [ + - ]: 1847 : key.erase(0, option_index + 1);
87 : : }
88 [ + - + + ]: 101374 : if (key.substr(0, 2) == "no") {
89 [ + - ]: 33766 : key.erase(0, 2);
90 : 33766 : result.negated = true;
91 : : }
92 [ + - ]: 101374 : result.name = key;
93 : 101374 : return result;
94 : 0 : }
95 : :
96 : : /**
97 : : * Interpret settings value based on registered flags.
98 : : *
99 : : * @param[in] key key information to know if key was negated
100 : : * @param[in] value string value of setting to be parsed
101 : : * @param[in] flags ArgsManager registered argument flags
102 : : * @param[out] error Error description if settings value is not valid
103 : : *
104 : : * @return parsed settings value if it is valid, otherwise nullopt accompanied
105 : : * by a descriptive error string
106 : : */
107 : 89967 : std::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 [ + + ]: 89967 : if (key.negated) {
112 [ + + ]: 31424 : if (flags & ArgsManager::DISALLOW_NEGATION) {
113 : 485 : error = strprintf("Negating of -%s is meaningless and therefore forbidden", key.name);
114 : 485 : return std::nullopt;
115 : : }
116 : : // Double negatives like -nofoo=0 are supported (but discouraged)
117 [ + + + + ]: 30939 : if (value && !InterpretBool(*value)) {
118 : 8282 : LogPrintf("Warning: parsed potentially confusing double-negative -%s=%s\n", key.name, *value);
119 : 8282 : return true;
120 : : }
121 : 22657 : return false;
122 : : }
123 [ + + + + ]: 58543 : if (!value && (flags & ArgsManager::DISALLOW_ELISION)) {
124 : 434 : error = strprintf("Can not set -%s with no value. Please specify value with -%s=value.", key.name, key.name);
125 : 434 : return std::nullopt;
126 : : }
127 : 116218 : 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.
133 : 1968 : ArgsManager::ArgsManager() = default;
134 [ - + ]: 9840 : ArgsManager::~ArgsManager() = default;
135 : :
136 : 1759 : std::set<std::string> ArgsManager::GetUnsuitableSectionOnlyArgs() const
137 : : {
138 [ + - ]: 1759 : std::set<std::string> unsuitables;
139 : :
140 [ + - ]: 1759 : LOCK(cs_args);
141 : :
142 : : // if there's no section selected, don't worry
143 [ + + ]: 1759 : 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 [ + - + + ]: 1406 : if (m_network == ChainTypeToString(ChainType::MAIN)) return std::set<std::string> {};
147 : :
148 [ + + ]: 13334 : for (const auto& arg : m_network_only_args) {
149 [ + - + - : 11941 : if (OnlyHasDefaultSectionSetting(m_settings, m_network, SettingName(arg))) {
- + ]
150 [ # # ]: 0 : unsuitables.insert(arg);
151 : : }
152 : : }
153 : 1393 : return unsuitables;
154 : 1759 : }
155 : :
156 : 1759 : std::list<SectionInfo> ArgsManager::GetUnrecognizedSections() const
157 : : {
158 : : // Section names to be recognized in the config file.
159 : 1759 : static const std::set<std::string> available_sections{
160 : : ChainTypeToString(ChainType::REGTEST),
161 : : ChainTypeToString(ChainType::SIGNET),
162 : : ChainTypeToString(ChainType::TESTNET),
163 : : ChainTypeToString(ChainType::TESTNET4),
164 : : ChainTypeToString(ChainType::MAIN),
165 [ + + + - : 2269 : };
- + + + -
- ]
166 : :
167 : 1759 : LOCK(cs_args);
168 [ + - ]: 1759 : std::list<SectionInfo> unrecognized = m_config_sections;
169 : 1759 : unrecognized.remove_if([](const SectionInfo& appeared){ return available_sections.find(appeared.m_name) != available_sections.end(); });
170 [ + - ]: 1759 : return unrecognized;
171 [ + - + - : 1844 : }
+ - + - +
- - - ]
172 : :
173 : 2427 : void ArgsManager::SelectConfigNetwork(const std::string& network)
174 : : {
175 : 2427 : LOCK(cs_args);
176 [ + - + - ]: 4854 : m_network = network;
177 : 2427 : }
178 : :
179 : 92442 : bool ArgsManager::ParseParameters(int argc, const char* const argv[], std::string& error)
180 : : {
181 : 92442 : LOCK(cs_args);
182 : 92442 : m_settings.command_line_options.clear();
183 : :
184 [ + + ]: 181490 : for (int i = 1; i < argc; i++) {
185 [ + - ]: 163013 : 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.substr(0, 5) == "-psn_") continue;
193 : : #endif
194 : :
195 [ + + ]: 163013 : if (key == "-") break; //bitcoin-tx using stdin
196 : 161348 : std::optional<std::string> val;
197 : 161348 : size_t is_index = key.find('=');
198 [ + + ]: 161348 : if (is_index != std::string::npos) {
199 [ + - ]: 50033 : val = key.substr(is_index + 1);
200 [ + - ]: 50033 : key.erase(is_index);
201 : : }
202 : : #ifdef WIN32
203 : : key = ToLower(key);
204 : : if (key[0] == '/')
205 : : key[0] = '-';
206 : : #endif
207 : :
208 [ + + ]: 161348 : if (key[0] != '-') {
209 [ - + - - ]: 59974 : if (!m_accept_any_command && m_command.empty()) {
210 : : // The first non-dash arg is a registered command
211 [ # # ]: 0 : std::optional<unsigned int> flags = GetArgFlags(key);
212 [ # # # # ]: 0 : if (!flags || !(*flags & ArgsManager::COMMAND)) {
213 [ # # ]: 0 : error = strprintf("Invalid command '%s'", argv[i]);
214 : 0 : return false;
215 : : }
216 : : }
217 [ + - ]: 59974 : m_command.push_back(key);
218 [ + + ]: 303085 : while (++i < argc) {
219 : : // The remaining args are command args
220 [ + - ]: 243111 : m_command.emplace_back(argv[i]);
221 : : }
222 : 59974 : break;
223 : : }
224 : :
225 : : // Transform --foo to -foo
226 [ + + + + ]: 101374 : if (key.length() > 1 && key[1] == '-')
227 [ + - ]: 6782 : key.erase(0, 1);
228 : :
229 : : // Transform -foo to foo
230 [ + - ]: 101374 : key.erase(0, 1);
231 [ + - + - ]: 101374 : KeyInfo keyinfo = InterpretKey(key);
232 [ + - + - ]: 101374 : 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 [ + + + + ]: 101374 : if (!flags || !keyinfo.section.empty()) {
238 [ + - ]: 11407 : error = strprintf("Invalid parameter %s", argv[i]);
239 : 11407 : return false;
240 : : }
241 : :
242 [ + + + - ]: 136181 : std::optional<common::SettingsValue> value = InterpretValue(keyinfo, val ? &*val : nullptr, *flags, error);
243 [ + + ]: 89967 : if (!value) return false;
244 : :
245 [ + - + - ]: 89048 : m_settings.command_line_options[keyinfo.name].push_back(*value);
246 : 325280 : }
247 : :
248 : : // we do not allow -includeconf from command line, only -noincludeconf
249 [ + - + + ]: 80116 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
250 : 3721 : const common::SettingsSpan values{*includes};
251 : : // Range may be empty if -noincludeconf was passed
252 [ + - + + ]: 3721 : if (!values.empty()) {
253 [ + - + - : 3440 : error = "-includeconf cannot be used from commandline; -includeconf=" + values.begin()->write();
+ - ]
254 : 3440 : return false; // pick first value as example
255 : : }
256 : : }
257 : : return true;
258 : 92442 : }
259 : :
260 : 210722 : std::optional<unsigned int> ArgsManager::GetArgFlags(const std::string& name) const
261 : : {
262 : 210722 : LOCK(cs_args);
263 [ + + ]: 539257 : for (const auto& arg_map : m_available_args) {
264 : 443904 : const auto search = arg_map.second.find(name);
265 [ + + ]: 443904 : if (search != arg_map.second.end()) {
266 : 115369 : return search->second.m_flags;
267 : : }
268 : : }
269 : 95353 : return std::nullopt;
270 : 210722 : }
271 : :
272 : 6049 : fs::path ArgsManager::GetPathArg(std::string arg, const fs::path& default_value) const
273 : : {
274 [ + + ]: 6049 : if (IsArgNegated(arg)) return fs::path{};
275 [ + - ]: 5965 : std::string path_str = GetArg(arg, "");
276 [ + + + - ]: 10781 : if (path_str.empty()) return default_value;
277 [ + - + - ]: 14448 : fs::path result = fs::PathFromString(path_str).lexically_normal();
278 : : // Remove trailing slash, if present.
279 [ + - + - : 14448 : return result.has_filename() ? result : result.parent_path();
- - ]
280 : 10781 : }
281 : :
282 : 4164 : fs::path ArgsManager::GetBlocksDirPath() const
283 : : {
284 : 4164 : LOCK(cs_args);
285 : 4164 : fs::path& path = m_cached_blocks_path;
286 : :
287 : : // Cache the path to avoid calling fs::create_directories on every call of
288 : : // this function
289 [ + + + - ]: 4164 : if (!path.empty()) return path;
290 : :
291 [ + - + - : 2408 : if (IsArgSet("-blocksdir")) {
- + ]
292 [ # # # # : 0 : path = fs::absolute(GetPathArg("-blocksdir"));
# # ]
293 [ # # # # ]: 0 : if (!fs::is_directory(path)) {
294 [ # # ]: 0 : path = "";
295 [ # # ]: 0 : return path;
296 : : }
297 : : } else {
298 [ + - ]: 4816 : path = GetDataDirBase();
299 : : }
300 : :
301 [ + - + - ]: 4816 : path /= fs::PathFromString(BaseParams().DataDir());
302 [ + - ]: 2408 : path /= "blocks";
303 [ + - ]: 2408 : fs::create_directories(path);
304 [ + - + - ]: 4164 : return path;
305 : 4164 : }
306 : :
307 : 39510 : fs::path ArgsManager::GetDataDir(bool net_specific) const
308 : : {
309 : 39510 : LOCK(cs_args);
310 [ + + ]: 39510 : fs::path& path = net_specific ? m_cached_network_datadir_path : m_cached_datadir_path;
311 : :
312 : : // Used cached path if available
313 [ + + + - : 44326 : if (!path.empty()) return path;
+ - ]
314 : :
315 [ + - + - ]: 9632 : const fs::path datadir{GetPathArg("-datadir")};
316 [ + - ]: 4816 : if (!datadir.empty()) {
317 [ + - ]: 9632 : path = fs::absolute(datadir);
318 [ + - - + ]: 4816 : if (!fs::is_directory(path)) {
319 [ # # ]: 0 : path = "";
320 [ # # ]: 0 : return path;
321 : : }
322 : : } else {
323 [ # # ]: 0 : path = GetDefaultDataDir();
324 : : }
325 : :
326 [ + + + - : 4816 : if (net_specific && !BaseParams().DataDir().empty()) {
+ + ]
327 [ + - + - ]: 7203 : path /= fs::PathFromString(BaseParams().DataDir());
328 : : }
329 : :
330 [ + - ]: 4816 : return path;
331 : 44326 : }
332 : :
333 : 1233 : void ArgsManager::ClearPathCache()
334 : : {
335 : 1233 : LOCK(cs_args);
336 : :
337 : 1233 : m_cached_datadir_path = fs::path();
338 : 1233 : m_cached_network_datadir_path = fs::path();
339 [ + - ]: 2466 : m_cached_blocks_path = fs::path();
340 : 1233 : }
341 : :
342 : 0 : std::optional<const ArgsManager::Command> ArgsManager::GetCommand() const
343 : : {
344 [ # # ]: 0 : Command ret;
345 [ # # ]: 0 : LOCK(cs_args);
346 [ # # ]: 0 : auto it = m_command.begin();
347 [ # # ]: 0 : if (it == m_command.end()) {
348 : : // No command was passed
349 : 0 : return std::nullopt;
350 : : }
351 [ # # ]: 0 : if (!m_accept_any_command) {
352 : : // The registered command
353 [ # # ]: 0 : ret.command = *(it++);
354 : : }
355 [ # # ]: 0 : while (it != m_command.end()) {
356 : : // The unregistered command and args (if any)
357 [ # # ]: 0 : ret.args.push_back(*(it++));
358 : : }
359 : 0 : return ret;
360 : 0 : }
361 : :
362 : 193903 : std::vector<std::string> ArgsManager::GetArgs(const std::string& strArg) const
363 : : {
364 : 193903 : std::vector<std::string> result;
365 [ + - + + ]: 201496 : for (const common::SettingsValue& value : GetSettingsList(strArg)) {
366 [ - + - - : 15186 : result.push_back(value.isFalse() ? "0" : value.isTrue() ? "1" : value.get_str());
+ + + - +
- + - +
- ]
367 : 193903 : }
368 : 193903 : return result;
369 : 0 : }
370 : :
371 : 117557 : bool ArgsManager::IsArgSet(const std::string& strArg) const
372 : : {
373 : 117557 : return !GetSetting(strArg).isNull();
374 : : }
375 : :
376 : 0 : bool ArgsManager::GetSettingsPath(fs::path* filepath, bool temp, bool backup) const
377 : : {
378 [ # # # # ]: 0 : fs::path settings = GetPathArg("-settings", BITCOIN_SETTINGS_FILENAME);
379 [ # # ]: 0 : if (settings.empty()) {
380 : : return false;
381 : : }
382 [ # # ]: 0 : if (backup) {
383 [ # # ]: 0 : settings += ".bak";
384 : : }
385 [ # # ]: 0 : if (filepath) {
386 [ # # # # : 0 : *filepath = fsbridge::AbsPathJoin(GetDataDirNet(), temp ? settings + ".tmp" : settings);
# # # # #
# # # ]
387 : : }
388 : : return true;
389 : 0 : }
390 : :
391 : 0 : static void SaveErrors(const std::vector<std::string> errors, std::vector<std::string>* error_out)
392 : : {
393 [ # # ]: 0 : for (const auto& error : errors) {
394 [ # # ]: 0 : if (error_out) {
395 : 0 : error_out->emplace_back(error);
396 : : } else {
397 : 0 : LogPrintf("%s\n", error);
398 : : }
399 : : }
400 : 0 : }
401 : :
402 : 0 : bool ArgsManager::ReadSettingsFile(std::vector<std::string>* errors)
403 : : {
404 : 0 : fs::path path;
405 [ # # # # ]: 0 : if (!GetSettingsPath(&path, /* temp= */ false)) {
406 : : return true; // Do nothing if settings file disabled.
407 : : }
408 : :
409 [ # # ]: 0 : LOCK(cs_args);
410 : 0 : m_settings.rw_settings.clear();
411 : 0 : std::vector<std::string> read_errors;
412 [ # # # # ]: 0 : if (!common::ReadSettings(path, m_settings.rw_settings, read_errors)) {
413 [ # # # # ]: 0 : SaveErrors(read_errors, errors);
414 : 0 : return false;
415 : : }
416 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
417 [ # # # # ]: 0 : KeyInfo key = InterpretKey(setting.first); // Split setting key into section and argname
418 [ # # # # : 0 : if (!GetArgFlags('-' + key.name)) {
# # ]
419 [ # # ]: 0 : LogPrintf("Ignoring unknown rw_settings value %s\n", setting.first);
420 : : }
421 : 0 : }
422 : : return true;
423 [ # # ]: 0 : }
424 : :
425 : 0 : bool ArgsManager::WriteSettingsFile(std::vector<std::string>* errors, bool backup) const
426 : : {
427 : 0 : fs::path path, path_tmp;
428 [ # # # # : 0 : if (!GetSettingsPath(&path, /*temp=*/false, backup) || !GetSettingsPath(&path_tmp, /*temp=*/true, backup)) {
# # # # ]
429 [ # # ]: 0 : throw std::logic_error("Attempt to write settings file when dynamic settings are disabled.");
430 : : }
431 : :
432 [ # # ]: 0 : LOCK(cs_args);
433 : 0 : std::vector<std::string> write_errors;
434 [ # # # # ]: 0 : if (!common::WriteSettings(path_tmp, m_settings.rw_settings, write_errors)) {
435 [ # # # # ]: 0 : SaveErrors(write_errors, errors);
436 : 0 : return false;
437 : : }
438 [ # # # # : 0 : if (!RenameOver(path_tmp, path)) {
# # # # ]
439 [ # # # # : 0 : SaveErrors({strprintf("Failed renaming settings file %s to %s\n", fs::PathToString(path_tmp), fs::PathToString(path))}, errors);
# # # # #
# ]
440 : 0 : return false;
441 : : }
442 : : return true;
443 [ # # # # : 0 : }
# # ]
444 : :
445 : 0 : common::SettingsValue ArgsManager::GetPersistentSetting(const std::string& name) const
446 : : {
447 : 0 : LOCK(cs_args);
448 [ # # # # : 0 : return common::GetSetting(m_settings, m_network, name, !UseDefaultSection("-" + name),
# # ]
449 [ # # ]: 0 : /*ignore_nonpersistent=*/true, /*get_chain_type=*/false);
450 : 0 : }
451 : :
452 : 7808 : bool ArgsManager::IsArgNegated(const std::string& strArg) const
453 : : {
454 : 7808 : return GetSetting(strArg).isFalse();
455 : : }
456 : :
457 : 34567 : std::string ArgsManager::GetArg(const std::string& strArg, const std::string& strDefault) const
458 : : {
459 [ + - ]: 69134 : return GetArg(strArg).value_or(strDefault);
460 : : }
461 : :
462 : 149473 : std::optional<std::string> ArgsManager::GetArg(const std::string& strArg) const
463 : : {
464 : 149473 : const common::SettingsValue value = GetSetting(strArg);
465 [ + - ]: 298946 : return SettingToString(value);
466 : 149473 : }
467 : :
468 : 149473 : std::optional<std::string> SettingToString(const common::SettingsValue& value)
469 : : {
470 [ + + ]: 149473 : if (value.isNull()) return std::nullopt;
471 [ + + ]: 5161 : if (value.isFalse()) return "0";
472 [ + + ]: 5142 : if (value.isTrue()) return "1";
473 [ - + ]: 5124 : if (value.isNum()) return value.getValStr();
474 : 5124 : return value.get_str();
475 : : }
476 : :
477 : 0 : std::string SettingToString(const common::SettingsValue& value, const std::string& strDefault)
478 : : {
479 [ # # ]: 0 : return SettingToString(value).value_or(strDefault);
480 : : }
481 : :
482 : 402236 : int64_t ArgsManager::GetIntArg(const std::string& strArg, int64_t nDefault) const
483 : : {
484 [ + + ]: 402236 : return GetIntArg(strArg).value_or(nDefault);
485 : : }
486 : :
487 : 467467 : std::optional<int64_t> ArgsManager::GetIntArg(const std::string& strArg) const
488 : : {
489 : 467467 : const common::SettingsValue value = GetSetting(strArg);
490 [ + - ]: 934934 : return SettingToInt(value);
491 : 467467 : }
492 : :
493 : 467467 : std::optional<int64_t> SettingToInt(const common::SettingsValue& value)
494 : : {
495 [ + + ]: 467467 : if (value.isNull()) return std::nullopt;
496 [ + + ]: 29097 : if (value.isFalse()) return 0;
497 [ + + ]: 29079 : if (value.isTrue()) return 1;
498 [ - + ]: 29062 : if (value.isNum()) return value.getInt<int64_t>();
499 : 29062 : return LocaleIndependentAtoi<int64_t>(value.get_str());
500 : : }
501 : :
502 : 0 : int64_t SettingToInt(const common::SettingsValue& value, int64_t nDefault)
503 : : {
504 [ # # ]: 0 : return SettingToInt(value).value_or(nDefault);
505 : : }
506 : :
507 : 515388 : bool ArgsManager::GetBoolArg(const std::string& strArg, bool fDefault) const
508 : : {
509 [ + + ]: 515388 : return GetBoolArg(strArg).value_or(fDefault);
510 : : }
511 : :
512 : 524104 : std::optional<bool> ArgsManager::GetBoolArg(const std::string& strArg) const
513 : : {
514 : 524104 : const common::SettingsValue value = GetSetting(strArg);
515 [ + - ]: 1048208 : return SettingToBool(value);
516 : 524104 : }
517 : :
518 : 524104 : std::optional<bool> SettingToBool(const common::SettingsValue& value)
519 : : {
520 [ + + ]: 524104 : if (value.isNull()) return std::nullopt;
521 [ + + ]: 5539 : if (value.isBool()) return value.get_bool();
522 : 5502 : return InterpretBool(value.get_str());
523 : : }
524 : :
525 : 0 : bool SettingToBool(const common::SettingsValue& value, bool fDefault)
526 : : {
527 [ # # ]: 0 : return SettingToBool(value).value_or(fDefault);
528 : : }
529 : :
530 : 53007 : bool ArgsManager::SoftSetArg(const std::string& strArg, const std::string& strValue)
531 : : {
532 : 53007 : LOCK(cs_args);
533 [ + - + + ]: 53007 : if (IsArgSet(strArg)) return false;
534 [ + - ]: 20574 : ForceSetArg(strArg, strValue);
535 : : return true;
536 : 53007 : }
537 : :
538 : 36804 : bool ArgsManager::SoftSetBoolArg(const std::string& strArg, bool fValue)
539 : : {
540 [ + + ]: 36804 : if (fValue)
541 [ + - ]: 32829 : return SoftSetArg(strArg, std::string("1"));
542 : : else
543 [ + - ]: 3975 : return SoftSetArg(strArg, std::string("0"));
544 : : }
545 : :
546 : 56014 : void ArgsManager::ForceSetArg(const std::string& strArg, const std::string& strValue)
547 : : {
548 : 56014 : LOCK(cs_args);
549 [ + - + - : 56014 : m_settings.forced_settings[SettingName(strArg)] = strValue;
+ - + - ]
550 : 56014 : }
551 : :
552 : 0 : void ArgsManager::AddCommand(const std::string& cmd, const std::string& help)
553 : : {
554 : 0 : Assert(cmd.find('=') == std::string::npos);
555 : 0 : Assert(cmd.at(0) != '-');
556 : :
557 : 0 : LOCK(cs_args);
558 : 0 : m_accept_any_command = false; // latch to false
559 [ # # ]: 0 : std::map<std::string, Arg>& arg_map = m_available_args[OptionsCategory::COMMANDS];
560 [ # # # # : 0 : auto ret = arg_map.emplace(cmd, Arg{"", help, ArgsManager::COMMAND});
# # ]
561 [ # # ]: 0 : Assert(ret.second); // Fail on duplicate commands
562 : 0 : }
563 : :
564 : 313117 : void ArgsManager::AddArg(const std::string& name, const std::string& help, unsigned int flags, const OptionsCategory& cat)
565 : : {
566 : 313117 : Assert((flags & ArgsManager::COMMAND) == 0); // use AddCommand
567 : :
568 : : // Split arg name from its help param
569 : 313117 : size_t eq_index = name.find('=');
570 [ + + ]: 313117 : if (eq_index == std::string::npos) {
571 : 183652 : eq_index = name.size();
572 : : }
573 : 313117 : std::string arg_name = name.substr(0, eq_index);
574 : :
575 [ + - ]: 313117 : LOCK(cs_args);
576 [ + - ]: 313117 : std::map<std::string, Arg>& arg_map = m_available_args[cat];
577 [ + - + - : 313117 : auto ret = arg_map.emplace(arg_name, Arg{name.substr(eq_index, name.size() - eq_index), help, flags});
+ - ]
578 [ - + ]: 313117 : assert(ret.second); // Make sure an insertion actually happened
579 : :
580 [ + + ]: 313117 : if (flags & ArgsManager::NETWORK_ONLY) {
581 [ + - ]: 18614 : m_network_only_args.emplace(arg_name);
582 : : }
583 : 313117 : }
584 : :
585 : 16241 : void ArgsManager::AddHiddenArgs(const std::vector<std::string>& names)
586 : : {
587 [ + + ]: 104466 : for (const std::string& name : names) {
588 [ + - ]: 176450 : AddArg(name, "", ArgsManager::ALLOW_ANY, OptionsCategory::HIDDEN);
589 : : }
590 : 16241 : }
591 : :
592 : 0 : void ArgsManager::CheckMultipleCLIArgs() const
593 : : {
594 : 0 : LOCK(cs_args);
595 : 0 : std::vector<std::string> found{};
596 : 0 : auto cmds = m_available_args.find(OptionsCategory::CLI_COMMANDS);
597 [ # # ]: 0 : if (cmds != m_available_args.end()) {
598 [ # # # # ]: 0 : for (const auto& [cmd, argspec] : cmds->second) {
599 [ # # # # ]: 0 : if (IsArgSet(cmd)) {
600 [ # # ]: 0 : found.push_back(cmd);
601 : : }
602 : : }
603 [ # # ]: 0 : if (found.size() > 1) {
604 [ # # # # : 0 : throw std::runtime_error(strprintf("Only one of %s may be specified.", util::Join(found, ", ")));
# # ]
605 : : }
606 : : }
607 [ # # ]: 0 : }
608 : :
609 : 526 : std::string ArgsManager::GetHelpMessage() const
610 : : {
611 [ + - ]: 526 : const bool show_debug = GetBoolArg("-help-debug", false);
612 : :
613 [ + - ]: 526 : std::string usage;
614 [ + - ]: 526 : LOCK(cs_args);
615 [ + + ]: 1403 : for (const auto& arg_map : m_available_args) {
616 [ + + + + : 1307 : switch(arg_map.first) {
+ + + + +
+ + + + +
+ + ]
617 : 361 : case OptionsCategory::OPTIONS:
618 [ + - + - ]: 722 : usage += HelpMessageGroup("Options:");
619 : 361 : break;
620 : 33 : case OptionsCategory::CONNECTION:
621 [ + - + - ]: 66 : usage += HelpMessageGroup("Connection options:");
622 : 33 : break;
623 : 28 : case OptionsCategory::ZMQ:
624 [ + - + - ]: 56 : usage += HelpMessageGroup("ZeroMQ notification options:");
625 : 28 : break;
626 : 38 : case OptionsCategory::DEBUG_TEST:
627 [ + - + - ]: 76 : usage += HelpMessageGroup("Debugging/Testing options:");
628 : 38 : break;
629 : 16 : case OptionsCategory::NODE_RELAY:
630 [ + - + - ]: 32 : usage += HelpMessageGroup("Node relay options:");
631 : 16 : break;
632 : 20 : case OptionsCategory::BLOCK_CREATION:
633 [ + - + - ]: 40 : usage += HelpMessageGroup("Block creation options:");
634 : 20 : break;
635 : 36 : case OptionsCategory::RPC:
636 [ + - + - ]: 72 : usage += HelpMessageGroup("RPC server options:");
637 : 36 : break;
638 : 11 : case OptionsCategory::IPC:
639 [ + - + - ]: 22 : usage += HelpMessageGroup("IPC interprocess connection options:");
640 : 11 : break;
641 : 52 : case OptionsCategory::WALLET:
642 [ + - + - ]: 104 : usage += HelpMessageGroup("Wallet options:");
643 : 52 : break;
644 : 46 : case OptionsCategory::WALLET_DEBUG_TEST:
645 [ + + + - : 55 : if (show_debug) usage += HelpMessageGroup("Wallet debugging/testing options:");
+ - ]
646 : : break;
647 : 29 : case OptionsCategory::CHAINPARAMS:
648 [ + - + - ]: 58 : usage += HelpMessageGroup("Chain selection options:");
649 : 29 : break;
650 : 11 : case OptionsCategory::GUI:
651 [ + - + - ]: 22 : usage += HelpMessageGroup("UI Options:");
652 : 11 : break;
653 : 64 : case OptionsCategory::COMMANDS:
654 [ + - + - ]: 128 : usage += HelpMessageGroup("Commands:");
655 : 64 : break;
656 : 51 : case OptionsCategory::REGISTER_COMMANDS:
657 [ + - + - ]: 102 : usage += HelpMessageGroup("Register Commands:");
658 : 51 : break;
659 : 81 : case OptionsCategory::CLI_COMMANDS:
660 [ + - + - ]: 162 : usage += HelpMessageGroup("CLI Commands:");
661 : 81 : break;
662 : : default:
663 : : break;
664 : : }
665 : :
666 : : // When we get to the hidden options, stop
667 [ + + ]: 1307 : if (arg_map.first == OptionsCategory::HIDDEN) break;
668 : :
669 [ + + ]: 4311 : for (const auto& arg : arg_map.second) {
670 [ + + + + ]: 3434 : if (show_debug || !(arg.second.m_flags & ArgsManager::DEBUG_ONLY)) {
671 [ + - ]: 2103 : std::string name;
672 [ + - ]: 2103 : if (arg.second.m_help_param.empty()) {
673 [ + - ]: 2103 : name = arg.first;
674 : : } else {
675 [ # # ]: 0 : name = arg.first + arg.second.m_help_param;
676 : : }
677 [ + - ]: 4206 : usage += HelpMessageOpt(name, arg.second.m_help_text);
678 : 2103 : }
679 : : }
680 : : }
681 [ + - ]: 526 : return usage;
682 : 526 : }
683 : :
684 : 526 : bool HelpRequested(const ArgsManager& args)
685 : : {
686 [ + - + - : 2142 : return args.IsArgSet("-?") || args.IsArgSet("-h") || args.IsArgSet("-help") || args.IsArgSet("-help-debug");
+ + + - +
- + + + -
+ - + + +
- + - + +
+ + + + -
- - - -
- ]
687 : : }
688 : :
689 : 1649 : void SetupHelpOptions(ArgsManager& args)
690 : : {
691 [ + - + - ]: 3298 : args.AddArg("-help", "Print this help message and exit (also -h or -?)", ArgsManager::ALLOW_ANY, OptionsCategory::OPTIONS);
692 [ + - ]: 1649 : args.AddHiddenArgs({"-h", "-?"});
693 : 1649 : }
694 : :
695 : : static const int screenWidth = 79;
696 : : static const int optIndent = 2;
697 : : static const int msgIndent = 7;
698 : :
699 : 1680 : std::string HelpMessageGroup(const std::string &message) {
700 [ + - + - ]: 3360 : return std::string(message) + std::string("\n\n");
701 : : }
702 : :
703 : 2943 : std::string HelpMessageOpt(const std::string &option, const std::string &message) {
704 [ + - + - ]: 11772 : return std::string(optIndent,' ') + std::string(option) +
705 [ + - + - : 11772 : std::string("\n") + std::string(msgIndent,' ') +
+ - ]
706 [ + - + - ]: 8829 : FormatParagraph(message, screenWidth - msgIndent, msgIndent) +
707 [ + - ]: 8829 : std::string("\n\n");
708 : : }
709 : :
710 : : const std::vector<std::string> TEST_OPTIONS_DOC{
711 : : "addrman (use deterministic addrman)",
712 : : "bip94 (enforce BIP94 consensus rules)",
713 : : };
714 : :
715 : 2476 : bool HasTestOption(const ArgsManager& args, const std::string& test_option)
716 : : {
717 [ + - ]: 2476 : const auto options = args.GetArgs("-test");
718 [ + - + - : 24760 : return std::any_of(options.begin(), options.end(), [test_option](const auto& option) {
+ - ]
719 [ # # # # : 0 : return option == test_option;
# # # # #
# # # #
# ]
720 : 2476 : });
721 : 2476 : }
722 : :
723 : 0 : fs::path GetDefaultDataDir()
724 : : {
725 : : // Windows:
726 : : // old: C:\Users\Username\AppData\Roaming\Bitcoin
727 : : // new: C:\Users\Username\AppData\Local\Bitcoin
728 : : // macOS: ~/Library/Application Support/Bitcoin
729 : : // Unix-like: ~/.bitcoin
730 : : #ifdef WIN32
731 : : // Windows
732 : : // Check for existence of datadir in old location and keep it there
733 : : fs::path legacy_path = GetSpecialFolderPath(CSIDL_APPDATA) / "Bitcoin";
734 : : if (fs::exists(legacy_path)) return legacy_path;
735 : :
736 : : // Otherwise, fresh installs can start in the new, "proper" location
737 : : return GetSpecialFolderPath(CSIDL_LOCAL_APPDATA) / "Bitcoin";
738 : : #else
739 : 0 : fs::path pathRet;
740 : 0 : char* pszHome = getenv("HOME");
741 [ # # # # ]: 0 : if (pszHome == nullptr || strlen(pszHome) == 0)
742 [ # # ]: 0 : pathRet = fs::path("/");
743 : : else
744 [ # # ]: 0 : pathRet = fs::path(pszHome);
745 : : #ifdef __APPLE__
746 : : // macOS
747 : : return pathRet / "Library/Application Support/Bitcoin";
748 : : #else
749 : : // Unix-like
750 [ # # # # ]: 0 : return pathRet / ".bitcoin";
751 : : #endif
752 : : #endif
753 : 0 : }
754 : :
755 : 0 : bool CheckDataDirOption(const ArgsManager& args)
756 : : {
757 [ # # # # ]: 0 : const fs::path datadir{args.GetPathArg("-datadir")};
758 [ # # # # : 0 : return datadir.empty() || fs::is_directory(fs::absolute(datadir));
# # # # ]
759 : 0 : }
760 : :
761 : 0 : fs::path ArgsManager::GetConfigFilePath() const
762 : : {
763 : 0 : LOCK(cs_args);
764 [ # # # # : 0 : return *Assert(m_config_path);
# # ]
765 : 0 : }
766 : :
767 : 0 : void ArgsManager::SetConfigFilePath(fs::path path)
768 : : {
769 : 0 : LOCK(cs_args);
770 [ # # ]: 0 : assert(!m_config_path);
771 [ # # ]: 0 : m_config_path = path;
772 : 0 : }
773 : :
774 : 1233 : ChainType ArgsManager::GetChainType() const
775 : : {
776 : 1233 : std::variant<ChainType, std::string> arg = GetChainArg();
777 [ + - ]: 1233 : if (auto* parsed = std::get_if<ChainType>(&arg)) return *parsed;
778 [ # # # # : 0 : throw std::runtime_error(strprintf("Unknown chain %s.", std::get<std::string>(arg)));
# # ]
779 : 1233 : }
780 : :
781 : 526 : std::string ArgsManager::GetChainTypeString() const
782 : : {
783 : 526 : auto arg = GetChainArg();
784 [ + + + - ]: 514 : if (auto* parsed = std::get_if<ChainType>(&arg)) return ChainTypeToString(*parsed);
785 [ - + + - ]: 18 : return std::get<std::string>(arg);
786 : 514 : }
787 : :
788 : 1759 : std::variant<ChainType, std::string> ArgsManager::GetChainArg() const
789 : : {
790 : 8795 : auto get_net = [&](const std::string& arg) {
791 : 7036 : LOCK(cs_args);
792 [ + - + - ]: 14072 : common::SettingsValue value = common::GetSetting(m_settings, /* section= */ "", SettingName(arg),
793 : : /* ignore_default_section_config= */ false,
794 : : /*ignore_nonpersistent=*/false,
795 [ + - ]: 7036 : /* get_chain_type= */ true);
796 [ + + + + : 7036 : return value.isNull() ? false : value.isBool() ? value.get_bool() : InterpretBool(value.get_str());
+ - + - +
- ]
797 [ + - ]: 14072 : };
798 : :
799 [ + - ]: 1759 : const bool fRegTest = get_net("-regtest");
800 [ + - ]: 1759 : const bool fSigNet = get_net("-signet");
801 [ + - ]: 1759 : const bool fTestNet = get_net("-testnet");
802 [ + - ]: 1759 : const bool fTestNet4 = get_net("-testnet4");
803 [ + - ]: 1759 : const auto chain_arg = GetArg("-chain");
804 : :
805 [ + + ]: 1759 : if ((int)chain_arg.has_value() + (int)fRegTest + (int)fSigNet + (int)fTestNet + (int)fTestNet4 > 1) {
806 [ + - ]: 12 : throw std::runtime_error("Invalid combination of -regtest, -signet, -testnet, -testnet4 and -chain. Can use at most one.");
807 : : }
808 [ + + ]: 1747 : if (chain_arg) {
809 [ + - + + ]: 24 : if (auto parsed = ChainTypeFromString(*chain_arg)) return *parsed;
810 : : // Not a known string, so return original string
811 [ + - ]: 18 : return *chain_arg;
812 : : }
813 [ + + ]: 1723 : if (fRegTest) return ChainType::REGTEST;
814 [ + + ]: 1721 : if (fSigNet) return ChainType::SIGNET;
815 [ + + ]: 1714 : if (fTestNet) return ChainType::TESTNET;
816 [ + + ]: 1711 : if (fTestNet4) return ChainType::TESTNET4;
817 : 1709 : return ChainType::MAIN;
818 : 1747 : }
819 : :
820 : 1460312 : bool ArgsManager::UseDefaultSection(const std::string& arg) const
821 : : {
822 [ + + + + ]: 1460312 : return m_network == ChainTypeToString(ChainType::MAIN) || m_network_only_args.count(arg) == 0;
823 : : }
824 : :
825 : 1266409 : common::SettingsValue ArgsManager::GetSetting(const std::string& arg) const
826 : : {
827 : 1266409 : LOCK(cs_args);
828 : 1266409 : return common::GetSetting(
829 [ + - + - ]: 2532818 : m_settings, m_network, SettingName(arg), !UseDefaultSection(arg),
830 [ + - + - ]: 1266409 : /*ignore_nonpersistent=*/false, /*get_chain_type=*/false);
831 : 1266409 : }
832 : :
833 : 193903 : std::vector<common::SettingsValue> ArgsManager::GetSettingsList(const std::string& arg) const
834 : : {
835 : 193903 : LOCK(cs_args);
836 [ + - + - : 387806 : return common::GetSettingsList(m_settings, m_network, SettingName(arg), !UseDefaultSection(arg));
+ - + - ]
837 : 193903 : }
838 : :
839 : 0 : void ArgsManager::logArgsPrefix(
840 : : const std::string& prefix,
841 : : const std::string& section,
842 : : const std::map<std::string, std::vector<common::SettingsValue>>& args) const
843 : : {
844 [ # # # # ]: 0 : std::string section_str = section.empty() ? "" : "[" + section + "] ";
845 [ # # ]: 0 : for (const auto& arg : args) {
846 [ # # ]: 0 : for (const auto& value : arg.second) {
847 [ # # # # ]: 0 : std::optional<unsigned int> flags = GetArgFlags('-' + arg.first);
848 [ # # ]: 0 : if (flags) {
849 [ # # # # : 0 : std::string value_str = (*flags & SENSITIVE) ? "****" : value.write();
# # ]
850 [ # # ]: 0 : LogPrintf("%s %s%s=%s\n", prefix, section_str, arg.first, value_str);
851 : 0 : }
852 : : }
853 : : }
854 : 0 : }
855 : :
856 : 0 : void ArgsManager::LogArgs() const
857 : : {
858 : 0 : LOCK(cs_args);
859 [ # # ]: 0 : for (const auto& section : m_settings.ro_config) {
860 [ # # # # ]: 0 : logArgsPrefix("Config file arg:", section.first, section.second);
861 : : }
862 [ # # ]: 0 : for (const auto& setting : m_settings.rw_settings) {
863 [ # # # # ]: 0 : LogPrintf("Setting file arg: %s = %s\n", setting.first, setting.second.write());
864 : : }
865 [ # # # # : 0 : logArgsPrefix("Command-line arg:", "", m_settings.command_line_options);
# # # # ]
866 : 0 : }
867 : :
868 : : namespace common {
869 : : #ifdef WIN32
870 : : WinCmdLineArgs::WinCmdLineArgs()
871 : : {
872 : : wchar_t** wargv = CommandLineToArgvW(GetCommandLineW(), &argc);
873 : : std::wstring_convert<std::codecvt_utf8_utf16<wchar_t>, wchar_t> utf8_cvt;
874 : : argv = new char*[argc];
875 : : args.resize(argc);
876 : : for (int i = 0; i < argc; i++) {
877 : : args[i] = utf8_cvt.to_bytes(wargv[i]);
878 : : argv[i] = &*args[i].begin();
879 : : }
880 : : LocalFree(wargv);
881 : : }
882 : :
883 : : WinCmdLineArgs::~WinCmdLineArgs()
884 : : {
885 : : delete[] argv;
886 : : }
887 : :
888 : : std::pair<int, char**> WinCmdLineArgs::get()
889 : : {
890 : : return std::make_pair(argc, argv);
891 : : }
892 : : #endif
893 : : } // namespace common
|
