Bitcoin ABC 0.26.3
P2P Digital Currency
Loading...
Searching...
No Matches
configfile.cpp
Go to the documentation of this file.
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 <logging.h>
8#include <sync.h>
9#include <tinyformat.h>
10#include <univalue.h>
11#include <util/fs.h>
12#include <util/settings.h>
13#include <util/string.h>
14
15#include <algorithm>
16#include <cassert>
17#include <cstdlib>
18#include <fstream>
19#include <iostream>
20#include <list>
21#include <map>
22#include <memory>
23#include <optional>
24#include <string>
25#include <string_view>
26#include <utility>
27#include <vector>
28
32 /*net_specific=*/false);
33}
34
35static bool
36GetConfigOptions(std::istream &stream, const std::string &filepath,
37 std::string &error,
38 std::vector<std::pair<std::string, std::string>> &options,
39 std::list<SectionInfo> &sections) {
40 std::string str, prefix;
41 std::string::size_type pos;
42 int linenr = 1;
43 while (std::getline(stream, str)) {
44 bool used_hash = false;
45 if ((pos = str.find('#')) != std::string::npos) {
46 str = str.substr(0, pos);
47 used_hash = true;
48 }
49 const static std::string pattern = " \t\r\n";
50 str = TrimString(str, pattern);
51 if (!str.empty()) {
52 if (*str.begin() == '[' && *str.rbegin() == ']') {
53 const std::string section = str.substr(1, str.size() - 2);
55 prefix = section + '.';
56 } else if (*str.begin() == '-') {
58 "parse error on line %i: %s, options in configuration file "
59 "must be specified without leading -",
60 linenr, str);
61 return false;
62 } else if ((pos = str.find('=')) != std::string::npos) {
63 std::string name =
64 prefix +
65 TrimString(std::string_view{str}.substr(0, pos), pattern);
66 std::string_view value = TrimStringView(
67 std::string_view{str}.substr(pos + 1), pattern);
68 if (used_hash &&
69 name.find("rpcpassword") != std::string::npos) {
71 "parse error on line %i, using # in rpcpassword can be "
72 "ambiguous and should be avoided",
73 linenr);
74 return false;
75 }
76 options.emplace_back(name, value);
77 if ((pos = name.rfind('.')) != std::string::npos &&
78 prefix.length() <= pos) {
79 sections.emplace_back(
80 SectionInfo{name.substr(0, pos), filepath, linenr});
81 }
82 } else {
83 error = strprintf("parse error on line %i: %s", linenr, str);
84 if (str.size() >= 2 && str.substr(0, 2) == "no") {
85 error += strprintf(", if you intended to specify a negated "
86 "option, use %s=1 instead",
87 str);
88 }
89 return false;
90 }
91 }
92 ++linenr;
93 }
94 return true;
95}
96
97bool ArgsManager::ReadConfigStream(std::istream &stream,
98 const std::string &filepath,
99 std::string &error,
100 bool ignore_invalid_keys) {
101 LOCK(cs_args);
102 std::vector<std::pair<std::string, std::string>> options;
103 if (!GetConfigOptions(stream, filepath, error, options,
105 return false;
106 }
107 for (const std::pair<std::string, std::string> &option : options) {
108 std::string section;
109 std::string key = option.first;
110 util::SettingsValue value =
111 InterpretOption(section, key, option.second);
112 std::optional<unsigned int> flags = GetArgFlags('-' + key);
113 if (flags) {
114 if (!CheckValid(key, value, *flags, error)) {
115 return false;
116 }
117 m_settings.ro_config[section][key].push_back(value);
118 } else {
120 LogPrintf("Ignoring unknown configuration value %s\n",
121 option.first);
122 } else {
123 error = strprintf("Invalid configuration value %s",
124 option.first.c_str());
125 return false;
126 }
127 }
128 }
129 return true;
130}
131
133 bool ignore_invalid_keys) {
134 {
135 LOCK(cs_args);
136 m_settings.ro_config.clear();
137 m_config_sections.clear();
138 }
139
140 const auto conf_path{GetConfigFilePath()};
141 std::ifstream stream{conf_path};
142
143 // ok to not have a config file
144 if (stream.good()) {
147 return false;
148 }
149 // `-includeconf` cannot be included in the command line arguments
150 // except as `-noincludeconf` (which indicates that no included conf
151 // file should be used).
152 bool use_conf_file{true};
153 {
154 LOCK(cs_args);
155 if (auto *includes = util::FindKey(m_settings.command_line_options,
156 "includeconf")) {
157 // ParseParameters() fails if a non-negated -includeconf is
158 // passed on the command-line
160 use_conf_file = false;
161 }
162 }
163 if (use_conf_file) {
164 std::string chain_id = GetChainName();
165 std::vector<std::string> conf_file_names;
166
167 auto add_includes = [&](const std::string &network,
168 size_t skip = 0) {
169 size_t num_values = 0;
170 LOCK(cs_args);
171 if (auto *section =
172 util::FindKey(m_settings.ro_config, network)) {
173 if (auto *values = util::FindKey(*section, "includeconf")) {
174 for (size_t i = std::max(
175 skip, util::SettingsSpan(*values).negated());
176 i < values->size(); ++i) {
177 conf_file_names.push_back((*values)[i].get_str());
178 }
179 num_values = values->size();
180 }
181 }
182 return num_values;
183 };
184
185 // We haven't set m_network yet (that happens in SelectParams()), so
186 // manually check for network.includeconf args.
187 const size_t chain_includes = add_includes(chain_id);
188 const size_t default_includes = add_includes({});
189
190 for (const std::string &conf_file_name : conf_file_names) {
191 std::ifstream conf_file_stream{
193 if (conf_file_stream.good()) {
196 return false;
197 }
198 LogPrintf("Included configuration file %s\n",
200 } else {
201 error = "Failed to include configuration file " +
203 return false;
204 }
205 }
206
207 // Warn about recursive -includeconf
208 conf_file_names.clear();
210 add_includes({}, /* skip= */ default_includes);
211 std::string chain_id_final = GetChainName();
212 if (chain_id_final != chain_id) {
213 // Also warn about recursive includeconf for the chain that was
214 // specified in one of the includeconfs
216 }
217 for (const std::string &conf_file_name : conf_file_names) {
218 tfm::format(std::cerr,
219 "warning: -includeconf cannot be used from "
220 "included files; ignoring -includeconf=%s\n",
222 }
223 }
224 }
225
226 // If datadir is changed in .conf file:
228 if (!CheckDataDirOption(*this)) {
229 error = strprintf("specified data directory \"%s\" does not exist.",
230 GetArg("-datadir", "").c_str());
231 return false;
232 }
233 return true;
234}
235
237 bool net_specific) {
238 if (path.is_absolute()) {
239 return path;
240 }
242 net_specific ? args.GetDataDirNet() : args.GetDataDirBase(), path);
243}
bool CheckValid(const std::string &key, const util::SettingsValue &val, unsigned int flags, std::string &error)
Check settings value validity according to flags.
Definition args.cpp:117
bool CheckDataDirOption(const ArgsManager &args)
Definition args.cpp:784
util::SettingsValue InterpretOption(std::string &section, std::string &key, const std::string &value)
Interpret -nofoo as if the user supplied -foo=0.
Definition args.cpp:87
fs::path GetConfigFile(const ArgsManager &args, const fs::path &configuration_file_path)
int flags
fs::path GetDataDirNet() const
Get data directory path with appended network identifier.
Definition args.h:215
std::optional< unsigned int > GetArgFlags(const std::string &name) const
Return Flags for known arg.
Definition args.cpp:264
void ClearPathCache()
Clear cached directory paths.
Definition args.cpp:363
fs::path GetDataDirBase() const
Get data directory path.
Definition args.h:206
fs::path GetConfigFilePath() const
Return config file path (read-only)
Definition args.cpp:789
RecursiveMutex cs_args
Definition args.h:122
std::string GetArg(const std::string &strArg, const std::string &strDefault) const
Return string argument or default value.
Definition args.cpp:494
bool ReadConfigStream(std::istream &stream, const std::string &filepath, std::string &error, bool ignore_invalid_keys=false)
bool ReadConfigFiles(std::string &error, bool ignore_invalid_keys=false)
std::string GetChainName() const
Looks for -regtest, -testnet and returns the appropriate BIP70 chain name.
Definition args.cpp:793
Path class wrapper to block calls to the fs::path(std::string) implicit constructor and the fs::path:...
Definition fs.h:30
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)
fs::path AbsPathForConfigVal(const ArgsManager &args, const fs::path &path, bool net_specific)
Most paths passed as configuration arguments are treated as relative to the datadir if they are not a...
fs::path GetConfigFile(const ArgsManager &args, const fs::path &configuration_file_path)
bool error(const char *fmt, const Args &...args)
Definition logging.h:263
#define LogPrintf(...)
Definition logging.h:227
static std::string PathToString(const path &path)
Convert path object to byte string.
Definition fs.h:142
static path PathFromString(const std::string &string)
Convert byte string to path object.
Definition fs.h:165
fs::path AbsPathJoin(const fs::path &base, const fs::path &path)
Helper function for joining two paths.
Definition fs.cpp:39
void format(std::ostream &out, const char *fmt, const Args &...args)
Format list of arguments to the stream according to given format string.
auto FindKey(Map &&map, Key &&key) -> decltype(&map.at(key))
Map lookup helper.
Definition settings.h:115
T GetRand(T nMax=std::numeric_limits< T >::max()) noexcept
Generate a uniform random integer of type T in the range [0..nMax) nMax defaults to std::numeric_limi...
Definition random.h:85
const char * prefix
Definition rest.cpp:817
const char * name
Definition rest.cpp:47
std::string TrimString(std::string_view str, std::string_view pattern=" \f\n\r\t\v")
Definition string.h:38
std::string_view TrimStringView(std::string_view str, std::string_view pattern=" \f\n\r\t\v")
Definition string.h:28
Accessor for list of settings that skips negated values when iterated over.
Definition settings.h:91
size_t negated() const
Number of negated values.
Definition settings.cpp:296
bool last_negated() const
True if the last value is negated.
Definition settings.cpp:293
#define LOCK(cs)
Definition sync.h:306
#define strprintf
Format arguments and return the string or write to given std::ostream (see tinyformat::format doc for...
assert(!tx.IsCoinBase())