mirror of
https://github.com/bitcoin/bitcoin.git
synced 2025-01-25 10:43:19 -03:00
Merge bitcoin/bitcoin#26196: kernel: move RunCommandParseJSON to its own file
43b8777dc3
refactor: move run_command from util to common (Cory Fields)192325a77d
kernel: move RunCommandParseJSON to its own file (Cory Fields) Pull request description: Because libbitcoinkernel does not include this new object, this has the side-effect of eliminating its unnecessary `boost::process` dependency. This leaves libbitcoinkernel with 3 remaining boost dependencies: - `boost::date_time` for `util/time.cpp`, which I'll separate out next. Exactly like this PR. - `boost::signals2` for which I have a POC re-implementation here: https://github.com/theuni/bitcoin/commits/replace-boost-signals - `boost::multi_index` which I'm not sure about yet. ACKs for top commit: ryanofsky: Code review ACK43b8777dc3
. Could consider squashing the two commits, so the code just moves once instead of twice. fanquake: ACK43b8777dc3
Tree-SHA512: f2a46cac34aaadfb8a1442316152ad354f6990021b82c78d80cae9fd43cd026209ffd62132eaa99d5d0f8cf34e996b6737d318a9d9a3f1d2ff8d17d697abf26d
This commit is contained in:
commit
866dd664a1
7 changed files with 90 additions and 62 deletions
|
@ -133,6 +133,7 @@ BITCOIN_CORE_H = \
|
|||
clientversion.h \
|
||||
coins.h \
|
||||
common/bloom.h \
|
||||
common/run_command.h \
|
||||
compat/assumptions.h \
|
||||
compat/byteswap.h \
|
||||
compat/compat.h \
|
||||
|
@ -616,7 +617,7 @@ libbitcoin_consensus_a_SOURCES = \
|
|||
version.h
|
||||
|
||||
# common: shared between bitcoind, and bitcoin-qt and non-server tools
|
||||
libbitcoin_common_a_CPPFLAGS = $(AM_CPPFLAGS) $(BITCOIN_INCLUDES)
|
||||
libbitcoin_common_a_CPPFLAGS = $(AM_CPPFLAGS) $(BITCOIN_INCLUDES) $(BOOST_CPPFLAGS)
|
||||
libbitcoin_common_a_CXXFLAGS = $(AM_CXXFLAGS) $(PIE_FLAGS)
|
||||
libbitcoin_common_a_SOURCES = \
|
||||
base58.cpp \
|
||||
|
@ -624,6 +625,7 @@ libbitcoin_common_a_SOURCES = \
|
|||
chainparams.cpp \
|
||||
coins.cpp \
|
||||
common/bloom.cpp \
|
||||
common/run_command.cpp \
|
||||
compressor.cpp \
|
||||
core_read.cpp \
|
||||
core_write.cpp \
|
||||
|
|
64
src/common/run_command.cpp
Normal file
64
src/common/run_command.cpp
Normal file
|
@ -0,0 +1,64 @@
|
|||
// Copyright (c) 2022 The Bitcoin Core developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#if defined(HAVE_CONFIG_H)
|
||||
#include <config/bitcoin-config.h>
|
||||
#endif
|
||||
|
||||
#include <common/run_command.h>
|
||||
|
||||
#include <tinyformat.h>
|
||||
#include <univalue.h>
|
||||
|
||||
#ifdef ENABLE_EXTERNAL_SIGNER
|
||||
#if defined(__GNUC__)
|
||||
// Boost 1.78 requires the following workaround.
|
||||
// See: https://github.com/boostorg/process/issues/235
|
||||
#pragma GCC diagnostic push
|
||||
#pragma GCC diagnostic ignored "-Wnarrowing"
|
||||
#endif
|
||||
#include <boost/process.hpp>
|
||||
#if defined(__GNUC__)
|
||||
#pragma GCC diagnostic pop
|
||||
#endif
|
||||
#endif // ENABLE_EXTERNAL_SIGNER
|
||||
|
||||
UniValue RunCommandParseJSON(const std::string& str_command, const std::string& str_std_in)
|
||||
{
|
||||
#ifdef ENABLE_EXTERNAL_SIGNER
|
||||
namespace bp = boost::process;
|
||||
|
||||
UniValue result_json;
|
||||
bp::opstream stdin_stream;
|
||||
bp::ipstream stdout_stream;
|
||||
bp::ipstream stderr_stream;
|
||||
|
||||
if (str_command.empty()) return UniValue::VNULL;
|
||||
|
||||
bp::child c(
|
||||
str_command,
|
||||
bp::std_out > stdout_stream,
|
||||
bp::std_err > stderr_stream,
|
||||
bp::std_in < stdin_stream
|
||||
);
|
||||
if (!str_std_in.empty()) {
|
||||
stdin_stream << str_std_in << std::endl;
|
||||
}
|
||||
stdin_stream.pipe().close();
|
||||
|
||||
std::string result;
|
||||
std::string error;
|
||||
std::getline(stdout_stream, result);
|
||||
std::getline(stderr_stream, error);
|
||||
|
||||
c.wait();
|
||||
const int n_error = c.exit_code();
|
||||
if (n_error) throw std::runtime_error(strprintf("RunCommandParseJSON error: process(%s) returned %d: %s\n", str_command, n_error, error));
|
||||
if (!result_json.read(result)) throw std::runtime_error("Unable to parse JSON: " + result);
|
||||
|
||||
return result_json;
|
||||
#else
|
||||
throw std::runtime_error("Compiled without external signing support (required for external signing).");
|
||||
#endif // ENABLE_EXTERNAL_SIGNER
|
||||
}
|
21
src/common/run_command.h
Normal file
21
src/common/run_command.h
Normal file
|
@ -0,0 +1,21 @@
|
|||
// Copyright (c) 2022 The Bitcoin Core developers
|
||||
// Distributed under the MIT software license, see the accompanying
|
||||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#ifndef BITCOIN_COMMON_RUN_COMMAND_H
|
||||
#define BITCOIN_COMMON_RUN_COMMAND_H
|
||||
|
||||
#include <string>
|
||||
|
||||
class UniValue;
|
||||
|
||||
/**
|
||||
* Execute a command which returns JSON, and parse the result.
|
||||
*
|
||||
* @param str_command The command to execute, including any arguments
|
||||
* @param str_std_in string to pass to stdin
|
||||
* @return parsed JSON
|
||||
*/
|
||||
UniValue RunCommandParseJSON(const std::string& str_command, const std::string& str_std_in="");
|
||||
|
||||
#endif // BITCOIN_COMMON_RUN_COMMAND_H
|
|
@ -3,10 +3,10 @@
|
|||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
|
||||
#include <chainparams.h>
|
||||
#include <common/run_command.h>
|
||||
#include <core_io.h>
|
||||
#include <psbt.h>
|
||||
#include <util/strencodings.h>
|
||||
#include <util/system.h>
|
||||
#include <external_signer.h>
|
||||
|
||||
#include <algorithm>
|
||||
|
|
|
@ -3,7 +3,7 @@
|
|||
// file COPYING or http://www.opensource.org/licenses/mit-license.php.
|
||||
//
|
||||
#include <test/util/setup_common.h>
|
||||
#include <util/system.h>
|
||||
#include <common/run_command.h>
|
||||
#include <univalue.h>
|
||||
|
||||
#ifdef ENABLE_EXTERNAL_SIGNER
|
||||
|
|
|
@ -5,19 +5,6 @@
|
|||
|
||||
#include <util/system.h>
|
||||
|
||||
#ifdef ENABLE_EXTERNAL_SIGNER
|
||||
#if defined(__GNUC__)
|
||||
// Boost 1.78 requires the following workaround.
|
||||
// See: https://github.com/boostorg/process/issues/235
|
||||
#pragma GCC diagnostic push
|
||||
#pragma GCC diagnostic ignored "-Wnarrowing"
|
||||
#endif
|
||||
#include <boost/process.hpp>
|
||||
#if defined(__GNUC__)
|
||||
#pragma GCC diagnostic pop
|
||||
#endif
|
||||
#endif // ENABLE_EXTERNAL_SIGNER
|
||||
|
||||
#include <chainparamsbase.h>
|
||||
#include <fs.h>
|
||||
#include <sync.h>
|
||||
|
@ -1332,44 +1319,6 @@ void runCommand(const std::string& strCommand)
|
|||
}
|
||||
#endif
|
||||
|
||||
UniValue RunCommandParseJSON(const std::string& str_command, const std::string& str_std_in)
|
||||
{
|
||||
#ifdef ENABLE_EXTERNAL_SIGNER
|
||||
namespace bp = boost::process;
|
||||
|
||||
UniValue result_json;
|
||||
bp::opstream stdin_stream;
|
||||
bp::ipstream stdout_stream;
|
||||
bp::ipstream stderr_stream;
|
||||
|
||||
if (str_command.empty()) return UniValue::VNULL;
|
||||
|
||||
bp::child c(
|
||||
str_command,
|
||||
bp::std_out > stdout_stream,
|
||||
bp::std_err > stderr_stream,
|
||||
bp::std_in < stdin_stream
|
||||
);
|
||||
if (!str_std_in.empty()) {
|
||||
stdin_stream << str_std_in << std::endl;
|
||||
}
|
||||
stdin_stream.pipe().close();
|
||||
|
||||
std::string result;
|
||||
std::string error;
|
||||
std::getline(stdout_stream, result);
|
||||
std::getline(stderr_stream, error);
|
||||
|
||||
c.wait();
|
||||
const int n_error = c.exit_code();
|
||||
if (n_error) throw std::runtime_error(strprintf("RunCommandParseJSON error: process(%s) returned %d: %s\n", str_command, n_error, error));
|
||||
if (!result_json.read(result)) throw std::runtime_error("Unable to parse JSON: " + result);
|
||||
|
||||
return result_json;
|
||||
#else
|
||||
throw std::runtime_error("Compiled without external signing support (required for external signing).");
|
||||
#endif // ENABLE_EXTERNAL_SIGNER
|
||||
}
|
||||
|
||||
void SetupEnvironment()
|
||||
{
|
||||
|
|
|
@ -107,14 +107,6 @@ std::string ShellEscape(const std::string& arg);
|
|||
#if HAVE_SYSTEM
|
||||
void runCommand(const std::string& strCommand);
|
||||
#endif
|
||||
/**
|
||||
* Execute a command which returns JSON, and parse the result.
|
||||
*
|
||||
* @param str_command The command to execute, including any arguments
|
||||
* @param str_std_in string to pass to stdin
|
||||
* @return parsed JSON
|
||||
*/
|
||||
UniValue RunCommandParseJSON(const std::string& str_command, const std::string& str_std_in="");
|
||||
|
||||
/**
|
||||
* Most paths passed as configuration arguments are treated as relative to
|
||||
|
|
Loading…
Add table
Reference in a new issue