Runner for executing commands on remote device

Summary: Add a runner that allows executing commands on a connected device. It enables a more keyboard-centric workflow than running the commands from the plasmoid.

Test Plan: Connect desktop device. Add some commands there. restart krunner, open it, start typing command or device name. Select entry to execute command. Check for success.

Reviewers: #kde_connect, #plasma, broulik, davidedmundson, apol

Reviewed By: #kde_connect, apol

Subscribers: apol, ngraham, kdeconnect

Tags: #kde_connect

Differential Revision: https://phabricator.kde.org/D14604

CMakeLists.txt

@@ -27,7 +27,7 @@ else()
     set(KF5_REQUIRED_COMPONENTS I18n ConfigWidgets DBusAddons IconThemes Notifications KIO KCMUtils)
     set(KF5_OPTIONAL_COMPONENTS DocTools)
     if(UNIX)
-        set(KF5_OPTIONAL_COMPONENTS ${KF5_OPTIONAL_COMPONENTS} PulseAudioQt)
+        set(KF5_OPTIONAL_COMPONENTS ${KF5_OPTIONAL_COMPONENTS} PulseAudioQt Runner)
     endif()
     set(QCA_MIN_VERSION "2.1.0")
     find_package(Qca-qt5 ${QCA_MIN_VERSION} REQUIRED)
@@ -99,6 +99,10 @@ add_subdirectory(plugins)
 add_subdirectory(cli)
 add_subdirectory(declarativeplugin)
 
+if(KF5Runner_FOUND)
+    add_subdirectory(runners)
+endif()
+
 if (NOT SAILFISHOS)
     add_subdirectory(indicator)
     add_subdirectory(urlhandler)

runners/CMakeLists.txt

@@ -0,0 +1 @@
+add_subdirectory(remotecommands)

runners/remotecommands/CMakeLists.txt

@@ -0,0 +1,7 @@
+add_definitions(-DTRANSLATION_DOMAIN="plasma_runner_kdeconnect_remotecommands")
+
+add_library(krunner_kdeconnect_remotecommands MODULE remotecommandsrunner.cpp)
+target_link_libraries(krunner_kdeconnect_remotecommands PUBLIC KF5::Runner kdeconnectinterfaces)
+
+install(TARGETS krunner_kdeconnect_remotecommands DESTINATION ${KDE_INSTALL_PLUGINDIR})
+install(FILES plasma-runner-kdeconnect-remotecommands.desktop DESTINATION ${KDE_INSTALL_KSERVICES5DIR})

runners/remotecommands/Messages.sh

@@ -0,0 +1,2 @@
+#! /usr/bin/env bash
+$XGETTEXT *.cpp -o $podir/plasma_runner_kdeconnect_remotecommands.pot

runners/remotecommands/plasma-runner-kdeconnect-remotecommands.desktop

@@ -0,0 +1,13 @@
+[Desktop Entry]
+Name=Run command
+Comment=Run commands on connected devices
+Icon=kdeconnect
+Type=Service
+X-KDE-ServiceTypes=Plasma/Runner
+
+X-KDE-Library=krunner_kdeconnect_remotecommands
+X-KDE-PluginInfo-Author=Nicolas Fella
+X-KDE-PluginInfo-Email=nicolas.fella@gmx.de
+X-KDE-PluginInfo-Version=0.1
+X-KDE-PluginInfo-License=GPL
+X-KDE-PluginInfo-EnabledByDefault=true

runners/remotecommands/remotecommandsrunner.cpp

@@ -0,0 +1,91 @@
+/***************************************************************************
+ *   Copyright © 2018 Nicolas Fella <nicolas.fella@gmx.de>                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU General Public License as        *
+ *   published by the Free Software Foundation; either version 2 of        *
+ *   the License or (at your option) version 3 or any later version        *
+ *   accepted by the membership of KDE e.V. (or its successor approved     *
+ *   by the membership of KDE e.V.), which shall act as a proxy            *
+ *   defined in Section 14 of version 3 of the license.                    *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ ***************************************************************************/
+
+#include "remotecommandsrunner.h"
+
+#include <QIcon>
+#include <QDebug>
+
+#include "interfaces/dbusinterfaces.h"
+
+K_EXPORT_PLASMA_RUNNER(installer, RemoteCommandsRunner)
+
+RemoteCommandsRunner::RemoteCommandsRunner(QObject *parent, const QVariantList &args)
+    : Plasma::AbstractRunner(parent, args)
+    , m_daemonInterface(new DaemonDbusInterface)
+{
+    Q_UNUSED(args)
+
+    setObjectName(QStringLiteral("Run Commands"));
+    setPriority(AbstractRunner::HighestPriority);
+}
+
+RemoteCommandsRunner::~RemoteCommandsRunner()
+{
+}
+
+void RemoteCommandsRunner::match(Plasma::RunnerContext &context)
+{
+    QDBusReply<QStringList> devicesReply = m_daemonInterface.devices(true, true);
+
+    if (devicesReply.isValid()) {
+
+        for (const QString& deviceId : devicesReply.value()) {
+
+            DeviceDbusInterface deviceInterface(deviceId, this);
+
+            if(!deviceInterface.hasPlugin("kdeconnect_remotecommands")) {
+                continue;
+            }
+
+            RemoteCommandsDbusInterface remoteCommandsInterface(deviceId, this);
+
+            const auto cmds = QJsonDocument::fromJson(remoteCommandsInterface.commands()).object();
+
+            for (auto it = cmds.constBegin(), itEnd = cmds.constEnd(); it!=itEnd; ++it) {
+                const QJsonObject cont = it->toObject();
+
+                const QString deviceName = deviceInterface.name();
+                const QString commandName = cont.value(QStringLiteral("name")).toString();
+
+                if (deviceName.contains(context.query(), Qt::CaseInsensitive) || commandName.contains(context.query(), Qt::CaseInsensitive)) {
+
+                    Plasma::QueryMatch match(this);
+                    match.setType(Plasma::QueryMatch::PossibleMatch);
+                    match.setId(it.key());
+                    match.setIcon(QIcon::fromTheme("kdeconnect"));
+                    match.setText(deviceName + ": " + commandName);
+                    match.setSubtext(cont.value(QStringLiteral("command")).toString());
+                    match.setData(deviceId + "$" + it.key());
+                    context.addMatch(match);
+                }
+            }
+        }
+    }
+}
+
+void RemoteCommandsRunner::run(const Plasma::RunnerContext &/*context*/, const Plasma::QueryMatch &match)
+{
+    RemoteCommandsDbusInterface remoteCommandsInterface(match.data().toString().split("$")[0], this);
+
+    remoteCommandsInterface.triggerCommand(match.data().toString().split("$")[1]);
+}
+
+#include "remotecommandsrunner.moc"

runners/remotecommands/remotecommandsrunner.h

@@ -0,0 +1,45 @@
+/***************************************************************************
+ *   Copyright © 2018 Nicolas Fella <nicolas.fella@gmx.de>                 *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or         *
+ *   modify it under the terms of the GNU General Public License as        *
+ *   published by the Free Software Foundation; either version 2 of        *
+ *   the License or (at your option) version 3 or any later version        *
+ *   accepted by the membership of KDE e.V. (or its successor approved     *
+ *   by the membership of KDE e.V.), which shall act as a proxy            *
+ *   defined in Section 14 of version 3 of the license.                    *
+ *                                                                         *
+ *   This program is distributed in the hope that it will be useful,       *
+ *   but WITHOUT ANY WARRANTY; without even the implied warranty of        *
+ *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         *
+ *   GNU General Public License for more details.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program.  If not, see <http://www.gnu.org/licenses/>. *
+ ***************************************************************************/
+
+#ifndef REMOTECOMMANDSRUNNER_H
+#define REMOTECOMMANDSRUNNER_H
+
+#include <KRunner/AbstractRunner>
+
+#include "interfaces/dbusinterfaces.h"
+
+class RemoteCommandsRunner : public Plasma::AbstractRunner
+{
+Q_OBJECT
+
+public:
+    RemoteCommandsRunner(QObject *parent, const QVariantList &args);
+    ~RemoteCommandsRunner() override;
+
+    void match(Plasma::RunnerContext &context) override;
+    void run(const Plasma::RunnerContext &context, const Plasma::QueryMatch &action) override;
+
+private:
+    DaemonDbusInterface m_daemonInterface;
+
+};
+
+#endif
+