Branch data Line data Source code
1 : : // Copyright (c) 2019-2022 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/settings.h>
6 : :
7 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
8 : :
9 : : #include <tinyformat.h>
10 : : #include <univalue.h>
11 : : #include <util/fs.h>
12 : :
13 : : #include <algorithm>
14 : : #include <fstream>
15 : : #include <iterator>
16 : : #include <map>
17 : : #include <string>
18 : : #include <utility>
19 : : #include <vector>
20 : :
21 : : namespace common {
22 : : namespace {
23 : :
24 : : enum class Source {
25 : : FORCED,
26 : : COMMAND_LINE,
27 : : RW_SETTINGS,
28 : : CONFIG_FILE_NETWORK_SECTION,
29 : : CONFIG_FILE_DEFAULT_SECTION
30 : : };
31 : :
32 : : // Json object key for the auto-generated warning comment
33 : : const std::string SETTINGS_WARN_MSG_KEY{"_warning_"};
34 : :
35 : : //! Merge settings from multiple sources in precedence order:
36 : : //! Forced config > command line > read-write settings file > config file network-specific section > config file default section
37 : : //!
38 : : //! This function is provided with a callback function fn that contains
39 : : //! specific logic for how to merge the sources.
40 : : template <typename Fn>
41 : 1480129 : static void MergeSettings(const Settings& settings, const std::string& section, const std::string& name, Fn&& fn)
42 : : {
43 : : // Merge in the forced settings
44 [ + + ]: 1480129 : if (auto* value = FindKey(settings.forced_settings, name)) {
45 : 84997 : fn(SettingsSpan(*value), Source::FORCED);
46 : : }
47 : : // Merge in the command-line options
48 [ + + ]: 1480129 : if (auto* values = FindKey(settings.command_line_options, name)) {
49 : 15870 : fn(SettingsSpan(*values), Source::COMMAND_LINE);
50 : : }
51 : : // Merge in the read-write settings
52 [ - + ]: 1480129 : if (const SettingsValue* value = FindKey(settings.rw_settings, name)) {
53 [ + + ]: 12781 : fn(SettingsSpan(*value), Source::RW_SETTINGS);
54 : : }
55 : : // Merge in the network-specific section of the config file
56 [ + + ]: 1480129 : if (!section.empty()) {
57 [ - + ]: 1409289 : if (auto* map = FindKey(settings.ro_config, section)) {
58 [ # # ]: 0 : if (auto* values = FindKey(*map, name)) {
59 : 0 : fn(SettingsSpan(*values), Source::CONFIG_FILE_NETWORK_SECTION);
60 : : }
61 : : }
62 : : }
63 : : // Merge in the default section of the config file
64 [ - + ]: 1480129 : if (auto* map = FindKey(settings.ro_config, "")) {
65 [ # # ]: 0 : if (auto* values = FindKey(*map, name)) {
66 : 0 : fn(SettingsSpan(*values), Source::CONFIG_FILE_DEFAULT_SECTION);
67 : : }
68 : : }
69 : 1480129 : }
70 : : } // namespace
71 : :
72 : 2308 : bool ReadSettings(const fs::path& path, std::map<std::string, SettingsValue>& values, std::vector<std::string>& errors)
73 : : {
74 : 2308 : values.clear();
75 : 2308 : errors.clear();
76 : :
77 : : // Ok for file to not exist
78 [ + - ]: 2308 : if (!fs::exists(path)) return true;
79 : :
80 : 2308 : std::ifstream file;
81 [ + - ]: 2308 : file.open(path);
82 [ - + ]: 2308 : if (!file.is_open()) {
83 [ # # # # : 0 : errors.emplace_back(strprintf("%s. Please check permissions.", fs::PathToString(path)));
# # ]
84 : 0 : return false;
85 : : }
86 : :
87 [ + - ]: 2308 : SettingsValue in;
88 [ + - + - : 4616 : if (!in.read(std::string{std::istreambuf_iterator<char>(file), std::istreambuf_iterator<char>()})) {
+ + ]
89 [ + - + - ]: 1431 : errors.emplace_back(strprintf("Settings file %s does not contain valid JSON. This is probably caused by disk corruption or a crash, "
90 : : "and can be fixed by removing the file, which will reset settings to default values.",
91 [ + - ]: 477 : fs::PathToString(path)));
92 : 477 : return false;
93 : : }
94 : :
95 [ - + ]: 1831 : if (file.fail()) {
96 [ # # # # : 0 : errors.emplace_back(strprintf("Failed reading settings file %s", fs::PathToString(path)));
# # ]
97 : 0 : return false;
98 : : }
99 [ + - ]: 1831 : file.close(); // Done with file descriptor. Release while copying data.
100 : :
101 [ + + ]: 1831 : if (!in.isObject()) {
102 [ + - + - : 462 : errors.emplace_back(strprintf("Found non-object value %s in settings file %s", in.write(), fs::PathToString(path)));
+ - + - ]
103 : 154 : return false;
104 : : }
105 : :
106 [ + - ]: 1677 : const std::vector<std::string>& in_keys = in.getKeys();
107 [ + - ]: 1677 : const std::vector<SettingsValue>& in_values = in.getValues();
108 [ + + ]: 6156 : for (size_t i = 0; i < in_keys.size(); ++i) {
109 [ + - ]: 4487 : auto inserted = values.emplace(in_keys[i], in_values[i]);
110 [ + + ]: 4487 : if (!inserted.second) {
111 [ + - + - : 24 : errors.emplace_back(strprintf("Found duplicate key %s in settings file %s", in_keys[i], fs::PathToString(path)));
+ - ]
112 : 8 : values.clear();
113 : 8 : break;
114 : : }
115 : : }
116 : :
117 : : // Remove auto-generated warning comment from the accessible settings.
118 : 1677 : values.erase(SETTINGS_WARN_MSG_KEY);
119 : :
120 : 1677 : return errors.empty();
121 : 2308 : }
122 : :
123 : 21732 : bool WriteSettings(const fs::path& path,
124 : : const std::map<std::string, SettingsValue>& values,
125 : : std::vector<std::string>& errors)
126 : : {
127 : 21732 : SettingsValue out(SettingsValue::VOBJ);
128 : : // Add auto-generated warning comment
129 [ + - + - : 43464 : out.pushKV(SETTINGS_WARN_MSG_KEY, strprintf("This file is automatically generated and updated by %s. Please do not edit this file while the node "
+ - + - ]
130 : : "is running, as any changes might be ignored or overwritten.", CLIENT_NAME));
131 : : // Push settings values
132 [ + + ]: 43464 : for (const auto& value : values) {
133 [ + - + - : 43464 : out.pushKVEnd(value.first, value.second);
+ - ]
134 : : }
135 [ + - ]: 21732 : std::ofstream file;
136 [ + - ]: 21732 : file.open(path);
137 [ + + ]: 21732 : if (file.fail()) {
138 [ + - + - : 15981 : errors.emplace_back(strprintf("Error: Unable to open settings file %s for writing", fs::PathToString(path)));
+ - ]
139 : 5327 : return false;
140 : : }
141 [ + - + - ]: 32810 : file << out.write(/* prettyIndent= */ 4, /* indentLevel= */ 1) << std::endl;
142 [ + - ]: 16405 : file.close();
143 : : return true;
144 : 21732 : }
145 : :
146 : 1273445 : SettingsValue GetSetting(const Settings& settings,
147 : : const std::string& section,
148 : : const std::string& name,
149 : : bool ignore_default_section_config,
150 : : bool ignore_nonpersistent,
151 : : bool get_chain_type)
152 : : {
153 [ + - ]: 1273445 : SettingsValue result;
154 : 1273445 : bool done = false; // Done merging any more settings sources.
155 [ + - ]: 1273445 : MergeSettings(settings, section, name, [&](SettingsSpan span, Source source) {
156 : : // Weird behavior preserved for backwards compatibility: Apply negated
157 : : // setting even if non-negated setting would be ignored. A negated
158 : : // value in the default section is applied to network specific options,
159 : : // even though normal non-negated values there would be ignored.
160 : 81330 : const bool never_ignore_negated_setting = span.last_negated();
161 : :
162 : : // Weird behavior preserved for backwards compatibility: Take first
163 : : // assigned value instead of last. In general, later settings take
164 : : // precedence over early settings, but for backwards compatibility in
165 : : // the config file the precedence is reversed for all settings except
166 : : // chain type settings.
167 : 162660 : const bool reverse_precedence =
168 [ - + ]: 81330 : (source == Source::CONFIG_FILE_NETWORK_SECTION || source == Source::CONFIG_FILE_DEFAULT_SECTION) &&
169 [ # # ]: 0 : !get_chain_type;
170 : :
171 : : // Weird behavior preserved for backwards compatibility: Negated
172 : : // -regtest and -testnet arguments which you would expect to override
173 : : // values set in the configuration file are currently accepted but
174 : : // silently ignored. It would be better to apply these just like other
175 : : // negated values, or at least warn they are ignored.
176 : 81330 : const bool skip_negated_command_line = get_chain_type;
177 : :
178 [ + + ]: 81330 : if (done) return;
179 : :
180 : : // Ignore settings in default config section if requested.
181 [ + + ]: 80537 : if (ignore_default_section_config && source == Source::CONFIG_FILE_DEFAULT_SECTION &&
182 [ + - ]: 1746 : !never_ignore_negated_setting) {
183 : : return;
184 : : }
185 : :
186 : : // Ignore nonpersistent settings if requested.
187 [ - + - - ]: 80537 : if (ignore_nonpersistent && (source == Source::COMMAND_LINE || source == Source::FORCED)) return;
188 : :
189 : : // Skip negated command line settings.
190 [ + + + + ]: 80537 : if (skip_negated_command_line && span.last_negated()) return;
191 : :
192 [ + + ]: 80536 : if (!span.empty()) {
193 [ - + ]: 79766 : result = reverse_precedence ? span.begin()[0] : span.end()[-1];
194 : 79766 : done = true;
195 [ + - ]: 770 : } else if (span.last_negated()) {
196 : 770 : result = false;
197 : 770 : done = true;
198 : : }
199 : : });
200 : 1273445 : return result;
201 : 0 : }
202 : :
203 : 193903 : std::vector<SettingsValue> GetSettingsList(const Settings& settings,
204 : : const std::string& section,
205 : : const std::string& name,
206 : : bool ignore_default_section_config)
207 : : {
208 : 193903 : std::vector<SettingsValue> result;
209 : 193903 : bool done = false; // Done merging any more settings sources.
210 : 193903 : bool prev_negated_empty = false;
211 [ + - ]: 193903 : MergeSettings(settings, section, name, [&](SettingsSpan span, Source source) {
212 : : // Weird behavior preserved for backwards compatibility: Apply config
213 : : // file settings even if negated on command line. Negating a setting on
214 : : // command line will ignore earlier settings on the command line and
215 : : // ignore settings in the config file, unless the negated command line
216 : : // value is followed by non-negated value, in which case config file
217 : : // settings will be brought back from the dead (but earlier command
218 : : // line settings will still be ignored).
219 : 12634 : const bool add_zombie_config_values =
220 [ - + ]: 6317 : (source == Source::CONFIG_FILE_NETWORK_SECTION || source == Source::CONFIG_FILE_DEFAULT_SECTION) &&
221 [ # # ]: 0 : !prev_negated_empty;
222 : :
223 : : // Ignore settings in default config section if requested.
224 [ + + + - ]: 6317 : if (ignore_default_section_config && source == Source::CONFIG_FILE_DEFAULT_SECTION) return;
225 : :
226 : : // Add new settings to the result if isn't already complete, or if the
227 : : // values are zombies.
228 [ + + - + ]: 6317 : if (!done || add_zombie_config_values) {
229 [ + + ]: 13898 : for (const auto& value : span) {
230 [ - + ]: 7593 : if (value.isArray()) {
231 : 0 : result.insert(result.end(), value.getValues().begin(), value.getValues().end());
232 : : } else {
233 : 7593 : result.push_back(value);
234 : : }
235 : : }
236 : : }
237 : :
238 : : // If a setting was negated, or if a setting was forced, set
239 : : // done to true to ignore any later lower priority settings.
240 [ + + + + ]: 6317 : done |= span.negated() > 0 || source == Source::FORCED;
241 : :
242 : : // Update the negated and empty state used for the zombie values check.
243 [ + + + + ]: 6318 : prev_negated_empty |= span.last_negated() && result.empty();
244 : : });
245 : 193903 : return result;
246 : 0 : }
247 : :
248 : 12781 : bool OnlyHasDefaultSectionSetting(const Settings& settings, const std::string& section, const std::string& name)
249 : : {
250 : 12781 : bool has_default_section_setting = false;
251 : 12781 : bool has_other_setting = false;
252 : 12781 : MergeSettings(settings, section, name, [&](SettingsSpan span, Source source) {
253 [ + - + + : 439 : if (span.empty()) return;
- - - - -
- ]
254 : 0 : else if (source == Source::CONFIG_FILE_DEFAULT_SECTION) has_default_section_setting = true;
255 : 426 : else has_other_setting = true;
256 : : });
257 : : // If a value is set in the default section and not explicitly overwritten by the
258 : : // user on the command line or in a different section, then we want to enable
259 : : // warnings about the value being ignored.
260 [ - + - - ]: 12781 : return has_default_section_setting && !has_other_setting;
261 : : }
262 : :
263 : 19591 : SettingsSpan::SettingsSpan(const std::vector<SettingsValue>& vec) noexcept : SettingsSpan(vec.data(), vec.size()) {}
264 : 9745 : const SettingsValue* SettingsSpan::begin() const { return data + negated(); }
265 : 86071 : const SettingsValue* SettingsSpan::end() const { return data + size; }
266 [ + - + + ]: 84696 : bool SettingsSpan::empty() const { return size == 0 || last_negated(); }
267 [ + - + + ]: 173162 : bool SettingsSpan::last_negated() const { return size > 0 && data[size - 1].isFalse(); }
268 : 16062 : size_t SettingsSpan::negated() const
269 : : {
270 [ + + ]: 34734 : for (size_t i = size; i > 0; --i) {
271 [ + + ]: 19752 : if (data[i - 1].isFalse()) return i; // Return number of negated values (position of last false value)
272 : : }
273 : : return 0;
274 : : }
275 : :
276 : : } // namespace common
|
