Branch data Line data Source code
1 : : // Copyright (c) 2023 The Bitcoin Core developers
2 : : // Distributed under the MIT software license, see the accompanying
3 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
4 : :
5 : : #include <common/args.h>
6 : :
7 : : #include <common/settings.h>
8 : : #include <logging.h>
9 : : #include <sync.h>
10 : : #include <tinyformat.h>
11 : : #include <univalue.h>
12 : : #include <util/chaintype.h>
13 : : #include <util/fs.h>
14 : : #include <util/string.h>
15 : :
16 : : #include <algorithm>
17 : : #include <cassert>
18 : : #include <cstdlib>
19 : : #include <filesystem>
20 : : #include <fstream>
21 : : #include <iostream>
22 : : #include <list>
23 : : #include <map>
24 : : #include <memory>
25 : : #include <optional>
26 : : #include <string>
27 : : #include <string_view>
28 : : #include <utility>
29 : : #include <vector>
30 : :
31 : : using util::TrimString;
32 : : using util::TrimStringView;
33 : :
34 : 50727 : static bool GetConfigOptions(std::istream& stream, const std::string& filepath, std::string& error, std::vector<std::pair<std::string, std::string>>& options, std::list<SectionInfo>& sections)
35 : : {
36 : 50727 : std::string str, prefix;
37 : 50727 : std::string::size_type pos;
38 : 50727 : int linenr = 1;
39 [ + - + + ]: 276314 : while (std::getline(stream, str)) {
40 : 225593 : bool used_hash = false;
41 [ + + ]: 225593 : if ((pos = str.find('#')) != std::string::npos) {
42 [ + - ]: 19 : str = str.substr(0, pos);
43 : 19 : used_hash = true;
44 : : }
45 [ + + + - ]: 225593 : const static std::string pattern = " \t\r\n";
46 [ + - ]: 225593 : str = TrimString(str, pattern);
47 [ + + ]: 225593 : if (!str.empty()) {
48 [ + + + - ]: 225552 : if (*str.begin() == '[' && *str.rbegin() == ']') {
49 [ + - ]: 1838 : const std::string section = str.substr(1, str.size() - 2);
50 [ + - + - : 1838 : sections.emplace_back(SectionInfo{section, filepath, linenr});
+ - ]
51 [ + - ]: 1838 : prefix = section + '.';
52 [ + + ]: 225552 : } else if (*str.begin() == '-') {
53 [ + - ]: 1 : error = strprintf("parse error on line %i: %s, options in configuration file must be specified without leading -", linenr, str);
54 : 1 : return false;
55 [ + + ]: 223713 : } else if ((pos = str.find('=')) != std::string::npos) {
56 [ + - + - : 223711 : std::string name = prefix + TrimString(std::string_view{str}.substr(0, pos), pattern);
+ - ]
57 [ + - + - ]: 223711 : std::string_view value = TrimStringView(std::string_view{str}.substr(pos + 1), pattern);
58 [ + + - + ]: 223711 : if (used_hash && name.find("rpcpassword") != std::string::npos) {
59 [ + - ]: 3 : error = strprintf("parse error on line %i, using # in rpcpassword can be ambiguous and should be avoided", linenr);
60 : 3 : return false;
61 : : }
62 [ + - ]: 223708 : options.emplace_back(name, value);
63 [ + + + + ]: 223708 : if ((pos = name.rfind('.')) != std::string::npos && prefix.length() <= pos) {
64 [ + - + - : 182788 : sections.emplace_back(SectionInfo{name.substr(0, pos), filepath, linenr});
+ - ]
65 : : }
66 : 223711 : } else {
67 [ + - ]: 2 : error = strprintf("parse error on line %i: %s", linenr, str);
68 [ + - + - : 4 : if (str.size() >= 2 && str.substr(0, 2) == "no") {
+ + + + ]
69 [ + - ]: 2 : error += strprintf(", if you intended to specify a negated option, use %s=1 instead", str);
70 : : }
71 : 2 : return false;
72 : : }
73 : : }
74 : 225587 : ++linenr;
75 : : }
76 : : return true;
77 : 50727 : }
78 : :
79 : 223702 : bool IsConfSupported(KeyInfo& key, std::string& error) {
80 [ + + ]: 223702 : if (key.name == "conf") {
81 : 2 : error = "conf cannot be set in the configuration file; use includeconf= if you want to include additional config files";
82 : 2 : return false;
83 : : }
84 [ + + ]: 223700 : if (key.name == "reindex") {
85 : : // reindex can be set in a config file but it is strongly discouraged as this will cause the node to reindex on
86 : : // every restart. Allow the config but throw a warning
87 : 1 : LogPrintf("Warning: reindex=1 is set in the configuration file, which will significantly slow down startup. Consider removing or commenting out this option for better performance, unless there is currently a condition which makes rebuilding the indexes necessary\n");
88 : 1 : return true;
89 : : }
90 : : return true;
91 : : }
92 : :
93 : 50727 : bool ArgsManager::ReadConfigStream(std::istream& stream, const std::string& filepath, std::string& error, bool ignore_invalid_keys)
94 : : {
95 : 50727 : LOCK(cs_args);
96 : 50727 : std::vector<std::pair<std::string, std::string>> options;
97 [ + - + + ]: 50727 : if (!GetConfigOptions(stream, filepath, error, options, m_config_sections)) {
98 : : return false;
99 : : }
100 [ + + ]: 274421 : for (const std::pair<std::string, std::string>& option : options) {
101 [ + - + - ]: 223702 : KeyInfo key = InterpretKey(option.first);
102 [ + - + - ]: 223702 : std::optional<unsigned int> flags = GetArgFlags('-' + key.name);
103 [ + - + + ]: 223702 : if (!IsConfSupported(key, error)) return false;
104 [ + + ]: 223700 : if (flags) {
105 [ + - ]: 209069 : std::optional<common::SettingsValue> value = InterpretValue(key, &option.second, *flags, error);
106 [ - + ]: 209069 : if (!value) {
107 : 0 : return false;
108 : : }
109 [ + - + - : 209069 : m_settings.ro_config[key.section][key.name].push_back(*value);
+ - ]
110 : 209069 : } else {
111 [ + - ]: 14631 : if (ignore_invalid_keys) {
112 [ + - ]: 14631 : LogPrintf("Ignoring unknown configuration value %s\n", option.first);
113 : : } else {
114 [ # # ]: 0 : error = strprintf("Invalid configuration value %s", option.first);
115 : 0 : return false;
116 : : }
117 : : }
118 : 223702 : }
119 : : return true;
120 [ + - ]: 101454 : }
121 : :
122 : 1835 : bool ArgsManager::ReadConfigFiles(std::string& error, bool ignore_invalid_keys)
123 : : {
124 : 1835 : {
125 : 1835 : LOCK(cs_args);
126 : 1835 : m_settings.ro_config.clear();
127 : 1835 : m_config_sections.clear();
128 [ + - + - : 7340 : m_config_path = AbsPathForConfigVal(*this, GetPathArg("-conf", BITCOIN_CONF_FILENAME), /*net_specific=*/false);
+ - + - +
- ]
129 : 0 : }
130 : :
131 : 1835 : const auto conf_path{GetConfigFilePath()};
132 [ + - ]: 1835 : std::ifstream stream;
133 [ + + ]: 1835 : if (!conf_path.empty()) { // path is empty when -noconf is specified
134 [ + - + + ]: 1833 : if (fs::is_directory(conf_path)) {
135 [ + - + - ]: 2 : error = strprintf("Config file \"%s\" is a directory.", fs::PathToString(conf_path));
136 : 1 : return false;
137 : : }
138 [ + - + - ]: 3664 : stream = std::ifstream{conf_path};
139 : : // If the file is explicitly specified, it must be readable
140 [ + - + - : 3664 : if (IsArgSet("-conf") && !stream.good()) {
+ + + + +
+ ]
141 [ + - + - ]: 2 : error = strprintf("specified config file \"%s\" could not be opened.", fs::PathToString(conf_path));
142 : 1 : return false;
143 : : }
144 : : }
145 : : // ok to not have a config file
146 [ + - ]: 1833 : if (stream.good()) {
147 [ + - + - : 3666 : if (!ReadConfigStream(stream, fs::PathToString(conf_path), error, ignore_invalid_keys)) {
+ + ]
148 : : return false;
149 : : }
150 : : // `-includeconf` cannot be included in the command line arguments except
151 : : // as `-noincludeconf` (which indicates that no included conf file should be used).
152 : 1831 : bool use_conf_file{true};
153 : 1831 : {
154 [ + - ]: 1831 : LOCK(cs_args);
155 [ + - - + ]: 1831 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
156 : : // ParseParameters() fails if a non-negated -includeconf is passed on the command-line
157 [ # # # # ]: 0 : assert(common::SettingsSpan(*includes).last_negated());
158 : : use_conf_file = false;
159 : : }
160 : 0 : }
161 [ + - ]: 1831 : if (use_conf_file) {
162 [ + - ]: 1831 : std::string chain_id = GetChainTypeString();
163 : 1831 : std::vector<std::string> conf_file_names;
164 : :
165 : 9139 : auto add_includes = [&](const std::string& network, size_t skip = 0) {
166 : 7308 : size_t num_values = 0;
167 : 7308 : LOCK(cs_args);
168 [ + + ]: 7308 : if (auto* section = common::FindKey(m_settings.ro_config, network)) {
169 [ + - + + ]: 7274 : if (auto* values = common::FindKey(*section, "includeconf")) {
170 [ + - + - : 93 : for (size_t i = std::max(skip, common::SettingsSpan(*values).negated()); i < values->size(); ++i) {
+ + ]
171 [ + - + - ]: 27 : conf_file_names.push_back((*values)[i].get_str());
172 : : }
173 : : num_values = values->size();
174 : : }
175 : : }
176 [ + - ]: 7308 : return num_values;
177 : 7308 : };
178 : :
179 : : // We haven't set m_network yet (that happens in SelectParams()), so manually check
180 : : // for network.includeconf args.
181 [ + - ]: 1831 : const size_t chain_includes = add_includes(chain_id);
182 [ + - ]: 1831 : const size_t default_includes = add_includes({});
183 : :
184 [ + + ]: 1849 : for (const std::string& conf_file_name : conf_file_names) {
185 [ + - + - ]: 26 : const auto include_conf_path{AbsPathForConfigVal(*this, fs::PathFromString(conf_file_name), /*net_specific=*/false)};
186 [ + - + + ]: 26 : if (fs::is_directory(include_conf_path)) {
187 [ + - + - ]: 2 : error = strprintf("Included config file \"%s\" is a directory.", fs::PathToString(include_conf_path));
188 : 1 : return false;
189 : : }
190 [ + - ]: 25 : std::ifstream conf_file_stream{include_conf_path};
191 [ + + ]: 25 : if (conf_file_stream.good()) {
192 [ + - + + ]: 24 : if (!ReadConfigStream(conf_file_stream, conf_file_name, error, ignore_invalid_keys)) {
193 : : return false;
194 : : }
195 [ + - ]: 18 : LogPrintf("Included configuration file %s\n", conf_file_name);
196 : : } else {
197 [ + - ]: 1 : error = "Failed to include configuration file " + conf_file_name;
198 : 1 : return false;
199 : : }
200 : 43 : }
201 : :
202 : : // Warn about recursive -includeconf
203 : 1823 : conf_file_names.clear();
204 [ + - ]: 1823 : add_includes(chain_id, /* skip= */ chain_includes);
205 [ + - ]: 1823 : add_includes({}, /* skip= */ default_includes);
206 [ + - ]: 1823 : std::string chain_id_final = GetChainTypeString();
207 [ - + ]: 1823 : if (chain_id_final != chain_id) {
208 : : // Also warn about recursive includeconf for the chain that was specified in one of the includeconfs
209 [ # # ]: 0 : add_includes(chain_id_final);
210 : : }
211 [ + + ]: 1824 : for (const std::string& conf_file_name : conf_file_names) {
212 [ + - ]: 1 : tfm::format(std::cerr, "warning: -includeconf cannot be used from included files; ignoring -includeconf=%s\n", conf_file_name);
213 : : }
214 : 1831 : }
215 : : }
216 : :
217 : : // If datadir is changed in .conf file:
218 [ + - ]: 1823 : ClearPathCache();
219 [ + - + + ]: 1823 : if (!CheckDataDirOption(*this)) {
220 [ + - + - : 1 : error = strprintf("specified data directory \"%s\" does not exist.", GetArg("-datadir", ""));
+ - + - ]
221 : 1 : return false;
222 : : }
223 : : return true;
224 : 3670 : }
225 : :
226 : 10420 : fs::path AbsPathForConfigVal(const ArgsManager& args, const fs::path& path, bool net_specific)
227 : : {
228 [ + + + + ]: 10420 : if (path.is_absolute() || path.empty()) {
229 : 88 : return path;
230 : : }
231 [ + + + - ]: 20664 : return fsbridge::AbsPathJoin(net_specific ? args.GetDataDirNet() : args.GetDataDirBase(), path);
232 : : }
|
