Branch data Line data Source code
1 : : // Copyright (c) 2023-present 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> // IWYU pragma: associated
6 : :
7 : : #include <common/settings.h>
8 : : #include <sync.h>
9 : : #include <tinyformat.h>
10 : : #include <univalue.h>
11 : : #include <util/check.h>
12 : : #include <util/fs.h>
13 : : #include <util/log.h>
14 : : #include <util/string.h>
15 : :
16 : : #include <algorithm>
17 : : #include <cstdlib>
18 : : #include <fstream>
19 : : #include <iostream>
20 : : #include <list>
21 : : #include <map>
22 : : #include <optional>
23 : : #include <sstream>
24 : : #include <string>
25 : : #include <string_view>
26 : : #include <utility>
27 : : #include <vector>
28 : :
29 : : using util::TrimString;
30 : : using util::TrimStringView;
31 : :
32 : 51186 : 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)
33 : : {
34 : 51186 : std::string str, prefix;
35 : 51186 : std::string::size_type pos;
36 : 51186 : int linenr = 1;
37 [ + - + + ]: 291447 : while (std::getline(stream, str)) {
38 : 240267 : bool used_hash = false;
39 [ + + ]: 240267 : if ((pos = str.find('#')) != std::string::npos) {
40 [ + - ]: 19 : str = str.substr(0, pos);
41 : 19 : used_hash = true;
42 : : }
43 [ + + + - ]: 240267 : const static std::string pattern = " \t\r\n";
44 [ - + - + : 240267 : str = TrimString(str, pattern);
+ - ]
45 [ + + ]: 240267 : if (!str.empty()) {
46 [ + + + - ]: 240222 : if (*str.begin() == '[' && *str.rbegin() == ']') {
47 [ - + + - ]: 2297 : const std::string section = str.substr(1, str.size() - 2);
48 [ - + - + : 6891 : sections.emplace_back(SectionInfo{section, filepath, linenr});
+ - ]
49 [ + - ]: 2297 : prefix = section + '.';
50 [ + + ]: 240222 : } else if (*str.begin() == '-') {
51 [ + - ]: 1 : error = strprintf("parse error on line %i: %s, options in configuration file must be specified without leading -", linenr, str);
52 : 1 : return false;
53 [ + + ]: 237924 : } else if ((pos = str.find('=')) != std::string::npos) {
54 [ - + - + : 237922 : std::string name = prefix + TrimString(std::string_view{str}.substr(0, pos), pattern);
+ - + - +
- ]
55 [ - + - + : 237922 : std::string_view value = TrimStringView(std::string_view{str}.substr(pos + 1), pattern);
+ - + - ]
56 [ + + - + ]: 237922 : if (used_hash && name.find("rpcpassword") != std::string::npos) {
57 [ + - ]: 3 : error = strprintf("parse error on line %i, using # in rpcpassword can be ambiguous and should be avoided", linenr);
58 : 3 : return false;
59 : : }
60 [ + - ]: 237919 : options.emplace_back(name, value);
61 [ + + + + ]: 379544 : if ((pos = name.rfind('.')) != std::string::npos && prefix.length() <= pos) {
62 [ + - - + : 274185 : sections.emplace_back(SectionInfo{name.substr(0, pos), filepath, linenr});
+ - ]
63 : : }
64 : 237922 : } else {
65 [ + - ]: 2 : error = strprintf("parse error on line %i: %s", linenr, str);
66 [ - + + - : 2 : if (str.size() >= 2 && str.starts_with("no")) {
+ + ]
67 [ + - ]: 2 : error += strprintf(", if you intended to specify a negated option, use %s=1 instead", str);
68 : : }
69 : 2 : return false;
70 : : }
71 : : }
72 : 240261 : ++linenr;
73 : : }
74 : : return true;
75 : 51186 : }
76 : :
77 : 237913 : bool IsConfSupported(KeyInfo& key, std::string& error) {
78 [ + + ]: 237913 : if (key.name == "conf") {
79 : 2 : error = "conf cannot be set in the configuration file; use includeconf= if you want to include additional config files";
80 : 2 : return false;
81 : : }
82 [ + + ]: 237911 : if (key.name == "reindex") {
83 : : // reindex can be set in a config file but it is strongly discouraged as this will cause the node to reindex on
84 : : // every restart. Allow the config but throw a warning
85 : 1 : LogWarning("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");
86 : 1 : return true;
87 : : }
88 : : return true;
89 : : }
90 : :
91 : 51186 : bool ArgsManager::ReadConfigStream(std::istream& stream, const std::string& filepath, std::string& error, bool ignore_invalid_keys)
92 : : {
93 : 51186 : LOCK(cs_args);
94 : 51186 : std::vector<std::pair<std::string, std::string>> options;
95 [ + - + + ]: 51186 : if (!GetConfigOptions(stream, filepath, error, options, m_config_sections)) {
96 : : return false;
97 : : }
98 [ + + ]: 289091 : for (const std::pair<std::string, std::string>& option : options) {
99 [ - + + - ]: 475826 : KeyInfo key = InterpretKey(option.first);
100 [ + - + - ]: 237913 : std::optional<unsigned int> flags = GetArgFlags_('-' + key.name);
101 [ + - + + ]: 237913 : if (!IsConfSupported(key, error)) return false;
102 [ + + ]: 237911 : if (flags) {
103 [ + - ]: 216385 : std::optional<common::SettingsValue> value = InterpretValue(key, &option.second, *flags, error);
104 [ - + ]: 216385 : if (!value) {
105 : 0 : return false;
106 : : }
107 [ + - + - : 216385 : m_settings.ro_config[key.section][key.name].push_back(*value);
+ - ]
108 : 216385 : } else {
109 [ + - ]: 21526 : if (ignore_invalid_keys) {
110 [ + - ]: 237911 : LogWarning("Ignoring unknown configuration value %s", option.first);
111 : : } else {
112 [ # # ]: 0 : error = strprintf("Invalid configuration value %s", option.first);
113 : 0 : return false;
114 : : }
115 : : }
116 : 237913 : }
117 : : return true;
118 [ + - ]: 102372 : }
119 : :
120 : 14 : bool ArgsManager::ReadConfigString(const std::string& str_config)
121 : : {
122 : 14 : std::istringstream streamConfig(str_config);
123 : 14 : {
124 [ + - ]: 14 : LOCK(cs_args);
125 : 14 : m_settings.ro_config.clear();
126 [ + - ]: 14 : m_config_sections.clear();
127 : 14 : }
128 [ + - ]: 14 : std::string error;
129 [ + - + - ]: 28 : return ReadConfigStream(streamConfig, "", error);
130 : 14 : }
131 : :
132 : 2293 : bool ArgsManager::ReadConfigFiles(std::string& error, bool ignore_invalid_keys)
133 : : {
134 : 2293 : {
135 : 2293 : LOCK(cs_args);
136 : 2293 : m_settings.ro_config.clear();
137 : 2293 : m_config_sections.clear();
138 [ + - + - : 4586 : const auto conf_val = GetPathArg_("-conf", BITCOIN_CONF_FILENAME);
+ - ]
139 [ + + + + : 6879 : m_config_path = (conf_val.is_absolute() || conf_val.empty()) ? conf_val : fsbridge::AbsPathJoin(GetDataDir(/*net_specific=*/false), conf_val);
+ - + - +
- + + -
- ]
140 [ + - ]: 2293 : }
141 : :
142 : 2293 : const auto conf_path{GetConfigFilePath()};
143 [ + - ]: 2293 : std::ifstream stream;
144 [ + + ]: 2293 : if (!conf_path.empty()) { // path is empty when -noconf is specified
145 [ + - + + ]: 2291 : if (fs::is_directory(conf_path)) {
146 [ - + + - ]: 2 : error = strprintf("Config file \"%s\" is a directory.", fs::PathToString(conf_path));
147 : 1 : return false;
148 : : }
149 [ + - + - ]: 4580 : stream = std::ifstream{conf_path.std_path()};
150 : : // If the file is explicitly specified, it must be readable
151 [ + - + - : 4580 : if (IsArgSet("-conf") && !stream.good()) {
+ + + + +
+ ]
152 [ - + + - ]: 2 : error = strprintf("specified config file \"%s\" could not be opened.", fs::PathToString(conf_path));
153 : 1 : return false;
154 : : }
155 : : }
156 : : // ok to not have a config file
157 [ + - ]: 2291 : if (stream.good()) {
158 [ - + + - : 4582 : if (!ReadConfigStream(stream, fs::PathToString(conf_path), error, ignore_invalid_keys)) {
+ + ]
159 : : return false;
160 : : }
161 : : // `-includeconf` cannot be included in the command line arguments except
162 : : // as `-noincludeconf` (which indicates that no included conf file should be used).
163 : 2289 : bool use_conf_file{true};
164 : 2289 : {
165 [ + - ]: 2289 : LOCK(cs_args);
166 [ + - - + ]: 2289 : if (auto* includes = common::FindKey(m_settings.command_line_options, "includeconf")) {
167 : : // ParseParameters() fails if a non-negated -includeconf is passed on the command-line
168 [ # # # # ]: 0 : assert(common::SettingsSpan(*includes).last_negated());
169 : : use_conf_file = false;
170 : : }
171 : 0 : }
172 [ + - ]: 2289 : if (use_conf_file) {
173 [ + - ]: 2289 : std::string chain_id = GetChainTypeString();
174 : 2289 : std::vector<std::string> conf_file_names;
175 : :
176 : 11429 : auto add_includes = [&](const std::string& network, size_t skip = 0) {
177 : 9140 : size_t num_values = 0;
178 : 9140 : LOCK(cs_args);
179 [ + + ]: 9140 : if (auto* section = common::FindKey(m_settings.ro_config, network)) {
180 [ + - + + ]: 9120 : if (auto* values = common::FindKey(*section, "includeconf")) {
181 [ + - + - : 93 : for (size_t i = std::max(skip, common::SettingsSpan(*values).negated()); i < values->size(); ++i) {
- + + + ]
182 [ + - + - ]: 27 : conf_file_names.push_back((*values)[i].get_str());
183 : : }
184 : : num_values = values->size();
185 : : }
186 : : }
187 [ + - ]: 9140 : return num_values;
188 : 9140 : };
189 : :
190 : : // We haven't set m_network yet (that happens in SelectParams()), so manually check
191 : : // for network.includeconf args.
192 [ + - ]: 2289 : const size_t chain_includes = add_includes(chain_id);
193 [ + - ]: 2289 : const size_t default_includes = add_includes({});
194 : :
195 [ + + ]: 2307 : for (const std::string& conf_file_name : conf_file_names) {
196 [ + - + - ]: 26 : const auto include_conf_path{AbsPathForConfigVal(*this, fs::PathFromString(conf_file_name), /*net_specific=*/false)};
197 [ + - + + ]: 26 : if (fs::is_directory(include_conf_path)) {
198 [ - + + - ]: 2 : error = strprintf("Included config file \"%s\" is a directory.", fs::PathToString(include_conf_path));
199 : 1 : return false;
200 : : }
201 [ + - ]: 25 : std::ifstream conf_file_stream{include_conf_path.std_path()};
202 [ + + ]: 25 : if (conf_file_stream.good()) {
203 [ + - + + ]: 24 : if (!ReadConfigStream(conf_file_stream, conf_file_name, error, ignore_invalid_keys)) {
204 : : return false;
205 : : }
206 [ + - ]: 18 : LogInfo("Included configuration file %s\n", conf_file_name);
207 : : } else {
208 [ + - ]: 1 : error = "Failed to include configuration file " + conf_file_name;
209 : 1 : return false;
210 : : }
211 : 43 : }
212 : :
213 : : // Warn about recursive -includeconf
214 : 2281 : conf_file_names.clear();
215 [ + - ]: 2281 : add_includes(chain_id, /* skip= */ chain_includes);
216 [ + - ]: 2281 : add_includes({}, /* skip= */ default_includes);
217 [ + - ]: 2281 : std::string chain_id_final = GetChainTypeString();
218 [ - + ]: 2281 : if (chain_id_final != chain_id) {
219 : : // Also warn about recursive includeconf for the chain that was specified in one of the includeconfs
220 [ # # ]: 0 : add_includes(chain_id_final);
221 : : }
222 [ + + ]: 2282 : for (const std::string& conf_file_name : conf_file_names) {
223 [ + - ]: 1 : tfm::format(std::cerr, "warning: -includeconf cannot be used from included files; ignoring -includeconf=%s\n", conf_file_name);
224 : : }
225 : 2289 : }
226 : : }
227 : :
228 : : // If datadir is changed in .conf file:
229 [ + - ]: 2281 : ClearPathCache();
230 [ + - + + ]: 2281 : if (!CheckDataDirOption(*this)) {
231 [ + - + - : 1 : error = strprintf("specified data directory \"%s\" does not exist.", GetArg("-datadir", ""));
+ - + - ]
232 : 1 : return false;
233 : : }
234 : : return true;
235 : 4586 : }
236 : :
237 : 10285 : fs::path AbsPathForConfigVal(const ArgsManager& args, const fs::path& path, bool net_specific)
238 : : {
239 [ + + + + ]: 10285 : if (path.is_absolute() || path.empty()) {
240 : 80 : return path;
241 : : }
242 [ + + + - ]: 20410 : return fsbridge::AbsPathJoin(net_specific ? args.GetDataDirNet() : args.GetDataDirBase(), path);
243 : : }
|
