diff --git a/src/rpc/server.h b/src/rpc/server.h index 6a9357d6a..f8d27b34d 100644 --- a/src/rpc/server.h +++ b/src/rpc/server.h @@ -1,254 +1,268 @@ // Copyright (c) 2010 Satoshi Nakamoto // Copyright (c) 2009-2016 The Bitcoin Core developers // Copyright (c) 2017-2019 The Bitcoin developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #ifndef BITCOIN_RPC_SERVER_H #define BITCOIN_RPC_SERVER_H #include #include #include +#include #include #include #include #include #include #include #include static const unsigned int DEFAULT_RPC_SERIALIZE_VERSION = 1; class CRPCCommand; namespace RPCServerSignals { void OnStarted(std::function slot); void OnStopped(std::function slot); } // namespace RPCServerSignals class Config; typedef std::map> RPCCommandMap; /** * Class for registering and managing all RPC calls. */ class RPCServer { private: RWCollection commands; public: RPCServer() {} RPCServer(const RPCServer &) = delete; RPCServer &operator=(const RPCServer &) = delete; /** * Attempts to execute an RPC command from the given request. * If no RPC command exists that matches the request, an error is returned. */ UniValue ExecuteCommand(Config &config, const JSONRPCRequest &request) const; /** * Register an RPC command. */ void RegisterCommand(std::unique_ptr command); }; /** * Query whether RPC is running */ bool IsRPCRunning(); /** Throw JSONRPCError if RPC is not running */ void RpcInterruptionPoint(); /** * Set the RPC warmup status. When this is done, all RPC calls will error out * immediately with RPC_IN_WARMUP. */ void SetRPCWarmupStatus(const std::string &newStatus); /** * Mark warmup as done. RPC calls will be processed from now on. */ void SetRPCWarmupFinished(); /** * Returns the current warmup state */ bool RPCIsInWarmup(std::string *outStatus); /** * Opaque base class for timers returned by NewTimerFunc. * This provides no methods at the moment, but makes sure that delete cleans up * the whole state. */ class RPCTimerBase { public: virtual ~RPCTimerBase() {} }; /** * RPC timer "driver". */ class RPCTimerInterface { public: virtual ~RPCTimerInterface() {} /** * Implementation name */ virtual const char *Name() = 0; /** * Factory function for timers. * RPC will call the function to create a timer that will call func in * *millis* milliseconds. * @note As the RPC mechanism is backend-neutral, it can use different * implementations of timers. * This is needed to cope with the case in which there is no HTTP server, * but only GUI RPC console, and to break the dependency of pcserver on * httprpc. */ virtual RPCTimerBase *NewTimer(std::function &func, int64_t millis) = 0; }; /** * Set the factory function for timers */ void RPCSetTimerInterface(RPCTimerInterface *iface); /** * Set the factory function for timer, but only, if unset */ void RPCSetTimerInterfaceIfUnset(RPCTimerInterface *iface); /** * Unset factory function for timers */ void RPCUnsetTimerInterface(RPCTimerInterface *iface); /** * Run func nSeconds from now. * Overrides previous timer (if any). */ void RPCRunLater(const std::string &name, std::function func, int64_t nSeconds); using rpcfn_type = UniValue (*)(Config &config, const JSONRPCRequest &jsonRequest); using const_rpcfn_type = UniValue (*)(const Config &config, const JSONRPCRequest &jsonRequest); +using RpcMethodFnType = RPCHelpMan (*)(); class CRPCCommand { public: //! RPC method handler reading request and assigning result. Should return //! true if request is fully handled, false if it should be passed on to //! subsequent handlers. using Actor = std::function; //! Constructor taking Actor callback supporting multiple handlers. CRPCCommand(std::string _category, std::string _name, Actor _actor, std::vector _args, intptr_t _unique_id) : category(std::move(_category)), name(std::move(_name)), actor(std::move(_actor)), argNames(std::move(_args)), unique_id(_unique_id) {} + //! Simplified constructor taking plain RpcMethodFnType function pointer. + CRPCCommand(std::string _category, std::string name_in, RpcMethodFnType _fn, + std::vector args_in) + : CRPCCommand( + _category, _fn().m_name, + [_fn](Config &config, const JSONRPCRequest &request, + UniValue &result, bool) { + result = _fn().HandleRequest(config, request); + return true; + }, + _fn().GetArgNames(), intptr_t(_fn)) {} + //! Simplified constructor taking plain rpcfn_type function pointer. CRPCCommand(const char *_category, const char *_name, rpcfn_type _fn, std::initializer_list _args) : CRPCCommand( _category, _name, [_fn](Config &config, const JSONRPCRequest &request, UniValue &result, bool) { result = _fn(config, request); return true; }, {_args.begin(), _args.end()}, intptr_t(_fn)) {} //! Simplified constructor taking plain const_rpcfn_type function pointer. CRPCCommand(const char *_category, const char *_name, const_rpcfn_type _fn, std::initializer_list _args) : CRPCCommand( _category, _name, [_fn](const Config &config, const JSONRPCRequest &request, UniValue &result, bool) { result = _fn(config, request); return true; }, {_args.begin(), _args.end()}, intptr_t(_fn)) {} std::string category; std::string name; Actor actor; std::vector argNames; intptr_t unique_id; }; /** - * Bitcoin RPC command dispatcher. + * RPC command dispatcher. */ class CRPCTable { private: std::map> mapCommands; public: CRPCTable(); std::string help(Config &config, const std::string &name, const JSONRPCRequest &helpreq) const; /** * Execute a method. * @param request The JSONRPCRequest to execute * @returns Result of the call. * @throws an exception (UniValue) when an error happens. */ UniValue execute(Config &config, const JSONRPCRequest &request) const; /** * Returns a list of registered commands * @returns List of registered commands. */ std::vector listCommands() const; /** * Appends a CRPCCommand to the dispatch table. * * Returns false if RPC server is already running (dump concurrency * protection). * * Commands with different method names but the same unique_id will * be considered aliases, and only the first registered method name will * show up in the help text command listing. Aliased commands do not have * to have the same behavior. Server and client code can distinguish * between calls based on method name, and aliased commands can also * register different names, types, and numbers of parameters. */ bool appendCommand(const std::string &name, const CRPCCommand *pcmd); bool removeCommand(const std::string &name, const CRPCCommand *pcmd); }; bool IsDeprecatedRPCEnabled(const ArgsManager &args, const std::string &method); extern CRPCTable tableRPC; void StartRPC(); void InterruptRPC(); void StopRPC(); std::string JSONRPCExecBatch(Config &config, RPCServer &rpcServer, const JSONRPCRequest &req, const UniValue &vReq); /** * Retrieves any serialization flags requested in command line argument */ int RPCSerializationFlags(); #endif // BITCOIN_RPC_SERVER_H diff --git a/src/rpc/util.cpp b/src/rpc/util.cpp index 56ae2dcc9..ffb948739 100644 --- a/src/rpc/util.cpp +++ b/src/rpc/util.cpp @@ -1,927 +1,942 @@ // Copyright (c) 2017-2019 The Bitcoin Core developers // Distributed under the MIT software license, see the accompanying // file COPYING or http://www.opensource.org/licenses/mit-license.php. #include #include #include