Branch data Line data Source code
1 : : // Copyright (c) 2010 Satoshi Nakamoto
2 : : // Copyright (c) 2009-present The Bitcoin Core developers
3 : : // Distributed under the MIT software license, see the accompanying
4 : : // file COPYING or http://www.opensource.org/licenses/mit-license.php.
5 : :
6 : : #include <bitcoin-build-config.h> // IWYU pragma: keep
7 : :
8 : : #include <rpc/server.h>
9 : :
10 : : #include <common/args.h>
11 : : #include <common/system.h>
12 : : #include <logging.h>
13 : : #include <node/context.h>
14 : : #include <node/kernel_notifications.h>
15 : : #include <rpc/server_util.h>
16 : : #include <rpc/util.h>
17 : : #include <sync.h>
18 : : #include <util/signalinterrupt.h>
19 : : #include <util/strencodings.h>
20 : : #include <util/string.h>
21 : : #include <util/time.h>
22 : : #include <validation.h>
23 : :
24 : : #include <algorithm>
25 : : #include <cassert>
26 : : #include <chrono>
27 : : #include <memory>
28 : : #include <mutex>
29 : : #include <string_view>
30 : : #include <unordered_map>
31 : :
32 : : using util::SplitString;
33 : :
34 : : static GlobalMutex g_rpc_warmup_mutex;
35 : : static std::atomic<bool> g_rpc_running{false};
36 : : static bool fRPCInWarmup GUARDED_BY(g_rpc_warmup_mutex) = true;
37 : : static std::string rpcWarmupStatus GUARDED_BY(g_rpc_warmup_mutex) = "RPC server started";
38 : : static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler);
39 : :
40 : 134 : struct RPCCommandExecutionInfo
41 : : {
42 : : std::string method;
43 : : SteadyClock::time_point start;
44 : : };
45 : :
46 : : struct RPCServerInfo
47 : : {
48 : : Mutex mutex;
49 : : std::list<RPCCommandExecutionInfo> active_commands GUARDED_BY(mutex);
50 : : };
51 : :
52 : : static RPCServerInfo g_rpc_server_info;
53 : :
54 : : struct RPCCommandExecution
55 : : {
56 : : std::list<RPCCommandExecutionInfo>::iterator it;
57 : 67 : explicit RPCCommandExecution(const std::string& method)
58 : 67 : {
59 : 67 : LOCK(g_rpc_server_info.mutex);
60 [ - + + - : 134 : it = g_rpc_server_info.active_commands.insert(g_rpc_server_info.active_commands.end(), {method, SteadyClock::now()});
+ - ]
61 [ + - ]: 134 : }
62 : 67 : ~RPCCommandExecution()
63 : : {
64 : 67 : LOCK(g_rpc_server_info.mutex);
65 [ + - ]: 67 : g_rpc_server_info.active_commands.erase(it);
66 : 67 : }
67 : : };
68 : :
69 : 0 : std::string CRPCTable::help(std::string_view strCommand, const JSONRPCRequest& helpreq) const
70 : : {
71 [ # # ]: 0 : std::string strRet;
72 : 0 : std::string category;
73 [ # # ]: 0 : std::set<intptr_t> setDone;
74 : 0 : std::vector<std::pair<std::string, const CRPCCommand*> > vCommands;
75 [ # # ]: 0 : vCommands.reserve(mapCommands.size());
76 : :
77 [ # # ]: 0 : for (const auto& entry : mapCommands)
78 [ # # # # ]: 0 : vCommands.emplace_back(entry.second.front()->category + entry.first, entry.second.front());
79 : 0 : std::ranges::sort(vCommands);
80 : :
81 [ # # ]: 0 : JSONRPCRequest jreq = helpreq;
82 : 0 : jreq.mode = JSONRPCRequest::GET_HELP;
83 : 0 : jreq.params = UniValue();
84 : :
85 [ # # # # ]: 0 : for (const auto& [_, pcmd] : vCommands) {
86 [ # # ]: 0 : std::string strMethod = pcmd->name;
87 [ # # # # : 0 : if ((strCommand != "" || pcmd->category == "hidden") && strMethod != strCommand)
# # ]
88 : 0 : continue;
89 [ # # ]: 0 : jreq.strMethod = strMethod;
90 : 0 : try
91 : : {
92 [ # # ]: 0 : UniValue unused_result;
93 [ # # # # ]: 0 : if (setDone.insert(pcmd->unique_id).second)
94 [ # # ]: 0 : pcmd->actor(jreq, unused_result, /*last_handler=*/true);
95 [ # # ]: 0 : } catch (const HelpResult& e) {
96 [ - - ]: 0 : std::string strHelp{e.what()};
97 [ - - ]: 0 : if (strCommand == "")
98 : : {
99 [ - - ]: 0 : if (strHelp.find('\n') != std::string::npos)
100 [ - - ]: 0 : strHelp = strHelp.substr(0, strHelp.find('\n'));
101 : :
102 [ - - ]: 0 : if (category != pcmd->category)
103 : : {
104 [ - - ]: 0 : if (!category.empty())
105 [ - - ]: 0 : strRet += "\n";
106 [ - - ]: 0 : category = pcmd->category;
107 [ - - - - : 0 : strRet += "== " + Capitalize(category) + " ==\n";
- - - - ]
108 : : }
109 : : }
110 [ - - ]: 0 : strRet += strHelp + "\n";
111 [ - - ]: 0 : }
112 : 0 : }
113 [ # # ]: 0 : if (strRet == "")
114 [ # # ]: 0 : strRet = strprintf("help: unknown command: %s\n", strCommand);
115 [ # # # # ]: 0 : strRet = strRet.substr(0,strRet.size()-1);
116 : 0 : return strRet;
117 : 0 : }
118 : :
119 : 290 : static RPCHelpMan help()
120 : : {
121 : 290 : return RPCHelpMan{
122 : 290 : "help",
123 [ + - ]: 580 : "List all commands, or get help for a specified command.\n",
124 : : {
125 [ + - + - : 870 : {"command", RPCArg::Type::STR, RPCArg::DefaultHint{"all commands"}, "The command to get help on"},
+ - ]
126 : : },
127 : : {
128 [ + - + - ]: 580 : RPCResult{RPCResult::Type::STR, "", "The help text"},
129 [ + - + - ]: 580 : RPCResult{RPCResult::Type::ANY, "", ""},
130 : : },
131 [ + - ]: 580 : RPCExamples{""},
132 : 290 : [&](const RPCHelpMan& self, const JSONRPCRequest& jsonRequest) -> UniValue
133 : : {
134 : 0 : auto command{self.MaybeArg<std::string_view>("command")};
135 [ # # ]: 0 : if (command == "dump_all_command_conversions") {
136 : : // Used for testing only, undocumented
137 : 0 : return tableRPC.dumpArgMap(jsonRequest);
138 : : }
139 : :
140 [ # # ]: 0 : return tableRPC.help(command.value_or(""), jsonRequest);
141 : : },
142 [ + - + - : 2900 : };
+ - + - +
+ + + - -
- - ]
143 [ + - + - : 1160 : }
+ - - - ]
144 : :
145 : 290 : static RPCHelpMan stop()
146 : : {
147 [ + + + - : 290 : static const std::string RESULT{CLIENT_NAME " stopping"};
+ - ]
148 : 290 : return RPCHelpMan{
149 : 290 : "stop",
150 : : // Also accept the hidden 'wait' integer argument (milliseconds)
151 : : // For instance, 'stop 1000' makes the call wait 1 second before returning
152 : : // to the client (intended for testing)
153 [ + - ]: 580 : "Request a graceful shutdown of " CLIENT_NAME ".",
154 : : {
155 [ + - + - : 580 : {"wait", RPCArg::Type::NUM, RPCArg::Optional::OMITTED, "how long to wait in ms", RPCArgOptions{.hidden=true}},
+ - ]
156 : : },
157 [ + - + - : 870 : RPCResult{RPCResult::Type::STR, "", "A string with the content '" + RESULT + "'"},
+ - + - ]
158 [ + - + - ]: 870 : RPCExamples{""},
159 : 290 : [&](const RPCHelpMan& self, const JSONRPCRequest& jsonRequest) -> UniValue
160 : : {
161 : : // Event loop will exit after current HTTP requests have been handled, so
162 : : // this reply will get back to the client.
163 : 0 : CHECK_NONFATAL((CHECK_NONFATAL(EnsureAnyNodeContext(jsonRequest.context).shutdown_request))());
164 [ # # ]: 0 : if (jsonRequest.params[0].isNum()) {
165 : 0 : UninterruptibleSleep(std::chrono::milliseconds{jsonRequest.params[0].getInt<int>()});
166 : : }
167 : 0 : return RESULT;
168 : : },
169 [ + - + - : 1450 : };
+ + - - ]
170 [ + - ]: 290 : }
171 : :
172 : 290 : static RPCHelpMan uptime()
173 : : {
174 : 290 : return RPCHelpMan{
175 : 290 : "uptime",
176 [ + - ]: 580 : "Returns the total uptime of the server.\n",
177 : : {},
178 [ + - ]: 580 : RPCResult{
179 [ + - ]: 580 : RPCResult::Type::NUM, "", "The number of seconds that the server has been running"
180 [ + - ]: 580 : },
181 : 290 : RPCExamples{
182 [ + - + - : 580 : HelpExampleCli("uptime", "")
+ - ]
183 [ + - + - : 1160 : + HelpExampleRpc("uptime", "")
+ - + - ]
184 [ + - ]: 290 : },
185 : 290 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
186 : : {
187 : 0 : return GetTime() - GetStartupTime();
188 : : }
189 [ + - + - ]: 1160 : };
190 : : }
191 : :
192 : 290 : static RPCHelpMan getrpcinfo()
193 : : {
194 : 290 : return RPCHelpMan{
195 : 290 : "getrpcinfo",
196 [ + - ]: 580 : "Returns details of the RPC server.\n",
197 : : {},
198 [ + - ]: 580 : RPCResult{
199 [ + - ]: 580 : RPCResult::Type::OBJ, "", "",
200 : : {
201 [ + - + - ]: 580 : {RPCResult::Type::ARR, "active_commands", "All active commands",
202 : : {
203 [ + - + - ]: 580 : {RPCResult::Type::OBJ, "", "Information about an active command",
204 : : {
205 [ + - + - ]: 580 : {RPCResult::Type::STR, "method", "The name of the RPC command"},
206 [ + - + - ]: 580 : {RPCResult::Type::NUM, "duration", "The running time in microseconds"},
207 : : }},
208 : : }},
209 [ + - + - ]: 580 : {RPCResult::Type::STR, "logpath", "The complete file path to the debug log"},
210 : : }
211 [ + - + - : 3190 : },
+ - + - +
+ + + + +
- - - - -
- ]
212 : 290 : RPCExamples{
213 [ + - + - : 580 : HelpExampleCli("getrpcinfo", "")
+ - ]
214 [ + - + - : 1450 : + HelpExampleRpc("getrpcinfo", "")},
+ - + - +
- ]
215 : 290 : [&](const RPCHelpMan& self, const JSONRPCRequest& request) -> UniValue
216 : : {
217 : 0 : LOCK(g_rpc_server_info.mutex);
218 : 0 : UniValue active_commands(UniValue::VARR);
219 [ # # ]: 0 : for (const RPCCommandExecutionInfo& info : g_rpc_server_info.active_commands) {
220 : 0 : UniValue entry(UniValue::VOBJ);
221 [ # # # # : 0 : entry.pushKV("method", info.method);
# # ]
222 [ # # # # : 0 : entry.pushKV("duration", int64_t{Ticks<std::chrono::microseconds>(SteadyClock::now() - info.start)});
# # ]
223 [ # # ]: 0 : active_commands.push_back(std::move(entry));
224 : 0 : }
225 : :
226 : 0 : UniValue result(UniValue::VOBJ);
227 [ # # # # ]: 0 : result.pushKV("active_commands", std::move(active_commands));
228 : :
229 [ # # # # ]: 0 : const std::string path = LogInstance().m_file_path.utf8string();
230 [ # # ]: 0 : UniValue log_path(UniValue::VSTR, path);
231 [ # # # # ]: 0 : result.pushKV("logpath", std::move(log_path));
232 : :
233 : 0 : return result;
234 [ # # ]: 0 : }
235 [ + - + - ]: 1160 : };
236 [ + - + - : 1450 : }
+ - + - +
- - - -
- ]
237 : :
238 : : static const CRPCCommand vRPCCommands[]{
239 : : /* Overall control/query calls */
240 : : {"control", &getrpcinfo},
241 : : {"control", &help},
242 : : {"control", &stop},
243 : : {"control", &uptime},
244 : : };
245 : :
246 : 157 : CRPCTable::CRPCTable()
247 : : {
248 [ + + ]: 785 : for (const auto& c : vRPCCommands) {
249 [ + - ]: 628 : appendCommand(c.name, &c);
250 : : }
251 : 157 : }
252 : :
253 : 20147 : void CRPCTable::appendCommand(const std::string& name, const CRPCCommand* pcmd)
254 : : {
255 : 20147 : CHECK_NONFATAL(!IsRPCRunning()); // Only add commands before rpc is running
256 : :
257 : 20147 : mapCommands[name].push_back(pcmd);
258 : 20147 : }
259 : :
260 : 1026 : bool CRPCTable::removeCommand(const std::string& name, const CRPCCommand* pcmd)
261 : : {
262 : 1026 : auto it = mapCommands.find(name);
263 [ + - ]: 1026 : if (it != mapCommands.end()) {
264 : 1026 : auto new_end = std::remove(it->second.begin(), it->second.end(), pcmd);
265 [ + - ]: 1026 : if (it->second.end() != new_end) {
266 : 1026 : it->second.erase(new_end, it->second.end());
267 : 1026 : return true;
268 : : }
269 : : }
270 : : return false;
271 : : }
272 : :
273 : 0 : void StartRPC()
274 : : {
275 [ # # ]: 0 : LogDebug(BCLog::RPC, "Starting RPC\n");
276 : 0 : g_rpc_running = true;
277 : 0 : }
278 : :
279 : 1 : void InterruptRPC()
280 : : {
281 : 1 : static std::once_flag g_rpc_interrupt_flag;
282 : : // This function could be called twice if the GUI has been started with -server=1.
283 : 1 : std::call_once(g_rpc_interrupt_flag, []() {
284 [ + - ]: 1 : LogDebug(BCLog::RPC, "Interrupting RPC\n");
285 : : // Interrupt e.g. running longpolls
286 : 1 : g_rpc_running = false;
287 : 1 : });
288 : 1 : }
289 : :
290 : 1 : void StopRPC()
291 : : {
292 : 1 : static std::once_flag g_rpc_stop_flag;
293 : : // This function could be called twice if the GUI has been started with -server=1.
294 [ - + ]: 1 : assert(!g_rpc_running);
295 : 1 : std::call_once(g_rpc_stop_flag, [&]() {
296 [ + - ]: 1 : LogDebug(BCLog::RPC, "Stopping RPC\n");
297 : 1 : DeleteAuthCookie();
298 [ + - ]: 1 : LogDebug(BCLog::RPC, "RPC stopped.\n");
299 : 1 : });
300 : 1 : }
301 : :
302 : 20147 : bool IsRPCRunning()
303 : : {
304 : 20147 : return g_rpc_running;
305 : : }
306 : :
307 : 0 : void RpcInterruptionPoint()
308 : : {
309 [ # # # # : 0 : if (!IsRPCRunning()) throw JSONRPCError(RPC_CLIENT_NOT_CONNECTED, "Shutting down");
# # ]
310 : 0 : }
311 : :
312 : 0 : void SetRPCWarmupStatus(const std::string& newStatus)
313 : : {
314 : 0 : LOCK(g_rpc_warmup_mutex);
315 [ # # # # ]: 0 : rpcWarmupStatus = newStatus;
316 : 0 : }
317 : :
318 : 626 : void SetRPCWarmupStarting()
319 : : {
320 : 626 : LOCK(g_rpc_warmup_mutex);
321 [ + - ]: 626 : fRPCInWarmup = true;
322 : 626 : }
323 : :
324 : 8 : void SetRPCWarmupFinished()
325 : : {
326 : 8 : LOCK(g_rpc_warmup_mutex);
327 [ - + ]: 8 : assert(fRPCInWarmup);
328 [ + - ]: 8 : fRPCInWarmup = false;
329 : 8 : }
330 : :
331 : 67 : bool RPCIsInWarmup(std::string *outStatus)
332 : : {
333 : 67 : LOCK(g_rpc_warmup_mutex);
334 [ - + ]: 67 : if (outStatus)
335 [ # # ]: 0 : *outStatus = rpcWarmupStatus;
336 [ + - ]: 67 : return fRPCInWarmup;
337 : 67 : }
338 : :
339 : 270 : bool IsDeprecatedRPCEnabled(const std::string& method)
340 : : {
341 [ + - ]: 270 : const std::vector<std::string> enabled_methods = gArgs.GetArgs("-deprecatedrpc");
342 : :
343 : 270 : return find(enabled_methods.begin(), enabled_methods.end(), method) != enabled_methods.end();
344 : 270 : }
345 : :
346 : 0 : UniValue JSONRPCExec(const JSONRPCRequest& jreq, bool catch_errors)
347 : : {
348 [ # # ]: 0 : UniValue result;
349 [ # # ]: 0 : if (catch_errors) {
350 : 0 : try {
351 [ # # ]: 0 : result = tableRPC.execute(jreq);
352 [ - - - ]: 0 : } catch (UniValue& e) {
353 [ - - - - : 0 : return JSONRPCReplyObj(NullUniValue, std::move(e), jreq.id, jreq.m_json_version);
- - ]
354 : 0 : } catch (const std::exception& e) {
355 [ - - - - : 0 : return JSONRPCReplyObj(NullUniValue, JSONRPCError(RPC_MISC_ERROR, e.what()), jreq.id, jreq.m_json_version);
- - - - -
- ]
356 : 0 : }
357 : : } else {
358 [ # # ]: 0 : result = tableRPC.execute(jreq);
359 : : }
360 : :
361 [ # # # # : 0 : return JSONRPCReplyObj(std::move(result), NullUniValue, jreq.id, jreq.m_json_version);
# # ]
362 : 0 : }
363 : :
364 : : /**
365 : : * Process named arguments into a vector of positional arguments, based on the
366 : : * passed-in specification for the RPC call's arguments.
367 : : */
368 : 11 : static inline JSONRPCRequest transformNamedArguments(const JSONRPCRequest& in, const std::vector<std::pair<std::string, bool>>& argNames)
369 : : {
370 : 11 : JSONRPCRequest out = in;
371 : 11 : out.params = UniValue(UniValue::VARR);
372 : : // Build a map of parameters, and remove ones that have been processed, so that we can throw a focused error if
373 : : // there is an unknown one.
374 [ + - ]: 11 : const std::vector<std::string>& keys = in.params.getKeys();
375 [ + - ]: 11 : const std::vector<UniValue>& values = in.params.getValues();
376 : 11 : std::unordered_map<std::string, const UniValue*> argsIn;
377 [ - + + + ]: 38 : for (size_t i=0; i<keys.size(); ++i) {
378 [ + - + + ]: 28 : auto [_, inserted] = argsIn.emplace(keys[i], &values[i]);
379 [ + + ]: 28 : if (!inserted) {
380 [ + - + - ]: 3 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Parameter " + keys[i] + " specified multiple times");
381 : : }
382 : : }
383 : : // Process expected parameters. If any parameters were left unspecified in
384 : : // the request before a parameter that was specified, null values need to be
385 : : // inserted at the unspecified parameter positions, and the "hole" variable
386 : : // below tracks the number of null values that need to be inserted.
387 : : // The "initial_hole_size" variable stores the size of the initial hole,
388 : : // i.e. how many initial positional arguments were left unspecified. This is
389 : : // used after the for-loop to add initial positional arguments from the
390 : : // "args" parameter, if present.
391 : 10 : int hole = 0;
392 : 10 : int initial_hole_size = 0;
393 : 10 : const std::string* initial_param = nullptr;
394 : 10 : UniValue options{UniValue::VOBJ};
395 [ - + + + ]: 59 : for (const auto& [argNamePattern, named_only]: argNames) {
396 [ - + + - ]: 50 : std::vector<std::string> vargNames = SplitString(argNamePattern, '|');
397 : 50 : auto fr = argsIn.end();
398 [ + + ]: 79 : for (const std::string & argName : vargNames) {
399 : 50 : fr = argsIn.find(argName);
400 [ + + ]: 50 : if (fr != argsIn.end()) {
401 : : break;
402 : : }
403 : : }
404 : :
405 : : // Handle named-only parameters by pushing them into a temporary options
406 : : // object, and then pushing the accumulated options as the next
407 : : // positional argument.
408 [ + + ]: 50 : if (named_only) {
409 [ + + ]: 10 : if (fr != argsIn.end()) {
410 [ + - - + ]: 4 : if (options.exists(fr->first)) {
411 [ # # # # ]: 0 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Parameter " + fr->first + " specified multiple times");
412 : : }
413 [ + - - + : 12 : options.pushKVEnd(fr->first, *fr->second);
+ - ]
414 : 4 : argsIn.erase(fr);
415 : : }
416 : 10 : continue;
417 : : }
418 : :
419 [ - + + + : 40 : if (!options.empty() || fr != argsIn.end()) {
+ + ]
420 [ + + ]: 29 : for (int i = 0; i < hole; ++i) {
421 : : // Fill hole between specified parameters with JSON nulls,
422 : : // but not at the end (for backwards compatibility with calls
423 : : // that act based on number of specified parameters).
424 [ + - ]: 10 : out.params.push_back(UniValue());
425 : : }
426 : 19 : hole = 0;
427 [ + + ]: 19 : if (!initial_param) initial_param = &argNamePattern;
428 : : } else {
429 : 21 : hole += 1;
430 [ - + + + ]: 21 : if (out.params.empty()) initial_hole_size = hole;
431 : : }
432 : :
433 : : // If named input parameter "fr" is present, push it onto out.params. If
434 : : // options are present, push them onto out.params. If both are present,
435 : : // throw an error.
436 [ + + ]: 40 : if (fr != argsIn.end()) {
437 [ - + + + ]: 17 : if (!options.empty()) {
438 [ + - + - : 3 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Parameter " + fr->first + " conflicts with parameter " + options.getKeys().front());
+ - + - ]
439 : : }
440 [ + - + - ]: 16 : out.params.push_back(*fr->second);
441 : 16 : argsIn.erase(fr);
442 : : }
443 [ - + + + ]: 39 : if (!options.empty()) {
444 [ + - ]: 2 : out.params.push_back(std::move(options));
445 : 2 : options = UniValue{UniValue::VOBJ};
446 : : }
447 : 50 : }
448 : : // If leftover "args" param was found, use it as a source of positional
449 : : // arguments and add named arguments after. This is a convenience for
450 : : // clients that want to pass a combination of named and positional
451 : : // arguments as described in doc/JSON-RPC-interface.md#parameter-passing
452 [ + - ]: 18 : auto positional_args{argsIn.extract("args")};
453 [ + + + - ]: 9 : if (positional_args && positional_args.mapped()->isArray()) {
454 [ - + + + : 4 : if (initial_hole_size < (int)positional_args.mapped()->size() && initial_param) {
+ + ]
455 [ + - + - ]: 6 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Parameter " + *initial_param + " specified twice both as positional and named argument");
456 : : }
457 : : // Assign positional_args to out.params and append named_args after.
458 : 2 : UniValue named_args{std::move(out.params)};
459 [ + - ]: 2 : out.params = *positional_args.mapped();
460 [ - + - + : 5 : for (size_t i{out.params.size()}; i < named_args.size(); ++i) {
+ + ]
461 [ + - + - : 3 : out.params.push_back(named_args[i]);
+ - ]
462 : : }
463 : 2 : }
464 : : // If there are still arguments in the argsIn map, this is an error.
465 [ + + ]: 7 : if (!argsIn.empty()) {
466 [ + - + - ]: 2 : throw JSONRPCError(RPC_INVALID_PARAMETER, "Unknown named parameter " + argsIn.begin()->first);
467 : : }
468 : : // Return request with named arguments transformed to positional arguments
469 [ + + ]: 6 : return out;
470 : 15 : }
471 : :
472 : 67 : static bool ExecuteCommands(const std::vector<const CRPCCommand*>& commands, const JSONRPCRequest& request, UniValue& result)
473 : : {
474 [ + - ]: 67 : for (const auto& command : commands) {
475 [ - + ]: 67 : if (ExecuteCommand(*command, request, result, &command == &commands.back())) {
476 : : return true;
477 : : }
478 : : }
479 : : return false;
480 : : }
481 : :
482 : 67 : UniValue CRPCTable::execute(const JSONRPCRequest &request) const
483 : : {
484 : : // Return immediately if in warmup
485 : 67 : {
486 : 67 : LOCK(g_rpc_warmup_mutex);
487 [ - + ]: 67 : if (fRPCInWarmup)
488 [ # # ]: 0 : throw JSONRPCError(RPC_IN_WARMUP, rpcWarmupStatus);
489 : 0 : }
490 : :
491 : : // Find method
492 : 67 : auto it = mapCommands.find(request.strMethod);
493 [ + - ]: 67 : if (it != mapCommands.end()) {
494 [ + + ]: 67 : UniValue result;
495 [ + + - + ]: 67 : if (ExecuteCommands(it->second, request, result)) {
496 : 43 : return result;
497 : : }
498 : 24 : }
499 [ # # # # ]: 0 : throw JSONRPCError(RPC_METHOD_NOT_FOUND, "Method not found");
500 : : }
501 : :
502 : 67 : static bool ExecuteCommand(const CRPCCommand& command, const JSONRPCRequest& request, UniValue& result, bool last_handler)
503 : : {
504 : 67 : try {
505 [ + - ]: 67 : RPCCommandExecution execution(request.strMethod);
506 : : // Execute, convert arguments to array if necessary
507 [ + + ]: 67 : if (request.params.isObject()) {
508 [ + + + - ]: 11 : return command.actor(transformNamedArguments(request, command.argNames), result, last_handler);
509 : : } else {
510 [ + + ]: 56 : return command.actor(request, result, last_handler);
511 : : }
512 [ + - + ]: 91 : } catch (const UniValue::type_error& e) {
513 [ - - - - ]: 0 : throw JSONRPCError(RPC_TYPE_ERROR, e.what());
514 : 6 : } catch (const std::exception& e) {
515 [ + - + - ]: 12 : throw JSONRPCError(RPC_MISC_ERROR, e.what());
516 : 6 : }
517 : : }
518 : :
519 : 0 : std::vector<std::string> CRPCTable::listCommands() const
520 : : {
521 : 0 : std::vector<std::string> commandList;
522 [ # # ]: 0 : commandList.reserve(mapCommands.size());
523 [ # # # # ]: 0 : for (const auto& i : mapCommands) commandList.emplace_back(i.first);
524 : 0 : return commandList;
525 : 0 : }
526 : :
527 : 0 : UniValue CRPCTable::dumpArgMap(const JSONRPCRequest& args_request) const
528 : : {
529 : 0 : JSONRPCRequest request = args_request;
530 : 0 : request.mode = JSONRPCRequest::GET_ARGS;
531 : :
532 : 0 : UniValue ret{UniValue::VARR};
533 [ # # ]: 0 : for (const auto& cmd : mapCommands) {
534 [ # # ]: 0 : UniValue result;
535 [ # # # # ]: 0 : if (ExecuteCommands(cmd.second, request, result)) {
536 [ # # # # ]: 0 : for (const auto& values : result.getValues()) {
537 [ # # # # ]: 0 : ret.push_back(values);
538 : : }
539 : : }
540 : 0 : }
541 : 0 : return ret;
542 : 0 : }
543 : :
544 : : CRPCTable tableRPC;
|
