qdbusviewer.cpp

Go to the documentation of this file.

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0
 
#include "qdbusviewer.h"
#include "qdbusmodel.h"
#include "servicesproxymodel.h"
#include "propertydialog.h"
#include "logviewer.h"
 
#include <QtWidgets/QLineEdit>
#include <QtWidgets/QVBoxLayout>
#include <QtWidgets/QSplitter>
#include <QtWidgets/QInputDialog>
#include <QtWidgets/QMessageBox>
#include <QtWidgets/QMenu>
#include <QtWidgets/QTableWidget>
#include <QtWidgets/QTreeWidget>
#include <QtWidgets/QHeaderView>
 
#include <QtDBus/QDBusConnectionInterface>
#include <QtDBus/QDBusInterface>
#include <QtDBus/QDBusMetaType>
#include <QtDBus/QDBusServiceWatcher>
 
#include <QtGui/QAction>
#include <QtGui/QClipboard>
#include <QtGui/QKeyEvent>
#include <QtGui/QShortcut>
 
#include <QtCore/QStringListModel>
#include <QtCore/QMetaProperty>
#include <QtCore/QSettings>
 
#include <private/qdbusutil_p.h>
 
using namespace Qt::StringLiterals;
 
// Use enum for context menu's QAction::data to avoid collisions
enum DBusActionData {
    // Start with 1, because 0 is ambiguous since QVariant::toInt returns 0 on failure.
    ACTION_DATA_REFRESH_CHILDREN = 1,
    ACTION_DATA_COPY_SERVICE_NAME,
    ACTION_DATA_COPY_OBJECT_PATH,
    ACTION_DATA_COPY_INTERFACE_NAME,
    ACTION_DATA_COPY_MEMBER_NAME,
    ACTION_DATA_CONNECT,
    ACTION_DATA_CALL,
    ACTION_DATA_SET_PROPERTY,
    ACTION_DATA_GET_PROPERTY
};
 
class QDBusViewModel: public QDBusModel
{
public:
    inline QDBusViewModel(const QString &service, const QDBusConnection &connection)
        : QDBusModel(service, connection)
    {}
 
    QVariant data(const QModelIndex &index, int role = Qt::DisplayRole) const override
    {
        if (role == Qt::FontRole && itemType(index) == InterfaceItem) {
            QFont f;
            f.setItalic(true);
            return f;
        }
        return QDBusModel::data(index, role);
    }
};
 
class ServicesModel : public QStringListModel
{
public:
    explicit ServicesModel(QObject *parent = nullptr)
        : QStringListModel(parent)
    {}
 
    Qt::ItemFlags flags(const QModelIndex &index) const override
    {
        return QStringListModel::flags(index) & ~Qt::ItemIsEditable;
    }
};
 
QDBusViewer::QDBusViewer(const QDBusConnection &connection, QWidget *parent)
    : QWidget(parent), c(connection), objectPathRegExp("\\‍[ObjectPath: (.*)\\‍]"_L1)
{
    serviceFilterLine = new QLineEdit(this);
    serviceFilterLine->setPlaceholderText(tr("Search..."));
    serviceFilterLine->setClearButtonEnabled(true);
 
    // Create model for services list
    servicesModel = new ServicesModel(this);
    // Wrap service list model in proxy for easy filtering and interactive sorting
    servicesProxyModel = new ServicesProxyModel(this);
    servicesProxyModel->setSourceModel(servicesModel);
    servicesProxyModel->setFilterCaseSensitivity(Qt::CaseInsensitive);
 
    servicesView = new QTableView(this);
    servicesView->installEventFilter(this);
    servicesView->setModel(servicesProxyModel);
    // Make services grid view behave like a list view with headers
    servicesView->verticalHeader()->hide();
    servicesView->horizontalHeader()->setStretchLastSection(true);
    servicesView->setShowGrid(false);
    // Sort service list by default
    servicesView->setSortingEnabled(true);
    servicesView->sortByColumn(0, Qt::AscendingOrder);
    servicesView->setContextMenuPolicy(Qt::CustomContextMenu);
    connect(servicesView, &QWidget::customContextMenuRequested, this, &QDBusViewer::showServicesViewContextMenu);
 
    connect(serviceFilterLine, &QLineEdit::textChanged, servicesProxyModel, &QSortFilterProxyModel::setFilterFixedString);
    connect(serviceFilterLine, &QLineEdit::returnPressed, this, &QDBusViewer::serviceFilterReturnPressed);
 
    tree = new QTreeView;
    tree->setContextMenuPolicy(Qt::CustomContextMenu);
    connect(tree, &QWidget::customContextMenuRequested, this, &QDBusViewer::showTreeViewContextMenu);
    connect(tree, &QAbstractItemView::activated, this, &QDBusViewer::activate);
 
    refreshChildrenAction = new QAction(tr("&Refresh"), this);
    refreshChildrenAction->setData(ACTION_DATA_REFRESH_CHILDREN);
    refreshChildrenAction->setShortcut(QKeySequence::Refresh);
    connect(refreshChildrenAction, &QAction::triggered, this, &QDBusViewer::refreshChildren);
 
    QShortcut *refreshShortcut = new QShortcut(QKeySequence::Refresh, this);
    connect(refreshShortcut, &QShortcut::activated, this, &QDBusViewer::refreshChildren);
 
    copyServiceNameAction = new QAction(tr("&Copy Service Name"), this);
    copyServiceNameAction->setData(ACTION_DATA_COPY_SERVICE_NAME);
    copyServiceNameAction->setShortcut(QKeySequence::Copy);
 
    copyObjectPathAction = new QAction(tr("&Copy Object Path"), this);
    copyObjectPathAction->setData(ACTION_DATA_COPY_OBJECT_PATH);
    copyInterfaceNameAction = new QAction(tr("Copy &Interface Name"), this);
    copyInterfaceNameAction->setData(ACTION_DATA_COPY_INTERFACE_NAME);
    // Mutually exclusive actions share the same data tag
    copyMemberSignalNameAction = new QAction(tr("Copy Signal &Name"), this);
    copyMemberSignalNameAction->setData(ACTION_DATA_COPY_MEMBER_NAME);
    copyMemberMethodNameAction = new QAction(tr("Copy Method &Name"), this);
    copyMemberMethodNameAction->setData(ACTION_DATA_COPY_MEMBER_NAME);
    copyMemberPropertyNameAction = new QAction(tr("Copy Property &Name"), this);
    copyMemberPropertyNameAction->setData(ACTION_DATA_COPY_MEMBER_NAME);
 
    connectAction = new QAction(tr("&Connect"), this);
    connectAction->setData(ACTION_DATA_CONNECT);
    callAction = new QAction(tr("&Call"), this);
    callAction->setData(ACTION_DATA_CALL);
 
    QVBoxLayout *layout = new QVBoxLayout(this);
    topSplitter = new QSplitter(Qt::Vertical, this);
    layout->addWidget(topSplitter);
 
    log = new LogViewer;
    connect(log, &QTextBrowser::anchorClicked, this, &QDBusViewer::anchorClicked);
 
    splitter = new QSplitter(topSplitter);
    splitter->addWidget(servicesView);
 
    QWidget *servicesWidget = new QWidget;
    QVBoxLayout *servicesLayout = new QVBoxLayout(servicesWidget);
    servicesLayout->setContentsMargins(QMargins());
    servicesLayout->addWidget(serviceFilterLine);
    servicesLayout->addWidget(servicesView);
    splitter->addWidget(servicesWidget);
    splitter->addWidget(tree);
 
    topSplitter->addWidget(splitter);
    topSplitter->addWidget(log);
 
    connect(servicesView->selectionModel(), &QItemSelectionModel::currentChanged, this, &QDBusViewer::serviceChanged);
 
    QMetaObject::invokeMethod(this, &QDBusViewer::refresh, Qt::QueuedConnection);
 
    if (c.isConnected()) {
        QDBusServiceWatcher *watcher =
                new QDBusServiceWatcher("*", c, QDBusServiceWatcher::WatchForOwnerChange, this);
        connect(watcher, &QDBusServiceWatcher::serviceOwnerChanged, this,
                &QDBusViewer::serviceOwnerChanged);
        logMessage(tr("Connected to D-Bus."));
    } else {
        logError(tr("Cannot connect to D-Bus: %1").arg(c.lastError().message()));
    }
 
    objectPathRegExp.setPatternOptions(QRegularExpression::InvertedGreedinessOption);
}
 
static inline QString topSplitterStateKey()
{
    return u"topSplitterState"_s;
}
 
static inline QString splitterStateKey()
{
    return u"splitterState"_s;
}
 
void QDBusViewer::saveState(QSettings *settings) const
{
    settings->setValue(topSplitterStateKey(), topSplitter->saveState());
    settings->setValue(splitterStateKey(), splitter->saveState());
}
 
void QDBusViewer::restoreState(const QSettings *settings)
{
    topSplitter->restoreState(settings->value(topSplitterStateKey()).toByteArray());
    splitter->restoreState(settings->value(splitterStateKey()).toByteArray());
}
 
void QDBusViewer::logMessage(const QString &msg)
{
    log->append(msg + '\n'_L1);
}
 
void QDBusViewer::showEvent(QShowEvent *)
{
    serviceFilterLine->setFocus();
}
 
bool QDBusViewer::eventFilter(QObject *obj, QEvent *event)
{
    if (obj == servicesView) {
        if (event->type() == QEvent::KeyPress) {
            QKeyEvent *keyEvent = static_cast<QKeyEvent*>(event);
            if (keyEvent->modifiers() == Qt::NoModifier) {
                if (keyEvent->key() == Qt::Key_Enter || keyEvent->key() == Qt::Key_Return) {
                    tree->setFocus();
                }
            }
        }
    }
    return false;
}
 
void QDBusViewer::logError(const QString &msg)
{
    log->append(tr("<font color=\"red\">Error: </font>%1<br>").arg(msg.toHtmlEscaped()));
}
 
void QDBusViewer::refresh()
{
    servicesModel->removeRows(0, servicesModel->rowCount());
 
    if (c.isConnected()) {
        const QStringList serviceNames = c.interface()->registeredServiceNames();
        servicesModel->setStringList(serviceNames);
    }
}
 
void QDBusViewer::activate(const QModelIndex &item)
{
    if (!item.isValid())
        return;
 
    const QDBusModel *model = static_cast<const QDBusModel *>(item.model());
 
    BusSignature sig;
    sig.mService = currentService;
    sig.mPath = model->dBusPath(item);
    sig.mInterface = model->dBusInterface(item);
    sig.mName = model->dBusMethodName(item);
    sig.mTypeSig = model->dBusTypeSignature(item);
 
    switch (model->itemType(item)) {
    case QDBusModel::SignalItem:
        connectionRequested(sig);
        break;
    case QDBusModel::MethodItem:
        callMethod(sig);
        break;
    case QDBusModel::PropertyItem:
        getProperty(sig);
        break;
    default:
        break;
    }
}
 
void QDBusViewer::getProperty(const BusSignature &sig)
{
    QDBusMessage message = QDBusMessage::createMethodCall(
            sig.mService, sig.mPath, "org.freedesktop.DBus.Properties"_L1, "Get"_L1);
    QList<QVariant> arguments;
    arguments << sig.mInterface << sig.mName;
    message.setArguments(arguments);
    c.callWithCallback(message, this, SLOT(dumpMessage(QDBusMessage)), SLOT(dumpError(QDBusError)));
}
 
void QDBusViewer::setProperty(const BusSignature &sig)
{
    QDBusInterface iface(sig.mService, sig.mPath, sig.mInterface, c);
    const int index = iface.metaObject()->indexOfProperty(sig.mName.toLatin1().constData());
    QMetaProperty prop = iface.metaObject()->property(index);
 
    bool ok;
    QString input = QInputDialog::getText(this, tr("Arguments"),
                    tr("Please enter the value of the property %1 (type %2)").arg(
                        sig.mName, QString::fromLatin1(prop.typeName())),
                    QLineEdit::Normal, QString(), &ok);
    if (!ok)
        return;
 
    QVariant value = input;
    if (!value.convert(prop.metaType())) {
        QMessageBox::warning(this, tr("Unable to marshall"),
                tr("Value conversion failed, unable to set property"));
        return;
    }
 
    QDBusMessage message = QDBusMessage::createMethodCall(
            sig.mService, sig.mPath, "org.freedesktop.DBus.Properties"_L1, "Set"_L1);
    QList<QVariant> arguments;
    arguments << sig.mInterface << sig.mName << QVariant::fromValue(QDBusVariant(value));
    message.setArguments(arguments);
    c.callWithCallback(message, this, SLOT(dumpMessage(QDBusMessage)), SLOT(dumpError(QDBusError)));
}
 
static QString getDbusSignature(const QMetaMethod& method)
{
    // create a D-Bus type signature from QMetaMethod's parameters
    QString sig;
    for (const auto &type : method.parameterTypes())
        sig.append(QString::fromLatin1(QDBusMetaType::typeToSignature(QMetaType::fromName(type))));
    return sig;
}
 
void QDBusViewer::callMethod(const BusSignature &sig)
{
    QDBusInterface iface(sig.mService, sig.mPath, sig.mInterface, c);
    const QMetaObject *mo = iface.metaObject();
 
    // find the method
    QMetaMethod method;
    for (int i = 0; i < mo->methodCount(); ++i) {
        const QString signature = QString::fromLatin1(mo->method(i).methodSignature());
        if (signature.startsWith(sig.mName) && signature.at(sig.mName.size()) == '('_L1)
            if (getDbusSignature(mo->method(i)) == sig.mTypeSig)
                method = mo->method(i);
    }
    if (!method.isValid()) {
        QMessageBox::warning(this, tr("Unable to find method"),
                tr("Unable to find method %1 on path %2 in interface %3").arg(
                    sig.mName).arg(sig.mPath).arg(sig.mInterface));
        return;
    }
 
    PropertyDialog dialog;
    QList<QVariant> args;
 
    const QList<QByteArray> paramTypes = method.parameterTypes();
    const QList<QByteArray> paramNames = method.parameterNames();
    QList<int> types; // remember the low-level D-Bus type
    for (int i = 0; i < paramTypes.size(); ++i) {
        const QByteArray paramType = paramTypes.at(i);
        if (paramType.endsWith('&'))
            continue; // ignore OUT parameters
 
        const int type = QMetaType::fromName(paramType).id();
        dialog.addProperty(QString::fromLatin1(paramNames.value(i)), type);
        types.append(type);
    }
 
    if (!types.isEmpty()) {
        dialog.setInfo(tr("Please enter parameters for the method \"%1\"").arg(sig.mName));
 
        if (dialog.exec() != QDialog::Accepted)
            return;
 
        args = dialog.values();
    }
 
    // Try to convert the values we got as closely as possible to the
    // dbus signature. This is especially important for those input as strings
    for (int i = 0; i < args.size(); ++i) {
        QVariant a = args.at(i);
        int desttype = types.at(i);
        if (desttype < int(QMetaType::User) && desttype != qMetaTypeId<QVariantMap>()) {
            const QMetaType metaType(desttype);
            if (a.canConvert(metaType))
                args[i].convert(metaType);
        }
        // Special case - convert a value to a QDBusVariant if the
        // interface wants a variant
        if (types.at(i) == qMetaTypeId<QDBusVariant>())
            args[i] = QVariant::fromValue(QDBusVariant(args.at(i)));
    }
 
    QDBusMessage message = QDBusMessage::createMethodCall(sig.mService, sig.mPath, sig.mInterface,
            sig.mName);
    message.setArguments(args);
    c.callWithCallback(message, this, SLOT(dumpMessage(QDBusMessage)), SLOT(dumpError(QDBusError)));
}
 
void QDBusViewer::showServicesViewContextMenu(const QPoint &point)
{
    QModelIndex item = servicesView->indexAt(point);
    if (!item.isValid())
        return;
 
    const QString serviceName = item.data().toString();
 
    QMenu menu;
    // servicesView doesn't need a manual refresh action, because the model updates automatically
    menu.addAction(copyServiceNameAction);
 
    QAction *selectedAction = menu.exec(servicesView->viewport()->mapToGlobal(point));
    if (!selectedAction)
        return;
 
    switch (selectedAction->data().toInt()) {
    case ACTION_DATA_COPY_SERVICE_NAME:
        QGuiApplication::clipboard()->setText(serviceName);
        break;
    default:
        break;
    }
}
 
void QDBusViewer::showTreeViewContextMenu(const QPoint &point)
{
    QModelIndex item = tree->indexAt(point);
    if (!item.isValid())
        return;
 
    const QDBusModel *model = static_cast<const QDBusModel *>(item.model());
 
    auto itemType = model->itemType(item);
 
    BusSignature sig;
    sig.mService = currentService;
    sig.mPath = model->dBusPath(item);
    sig.mInterface = model->dBusInterface(item);
    sig.mName = model->dBusMethodName(item);
    sig.mTypeSig = model->dBusTypeSignature(item);
 
    QMenu menu;
    menu.addAction(refreshChildrenAction);
 
    // Object path is applicable to all types of items
    menu.addAction(copyObjectPathAction);
 
    // Interface name is applicable to interfaces and members
    switch (itemType) {
    case QDBusModel::InterfaceItem:
    case QDBusModel::SignalItem:
    case QDBusModel::MethodItem:
    case QDBusModel::PropertyItem:
        menu.addAction(copyInterfaceNameAction);
        break;
    default:
        break;
    }
 
    switch (itemType) {
    case QDBusModel::SignalItem: {
        menu.addAction(copyMemberSignalNameAction);
        menu.addAction(connectAction);
        break; }
    case QDBusModel::MethodItem: {
        menu.addAction(copyMemberMethodNameAction);
        menu.addAction(callAction);
        break; }
    case QDBusModel::PropertyItem: {
        menu.addAction(copyMemberPropertyNameAction);
        QDBusInterface iface(sig.mService, sig.mPath, sig.mInterface, c);
        const int index = iface.metaObject()->indexOfProperty(sig.mName.toLatin1().constData());
        QMetaProperty prop = iface.metaObject()->property(index);
        QAction *actionSet = new QAction(tr("&Set value"), &menu);
        actionSet->setData(ACTION_DATA_SET_PROPERTY);
        actionSet->setEnabled(prop.isWritable());
        QAction *actionGet = new QAction(tr("&Get value"), &menu);
        actionGet->setEnabled(prop.isReadable());
        actionGet->setData(ACTION_DATA_GET_PROPERTY);
        menu.addAction(actionSet);
        menu.addAction(actionGet);
        break; }
    default:
        break;
    }
 
    QAction *selectedAction = menu.exec(tree->viewport()->mapToGlobal(point));
    if (!selectedAction)
        return;
 
    switch (selectedAction->data().toInt()) {
    case ACTION_DATA_COPY_OBJECT_PATH:
        QGuiApplication::clipboard()->setText(sig.mPath);
        break;
    case ACTION_DATA_COPY_INTERFACE_NAME:
        QGuiApplication::clipboard()->setText(sig.mInterface);
        break;
    case ACTION_DATA_COPY_MEMBER_NAME:
        QGuiApplication::clipboard()->setText(sig.mName);
        break;
    case ACTION_DATA_CONNECT:
        connectionRequested(sig);
        break;
    case ACTION_DATA_CALL:
        callMethod(sig);
        break;
    case ACTION_DATA_SET_PROPERTY:
        setProperty(sig);
        break;
    case ACTION_DATA_GET_PROPERTY:
        getProperty(sig);
        break;
    default:
        break;
    }
}
 
void QDBusViewer::connectionRequested(const BusSignature &sig)
{
    if (c.connect(sig.mService, QString(), sig.mInterface, sig.mName, this,
              SLOT(dumpMessage(QDBusMessage)))) {
        logMessage(tr("Connected to service %1, path %2, interface %3, signal %4").arg(
                    sig.mService, sig.mPath, sig.mInterface, sig.mName));
    } else {
        logError(tr("Unable to connect to service %1, path %2, interface %3, signal %4").arg(
                    sig.mService, sig.mPath, sig.mInterface, sig.mName));
    }
}
 
void QDBusViewer::dumpMessage(const QDBusMessage &message)
{
    QList<QVariant> args = message.arguments();
 
    QString messageType;
    switch (message.type()) {
    case QDBusMessage::SignalMessage:
        messageType = tr("signal");
        break;
    case QDBusMessage::ErrorMessage:
        messageType = tr("error message");
        break;
    case QDBusMessage::ReplyMessage:
        messageType = tr("reply");
        break;
    default:
        messageType = tr("message");
        break;
    }
 
    QString out = tr("Received %1 from %2").arg(messageType).arg(message.service());
 
    if (!message.path().isEmpty())
        out += tr(", path %1").arg(message.path());
    if (!message.interface().isEmpty())
        out += tr(", interface <i>%1</i>").arg(message.interface());
    if (!message.member().isEmpty())
        out += tr(", member %1").arg(message.member());
    out += "<br>"_L1;
    if (args.isEmpty()) {
        out += tr("&nbsp;&nbsp;(no arguments)");
    } else {
        QStringList argStrings;
        for (const QVariant &arg : std::as_const(args)) {
            QString str = QDBusUtil::argumentToString(arg).toHtmlEscaped();
            // turn object paths into clickable links
            str.replace(objectPathRegExp, tr("[ObjectPath: <a href=\"qdbus://bus\\1\">\\1</a>]"));
            // convert new lines from command to proper HTML line breaks
            str.replace("\n"_L1, "<br/>"_L1);
            argStrings.append(str);
        }
        out += tr("&nbsp;&nbsp;Arguments: %1").arg(argStrings.join(tr(", ")));
    }
 
    log->append(out);
}
 
void QDBusViewer::dumpError(const QDBusError &error)
{
    logError(error.message());
}
 
void QDBusViewer::serviceChanged(const QModelIndex &index)
{
    delete tree->model();
 
    currentService.clear();
    if (!index.isValid())
        return;
    currentService = index.data().toString();
 
    QDBusViewModel *model = new QDBusViewModel(currentService, c);
    tree->setModel(model);
    connect(model, &QDBusModel::busError, this, &QDBusViewer::logError);
}
 
void QDBusViewer::serviceRegistered(const QString &service)
{
    if (service == c.baseService())
        return;
 
    servicesModel->insertRows(0, 1);
    servicesModel->setData(servicesModel->index(0, 0), service);
}
 
static QModelIndex findItem(QStringListModel *servicesModel, const QString &name)
{
    QModelIndexList hits = servicesModel->match(servicesModel->index(0, 0), Qt::DisplayRole, name);
    if (hits.isEmpty())
        return QModelIndex();
 
    return hits.first();
}
 
void QDBusViewer::serviceOwnerChanged(const QString &name, const QString &oldOwner,
                                      const QString &newOwner)
{
    QModelIndex hit = findItem(servicesModel, name);
 
    if (!hit.isValid() && oldOwner.isEmpty() && !newOwner.isEmpty())
        serviceRegistered(name);
    else if (hit.isValid() && !oldOwner.isEmpty() && newOwner.isEmpty())
        servicesModel->removeRows(hit.row(), 1);
    else if (hit.isValid() && !oldOwner.isEmpty() && !newOwner.isEmpty()) {
        servicesModel->removeRows(hit.row(), 1);
        serviceRegistered(name);
    }
}
 
void QDBusViewer::serviceFilterReturnPressed()
{
    if (servicesProxyModel->rowCount() <= 0)
        return;
 
    servicesView->selectRow(0);
    servicesView->setFocus();
}
 
void QDBusViewer::refreshChildren()
{
    QDBusModel *model = qobject_cast<QDBusModel *>(tree->model());
    if (!model)
        return;
    model->refresh(tree->currentIndex());
}
 
void QDBusViewer::anchorClicked(const QUrl &url)
{
    if (url.scheme() != "qdbus"_L1)
        // not ours
        return;
 
    // swallow the click without setting a new document
    log->setSource(QUrl());
 
    QDBusModel *model = qobject_cast<QDBusModel *>(tree->model());
    if (!model)
        return;
 
    QModelIndex idx = model->findObject(QDBusObjectPath(url.path()));
    if (!idx.isValid())
        return;
 
    tree->scrollTo(idx);
    tree->setCurrentIndex(idx);
}