Bitcoin Core 30.99.0
P2P Digital Currency
rpcconsole.cpp
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#include <bitcoin-build-config.h> // IWYU pragma: keep
6
7#include <qt/rpcconsole.h>
8#include <qt/forms/ui_debugwindow.h>
9
10#include <chainparams.h>
11#include <common/system.h>
12#include <interfaces/node.h>
14#include <qt/bantablemodel.h>
15#include <qt/clientmodel.h>
16#include <qt/guiutil.h>
18#include <qt/platformstyle.h>
19#ifdef ENABLE_WALLET
20#include <qt/walletmodel.h>
21#endif // ENABLE_WALLET
22#include <rpc/client.h>
23#include <rpc/server.h>
24#include <util/strencodings.h>
25#include <util/string.h>
26#include <util/time.h>
27#include <util/threadnames.h>
28
29#include <univalue.h>
30
31#include <QAbstractButton>
32#include <QAbstractItemModel>
33#include <QDateTime>
34#include <QFont>
35#include <QKeyEvent>
36#include <QKeySequence>
37#include <QLatin1String>
38#include <QLocale>
39#include <QMenu>
40#include <QMessageBox>
41#include <QScreen>
42#include <QScrollBar>
43#include <QSettings>
44#include <QString>
45#include <QStringList>
46#include <QStyledItemDelegate>
47#include <QTime>
48#include <QTimer>
49#include <QVariant>
50
51#include <chrono>
52
53using util::Join;
54
55const int CONSOLE_HISTORY = 50;
57const QSize FONT_RANGE(4, 40);
58const char fontSizeSettingsKey[] = "consoleFontSize";
59
60const struct {
61 const char *url;
62 const char *source;
63} ICON_MAPPING[] = {
64 {"cmd-request", ":/icons/tx_input"},
65 {"cmd-reply", ":/icons/tx_output"},
66 {"cmd-error", ":/icons/tx_output"},
67 {"misc", ":/icons/tx_inout"},
68 {nullptr, nullptr}
69};
70
71namespace {
72
73// don't add private key handling cmd's to the history
74const QStringList historyFilter = QStringList()
75 << "createwallet"
76 << "createwalletdescriptor"
77 << "migratewallet"
78 << "signmessagewithprivkey"
79 << "signrawtransactionwithkey"
80 << "walletpassphrase"
81 << "walletpassphrasechange"
82 << "encryptwallet";
83
84}
85
86/* Object for executing console RPC commands in a separate thread.
87*/
88class RPCExecutor : public QObject
89{
90 Q_OBJECT
91public:
93
94public Q_SLOTS:
95 void request(const QString &command, const QString& wallet_name);
96
97Q_SIGNALS:
98 void reply(int category, const QString &command);
99
100private:
102};
103
104class PeerIdViewDelegate : public QStyledItemDelegate
105{
106 Q_OBJECT
107public:
108 explicit PeerIdViewDelegate(QObject* parent = nullptr)
109 : QStyledItemDelegate(parent) {}
110
111 QString displayText(const QVariant& value, const QLocale& locale) const override
112 {
113 // Additional spaces should visually separate right-aligned content
114 // from the next column to the right.
115 return value.toString() + QLatin1String(" ");
116 }
117};
118
119#include <qt/rpcconsole.moc>
120
141bool RPCConsole::RPCParseCommandLine(interfaces::Node* node, std::string &strResult, const std::string &strCommand, const bool fExecute, std::string * const pstrFilteredOut, const QString& wallet_name)
142{
143 std::vector< std::vector<std::string> > stack;
144 stack.emplace_back();
145
146 enum CmdParseState
147 {
148 STATE_EATING_SPACES,
149 STATE_EATING_SPACES_IN_ARG,
150 STATE_EATING_SPACES_IN_BRACKETS,
151 STATE_ARGUMENT,
152 STATE_SINGLEQUOTED,
153 STATE_DOUBLEQUOTED,
154 STATE_ESCAPE_OUTER,
155 STATE_ESCAPE_DOUBLEQUOTED,
156 STATE_COMMAND_EXECUTED,
157 STATE_COMMAND_EXECUTED_INNER
158 } state = STATE_EATING_SPACES;
159 std::string curarg;
160 UniValue lastResult;
161 unsigned nDepthInsideSensitive = 0;
162 size_t filter_begin_pos = 0, chpos;
163 std::vector<std::pair<size_t, size_t>> filter_ranges;
164
165 auto add_to_current_stack = [&](const std::string& strArg) {
166 if (stack.back().empty() && (!nDepthInsideSensitive) && historyFilter.contains(QString::fromStdString(strArg), Qt::CaseInsensitive)) {
167 nDepthInsideSensitive = 1;
168 filter_begin_pos = chpos;
169 }
170 // Make sure stack is not empty before adding something
171 if (stack.empty()) {
172 stack.emplace_back();
173 }
174 stack.back().push_back(strArg);
175 };
176
177 auto close_out_params = [&]() {
178 if (nDepthInsideSensitive) {
179 if (!--nDepthInsideSensitive) {
180 assert(filter_begin_pos);
181 filter_ranges.emplace_back(filter_begin_pos, chpos);
182 filter_begin_pos = 0;
183 }
184 }
185 stack.pop_back();
186 };
187
188 std::string strCommandTerminated = strCommand;
189 if (strCommandTerminated.back() != '\n')
190 strCommandTerminated += "\n";
191 for (chpos = 0; chpos < strCommandTerminated.size(); ++chpos)
192 {
193 char ch = strCommandTerminated[chpos];
194 switch(state)
195 {
196 case STATE_COMMAND_EXECUTED_INNER:
197 case STATE_COMMAND_EXECUTED:
198 {
199 bool breakParsing = true;
200 switch(ch)
201 {
202 case '[': curarg.clear(); state = STATE_COMMAND_EXECUTED_INNER; break;
203 default:
204 if (state == STATE_COMMAND_EXECUTED_INNER)
205 {
206 if (ch != ']')
207 {
208 // append char to the current argument (which is also used for the query command)
209 curarg += ch;
210 break;
211 }
212 if (curarg.size() && fExecute)
213 {
214 // if we have a value query, query arrays with index and objects with a string key
215 UniValue subelement;
216 if (lastResult.isArray())
217 {
218 const auto parsed{ToIntegral<size_t>(curarg)};
219 if (!parsed) {
220 throw std::runtime_error("Invalid result query");
221 }
222 subelement = lastResult[parsed.value()];
223 }
224 else if (lastResult.isObject())
225 subelement = lastResult.find_value(curarg);
226 else
227 throw std::runtime_error("Invalid result query"); //no array or object: abort
228 lastResult = subelement;
229 }
230
231 state = STATE_COMMAND_EXECUTED;
232 break;
233 }
234 // don't break parsing when the char is required for the next argument
235 breakParsing = false;
236
237 // pop the stack and return the result to the current command arguments
238 close_out_params();
239
240 // don't stringify the json in case of a string to avoid doublequotes
241 if (lastResult.isStr())
242 curarg = lastResult.get_str();
243 else
244 curarg = lastResult.write(2);
245
246 // if we have a non empty result, use it as stack argument otherwise as general result
247 if (curarg.size())
248 {
249 if (stack.size())
250 add_to_current_stack(curarg);
251 else
252 strResult = curarg;
253 }
254 curarg.clear();
255 // assume eating space state
256 state = STATE_EATING_SPACES;
257 }
258 if (breakParsing)
259 break;
260 [[fallthrough]];
261 }
262 case STATE_ARGUMENT: // In or after argument
263 case STATE_EATING_SPACES_IN_ARG:
264 case STATE_EATING_SPACES_IN_BRACKETS:
265 case STATE_EATING_SPACES: // Handle runs of whitespace
266 switch(ch)
267 {
268 case '"': state = STATE_DOUBLEQUOTED; break;
269 case '\'': state = STATE_SINGLEQUOTED; break;
270 case '\\': state = STATE_ESCAPE_OUTER; break;
271 case '(': case ')': case '\n':
272 if (state == STATE_EATING_SPACES_IN_ARG)
273 throw std::runtime_error("Invalid Syntax");
274 if (state == STATE_ARGUMENT)
275 {
276 if (ch == '(' && stack.size() && stack.back().size() > 0)
277 {
278 if (nDepthInsideSensitive) {
279 ++nDepthInsideSensitive;
280 }
281 stack.emplace_back();
282 }
283
284 // don't allow commands after executed commands on baselevel
285 if (!stack.size())
286 throw std::runtime_error("Invalid Syntax");
287
288 add_to_current_stack(curarg);
289 curarg.clear();
290 state = STATE_EATING_SPACES_IN_BRACKETS;
291 }
292 if ((ch == ')' || ch == '\n') && stack.size() > 0)
293 {
294 if (fExecute) {
295 // Convert argument list to JSON objects in method-dependent way,
296 // and pass it along with the method name to the dispatcher.
297 UniValue params = RPCConvertValues(stack.back()[0], std::vector<std::string>(stack.back().begin() + 1, stack.back().end()));
298 std::string method = stack.back()[0];
299 std::string uri;
300 if (!wallet_name.isEmpty()) {
301 QByteArray encodedName = QUrl::toPercentEncoding(wallet_name);
302 uri = "/wallet/"+std::string(encodedName.constData(), encodedName.length());
303 }
304 assert(node);
305 lastResult = node->executeRpc(method, params, uri);
306 }
307
308 state = STATE_COMMAND_EXECUTED;
309 curarg.clear();
310 }
311 break;
312 case ' ': case ',': case '\t':
313 if(state == STATE_EATING_SPACES_IN_ARG && curarg.empty() && ch == ',')
314 throw std::runtime_error("Invalid Syntax");
315
316 else if(state == STATE_ARGUMENT) // Space ends argument
317 {
318 add_to_current_stack(curarg);
319 curarg.clear();
320 }
321 if ((state == STATE_EATING_SPACES_IN_BRACKETS || state == STATE_ARGUMENT) && ch == ',')
322 {
323 state = STATE_EATING_SPACES_IN_ARG;
324 break;
325 }
326 state = STATE_EATING_SPACES;
327 break;
328 default: curarg += ch; state = STATE_ARGUMENT;
329 }
330 break;
331 case STATE_SINGLEQUOTED: // Single-quoted string
332 switch(ch)
333 {
334 case '\'': state = STATE_ARGUMENT; break;
335 default: curarg += ch;
336 }
337 break;
338 case STATE_DOUBLEQUOTED: // Double-quoted string
339 switch(ch)
340 {
341 case '"': state = STATE_ARGUMENT; break;
342 case '\\': state = STATE_ESCAPE_DOUBLEQUOTED; break;
343 default: curarg += ch;
344 }
345 break;
346 case STATE_ESCAPE_OUTER: // '\' outside quotes
347 curarg += ch; state = STATE_ARGUMENT;
348 break;
349 case STATE_ESCAPE_DOUBLEQUOTED: // '\' in double-quoted text
350 if(ch != '"' && ch != '\\') curarg += '\\'; // keep '\' for everything but the quote and '\' itself
351 curarg += ch; state = STATE_DOUBLEQUOTED;
352 break;
353 }
354 }
355 if (pstrFilteredOut) {
356 if (STATE_COMMAND_EXECUTED == state) {
357 assert(!stack.empty());
358 close_out_params();
359 }
360 *pstrFilteredOut = strCommand;
361 for (auto i = filter_ranges.rbegin(); i != filter_ranges.rend(); ++i) {
362 pstrFilteredOut->replace(i->first, i->second - i->first, "(…)");
363 }
364 }
365 switch(state) // final state
366 {
367 case STATE_COMMAND_EXECUTED:
368 if (lastResult.isStr())
369 strResult = lastResult.get_str();
370 else
371 strResult = lastResult.write(2);
372 [[fallthrough]];
373 case STATE_ARGUMENT:
374 case STATE_EATING_SPACES:
375 return true;
376 default: // ERROR to end in one of the other states
377 return false;
378 }
379}
380
381void RPCExecutor::request(const QString &command, const QString& wallet_name)
382{
383 try
384 {
385 std::string result;
386 std::string executableCommand = command.toStdString() + "\n";
387
388 // Catch the console-only-help command before RPC call is executed and reply with help text as-if a RPC reply.
389 if(executableCommand == "help-console\n") {
390 Q_EMIT reply(RPCConsole::CMD_REPLY, QString(("\n"
391 "This console accepts RPC commands using the standard syntax.\n"
392 " example: getblockhash 0\n\n"
393
394 "This console can also accept RPC commands using the parenthesized syntax.\n"
395 " example: getblockhash(0)\n\n"
396
397 "Commands may be nested when specified with the parenthesized syntax.\n"
398 " example: getblock(getblockhash(0) 1)\n\n"
399
400 "A space or a comma can be used to delimit arguments for either syntax.\n"
401 " example: getblockhash 0\n"
402 " getblockhash,0\n\n"
403
404 "Named results can be queried with a non-quoted key string in brackets using the parenthesized syntax.\n"
405 " example: getblock(getblockhash(0) 1)[tx]\n\n"
406
407 "Results without keys can be queried with an integer in brackets using the parenthesized syntax.\n"
408 " example: getblock(getblockhash(0),1)[tx][0]\n\n")));
409 return;
410 }
411 if (!RPCConsole::RPCExecuteCommandLine(m_node, result, executableCommand, nullptr, wallet_name)) {
412 Q_EMIT reply(RPCConsole::CMD_ERROR, QString("Parse error: unbalanced ' or \""));
413 return;
414 }
415
416 Q_EMIT reply(RPCConsole::CMD_REPLY, QString::fromStdString(result));
417 }
418 catch (UniValue& objError)
419 {
420 try // Nice formatting for standard-format error
421 {
422 int code = objError.find_value("code").getInt<int>();
423 std::string message = objError.find_value("message").get_str();
424 Q_EMIT reply(RPCConsole::CMD_ERROR, QString::fromStdString(message) + " (code " + QString::number(code) + ")");
425 }
426 catch (const std::runtime_error&) // raised when converting to invalid type, i.e. missing code or message
427 { // Show raw JSON object
428 Q_EMIT reply(RPCConsole::CMD_ERROR, QString::fromStdString(objError.write()));
429 }
430 }
431 catch (const std::exception& e)
432 {
433 Q_EMIT reply(RPCConsole::CMD_ERROR, QString("Error: ") + QString::fromStdString(e.what()));
434 }
435}
436
437RPCConsole::RPCConsole(interfaces::Node& node, const PlatformStyle *_platformStyle, QWidget *parent) :
438 QWidget(parent),
439 m_node(node),
440 ui(new Ui::RPCConsole),
441 platformStyle(_platformStyle)
442{
443 ui->setupUi(this);
444 QSettings settings;
445#ifdef ENABLE_WALLET
447 // RPCConsole widget is a window.
448 if (!restoreGeometry(settings.value("RPCConsoleWindowGeometry").toByteArray())) {
449 // Restore failed (perhaps missing setting), center the window
450 move(QGuiApplication::primaryScreen()->availableGeometry().center() - frameGeometry().center());
451 }
452 ui->splitter->restoreState(settings.value("RPCConsoleWindowPeersTabSplitterSizes").toByteArray());
453 } else
454#endif // ENABLE_WALLET
455 {
456 // RPCConsole is a child widget.
457 ui->splitter->restoreState(settings.value("RPCConsoleWidgetPeersTabSplitterSizes").toByteArray());
458 }
459
460 m_peer_widget_header_state = settings.value("PeersTabPeerHeaderState").toByteArray();
461 m_banlist_widget_header_state = settings.value("PeersTabBanlistHeaderState").toByteArray();
462
463 constexpr QChar nonbreaking_hyphen(8209);
464 const std::vector<QString> CONNECTION_TYPE_DOC{
465 //: Explanatory text for an inbound peer connection.
466 tr("Inbound: initiated by peer"),
467 /*: Explanatory text for an outbound peer connection that
468 relays all network information. This is the default behavior for
469 outbound connections. */
470 tr("Outbound Full Relay: default"),
471 /*: Explanatory text for an outbound peer connection that relays
472 network information about blocks and not transactions or addresses. */
473 tr("Outbound Block Relay: does not relay transactions or addresses"),
474 /*: Explanatory text for an outbound peer connection that was
475 established manually through one of several methods. The numbered
476 arguments are stand-ins for the methods available to establish
477 manual connections. */
478 tr("Outbound Manual: added using RPC %1 or %2/%3 configuration options")
479 .arg("addnode")
480 .arg(QString(nonbreaking_hyphen) + "addnode")
481 .arg(QString(nonbreaking_hyphen) + "connect"),
482 /*: Explanatory text for a short-lived outbound peer connection that
483 is used to test the aliveness of known addresses. */
484 tr("Outbound Feeler: short-lived, for testing addresses"),
485 /*: Explanatory text for a short-lived outbound peer connection that is used
486 to request addresses from a peer. */
487 tr("Outbound Address Fetch: short-lived, for soliciting addresses")};
488 const QString connection_types_list{"<ul><li>" + Join(CONNECTION_TYPE_DOC, QString("</li><li>")) + "</li></ul>"};
489 ui->peerConnectionTypeLabel->setToolTip(ui->peerConnectionTypeLabel->toolTip().arg(connection_types_list));
490 const std::vector<QString> TRANSPORT_TYPE_DOC{
491 //: Explanatory text for "detecting" transport type.
492 tr("detecting: peer could be v1 or v2"),
493 //: Explanatory text for v1 transport type.
494 tr("v1: unencrypted, plaintext transport protocol"),
495 //: Explanatory text for v2 transport type.
496 tr("v2: BIP324 encrypted transport protocol")};
497 const QString transport_types_list{"<ul><li>" + Join(TRANSPORT_TYPE_DOC, QString("</li><li>")) + "</li></ul>"};
498 ui->peerTransportTypeLabel->setToolTip(ui->peerTransportTypeLabel->toolTip().arg(transport_types_list));
499 const QString hb_list{"<ul><li>\""
500 + ts.to + "\" – " + tr("we selected the peer for high bandwidth relay") + "</li><li>\""
501 + ts.from + "\" – " + tr("the peer selected us for high bandwidth relay") + "</li><li>\""
502 + ts.no + "\" – " + tr("no high bandwidth relay selected") + "</li></ul>"};
503 ui->peerHighBandwidthLabel->setToolTip(ui->peerHighBandwidthLabel->toolTip().arg(hb_list));
504 ui->dataDir->setToolTip(ui->dataDir->toolTip().arg(QString(nonbreaking_hyphen) + "datadir"));
505 ui->blocksDir->setToolTip(ui->blocksDir->toolTip().arg(QString(nonbreaking_hyphen) + "blocksdir"));
506 ui->openDebugLogfileButton->setToolTip(ui->openDebugLogfileButton->toolTip().arg(CLIENT_NAME));
507
509 ui->openDebugLogfileButton->setIcon(platformStyle->SingleColorIcon(":/icons/export"));
510 }
511 ui->clearButton->setIcon(platformStyle->SingleColorIcon(":/icons/remove"));
512
513 ui->fontBiggerButton->setIcon(platformStyle->SingleColorIcon(":/icons/fontbigger"));
514 //: Main shortcut to increase the RPC console font size.
515 ui->fontBiggerButton->setShortcut(tr("Ctrl++"));
516 //: Secondary shortcut to increase the RPC console font size.
517 GUIUtil::AddButtonShortcut(ui->fontBiggerButton, tr("Ctrl+="));
518
519 ui->fontSmallerButton->setIcon(platformStyle->SingleColorIcon(":/icons/fontsmaller"));
520 //: Main shortcut to decrease the RPC console font size.
521 ui->fontSmallerButton->setShortcut(tr("Ctrl+-"));
522 //: Secondary shortcut to decrease the RPC console font size.
523 GUIUtil::AddButtonShortcut(ui->fontSmallerButton, tr("Ctrl+_"));
524
525 ui->promptIcon->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/prompticon")));
526
527 // Install event filter for up and down arrow
528 ui->lineEdit->installEventFilter(this);
529 ui->lineEdit->setMaxLength(16 * 1024 * 1024);
530 ui->messagesWidget->installEventFilter(this);
531
532 connect(ui->hidePeersDetailButton, &QAbstractButton::clicked, this, &RPCConsole::clearSelectedNode);
533 connect(ui->clearButton, &QAbstractButton::clicked, [this] { clear(); });
534 connect(ui->fontBiggerButton, &QAbstractButton::clicked, this, &RPCConsole::fontBigger);
535 connect(ui->fontSmallerButton, &QAbstractButton::clicked, this, &RPCConsole::fontSmaller);
536 connect(ui->btnClearTrafficGraph, &QPushButton::clicked, ui->trafficGraph, &TrafficGraphWidget::clear);
537
538 // disable the wallet selector by default
539 ui->WalletSelector->setVisible(false);
540 ui->WalletSelectorLabel->setVisible(false);
541
544
545 consoleFontSize = settings.value(fontSizeSettingsKey, QFont().pointSize()).toInt();
546 clear();
547
549
551}
552
554{
555 QSettings settings;
556#ifdef ENABLE_WALLET
558 // RPCConsole widget is a window.
559 settings.setValue("RPCConsoleWindowGeometry", saveGeometry());
560 settings.setValue("RPCConsoleWindowPeersTabSplitterSizes", ui->splitter->saveState());
561 } else
562#endif // ENABLE_WALLET
563 {
564 // RPCConsole is a child widget.
565 settings.setValue("RPCConsoleWidgetPeersTabSplitterSizes", ui->splitter->saveState());
566 }
567
568 settings.setValue("PeersTabPeerHeaderState", m_peer_widget_header_state);
569 settings.setValue("PeersTabBanlistHeaderState", m_banlist_widget_header_state);
570
571 delete ui;
572}
573
574bool RPCConsole::eventFilter(QObject* obj, QEvent *event)
575{
576 if(event->type() == QEvent::KeyPress) // Special key handling
577 {
578 QKeyEvent *keyevt = static_cast<QKeyEvent*>(event);
579 int key = keyevt->key();
580 Qt::KeyboardModifiers mod = keyevt->modifiers();
581 switch(key)
582 {
583 case Qt::Key_Up: if(obj == ui->lineEdit) { browseHistory(-1); return true; } break;
584 case Qt::Key_Down: if(obj == ui->lineEdit) { browseHistory(1); return true; } break;
585 case Qt::Key_PageUp: /* pass paging keys to messages widget */
586 case Qt::Key_PageDown:
587 if (obj == ui->lineEdit) {
588 QApplication::sendEvent(ui->messagesWidget, keyevt);
589 return true;
590 }
591 break;
592 case Qt::Key_Return:
593 case Qt::Key_Enter:
594 // forward these events to lineEdit
595 if (obj == autoCompleter->popup()) {
596 QApplication::sendEvent(ui->lineEdit, keyevt);
597 autoCompleter->popup()->hide();
598 return true;
599 }
600 break;
601 default:
602 // Typing in messages widget brings focus to line edit, and redirects key there
603 // Exclude most combinations and keys that emit no text, except paste shortcuts
604 if(obj == ui->messagesWidget && (
605 (!mod && !keyevt->text().isEmpty() && key != Qt::Key_Tab) ||
606 ((mod & Qt::ControlModifier) && key == Qt::Key_V) ||
607 ((mod & Qt::ShiftModifier) && key == Qt::Key_Insert)))
608 {
609 ui->lineEdit->setFocus();
610 QApplication::sendEvent(ui->lineEdit, keyevt);
611 return true;
612 }
613 }
614 }
615 return QWidget::eventFilter(obj, event);
616}
617
618void RPCConsole::setClientModel(ClientModel *model, int bestblock_height, int64_t bestblock_date, double verification_progress)
619{
620 clientModel = model;
621
622 bool wallet_enabled{false};
623#ifdef ENABLE_WALLET
624 wallet_enabled = WalletModel::isWalletEnabled();
625#endif // ENABLE_WALLET
626 if (model && !wallet_enabled) {
627 // Show warning, for example if this is a prerelease version
630 }
631
632 ui->trafficGraph->setClientModel(model);
634 // Keep up to date with client
637
638 setNumBlocks(bestblock_height, QDateTime::fromSecsSinceEpoch(bestblock_date), verification_progress, SyncType::BLOCK_SYNC);
640
643
645 updateTrafficStats(node.getTotalBytesRecv(), node.getTotalBytesSent());
647
649
650 // set up peer table
651 ui->peerWidget->setModel(model->peerTableSortProxy());
652 ui->peerWidget->verticalHeader()->hide();
653 ui->peerWidget->setSelectionBehavior(QAbstractItemView::SelectRows);
654 ui->peerWidget->setSelectionMode(QAbstractItemView::ExtendedSelection);
655 ui->peerWidget->setContextMenuPolicy(Qt::CustomContextMenu);
656
657 if (!ui->peerWidget->horizontalHeader()->restoreState(m_peer_widget_header_state)) {
658 ui->peerWidget->setColumnWidth(PeerTableModel::Address, ADDRESS_COLUMN_WIDTH);
659 ui->peerWidget->setColumnWidth(PeerTableModel::Subversion, SUBVERSION_COLUMN_WIDTH);
660 ui->peerWidget->setColumnWidth(PeerTableModel::Ping, PING_COLUMN_WIDTH);
661 }
662 ui->peerWidget->horizontalHeader()->setSectionResizeMode(PeerTableModel::Age, QHeaderView::ResizeToContents);
663 ui->peerWidget->horizontalHeader()->setStretchLastSection(true);
664 ui->peerWidget->setItemDelegateForColumn(PeerTableModel::NetNodeId, new PeerIdViewDelegate(this));
665
666 // create peer table context menu
667 peersTableContextMenu = new QMenu(this);
668 //: Context menu action to copy the address of a peer.
669 peersTableContextMenu->addAction(tr("&Copy address"), [this] {
670 GUIUtil::copyEntryData(ui->peerWidget, PeerTableModel::Address, Qt::DisplayRole);
671 });
672 peersTableContextMenu->addSeparator();
673 peersTableContextMenu->addAction(tr("&Disconnect"), this, &RPCConsole::disconnectSelectedNode);
674 peersTableContextMenu->addAction(ts.ban_for + " " + tr("1 &hour"), [this] { banSelectedNode(60 * 60); });
675 peersTableContextMenu->addAction(ts.ban_for + " " + tr("1 d&ay"), [this] { banSelectedNode(60 * 60 * 24); });
676 peersTableContextMenu->addAction(ts.ban_for + " " + tr("1 &week"), [this] { banSelectedNode(60 * 60 * 24 * 7); });
677 peersTableContextMenu->addAction(ts.ban_for + " " + tr("1 &year"), [this] { banSelectedNode(60 * 60 * 24 * 365); });
678 connect(ui->peerWidget, &QTableView::customContextMenuRequested, this, &RPCConsole::showPeersTableContextMenu);
679
680 // peer table signal handling - update peer details when selecting new node
681 connect(ui->peerWidget->selectionModel(), &QItemSelectionModel::selectionChanged, this, &RPCConsole::updateDetailWidget);
682 connect(model->getPeerTableModel(), &QAbstractItemModel::dataChanged, [this] { updateDetailWidget(); });
683
684 // set up ban table
685 ui->banlistWidget->setModel(model->getBanTableModel());
686 ui->banlistWidget->verticalHeader()->hide();
687 ui->banlistWidget->setSelectionBehavior(QAbstractItemView::SelectRows);
688 ui->banlistWidget->setSelectionMode(QAbstractItemView::SingleSelection);
689 ui->banlistWidget->setContextMenuPolicy(Qt::CustomContextMenu);
690
691 if (!ui->banlistWidget->horizontalHeader()->restoreState(m_banlist_widget_header_state)) {
692 ui->banlistWidget->setColumnWidth(BanTableModel::Address, BANSUBNET_COLUMN_WIDTH);
693 ui->banlistWidget->setColumnWidth(BanTableModel::Bantime, BANTIME_COLUMN_WIDTH);
694 }
695 ui->banlistWidget->horizontalHeader()->setSectionResizeMode(BanTableModel::Address, QHeaderView::ResizeToContents);
696 ui->banlistWidget->horizontalHeader()->setStretchLastSection(true);
697
698 // create ban table context menu
699 banTableContextMenu = new QMenu(this);
700 /*: Context menu action to copy the IP/Netmask of a banned peer.
701 IP/Netmask is the combination of a peer's IP address and its Netmask.
702 For IP address, see: https://en.wikipedia.org/wiki/IP_address. */
703 banTableContextMenu->addAction(tr("&Copy IP/Netmask"), [this] {
704 GUIUtil::copyEntryData(ui->banlistWidget, BanTableModel::Address, Qt::DisplayRole);
705 });
706 banTableContextMenu->addSeparator();
707 banTableContextMenu->addAction(tr("&Unban"), this, &RPCConsole::unbanSelectedNode);
708 connect(ui->banlistWidget, &QTableView::customContextMenuRequested, this, &RPCConsole::showBanTableContextMenu);
709
710 // ban table signal handling - clear peer details when clicking a peer in the ban table
711 connect(ui->banlistWidget, &QTableView::clicked, this, &RPCConsole::clearSelectedNode);
712 // ban table signal handling - ensure ban table is shown or hidden (if empty)
713 connect(model->getBanTableModel(), &BanTableModel::layoutChanged, this, &RPCConsole::showOrHideBanTableIfRequired);
715
716 // Provide initial values
717 ui->clientVersion->setText(model->formatFullVersion());
718 ui->clientUserAgent->setText(model->formatSubVersion());
719 ui->dataDir->setText(model->dataDir());
720 ui->blocksDir->setText(model->blocksDir());
721 ui->startupTime->setText(model->formatClientStartupTime());
722 ui->networkName->setText(QString::fromStdString(Params().GetChainTypeString()));
723
724 //Setup autocomplete and attach it
725 QStringList wordList;
726 std::vector<std::string> commandList = m_node.listRpcCommands();
727 for (size_t i = 0; i < commandList.size(); ++i)
728 {
729 wordList << commandList[i].c_str();
730 wordList << ("help " + commandList[i]).c_str();
731 }
732
733 wordList << "help-console";
734 wordList.sort();
735 autoCompleter = new QCompleter(wordList, this);
736 autoCompleter->setModelSorting(QCompleter::CaseSensitivelySortedModel);
737 // ui->lineEdit is initially disabled because running commands is only
738 // possible from now on.
739 ui->lineEdit->setEnabled(true);
740 ui->lineEdit->setCompleter(autoCompleter);
741 autoCompleter->popup()->installEventFilter(this);
742 // Start thread to execute RPC commands.
744 }
745 if (!model) {
746 // Client model is being set to 0, this means shutdown() is about to be called.
747 thread.quit();
748 thread.wait();
749 }
750}
751
752#ifdef ENABLE_WALLET
753void RPCConsole::addWallet(WalletModel * const walletModel)
754{
755 // use name for text and wallet model for internal data object (to allow to move to a wallet id later)
756 ui->WalletSelector->addItem(walletModel->getDisplayName(), QVariant::fromValue(walletModel));
757 if (ui->WalletSelector->count() == 2) {
758 // First wallet added, set to default to match wallet RPC behavior
759 ui->WalletSelector->setCurrentIndex(1);
760 }
761 if (ui->WalletSelector->count() > 2) {
762 ui->WalletSelector->setVisible(true);
763 ui->WalletSelectorLabel->setVisible(true);
764 }
765}
766
767void RPCConsole::removeWallet(WalletModel * const walletModel)
768{
769 ui->WalletSelector->removeItem(ui->WalletSelector->findData(QVariant::fromValue(walletModel)));
770 if (ui->WalletSelector->count() == 2) {
771 ui->WalletSelector->setVisible(false);
772 ui->WalletSelectorLabel->setVisible(false);
773 }
774}
775
776void RPCConsole::setCurrentWallet(WalletModel* const wallet_model)
777{
778 QVariant data = QVariant::fromValue(wallet_model);
779 ui->WalletSelector->setCurrentIndex(ui->WalletSelector->findData(data));
780}
781#endif
782
783static QString categoryClass(int category)
784{
785 switch(category)
786 {
787 case RPCConsole::CMD_REQUEST: return "cmd-request"; break;
788 case RPCConsole::CMD_REPLY: return "cmd-reply"; break;
789 case RPCConsole::CMD_ERROR: return "cmd-error"; break;
790 default: return "misc";
791 }
792}
793
795{
797}
798
800{
802}
803
804void RPCConsole::setFontSize(int newSize)
805{
806 QSettings settings;
807
808 //don't allow an insane font size
809 if (newSize < FONT_RANGE.width() || newSize > FONT_RANGE.height())
810 return;
811
812 // temp. store the console content
813 QString str = ui->messagesWidget->toHtml();
814
815 // replace font tags size in current content
816 str.replace(QString("font-size:%1pt").arg(consoleFontSize), QString("font-size:%1pt").arg(newSize));
817
818 // store the new font size
819 consoleFontSize = newSize;
820 settings.setValue(fontSizeSettingsKey, consoleFontSize);
821
822 // clear console (reset icon sizes, default stylesheet) and re-add the content
823 float oldPosFactor = 1.0 / ui->messagesWidget->verticalScrollBar()->maximum() * ui->messagesWidget->verticalScrollBar()->value();
824 clear(/*keep_prompt=*/true);
825 ui->messagesWidget->setHtml(str);
826 ui->messagesWidget->verticalScrollBar()->setValue(oldPosFactor * ui->messagesWidget->verticalScrollBar()->maximum());
827}
828
829void RPCConsole::clear(bool keep_prompt)
830{
831 ui->messagesWidget->clear();
832 if (!keep_prompt) ui->lineEdit->clear();
833 ui->lineEdit->setFocus();
834
835 // Add smoothly scaled icon images.
836 // (when using width/height on an img, Qt uses nearest instead of linear interpolation)
837 for(int i=0; ICON_MAPPING[i].url; ++i)
838 {
839 ui->messagesWidget->document()->addResource(
840 QTextDocument::ImageResource,
841 QUrl(ICON_MAPPING[i].url),
842 platformStyle->SingleColorImage(ICON_MAPPING[i].source).scaled(QSize(consoleFontSize*2, consoleFontSize*2), Qt::IgnoreAspectRatio, Qt::SmoothTransformation));
843 }
844
845 // Set default style sheet
846#ifdef Q_OS_MACOS
847 QFontInfo fixedFontInfo(GUIUtil::fixedPitchFont(/*use_embedded_font=*/true));
848#else
849 QFontInfo fixedFontInfo(GUIUtil::fixedPitchFont());
850#endif
851 ui->messagesWidget->document()->setDefaultStyleSheet(
852 QString(
853 "table { }"
854 "td.time { color: #808080; font-size: %2; padding-top: 3px; } "
855 "td.message { font-family: %1; font-size: %2; white-space:pre-wrap; } "
856 "td.cmd-request { color: #006060; } "
857 "td.cmd-error { color: red; } "
858 ".secwarning { color: red; }"
859 "b { color: #006060; } "
860 ).arg(fixedFontInfo.family(), QString("%1pt").arg(consoleFontSize))
861 );
862
863 static const QString welcome_message =
864 /*: RPC console welcome message.
865 Placeholders %7 and %8 are style tags for the warning content, and
866 they are not space separated from the rest of the text intentionally. */
867 tr("Welcome to the %1 RPC console.\n"
868 "Use up and down arrows to navigate history, and %2 to clear screen.\n"
869 "Use %3 and %4 to increase or decrease the font size.\n"
870 "Type %5 for an overview of available commands.\n"
871 "For more information on using this console, type %6.\n"
872 "\n"
873 "%7WARNING: Scammers have been active, telling users to type"
874 " commands here, stealing their wallet contents. Do not use this console"
875 " without fully understanding the ramifications of a command.%8")
876 .arg(CLIENT_NAME,
877 "<b>" + ui->clearButton->shortcut().toString(QKeySequence::NativeText) + "</b>",
878 "<b>" + ui->fontBiggerButton->shortcut().toString(QKeySequence::NativeText) + "</b>",
879 "<b>" + ui->fontSmallerButton->shortcut().toString(QKeySequence::NativeText) + "</b>",
880 "<b>help</b>",
881 "<b>help-console</b>",
882 "<span class=\"secwarning\">",
883 "<span>");
884
885 message(CMD_REPLY, welcome_message, true);
886}
887
888void RPCConsole::keyPressEvent(QKeyEvent *event)
889{
890 if (windowType() != Qt::Widget && GUIUtil::IsEscapeOrBack(event->key())) {
891 close();
892 }
893}
894
896{
897 if (e->type() == QEvent::PaletteChange) {
898 ui->clearButton->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/remove")));
899 ui->fontBiggerButton->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/fontbigger")));
900 ui->fontSmallerButton->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/fontsmaller")));
901 ui->promptIcon->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/prompticon")));
902
903 for (int i = 0; ICON_MAPPING[i].url; ++i) {
904 ui->messagesWidget->document()->addResource(
905 QTextDocument::ImageResource,
906 QUrl(ICON_MAPPING[i].url),
907 platformStyle->SingleColorImage(ICON_MAPPING[i].source).scaled(QSize(consoleFontSize * 2, consoleFontSize * 2), Qt::IgnoreAspectRatio, Qt::SmoothTransformation));
908 }
909 }
910
911 QWidget::changeEvent(e);
912}
913
914void RPCConsole::message(int category, const QString &message, bool html)
915{
916 QTime time = QTime::currentTime();
917 QString timeString = time.toString();
918 QString out;
919 out += "<table><tr><td class=\"time\" width=\"65\">" + timeString + "</td>";
920 out += "<td class=\"icon\" width=\"32\"><img src=\"" + categoryClass(category) + "\"></td>";
921 out += "<td class=\"message " + categoryClass(category) + "\" valign=\"middle\">";
922 if(html)
923 out += message;
924 else
926 out += "</td></tr></table>";
927 ui->messagesWidget->append(out);
928}
929
931{
932 if (!clientModel) return;
933 QString connections = QString::number(clientModel->getNumConnections()) + " (";
934 connections += tr("In:") + " " + QString::number(clientModel->getNumConnections(CONNECTIONS_IN)) + " / ";
935 connections += tr("Out:") + " " + QString::number(clientModel->getNumConnections(CONNECTIONS_OUT)) + ")";
936
938 connections += " (" + tr("Network activity disabled") + ")";
939 }
940
941 ui->numberOfConnections->setText(connections);
942
943 QString local_addresses;
944 std::map<CNetAddr, LocalServiceInfo> hosts = clientModel->getNetLocalAddresses();
945 for (const auto& [addr, info] : hosts) {
946 local_addresses += QString::fromStdString(addr.ToStringAddr());
947 if (!addr.IsI2P()) local_addresses += ":" + QString::number(info.nPort);
948 local_addresses += ", ";
949 }
950 local_addresses.chop(2); // remove last ", "
951 if (local_addresses.isEmpty()) local_addresses = tr("None");
952
953 ui->localAddresses->setText(local_addresses);
954}
955
957{
958 if (!clientModel)
959 return;
960
962}
963
964void RPCConsole::setNetworkActive(bool networkActive)
965{
967}
968
969void RPCConsole::setNumBlocks(int count, const QDateTime& blockDate, double nVerificationProgress, SyncType synctype)
970{
971 if (synctype == SyncType::BLOCK_SYNC) {
972 ui->numberOfBlocks->setText(QString::number(count));
973 ui->lastBlockTime->setText(blockDate.toString());
974 }
975}
976
977void RPCConsole::setMempoolSize(long numberOfTxs, size_t dynUsage, size_t maxUsage)
978{
979 ui->mempoolNumberTxs->setText(QString::number(numberOfTxs));
980
981 const auto cur_usage_str = dynUsage < 1000000 ?
982 QObject::tr("%1 kB").arg(dynUsage / 1000.0, 0, 'f', 2) :
983 QObject::tr("%1 MB").arg(dynUsage / 1000000.0, 0, 'f', 2);
984 const auto max_usage_str = QObject::tr("%1 MB").arg(maxUsage / 1000000.0, 0, 'f', 2);
985
986 ui->mempoolSize->setText(cur_usage_str + " / " + max_usage_str);
987}
988
990{
991 QString cmd = ui->lineEdit->text().trimmed();
992
993 if (cmd.isEmpty()) {
994 return;
995 }
996
997 std::string strFilteredCmd;
998 try {
999 std::string dummy;
1000 if (!RPCParseCommandLine(nullptr, dummy, cmd.toStdString(), false, &strFilteredCmd)) {
1001 // Failed to parse command, so we cannot even filter it for the history
1002 throw std::runtime_error("Invalid command line");
1003 }
1004 } catch (const std::exception& e) {
1005 QMessageBox::critical(this, "Error", QString("Error: ") + QString::fromStdString(e.what()));
1006 return;
1007 }
1008
1009 // A special case allows to request shutdown even a long-running command is executed.
1010 if (cmd == QLatin1String("stop")) {
1011 std::string dummy;
1012 RPCExecuteCommandLine(m_node, dummy, cmd.toStdString());
1013 return;
1014 }
1015
1016 if (m_is_executing) {
1017 return;
1018 }
1019
1020 ui->lineEdit->clear();
1021
1022 QString in_use_wallet_name;
1023#ifdef ENABLE_WALLET
1024 WalletModel* wallet_model = ui->WalletSelector->currentData().value<WalletModel*>();
1025 in_use_wallet_name = wallet_model ? wallet_model->getWalletName() : QString();
1026 if (m_last_wallet_model != wallet_model) {
1027 if (wallet_model) {
1028 message(CMD_REQUEST, tr("Executing command using \"%1\" wallet").arg(wallet_model->getWalletName()));
1029 } else {
1030 message(CMD_REQUEST, tr("Executing command without any wallet"));
1031 }
1032 m_last_wallet_model = wallet_model;
1033 }
1034#endif // ENABLE_WALLET
1035
1036 message(CMD_REQUEST, QString::fromStdString(strFilteredCmd));
1037 //: A console message indicating an entered command is currently being executed.
1038 message(CMD_REPLY, tr("Executing…"));
1039 m_is_executing = true;
1040
1041 QMetaObject::invokeMethod(m_executor, [this, cmd, in_use_wallet_name] {
1042 m_executor->request(cmd, in_use_wallet_name);
1043 });
1044
1045 cmd = QString::fromStdString(strFilteredCmd);
1046
1047 // Remove command, if already in history
1048 history.removeOne(cmd);
1049 // Append command to history
1050 history.append(cmd);
1051 // Enforce maximum history size
1052 while (history.size() > CONSOLE_HISTORY) {
1053 history.removeFirst();
1054 }
1055 // Set pointer to end of history
1056 historyPtr = history.size();
1057
1058 // Scroll console view to end
1059 scrollToEnd();
1060}
1061
1063{
1064 // store current text when start browsing through the history
1065 if (historyPtr == history.size()) {
1066 cmdBeforeBrowsing = ui->lineEdit->text();
1067 }
1068
1069 historyPtr += offset;
1070 if(historyPtr < 0)
1071 historyPtr = 0;
1072 if(historyPtr > history.size())
1073 historyPtr = history.size();
1074 QString cmd;
1075 if(historyPtr < history.size())
1076 cmd = history.at(historyPtr);
1077 else if (!cmdBeforeBrowsing.isNull()) {
1079 }
1080 ui->lineEdit->setText(cmd);
1081}
1082
1084{
1086 m_executor->moveToThread(&thread);
1087
1088 // Replies from executor object must go to this object
1089 connect(m_executor, &RPCExecutor::reply, this, [this](int category, const QString& command) {
1090 // Remove "Executing…" message.
1091 ui->messagesWidget->undo();
1092 message(category, command);
1093 scrollToEnd();
1094 m_is_executing = false;
1095 });
1096
1097 // Make sure executor object is deleted in its own thread
1098 connect(&thread, &QThread::finished, m_executor, &RPCExecutor::deleteLater);
1099
1100 // Default implementation of QThread::run() simply spins up an event loop in the thread,
1101 // which is what we want.
1102 thread.start();
1103 QTimer::singleShot(0, m_executor, []() {
1104 util::ThreadRename("qt-rpcconsole");
1105 });
1106}
1107
1109{
1110 if (ui->tabWidget->widget(index) == ui->tab_console) {
1111 ui->lineEdit->setFocus();
1112 }
1113}
1114
1116{
1118}
1119
1121{
1122 QScrollBar *scrollbar = ui->messagesWidget->verticalScrollBar();
1123 scrollbar->setValue(scrollbar->maximum());
1124}
1125
1127{
1128 const int multiplier = 5; // each position on the slider represents 5 min
1129 int mins = value * multiplier;
1131}
1132
1134{
1135 ui->trafficGraph->setGraphRange(std::chrono::minutes{mins});
1136 ui->lblGraphRange->setText(GUIUtil::formatDurationStr(std::chrono::minutes{mins}));
1137}
1138
1139void RPCConsole::updateTrafficStats(quint64 totalBytesIn, quint64 totalBytesOut)
1140{
1141 ui->lblBytesIn->setText(GUIUtil::formatBytes(totalBytesIn));
1142 ui->lblBytesOut->setText(GUIUtil::formatBytes(totalBytesOut));
1143}
1144
1146{
1147 const QList<QModelIndex> selected_peers = GUIUtil::getEntryData(ui->peerWidget, PeerTableModel::NetNodeId);
1148 if (!clientModel || !clientModel->getPeerTableModel() || selected_peers.size() != 1) {
1149 ui->peersTabRightPanel->hide();
1150 ui->peerHeading->setText(tr("Select a peer to view detailed information."));
1151 return;
1152 }
1153 const auto stats = selected_peers.first().data(PeerTableModel::StatsRole).value<CNodeCombinedStats*>();
1154 // update the detail ui with latest node information
1155 QString peerAddrDetails(QString::fromStdString(stats->nodeStats.m_addr_name) + " ");
1156 peerAddrDetails += tr("(peer: %1)").arg(QString::number(stats->nodeStats.nodeid));
1157 if (!stats->nodeStats.addrLocal.empty())
1158 peerAddrDetails += "<br />" + tr("via %1").arg(QString::fromStdString(stats->nodeStats.addrLocal));
1159 ui->peerHeading->setText(peerAddrDetails);
1160 QString bip152_hb_settings;
1161 if (stats->nodeStats.m_bip152_highbandwidth_to) bip152_hb_settings = ts.to;
1162 if (stats->nodeStats.m_bip152_highbandwidth_from) bip152_hb_settings += (bip152_hb_settings.isEmpty() ? ts.from : QLatin1Char('/') + ts.from);
1163 if (bip152_hb_settings.isEmpty()) bip152_hb_settings = ts.no;
1164 ui->peerHighBandwidth->setText(bip152_hb_settings);
1165 const auto time_now{GetTime<std::chrono::seconds>()};
1166 ui->peerConnTime->setText(GUIUtil::formatDurationStr(time_now - stats->nodeStats.m_connected));
1167 ui->peerLastBlock->setText(TimeDurationField(time_now, stats->nodeStats.m_last_block_time));
1168 ui->peerLastTx->setText(TimeDurationField(time_now, stats->nodeStats.m_last_tx_time));
1169 ui->peerLastSend->setText(TimeDurationField(time_now, stats->nodeStats.m_last_send));
1170 ui->peerLastRecv->setText(TimeDurationField(time_now, stats->nodeStats.m_last_recv));
1171 ui->peerBytesSent->setText(GUIUtil::formatBytes(stats->nodeStats.nSendBytes));
1172 ui->peerBytesRecv->setText(GUIUtil::formatBytes(stats->nodeStats.nRecvBytes));
1173 ui->peerPingTime->setText(GUIUtil::formatPingTime(stats->nodeStats.m_last_ping_time));
1174 ui->peerMinPing->setText(GUIUtil::formatPingTime(stats->nodeStats.m_min_ping_time));
1175 if (stats->nodeStats.nVersion) {
1176 ui->peerVersion->setText(QString::number(stats->nodeStats.nVersion));
1177 }
1178 if (!stats->nodeStats.cleanSubVer.empty()) {
1179 ui->peerSubversion->setText(QString::fromStdString(stats->nodeStats.cleanSubVer));
1180 }
1181 ui->peerConnectionType->setText(GUIUtil::ConnectionTypeToQString(stats->nodeStats.m_conn_type, /*prepend_direction=*/true));
1182 ui->peerTransportType->setText(QString::fromStdString(TransportTypeAsString(stats->nodeStats.m_transport_type)));
1183 if (stats->nodeStats.m_transport_type == TransportProtocolType::V2) {
1184 ui->peerSessionIdLabel->setVisible(true);
1185 ui->peerSessionId->setVisible(true);
1186 ui->peerSessionId->setText(QString::fromStdString(stats->nodeStats.m_session_id));
1187 } else {
1188 ui->peerSessionIdLabel->setVisible(false);
1189 ui->peerSessionId->setVisible(false);
1190 }
1191 ui->peerNetwork->setText(GUIUtil::NetworkToQString(stats->nodeStats.m_network));
1192 if (stats->nodeStats.m_permission_flags == NetPermissionFlags::None) {
1193 ui->peerPermissions->setText(ts.na);
1194 } else {
1195 QStringList permissions;
1196 for (const auto& permission : NetPermissions::ToStrings(stats->nodeStats.m_permission_flags)) {
1197 permissions.append(QString::fromStdString(permission));
1198 }
1199 ui->peerPermissions->setText(permissions.join(" & "));
1200 }
1201 ui->peerMappedAS->setText(stats->nodeStats.m_mapped_as != 0 ? QString::number(stats->nodeStats.m_mapped_as) : ts.na);
1202
1203 // This check fails for example if the lock was busy and
1204 // nodeStateStats couldn't be fetched.
1205 if (stats->fNodeStateStatsAvailable) {
1206 ui->timeoffset->setText(GUIUtil::formatTimeOffset(Ticks<std::chrono::seconds>(stats->nodeStateStats.time_offset)));
1207 ui->peerServices->setText(GUIUtil::formatServicesStr(stats->nodeStateStats.their_services));
1208 // Sync height is init to -1
1209 if (stats->nodeStateStats.nSyncHeight > -1) {
1210 ui->peerSyncHeight->setText(QString("%1").arg(stats->nodeStateStats.nSyncHeight));
1211 } else {
1212 ui->peerSyncHeight->setText(ts.unknown);
1213 }
1214 // Common height is init to -1
1215 if (stats->nodeStateStats.nCommonHeight > -1) {
1216 ui->peerCommonHeight->setText(QString("%1").arg(stats->nodeStateStats.nCommonHeight));
1217 } else {
1218 ui->peerCommonHeight->setText(ts.unknown);
1219 }
1220 ui->peerHeight->setText(QString::number(stats->nodeStateStats.m_starting_height));
1221 ui->peerPingWait->setText(GUIUtil::formatPingTime(stats->nodeStateStats.m_ping_wait));
1222 ui->peerAddrRelayEnabled->setText(stats->nodeStateStats.m_addr_relay_enabled ? ts.yes : ts.no);
1223 ui->peerAddrProcessed->setText(QString::number(stats->nodeStateStats.m_addr_processed));
1224 ui->peerAddrRateLimited->setText(QString::number(stats->nodeStateStats.m_addr_rate_limited));
1225 ui->peerRelayTxes->setText(stats->nodeStateStats.m_relay_txs ? ts.yes : ts.no);
1226 }
1227
1228 ui->hidePeersDetailButton->setIcon(platformStyle->SingleColorIcon(QStringLiteral(":/icons/remove")));
1229 ui->peersTabRightPanel->show();
1230}
1231
1232void RPCConsole::resizeEvent(QResizeEvent *event)
1233{
1234 QWidget::resizeEvent(event);
1235}
1236
1237void RPCConsole::showEvent(QShowEvent *event)
1238{
1239 QWidget::showEvent(event);
1240
1242 return;
1243
1244 // start PeerTableModel auto refresh
1246}
1247
1248void RPCConsole::hideEvent(QHideEvent *event)
1249{
1250 // It is too late to call QHeaderView::saveState() in ~RPCConsole(), as all of
1251 // the columns of QTableView child widgets will have zero width at that moment.
1252 m_peer_widget_header_state = ui->peerWidget->horizontalHeader()->saveState();
1253 m_banlist_widget_header_state = ui->banlistWidget->horizontalHeader()->saveState();
1254
1255 QWidget::hideEvent(event);
1256
1258 return;
1259
1260 // stop PeerTableModel auto refresh
1262}
1263
1265{
1266 QModelIndex index = ui->peerWidget->indexAt(point);
1267 if (index.isValid())
1268 peersTableContextMenu->exec(QCursor::pos());
1269}
1270
1272{
1273 QModelIndex index = ui->banlistWidget->indexAt(point);
1274 if (index.isValid())
1275 banTableContextMenu->exec(QCursor::pos());
1276}
1277
1279{
1280 // Get selected peer addresses
1281 QList<QModelIndex> nodes = GUIUtil::getEntryData(ui->peerWidget, PeerTableModel::NetNodeId);
1282 for(int i = 0; i < nodes.count(); i++)
1283 {
1284 // Get currently selected peer address
1285 NodeId id = nodes.at(i).data().toLongLong();
1286 // Find the node, disconnect it and clear the selected node
1287 if(m_node.disconnectById(id))
1289 }
1290}
1291
1293{
1294 if (!clientModel)
1295 return;
1296
1297 for (const QModelIndex& peer : GUIUtil::getEntryData(ui->peerWidget, PeerTableModel::NetNodeId)) {
1298 // Find possible nodes, ban it and clear the selected node
1299 const auto stats = peer.data(PeerTableModel::StatsRole).value<CNodeCombinedStats*>();
1300 if (stats) {
1301 m_node.ban(stats->nodeStats.addr, bantime);
1302 m_node.disconnectByAddress(stats->nodeStats.addr);
1303 }
1304 }
1307}
1308
1310{
1311 if (!clientModel)
1312 return;
1313
1314 // Get selected ban addresses
1315 QList<QModelIndex> nodes = GUIUtil::getEntryData(ui->banlistWidget, BanTableModel::Address);
1316 BanTableModel* ban_table_model{clientModel->getBanTableModel()};
1317 bool unbanned{false};
1318 for (const auto& node_index : nodes) {
1319 unbanned |= ban_table_model->unban(node_index);
1320 }
1321 if (unbanned) {
1322 ban_table_model->refresh();
1323 }
1324}
1325
1327{
1328 ui->peerWidget->selectionModel()->clearSelection();
1329 cachedNodeids.clear();
1331}
1332
1334{
1335 if (!clientModel)
1336 return;
1337
1338 bool visible = clientModel->getBanTableModel()->shouldShow();
1339 ui->banlistWidget->setVisible(visible);
1340 ui->banHeading->setVisible(visible);
1341}
1342
1344{
1345 ui->tabWidget->setCurrentIndex(int(tabType));
1346}
1347
1348QString RPCConsole::tabTitle(TabTypes tab_type) const
1349{
1350 return ui->tabWidget->tabText(int(tab_type));
1351}
1352
1353QKeySequence RPCConsole::tabShortcut(TabTypes tab_type) const
1354{
1355 switch (tab_type) {
1356 case TabTypes::INFO: return QKeySequence(tr("Ctrl+I"));
1357 case TabTypes::CONSOLE: return QKeySequence(tr("Ctrl+T"));
1358 case TabTypes::GRAPH: return QKeySequence(tr("Ctrl+N"));
1359 case TabTypes::PEERS: return QKeySequence(tr("Ctrl+P"));
1360 } // no default case, so the compiler can warn about missing cases
1361
1362 assert(false);
1363}
1364
1365void RPCConsole::updateAlerts(const QString& warnings)
1366{
1367 this->ui->label_alerts->setVisible(!warnings.isEmpty());
1368 this->ui->label_alerts->setText(warnings);
1369}
1370
1372{
1373 const ChainType chain = Params().GetChainType();
1374 if (chain == ChainType::MAIN) return;
1375
1376 const QString chainType = QString::fromStdString(Params().GetChainTypeString());
1377 const QString title = tr("Node window - [%1]").arg(chainType);
1378 this->setWindowTitle(title);
1379}
node::NodeContext m_node
Definition: bitcoin-gui.cpp:43
const auto cmd
const auto command
const CChainParams & Params()
Return the currently selected parameters.
ChainType
Definition: chaintype.h:11
Qt model providing information about banned peers, similar to the "getpeerinfo" RPC call.
Definition: bantablemodel.h:44
bool unban(const QModelIndex &index)
ChainType GetChainType() const
Return the chain type.
Definition: chainparams.h:112
Model for Bitcoin network client.
Definition: clientmodel.h:57
void bytesChanged(quint64 totalBytesIn, quint64 totalBytesOut)
QString blocksDir() const
QString getStatusBarWarnings() const
Return warnings to be displayed in status bar.
std::map< CNetAddr, LocalServiceInfo > getNetLocalAddresses() const
PeerTableModel * getPeerTableModel()
PeerTableSortProxy * peerTableSortProxy()
void numConnectionsChanged(int count)
QString formatClientStartupTime() const
int getNumConnections(unsigned int flags=CONNECTIONS_ALL) const
Return number of connections, default is in- and outbound (total)
Definition: clientmodel.cpp:84
BanTableModel * getBanTableModel()
void numBlocksChanged(int count, const QDateTime &blockDate, double nVerificationProgress, SyncType header, SynchronizationState sync_state)
void alertsChanged(const QString &warnings)
void mempoolSizeChanged(long count, size_t mempoolSizeInBytes, size_t mempoolMaxSizeInBytes)
QString dataDir() const
QString formatFullVersion() const
QString formatSubVersion() const
void networkActiveChanged(bool networkActive)
interfaces::Node & node() const
Definition: clientmodel.h:66
static std::vector< std::string > ToStrings(NetPermissionFlags flags)
QString displayText(const QVariant &value, const QLocale &locale) const override
Definition: rpcconsole.cpp:111
PeerIdViewDelegate(QObject *parent=nullptr)
Definition: rpcconsole.cpp:108
QIcon SingleColorIcon(const QString &filename) const
Colorize an icon (given filename) with the icon color.
bool getImagesOnButtons() const
Definition: platformstyle.h:21
QImage SingleColorImage(const QString &filename) const
Colorize an image (given filename) with the icon color.
Local Bitcoin RPC console.
Definition: rpcconsole.h:44
static bool RPCExecuteCommandLine(interfaces::Node &node, std::string &strResult, const std::string &strCommand, std::string *const pstrFilteredOut=nullptr, const QString &wallet_name={})
Definition: rpcconsole.h:52
QMenu * peersTableContextMenu
Definition: rpcconsole.h:171
RPCConsole(interfaces::Node &node, const PlatformStyle *platformStyle, QWidget *parent)
Definition: rpcconsole.cpp:437
struct RPCConsole::TranslatedStrings ts
void browseHistory(int offset)
Go forward or back in history.
static bool RPCParseCommandLine(interfaces::Node *node, std::string &strResult, const std::string &strCommand, bool fExecute, std::string *const pstrFilteredOut=nullptr, const QString &wallet_name={})
Split shell command line into a list of arguments and optionally execute the command(s).
Definition: rpcconsole.cpp:141
QByteArray m_banlist_widget_header_state
Definition: rpcconsole.h:180
void fontSmaller()
Definition: rpcconsole.cpp:799
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:186
void on_lineEdit_returnPressed()
Definition: rpcconsole.cpp:989
QStringList history
Definition: rpcconsole.h:166
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:804
void updateTrafficStats(quint64 totalBytesIn, quint64 totalBytesOut)
update traffic statistics
void setTrafficGraphRange(int mins)
const PlatformStyle *const platformStyle
Definition: rpcconsole.h:170
void setMempoolSize(long numberOfTxs, size_t dynUsage, size_t maxUsage)
Set size (number of transactions and memory usage) of the mempool in the UI.
Definition: rpcconsole.cpp:977
void updateDetailWidget()
show detailed information on ui about selected node
void showEvent(QShowEvent *event) override
void resizeEvent(QResizeEvent *event) override
QString tabTitle(TabTypes tab_type) const
void updateNetworkState()
Update UI with latest network info from model.
Definition: rpcconsole.cpp:930
void clear(bool keep_prompt=false)
Definition: rpcconsole.cpp:829
void disconnectSelectedNode()
Disconnect a selected node on the Peers tab.
@ BANTIME_COLUMN_WIDTH
Definition: rpcconsole.h:159
@ ADDRESS_COLUMN_WIDTH
Definition: rpcconsole.h:155
@ SUBVERSION_COLUMN_WIDTH
Definition: rpcconsole.h:156
@ PING_COLUMN_WIDTH
Definition: rpcconsole.h:157
@ BANSUBNET_COLUMN_WIDTH
Definition: rpcconsole.h:158
QCompleter * autoCompleter
Definition: rpcconsole.h:174
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:169
bool m_is_executing
Definition: rpcconsole.h:178
interfaces::Node & m_node
Definition: rpcconsole.h:163
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:173
void setNumConnections(int count)
Set number of connections shown in the UI.
Definition: rpcconsole.cpp:956
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:969
ClientModel * clientModel
Definition: rpcconsole.h:165
void banSelectedNode(int bantime)
Ban a selected node on the Peers tab.
int historyPtr
Definition: rpcconsole.h:167
void scrollToEnd()
Scroll console view to end.
void keyPressEvent(QKeyEvent *) override
Definition: rpcconsole.cpp:888
void on_tabWidget_currentChanged(int index)
Ui::RPCConsole *const ui
Definition: rpcconsole.h:164
void startExecutor()
void setNetworkActive(bool networkActive)
Set network state shown in the UI.
Definition: rpcconsole.cpp:964
void updateWindowTitle()
void fontBigger()
Definition: rpcconsole.cpp:794
QString cmdBeforeBrowsing
Definition: rpcconsole.h:168
virtual bool eventFilter(QObject *obj, QEvent *event) override
Definition: rpcconsole.cpp:574
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:618
void setTabFocus(enum TabTypes tabType)
set which tab has the focus (is visible)
QByteArray m_peer_widget_header_state
Definition: rpcconsole.h:179
void changeEvent(QEvent *e) override
Definition: rpcconsole.cpp:895
WalletModel * m_last_wallet_model
Definition: rpcconsole.h:177
void showOrHideBanTableIfRequired()
Hides ban table if no bans are present.
RPCExecutor * m_executor
Definition: rpcconsole.h:176
QMenu * banTableContextMenu
Definition: rpcconsole.h:172
QThread thread
Definition: rpcconsole.h:175
void reply(int category, const QString &command)
RPCExecutor(interfaces::Node &node)
Definition: rpcconsole.cpp:92
interfaces::Node & m_node
Definition: rpcconsole.cpp:101
void request(const QString &command, const QString &wallet_name)
Definition: rpcconsole.cpp:381
void push_back(UniValue val)
Definition: univalue.cpp:104
const std::string & get_str() const
bool isArray() const
Definition: univalue.h:87
const UniValue & find_value(std::string_view key) const
Definition: univalue.cpp:233
std::string write(unsigned int prettyIndent=0, unsigned int indentLevel=0) const
bool isStr() const
Definition: univalue.h:85
Int getInt() const
Definition: univalue.h:140
bool isObject() const
Definition: univalue.h:88
Interface to Bitcoin wallet from Qt view code.
Definition: walletmodel.h:49
QString getDisplayName() const
static bool isWalletEnabled()
QString getWalletName() const
Top-level interface for a bitcoin node (bitcoind process).
Definition: node.h:70
virtual bool disconnectById(NodeId id)=0
Disconnect node by id.
virtual bool ban(const CNetAddr &net_addr, int64_t ban_time_offset)=0
Ban node.
virtual std::vector< std::string > listRpcCommands()=0
List rpc commands.
virtual bool getNetworkActive()=0
Get network active.
virtual bool disconnectByAddress(const CNetAddr &net_addr)=0
Disconnect node by address.
UniValue RPCConvertValues(const std::string &strMethod, const std::vector< std::string > &strParams)
Convert command lines arguments to params object when -named is disabled.
Definition: client.cpp:433
SyncType
Definition: clientmodel.h:42
@ CONNECTIONS_IN
Definition: clientmodel.h:50
@ CONNECTIONS_OUT
Definition: clientmodel.h:51
std::string TransportTypeAsString(TransportProtocolType transport_type)
Convert TransportProtocolType enum to a string value.
@ V2
BIP324 protocol.
QString NetworkToQString(Network net)
Convert enum Network to QString.
Definition: guiutil.cpp:680
QString HtmlEscape(const QString &str, bool fMultiLine)
Definition: guiutil.cpp:249
QList< QModelIndex > getEntryData(const QAbstractItemView *view, int column)
Return a field of the currently selected entry as a QString.
Definition: guiutil.cpp:277
QFont fixedPitchFont(bool use_embedded_font)
Definition: guiutil.cpp:100
QString formatBytes(uint64_t bytes)
Definition: guiutil.cpp:817
QString formatDurationStr(std::chrono::seconds dur)
Convert seconds into a QString with days, hours, mins, secs.
Definition: guiutil.cpp:729
void AddButtonShortcut(QAbstractButton *button, const QKeySequence &shortcut)
Connects an additional shortcut to a QAbstractButton.
Definition: guiutil.cpp:144
void handleCloseWindowShortcut(QWidget *w)
Definition: guiutil.cpp:424
void copyEntryData(const QAbstractItemView *view, int column, int role)
Copy a field of the currently selected entry of a view to the clipboard.
Definition: guiutil.cpp:264
QString formatPingTime(std::chrono::microseconds ping_time)
Format a CNodeStats.m_last_ping_time into a user-readable string or display N/A, if 0.
Definition: guiutil.cpp:768
void openDebugLogfile()
Definition: guiutil.cpp:429
QString ConnectionTypeToQString(ConnectionType conn_type, bool prepend_direction)
Convert enum ConnectionType to QString.
Definition: guiutil.cpp:700
QString formatServicesStr(quint64 mask)
Format CNodeStats.nServices bitmask into a user-readable string.
Definition: guiutil.cpp:754
QString formatTimeOffset(int64_t time_offset)
Format a CNodeStateStats.time_offset into a user-readable string.
Definition: guiutil.cpp:775
bool IsEscapeOrBack(int key)
Definition: guiutil.h:408
Definition: messages.h:21
void ThreadRename(const std::string &)
Rename a thread both in terms of an internal (in-memory) name as well as its system thread name.
Definition: threadnames.cpp:55
auto Join(const C &container, const S &separator, UnaryOp unary_op)
Join all container items.
Definition: string.h:204
int64_t NodeId
Definition: net.h:99
const std::vector< std::string > CONNECTION_TYPE_DOC
Definition: net.cpp:45
const std::vector< std::string > TRANSPORT_TYPE_DOC
Definition: net.cpp:54
const int INITIAL_TRAFFIC_GRAPH_MINS
Definition: rpcconsole.cpp:56
const struct @8 ICON_MAPPING[]
const QSize FONT_RANGE(4, 40)
const int CONSOLE_HISTORY
Definition: rpcconsole.cpp:55
static QString categoryClass(int category)
Definition: rpcconsole.cpp:783
const char fontSizeSettingsKey[]
Definition: rpcconsole.cpp:58
const char * url
Definition: rpcconsole.cpp:61
const char * source
Definition: rpcconsole.cpp:62
static int count
assert(!tx.IsCoinBase())