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