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