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