1 #include "rpcconsole.h"
2 #include "ui_rpcconsole.h"
4 #include "clientmodel.h"
5 #include "bitcoinrpc.h"
7 #include "dialogwindowflags.h"
17 #include <openssl/crypto.h>
20 // TODO: make it possible to filter out categories (esp debug messages when implemented)
21 // TODO: receive errors and debug messages through ClientModel
23 const int CONSOLE_HISTORY = 50;
25 const QSize ICON_SIZE(24, 24);
27 const int INITIAL_TRAFFIC_GRAPH_MINS = 30;
33 {"cmd-request", ":/icons/tx_input"},
34 {"cmd-reply", ":/icons/tx_output"},
35 {"cmd-error", ":/icons/tx_output"},
36 {"misc", ":/icons/tx_inout"},
40 /* Object for executing console RPC commands in a separate thread.
42 class RPCExecutor: public QObject
47 void request(const QString &command);
49 void reply(int category, const QString &command);
52 #include "rpcconsole.moc"
54 void RPCExecutor::start()
60 * Split shell command line into a list of arguments. Aims to emulate \c bash and friends.
62 * - Arguments are delimited with whitespace
63 * - Extra whitespace at the beginning and end and between arguments will be ignored
64 * - Text can be "double" or 'single' quoted
65 * - The backslash \c \ is used as escape character
66 * - Outside quotes, any character can be escaped
67 * - Within double quotes, only escape \c " and backslashes before a \c " or another backslash
68 * - Within single quotes, no escaping is possible and no special interpretation takes place
70 * @param[out] args Parsed arguments will be appended to this list
71 * @param[in] strCommand Command line to split
73 bool parseCommandLine(std::vector<std::string> &args, const std::string &strCommand)
82 STATE_ESCAPE_DOUBLEQUOTED
83 } state = STATE_EATING_SPACES;
85 foreach(char ch, strCommand)
89 case STATE_ARGUMENT: // In or after argument
90 case STATE_EATING_SPACES: // Handle runs of whitespace
93 case '"': state = STATE_DOUBLEQUOTED; break;
94 case '\'': state = STATE_SINGLEQUOTED; break;
95 case '\\': state = STATE_ESCAPE_OUTER; break;
96 case ' ': case '\n': case '\t':
97 if(state == STATE_ARGUMENT) // Space ends argument
99 args.push_back(curarg);
102 state = STATE_EATING_SPACES;
104 default: curarg += ch; state = STATE_ARGUMENT;
107 case STATE_SINGLEQUOTED: // Single-quoted string
110 case '\'': state = STATE_ARGUMENT; break;
111 default: curarg += ch;
114 case STATE_DOUBLEQUOTED: // Double-quoted string
117 case '"': state = STATE_ARGUMENT; break;
118 case '\\': state = STATE_ESCAPE_DOUBLEQUOTED; break;
119 default: curarg += ch;
122 case STATE_ESCAPE_OUTER: // '\' outside quotes
123 curarg += ch; state = STATE_ARGUMENT;
125 case STATE_ESCAPE_DOUBLEQUOTED: // '\' in double-quoted text
126 if(ch != '"' && ch != '\\') curarg += '\\'; // keep '\' for everything but the quote and '\' itself
127 curarg += ch; state = STATE_DOUBLEQUOTED;
131 switch(state) // final state
133 case STATE_EATING_SPACES:
136 args.push_back(curarg);
138 default: // ERROR to end in one of the other states
143 void RPCExecutor::request(const QString &command)
145 std::vector<std::string> args;
146 if(!parseCommandLine(args, command.toStdString()))
148 emit reply(RPCConsole::CMD_ERROR, QString("Parse error: unbalanced ' or \""));
152 return; // Nothing to do
155 std::string strPrint;
156 // Convert argument list to JSON objects in method-dependent way,
157 // and pass it along with the method name to the dispatcher.
158 json_spirit::Value result = tableRPC.execute(
160 RPCConvertValues(args[0], std::vector<std::string>(args.begin() + 1, args.end())));
162 // Format result reply
163 if (result.type() == json_spirit::null_type)
165 else if (result.type() == json_spirit::str_type)
166 strPrint = result.get_str();
168 strPrint = write_string(result, true);
170 emit reply(RPCConsole::CMD_REPLY, QString::fromStdString(strPrint));
172 catch (json_spirit::Object& objError)
174 try // Nice formatting for standard-format error
176 int code = find_value(objError, "code").get_int();
177 std::string message = find_value(objError, "message").get_str();
178 emit reply(RPCConsole::CMD_ERROR, QString::fromStdString(message) + " (code " + QString::number(code) + ")");
180 catch(std::runtime_error &) // raised when converting to invalid type, i.e. missing code or message
181 { // Show raw JSON object
182 emit reply(RPCConsole::CMD_ERROR, QString::fromStdString(write_string(json_spirit::Value(objError), false)));
185 catch (std::exception& e)
187 emit reply(RPCConsole::CMD_ERROR, QString("Error: ") + QString::fromStdString(e.what()));
191 RPCConsole::RPCConsole(QWidget *parent) :
193 ui(new Ui::RPCConsole),
199 ui->openDebugLogfileButton->setIcon(QIcon(":/icons/export"));
200 ui->openConfigurationfileButton->setIcon(QIcon(":/icons/export"));
201 ui->showCLOptionsButton->setIcon(QIcon(":/icons/options"));
204 // Install event filter for up and down arrow
205 ui->lineEdit->installEventFilter(this);
206 ui->messagesWidget->installEventFilter(this);
208 connect(ui->clearButton, SIGNAL(clicked()), this, SLOT(clear()));
209 connect(ui->btnClearTrafficGraph, SIGNAL(clicked()), ui->trafficGraph, SLOT(clear()));
211 // set library version labels
212 ui->openSSLVersion->setText(SSLeay_version(SSLEAY_VERSION));
213 ui->berkeleyDBVersion->setText(DbEnv::version(0, 0, 0));
216 setTrafficGraphRange(INITIAL_TRAFFIC_GRAPH_MINS);
221 RPCConsole::~RPCConsole()
227 bool RPCConsole::eventFilter(QObject* obj, QEvent *event)
229 if(event->type() == QEvent::KeyPress) // Special key handling
231 QKeyEvent *keyevt = static_cast<QKeyEvent*>(event);
232 int key = keyevt->key();
233 Qt::KeyboardModifiers mod = keyevt->modifiers();
236 case Qt::Key_Up: if(obj == ui->lineEdit) { browseHistory(-1); return true; } break;
237 case Qt::Key_Down: if(obj == ui->lineEdit) { browseHistory(1); return true; } break;
238 case Qt::Key_PageUp: /* pass paging keys to messages widget */
239 case Qt::Key_PageDown:
240 if(obj == ui->lineEdit)
242 QApplication::postEvent(ui->messagesWidget, new QKeyEvent(*keyevt));
247 // Typing in messages widget brings focus to line edit, and redirects key there
248 // Exclude most combinations and keys that emit no text, except paste shortcuts
249 if(obj == ui->messagesWidget && (
250 (!mod && !keyevt->text().isEmpty() && key != Qt::Key_Tab) ||
251 ((mod & Qt::ControlModifier) && key == Qt::Key_V) ||
252 ((mod & Qt::ShiftModifier) && key == Qt::Key_Insert)))
254 ui->lineEdit->setFocus();
255 QApplication::postEvent(ui->lineEdit, new QKeyEvent(*keyevt));
260 return QWidget::eventFilter(obj, event);
263 void RPCConsole::setClientModel(ClientModel *model)
265 this->clientModel = model;
266 ui->trafficGraph->setClientModel(model);
269 // Subscribe to information, replies, messages, errors
270 connect(model, SIGNAL(numConnectionsChanged(int)), this, SLOT(setNumConnections(int)));
271 connect(model, SIGNAL(numBlocksChanged(int,int)), this, SLOT(setNumBlocks(int,int)));
273 updateTrafficStats(model->getTotalBytesRecv(), model->getTotalBytesSent());
274 connect(model, SIGNAL(bytesChanged(quint64,quint64)), this, SLOT(updateTrafficStats(quint64, quint64)));
275 // Provide initial values
276 ui->clientVersion->setText(model->formatFullVersion());
277 ui->clientName->setText(model->clientName());
278 ui->buildDate->setText(model->formatBuildDate());
279 ui->startupTime->setText(model->formatClientStartupTime());
281 setNumConnections(model->getNumConnections());
282 ui->isTestNet->setChecked(model->isTestNet());
284 setNumBlocks(model->getNumBlocks(), model->getNumBlocksOfPeers());
288 static QString categoryClass(int category)
292 case RPCConsole::CMD_REQUEST: return "cmd-request"; break;
293 case RPCConsole::CMD_REPLY: return "cmd-reply"; break;
294 case RPCConsole::CMD_ERROR: return "cmd-error"; break;
295 default: return "misc";
299 void RPCConsole::clear()
301 ui->messagesWidget->clear();
302 ui->lineEdit->clear();
303 ui->lineEdit->setFocus();
305 // Add smoothly scaled icon images.
306 // (when using width/height on an img, Qt uses nearest instead of linear interpolation)
307 for(int i=0; ICON_MAPPING[i].url; ++i)
309 ui->messagesWidget->document()->addResource(
310 QTextDocument::ImageResource,
311 QUrl(ICON_MAPPING[i].url),
312 QImage(ICON_MAPPING[i].source).scaled(ICON_SIZE, Qt::IgnoreAspectRatio, Qt::SmoothTransformation));
315 // Set default style sheet
316 ui->messagesWidget->document()->setDefaultStyleSheet(
318 "td.time { color: #808080; padding-top: 3px; } "
319 "td.message { font-family: Monospace; } "
320 "td.cmd-request { color: #006060; } "
321 "td.cmd-error { color: red; } "
322 "b { color: #006060; } "
325 message(CMD_REPLY, (tr("Welcome to the NovaCoin RPC console.") + "<br>" +
326 tr("Use up and down arrows to navigate history, and <b>Ctrl-L</b> to clear screen.") + "<br>" +
327 tr("Type <b>help</b> for an overview of available commands.")), true);
330 void RPCConsole::message(int category, const QString &message, bool html)
332 QTime time = QTime::currentTime();
333 QString timeString = time.toString();
335 out += "<table><tr><td class=\"time\" width=\"65\">" + timeString + "</td>";
336 out += "<td class=\"icon\" width=\"32\"><img src=\"" + categoryClass(category) + "\"></td>";
337 out += "<td class=\"message " + categoryClass(category) + "\" valign=\"middle\">";
341 out += GUIUtil::HtmlEscape(message, true);
342 out += "</td></tr></table>";
343 ui->messagesWidget->append(out);
346 void RPCConsole::setNumConnections(int count)
351 QString connections = QString::number(count) + " (";
352 connections += tr("Inbound:") + " " + QString::number(clientModel->getNumConnections(CONNECTIONS_IN)) + " / ";
353 connections += tr("Outbound:") + " " + QString::number(clientModel->getNumConnections(CONNECTIONS_OUT)) + ")";
355 ui->numberOfConnections->setText(connections);
358 void RPCConsole::setNumBlocks(int count, int countOfPeers)
360 ui->numberOfBlocks->setText(QString::number(count));
361 ui->totalBlocks->setText(QString::number(countOfPeers));
364 // If there is no current number available display N/A instead of 0, which can't ever be true
365 ui->totalBlocks->setText(clientModel->getNumBlocksOfPeers() == 0 ? tr("N/A") : QString::number(clientModel->getNumBlocksOfPeers()));
366 ui->lastBlockTime->setText(clientModel->getLastBlockDate().toString());
370 void RPCConsole::on_lineEdit_returnPressed()
372 QString cmd = ui->lineEdit->text();
373 ui->lineEdit->clear();
377 message(CMD_REQUEST, cmd);
378 emit cmdRequest(cmd);
379 // Remove command, if already in history
380 history.removeOne(cmd);
381 // Append command to history
383 // Enforce maximum history size
384 while(history.size() > CONSOLE_HISTORY)
385 history.removeFirst();
386 // Set pointer to end of history
387 historyPtr = history.size();
388 // Scroll console view to end
393 void RPCConsole::browseHistory(int offset)
395 historyPtr += offset;
398 if(historyPtr > history.size())
399 historyPtr = history.size();
401 if(historyPtr < history.size())
402 cmd = history.at(historyPtr);
403 ui->lineEdit->setText(cmd);
406 void RPCConsole::startExecutor()
408 QThread* thread = new QThread;
409 RPCExecutor *executor = new RPCExecutor();
410 executor->moveToThread(thread);
412 // Notify executor when thread started (in executor thread)
413 connect(thread, SIGNAL(started()), executor, SLOT(start()));
414 // Replies from executor object must go to this object
415 connect(executor, SIGNAL(reply(int,QString)), this, SLOT(message(int,QString)));
416 // Requests from this object must go to executor
417 connect(this, SIGNAL(cmdRequest(QString)), executor, SLOT(request(QString)));
418 // On stopExecutor signal
419 // - queue executor for deletion (in execution thread)
420 // - quit the Qt event loop in the execution thread
421 connect(this, SIGNAL(stopExecutor()), executor, SLOT(deleteLater()));
422 connect(this, SIGNAL(stopExecutor()), thread, SLOT(quit()));
423 // Queue the thread for deletion (in this thread) when it is finished
424 connect(thread, SIGNAL(finished()), thread, SLOT(deleteLater()));
426 // Default implementation of QThread::run() simply spins up an event loop in the thread,
427 // which is what we want.
431 void RPCConsole::on_tabWidget_currentChanged(int index)
433 if(ui->tabWidget->widget(index) == ui->tab_console)
435 ui->lineEdit->setFocus();
439 void RPCConsole::on_openDebugLogfileButton_clicked()
441 GUIUtil::openDebugLogfile();
444 void RPCConsole::on_openConfigurationfileButton_clicked()
446 GUIUtil::openConfigfile();
449 void RPCConsole::scrollToEnd()
451 QScrollBar *scrollbar = ui->messagesWidget->verticalScrollBar();
452 scrollbar->setValue(scrollbar->maximum());
455 void RPCConsole::on_showCLOptionsButton_clicked()
457 GUIUtil::HelpMessageBox help;
460 void RPCConsole::on_sldGraphRange_valueChanged(int value)
462 const int multiplier = 5; // each position on the slider represents 5 min
463 int mins = value * multiplier;
464 setTrafficGraphRange(mins);
467 QString RPCConsole::FormatBytes(quint64 bytes)
470 return QString(tr("%1 B")).arg(bytes);
471 if(bytes < 1024 * 1024)
472 return QString(tr("%1 KB")).arg(bytes / 1024);
473 if(bytes < 1024 * 1024 * 1024)
474 return QString(tr("%1 MB")).arg(bytes / 1024 / 1024);
476 return QString(tr("%1 GB")).arg(bytes / 1024 / 1024 / 1024);
479 void RPCConsole::setTrafficGraphRange(int mins)
481 ui->trafficGraph->setGraphRangeMins(mins);
482 ui->lblGraphRange->setText(GUIUtil::formatDurationStr(mins * 60));
485 void RPCConsole::updateTrafficStats(quint64 totalBytesIn, quint64 totalBytesOut)
487 ui->lblBytesIn->setText(FormatBytes(totalBytesIn));
488 ui->lblBytesOut->setText(FormatBytes(totalBytesOut));
491 void RPCConsole::resizeEvent(QResizeEvent *event)
493 QWidget::resizeEvent(event);
496 void RPCConsole::showEvent(QShowEvent *event)
498 QWidget::showEvent(event);
504 void RPCConsole::hideEvent(QHideEvent *event)
506 QWidget::hideEvent(event);
512 void RPCConsole::keyPressEvent(QKeyEvent *event)
515 if(windowType() != Qt::Widget && event->key() == Qt::Key_Back)
520 if(windowType() != Qt::Widget && event->key() == Qt::Key_Escape)