Bitcoin Core  24.99.0
P2P Digital Currency
rpcconsole.h
Go to the documentation of this file.
1 // Copyright (c) 2011-2022 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 #ifndef BITCOIN_QT_RPCCONSOLE_H
6 #define BITCOIN_QT_RPCCONSOLE_H
7 
8 #if defined(HAVE_CONFIG_H)
10 #endif
11 
12 #include <qt/clientmodel.h>
13 #include <qt/guiutil.h>
14 #include <qt/peertablemodel.h>
15 
16 #include <net.h>
17 
18 #include <QByteArray>
19 #include <QCompleter>
20 #include <QThread>
21 #include <QWidget>
22 
23 class PlatformStyle;
24 class RPCExecutor;
25 class RPCTimerInterface;
26 class WalletModel;
27 
28 namespace interfaces {
29  class Node;
30 }
31 
32 namespace Ui {
33  class RPCConsole;
34 }
35 
36 QT_BEGIN_NAMESPACE
37 class QDateTime;
38 class QMenu;
39 class QItemSelection;
40 QT_END_NAMESPACE
41 
43 class RPCConsole: public QWidget
44 {
45  Q_OBJECT
46 
47 public:
48  explicit RPCConsole(interfaces::Node& node, const PlatformStyle *platformStyle, QWidget *parent);
49  ~RPCConsole();
50 
51  static bool RPCParseCommandLine(interfaces::Node* node, std::string &strResult, const std::string &strCommand, bool fExecute, std::string * const pstrFilteredOut = nullptr, const WalletModel* wallet_model = nullptr);
52  static bool RPCExecuteCommandLine(interfaces::Node& node, std::string &strResult, const std::string &strCommand, std::string * const pstrFilteredOut = nullptr, const WalletModel* wallet_model = nullptr) {
53  return RPCParseCommandLine(&node, strResult, strCommand, true, pstrFilteredOut, wallet_model);
54  }
55 
56  void setClientModel(ClientModel *model = nullptr, int bestblock_height = 0, int64_t bestblock_date = 0, double verification_progress = 0.0);
57 
58 #ifdef ENABLE_WALLET
59  void addWallet(WalletModel* const walletModel);
60  void removeWallet(WalletModel* const walletModel);
61 #endif // ENABLE_WALLET
62 
63  enum MessageClass {
68  CMD_ERROR
69  };
70 
71  enum class TabTypes {
72  INFO,
73  CONSOLE,
74  GRAPH,
75  PEERS
76  };
77 
78  std::vector<TabTypes> tabs() const { return {TabTypes::INFO, TabTypes::CONSOLE, TabTypes::GRAPH, TabTypes::PEERS}; }
79 
80  QString tabTitle(TabTypes tab_type) const;
81  QKeySequence tabShortcut(TabTypes tab_type) const;
82 
83 protected:
84  virtual bool eventFilter(QObject* obj, QEvent *event) override;
85  void keyPressEvent(QKeyEvent *) override;
86  void changeEvent(QEvent* e) override;
87 
88 private Q_SLOTS:
90  void on_tabWidget_currentChanged(int index);
94  void on_sldGraphRange_valueChanged(int value);
96  void updateTrafficStats(quint64 totalBytesIn, quint64 totalBytesOut);
97  void resizeEvent(QResizeEvent *event) override;
98  void showEvent(QShowEvent *event) override;
99  void hideEvent(QHideEvent *event) override;
101  void showPeersTableContextMenu(const QPoint& point);
103  void showBanTableContextMenu(const QPoint& point);
107  void clearSelectedNode();
109  void updateDetailWidget();
110 
111 public Q_SLOTS:
112  void clear(bool keep_prompt = false);
113  void fontBigger();
114  void fontSmaller();
115  void setFontSize(int newSize);
117  void message(int category, const QString &msg) { message(category, msg, false); }
118  void message(int category, const QString &message, bool html);
120  void setNumConnections(int count);
122  void setNetworkActive(bool networkActive);
124  void setNumBlocks(int count, const QDateTime& blockDate, double nVerificationProgress, SyncType synctype);
126  void setMempoolSize(long numberOfTxs, size_t dynUsage);
128  void browseHistory(int offset);
130  void scrollToEnd();
132  void disconnectSelectedNode();
134  void banSelectedNode(int bantime);
136  void unbanSelectedNode();
138  void setTabFocus(enum TabTypes tabType);
139 
140 private:
142  const QString yes{tr("Yes")}, no{tr("No")}, to{tr("To")}, from{tr("From")},
143  ban_for{tr("Ban for")}, na{tr("N/A")}, unknown{tr("Unknown")};
144  } const ts;
145 
146  void startExecutor();
147  void setTrafficGraphRange(int mins);
148 
150  {
156 
157  };
158 
160  Ui::RPCConsole* const ui;
162  QStringList history;
163  int historyPtr = 0;
165  QList<NodeId> cachedNodeids;
168  QMenu *peersTableContextMenu = nullptr;
169  QMenu *banTableContextMenu = nullptr;
171  QCompleter *autoCompleter = nullptr;
172  QThread thread;
175  bool m_is_executing{false};
178 
180  void updateNetworkState();
181 
183  QString TimeDurationField(std::chrono::seconds time_now, std::chrono::seconds time_at_event) const
184  {
185  return time_at_event.count() ? GUIUtil::formatDurationStr(time_now - time_at_event) : tr("Never");
186  }
187 
188 private Q_SLOTS:
189  void updateAlerts(const QString& warnings);
190 };
191 
192 #endif // BITCOIN_QT_RPCCONSOLE_H
Model for Bitcoin network client.
Definition: clientmodel.h:55
Local Bitcoin RPC console.
Definition: rpcconsole.h:44
QMenu * peersTableContextMenu
Definition: rpcconsole.h:168
RPCConsole(interfaces::Node &node, const PlatformStyle *platformStyle, QWidget *parent)
Definition: rpcconsole.cpp:467
struct RPCConsole::TranslatedStrings ts
void browseHistory(int offset)
Go forward or back in history.
QByteArray m_banlist_widget_header_state
Definition: rpcconsole.h:177
void fontSmaller()
Definition: rpcconsole.cpp:819
RPCTimerInterface * rpcTimerInterface
Definition: rpcconsole.h:167
QString TimeDurationField(std::chrono::seconds time_now, std::chrono::seconds time_at_event) const
Helper for the output of a time duration field.
Definition: rpcconsole.h:183
void on_lineEdit_returnPressed()
Definition: rpcconsole.cpp:994
QStringList history
Definition: rpcconsole.h:162
void message(int category, const QString &msg)
Append the message to the message widget.
Definition: rpcconsole.h:117
void setFontSize(int newSize)
Definition: rpcconsole.cpp:824
void updateTrafficStats(quint64 totalBytesIn, quint64 totalBytesOut)
update traffic statistics
void setTrafficGraphRange(int mins)
static bool RPCParseCommandLine(interfaces::Node *node, std::string &strResult, const std::string &strCommand, bool fExecute, std::string *const pstrFilteredOut=nullptr, const WalletModel *wallet_model=nullptr)
Split shell command line into a list of arguments and optionally execute the command(s).
Definition: rpcconsole.cpp:169
const PlatformStyle *const platformStyle
Definition: rpcconsole.h:166
void updateDetailWidget()
show detailed information on ui about selected node
void showEvent(QShowEvent *event) override
void resizeEvent(QResizeEvent *event) override
static bool RPCExecuteCommandLine(interfaces::Node &node, std::string &strResult, const std::string &strCommand, std::string *const pstrFilteredOut=nullptr, const WalletModel *wallet_model=nullptr)
Definition: rpcconsole.h:52
QString tabTitle(TabTypes tab_type) const
void updateNetworkState()
Update UI with latest network info from model.
Definition: rpcconsole.cpp:950
void clear(bool keep_prompt=false)
Definition: rpcconsole.cpp:849
void disconnectSelectedNode()
Disconnect a selected node on the Peers tab.
std::vector< TabTypes > tabs() const
Definition: rpcconsole.h:78
@ BANTIME_COLUMN_WIDTH
Definition: rpcconsole.h:155
@ ADDRESS_COLUMN_WIDTH
Definition: rpcconsole.h:151
@ SUBVERSION_COLUMN_WIDTH
Definition: rpcconsole.h:152
@ PING_COLUMN_WIDTH
Definition: rpcconsole.h:153
@ BANSUBNET_COLUMN_WIDTH
Definition: rpcconsole.h:154
QCompleter * autoCompleter
Definition: rpcconsole.h:171
void setMempoolSize(long numberOfTxs, size_t dynUsage)
Set size (number of transactions and memory usage) of the mempool in the UI.
Definition: rpcconsole.cpp:984
void hideEvent(QHideEvent *event) override
QKeySequence tabShortcut(TabTypes tab_type) const
void showPeersTableContextMenu(const QPoint &point)
Show custom context menu on Peers tab.
QList< NodeId > cachedNodeids
Definition: rpcconsole.h:165
bool m_is_executing
Definition: rpcconsole.h:175
interfaces::Node & m_node
Definition: rpcconsole.h:159
void unbanSelectedNode()
Unban a selected node on the Bans tab.
void updateAlerts(const QString &warnings)
void clearSelectedNode()
clear the selected node
void on_sldGraphRange_valueChanged(int value)
change the time range of the network traffic graph
int consoleFontSize
Definition: rpcconsole.h:170
void setNumConnections(int count)
Set number of connections shown in the UI.
Definition: rpcconsole.cpp:963
void setNumBlocks(int count, const QDateTime &blockDate, double nVerificationProgress, SyncType synctype)
Set number of blocks and last block date shown in the UI.
Definition: rpcconsole.cpp:976
ClientModel * clientModel
Definition: rpcconsole.h:161
void banSelectedNode(int bantime)
Ban a selected node on the Peers tab.
int historyPtr
Definition: rpcconsole.h:163
void scrollToEnd()
Scroll console view to end.
void keyPressEvent(QKeyEvent *) override
Definition: rpcconsole.cpp:908
void on_tabWidget_currentChanged(int index)
Ui::RPCConsole *const ui
Definition: rpcconsole.h:160
void startExecutor()
void setNetworkActive(bool networkActive)
Set network state shown in the UI.
Definition: rpcconsole.cpp:971
void fontBigger()
Definition: rpcconsole.cpp:814
QString cmdBeforeBrowsing
Definition: rpcconsole.h:164
virtual bool eventFilter(QObject *obj, QEvent *event) override
Definition: rpcconsole.cpp:600
void on_openDebugLogfileButton_clicked()
open the debug.log from the current datadir
void showBanTableContextMenu(const QPoint &point)
Show custom context menu on Bans tab.
void setClientModel(ClientModel *model=nullptr, int bestblock_height=0, int64_t bestblock_date=0, double verification_progress=0.0)
Definition: rpcconsole.cpp:644
void setTabFocus(enum TabTypes tabType)
set which tab has the focus (is visible)
QByteArray m_peer_widget_header_state
Definition: rpcconsole.h:176
void changeEvent(QEvent *e) override
Definition: rpcconsole.cpp:915
WalletModel * m_last_wallet_model
Definition: rpcconsole.h:174
void showOrHideBanTableIfRequired()
Hides ban table if no bans are present.
RPCExecutor * m_executor
Definition: rpcconsole.h:173
QMenu * banTableContextMenu
Definition: rpcconsole.h:169
QThread thread
Definition: rpcconsole.h:172
RPC timer "driver".
Definition: server.h:60
Interface to Bitcoin wallet from Qt view code.
Definition: walletmodel.h:53
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:70
SyncType
Definition: clientmodel.h:40
QString formatDurationStr(std::chrono::seconds dur)
Convert seconds into a QString with days, hours, mins, secs.
Definition: guiutil.cpp:715
Definition: init.h:25
static int count
Definition: tests.c:34