From a8cb82d4dacdb1003c6cada127f5e389365a2610 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Mon, 2 Dec 2019 19:32:45 +0100 Subject: [PATCH 01/13] Add installation commands for build dependencies --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index b7289fc..1b1ac83 100644 --- a/README.md +++ b/README.md @@ -17,6 +17,16 @@ Requirements: * Python 3.x * KF5 & Qt5 +Debian/Ubuntu: +`sudo apt install cmake extra-cmake-modules build-essential libkf5runner-dev libkf5textwidgets-dev qtdeclarative5-dev gettext` + +openSUSE: +`sudo zypper install cmake extra-cmake-modules libQt5Widgets5 libQt5Core5 libqt5-qtlocation-devel ki18n-devel +ktextwidgets-devel kservice-devel krunner-devel gettext-tools` + +Fedora: +`sudo dnf install cmake extra-cmake-modules kf5-ki18n-devel kf5-kservice-devel kf5-krunner-devel kf5-ktextwidgets-devel gettext` + Clone this repository to local filesystem and cd into it. ```sh From 85ec159d2d84c871ce8decfc5745a22484470d8d Mon Sep 17 00:00:00 2001 From: alex1701c Date: Tue, 3 Dec 2019 19:09:44 +0100 Subject: [PATCH 02/13] Bugfixes, additional options and optimizations --- .gitignore | 2 + README.md | 5 +- example_calc.py | 2 +- example_search.py | 2 +- install_example.sh | 8 ++-- krunner_bridge.cc | 113 +++++++++++++++++++++++---------------------- krunner_bridge.h | 13 ++++-- 7 files changed, 76 insertions(+), 69 deletions(-) diff --git a/.gitignore b/.gitignore index 7d75298..25335aa 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,4 @@ build __pycache__ +.idea +cmake-build-debug \ No newline at end of file diff --git a/README.md b/README.md index b7289fc..d12c5c0 100644 --- a/README.md +++ b/README.md @@ -22,8 +22,7 @@ Clone this repository to local filesystem and cd into it. ```sh mkdir build cd build - -cmake .. +cmake -DCMAKE_BUILD_TYPE=Release .. make make install ``` @@ -35,7 +34,7 @@ We will try to write a basic calculator using python's eval function. Follow the installation instructions and then edit `~/.local/share/kservices5/example_calc.py`: ```python -#!/usr/bin/env python +#!/usr/bin/env python3 import krunner_bridge from math import * diff --git a/example_calc.py b/example_calc.py index 0460da6..d7fad50 100755 --- a/example_calc.py +++ b/example_calc.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 import krunner_bridge from math import * diff --git a/example_search.py b/example_search.py index 35313c9..5f86ea0 100755 --- a/example_search.py +++ b/example_search.py @@ -1,4 +1,4 @@ -#!/usr/bin/env python +#!/usr/bin/env python3 import os import sys diff --git a/install_example.sh b/install_example.sh index 0000306..d489fd1 100755 --- a/install_example.sh +++ b/install_example.sh @@ -1,16 +1,16 @@ #!/bin/bash -if [ ! -f example_search.py ]; then - echo "example.py is missing. Aborted." +if [[ ! -f example_search.py || ! -f example_calc.py || ! -f krunner_bridge.py ]]; then + echo "Project files are missing. Aborted." exit fi -if [ ! -d build ]; then +if [[ ! -d build ]]; then mkdir build fi cd build -cmake .. +cmake -DCMAKE_BUILD_TYPE=Release .. make make install diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 9b600a9..5877cff 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -9,20 +9,25 @@ #define KB_ASSERT(cond) {if(!(cond)) {qDebug().nospace() << "[" << script << "] Failed on " << #cond; return;}} #define KB_ASSERT_MSG(cond, msg) {if(!(cond)) {qDebug().nospace() << "[" << script << "] " << msg; return;}} -KRunnerBridge::KRunnerBridge(QObject* parent, const QVariantList& args) - : Plasma::AbstractRunner(parent, args) -{ +KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) + : Plasma::AbstractRunner(parent, args) { cwd = QDir::cleanPath(QDir::homePath() + QDir::separator() + ".local/share/kservices5"); - if(!QDir(cwd).exists()) cwd = ""; + if (!QDir(cwd).exists()) cwd = ""; - for(const QString& kw : metadata().service()->propertyNames()) { - if(kw.startsWith("X-KRunner-Bridge-Script")) { + // Read config from file + for (const QString &kw : metadata().service()->propertyNames()) { + if (kw.startsWith("X-KRunner-Bridge-Script")) { QString script = metadata().service()->property(kw, QVariant::String).toString(); // find the corresponding script in desktop file install path - QString abs_script = QDir::cleanPath(cwd + QDir::separator() + script); - if(QFileInfo(abs_script).exists()) script = abs_script; - + const QString abs_script = QDir::cleanPath(cwd + QDir::separator() + script); + if (QFileInfo(abs_script).exists()) script = abs_script; scripts.append(script); + } else if (kw.startsWith("X-KRunner-Bridge-Run-Timeout")) { + runTimeout = metadata().service()->property(kw, QVariant::String).toInt(); + if (runTimeout <= 0) runTimeout = 2000; + } else if (kw.startsWith("X-KRunner-Bridge-Match-Timeout")) { + matchTimeout = metadata().service()->property(kw, QVariant::String).toInt(); + if (matchTimeout <= 0) matchTimeout = 1000; } } @@ -31,61 +36,55 @@ KRunnerBridge::KRunnerBridge(QObject* parent, const QVariantList& args) setHasRunOptions(true); setDefaultSyntax(Plasma::RunnerSyntax( - QString::fromLatin1(":q:"), metadata().comment())); + QString::fromLatin1(":q:"), metadata().comment())); - for(QString& script : scripts) { + for (const QString &script : scripts) { QProcess process; process.setWorkingDirectory(cwd); process.setProcessChannelMode(QProcess::ForwardedErrorChannel); process.start("sh", QStringList() << "-c" << script); - QJsonObject command; - command.insert("operation", QJsonValue("init")); - QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); - process.write(input); + process.write(json_init); process.closeWriteChannel(); - KB_ASSERT_MSG(process.waitForFinished(1000), "Initialization timeout"); + KB_ASSERT_MSG(process.waitForFinished(runTimeout), "Initialization timeout"); } } -void KRunnerBridge::match(Plasma::RunnerContext& ctxt) -{ +void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { if (!ctxt.isValid()) return; - for(QString& script : scripts) { + // Prepare for input + const QString query = ctxt.query(); + QJsonObject command; + command.insert("operation", QJsonValue("match")); + command.insert("query", QJsonValue(query)); + const QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); + + for (const QString &script : scripts) { QProcess process; process.setWorkingDirectory(cwd); process.setProcessChannelMode(QProcess::ForwardedErrorChannel); process.start("sh", QStringList() << "-c" << script); - //// Prepare for input - QString query = ctxt.query(); - - QJsonObject command; - command.insert("operation", QJsonValue("match")); - command.insert("query", QJsonValue(query)); - - QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); process.write(input); process.closeWriteChannel(); - KB_ASSERT_MSG(process.waitForFinished(1000), "Result retrieve timeout"); + KB_ASSERT_MSG(process.waitForFinished(1000), "Result retrieve timeout") - //// Retrieve output - if(process.exitStatus() == QProcess::CrashExit) + // Retrieve output + if (process.exitStatus() == QProcess::CrashExit) qDebug() << process.readAllStandardError().data(); - QByteArray output = process.readAllStandardOutput(); - QJsonDocument doc = QJsonDocument::fromJson(output); + const QByteArray output = process.readAllStandardOutput(); + const QJsonDocument doc = QJsonDocument::fromJson(output); - KB_ASSERT(doc.isObject()); + KB_ASSERT(doc.isObject()) QJsonValue v_result = doc.object().value("result"); - KB_ASSERT(v_result.isArray()); - QJsonArray results = v_result.toArray(); + KB_ASSERT(v_result.isArray()) - for(QJsonValue result : results) { + for (const auto &result :v_result.toArray()) { KB_ASSERT(result.isObject()); QJsonObject obj = result.toObject(); @@ -105,35 +104,37 @@ void KRunnerBridge::match(Plasma::RunnerContext& ctxt) #undef MAP_PROPERTY QJsonValue data = obj.value("data"); - if(!data.isUndefined()) m.setData(data.toVariant()); - - if(relevance == 1) - m.setType(Plasma::QueryMatch::ExactMatch); - else m.setType(Plasma::QueryMatch::CompletionMatch); + if (!data.isUndefined()) m.setData(QVariantList({script, data.toVariant()})); + else m.setData(QVariantList()); + m.setType(relevance == 1 ? Plasma::QueryMatch::ExactMatch : Plasma::QueryMatch::CompletionMatch); ctxt.addMatch(m); } } } -void KRunnerBridge::run(const Plasma::RunnerContext& ctxt, const Plasma::QueryMatch& match) -{ - for(QString& script : scripts) { - QProcess process; - process.setWorkingDirectory(cwd); - process.setProcessChannelMode(QProcess::ForwardedErrorChannel); - process.start("sh", QStringList() << "-c" << script); +void KRunnerBridge::run(const Plasma::RunnerContext &ctxt, const Plasma::QueryMatch &match) { + Q_UNUSED(ctxt) - QJsonObject command; - command.insert("operation", QJsonValue("run")); - command.insert("data", QJsonValue::fromVariant(match.data())); + const QVariantList data = match.data().toList(); + if (data.size() != 2) return; - QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); - process.write(input); - process.closeWriteChannel(); + // Data should only be passed to script that generated the run option + const QString script = data.at(0).toString(); + QJsonObject command; + command.insert("operation", QJsonValue("run")); + command.insert("data", QJsonValue::fromVariant(data.at(1))); - KB_ASSERT_MSG(process.waitForFinished(2000), "Running timeout"); - } + QProcess process; + process.setWorkingDirectory(cwd); + process.setProcessChannelMode(QProcess::ForwardedErrorChannel); + process.start("sh", QStringList() << "-c" << script); + + const QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); + process.write(input); + process.closeWriteChannel(); + + KB_ASSERT_MSG(process.waitForFinished(runTimeout), "Running timeout"); } K_EXPORT_PLASMA_RUNNER(krunner_bridge, KRunnerBridge) diff --git a/krunner_bridge.h b/krunner_bridge.h index 0dd8b52..92fac35 100644 --- a/krunner_bridge.h +++ b/krunner_bridge.h @@ -5,16 +5,21 @@ #include class KRunnerBridge : public Plasma::AbstractRunner { - Q_OBJECT +Q_OBJECT QStringList scripts; QString cwd; + int matchTimeout = 1000; + int runTimeout = 2000; + + const QByteArray json_init = R"({"operation":"init"})"; public: - KRunnerBridge(QObject* parent, const QVariantList& args); + KRunnerBridge(QObject *parent, const QVariantList &args); + + void match(Plasma::RunnerContext &) override; - void match(Plasma::RunnerContext&); - void run(const Plasma::RunnerContext&, const Plasma::QueryMatch&); + void run(const Plasma::RunnerContext &, const Plasma::QueryMatch &) override; }; #endif // KRUNNER_BRIDGE From d644507db54ad473506a97736890328f86bab6a7 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Mon, 13 Jan 2020 19:17:37 +0100 Subject: [PATCH 03/13] Typo --- krunner_bridge.cc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 5877cff..f11f730 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -71,7 +71,7 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { process.write(input); process.closeWriteChannel(); - KB_ASSERT_MSG(process.waitForFinished(1000), "Result retrieve timeout") + KB_ASSERT_MSG(process.waitForFinished(matchTimeout), "Result retrieve timeout") // Retrieve output if (process.exitStatus() == QProcess::CrashExit) From 391f0d9780a557a06bd11e40bc456ff5fee7268a Mon Sep 17 00:00:00 2001 From: alex1701c Date: Tue, 14 Jan 2020 11:29:31 +0100 Subject: [PATCH 04/13] Install python files using setuptools --- .gitignore | 5 ++++- README.md | 6 +----- install_example.sh | 8 +++----- .../krunner_bridge/__init__.py | 2 +- python/setup.py | 12 ++++++++++++ 5 files changed, 21 insertions(+), 12 deletions(-) rename krunner_bridge.py => python/krunner_bridge/__init__.py (98%) create mode 100644 python/setup.py diff --git a/.gitignore b/.gitignore index 25335aa..3481c23 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,7 @@ build __pycache__ .idea -cmake-build-debug \ No newline at end of file +cmake-build-debug +python/build +python/dist +python/KRunner_Bridge.egg-info \ No newline at end of file diff --git a/README.md b/README.md index d364834..bd12a7c 100644 --- a/README.md +++ b/README.md @@ -30,11 +30,7 @@ Fedora: Clone this repository to local filesystem and cd into it. ```sh -mkdir build -cd build -cmake -DCMAKE_BUILD_TYPE=Release .. -make -make install +./install_example.sh ``` ## Quick Start diff --git a/install_example.sh b/install_example.sh index d489fd1..c06963f 100755 --- a/install_example.sh +++ b/install_example.sh @@ -1,9 +1,8 @@ #!/bin/bash -if [[ ! -f example_search.py || ! -f example_calc.py || ! -f krunner_bridge.py ]]; then - echo "Project files are missing. Aborted." - exit -fi +cd python +python3 setup.py install --user +cd .. if [[ ! -d build ]]; then mkdir build @@ -16,7 +15,6 @@ make install install ../example_search.py $HOME/.local/share/kservices5 install ../example_calc.py $HOME/.local/share/kservices5 -install ../krunner_bridge.py $HOME/.local/share/kservices5 echo X-KRunner-Bridge-Script-1=example_search.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop echo X-KRunner-Bridge-Script-2=example_calc.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop diff --git a/krunner_bridge.py b/python/krunner_bridge/__init__.py similarity index 98% rename from krunner_bridge.py rename to python/krunner_bridge/__init__.py index 69aafda..2ddc730 100644 --- a/krunner_bridge.py +++ b/python/krunner_bridge/__init__.py @@ -80,7 +80,7 @@ def fuzzy_match(self, q): def __repr__(self): return "".format( - repr(self.text), repr(self.cmp)) + repr(self.text), repr(self.cmp)) __MATCH_HANDLER = lambda query: [] def match_handler(func): diff --git a/python/setup.py b/python/setup.py new file mode 100644 index 0000000..f289ba4 --- /dev/null +++ b/python/setup.py @@ -0,0 +1,12 @@ +#!/usr/bin/python3 + +from setuptools import setup, find_packages + +setup( + name='KRunner-Bridge', + version='1.0.0', + description='Utility for the KRunner-Bridge plugin', + url='https://github.com/alex1701c/krunner-bridge', + entry_points={}, + packages=find_packages(), +) From 42846a2fe69ccdd0e6193c469e33120820bc349d Mon Sep 17 00:00:00 2001 From: alex1701c Date: Thu, 16 Jan 2020 20:43:26 +0100 Subject: [PATCH 05/13] Run match/init processes async --- README.md | 4 +++ krunner_bridge.cc | 51 ++++++++++++++++++------------- krunner_bridge.desktop | 2 ++ python/krunner_bridge/__init__.py | 2 +- 4 files changed, 37 insertions(+), 22 deletions(-) diff --git a/README.md b/README.md index bd12a7c..ea217e0 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,9 @@ # KRunner Bridge +### NOTE: This branch is currently developed and supports only python3 as a plugin language, +other languages and new features will come soon ! + + **Write krunner python plugins the quick way.** Plasma 5 stopped exposing KDE Framework API to script languages (except QML) for the purpose of so-called stability (but it is not at all stable, crashing from time to time). But this brings some horrible consequence that writing krunner plugins becomes time-consuming. You have to write long C++ code, configure your C++ building toolchain, and compile them each time you modify something. diff --git a/krunner_bridge.cc b/krunner_bridge.cc index f11f730..4bbfe1f 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -2,6 +2,7 @@ #include #include #include +#include #include #include "krunner_bridge.h" @@ -38,46 +39,53 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) setDefaultSyntax(Plasma::RunnerSyntax( QString::fromLatin1(":q:"), metadata().comment())); + const QByteArray json_init = R"({"operation":"init"})"; + QList processes; for (const QString &script : scripts) { - QProcess process; - process.setWorkingDirectory(cwd); - process.setProcessChannelMode(QProcess::ForwardedErrorChannel); - process.start("sh", QStringList() << "-c" << script); + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start("python3", QStringList() << script << json_init); - - process.write(json_init); - process.closeWriteChannel(); - - KB_ASSERT_MSG(process.waitForFinished(runTimeout), "Initialization timeout"); + process->write(json_init); + process->closeWriteChannel(); + processes.append(process); + } + for (auto *process:processes) { + process->waitForFinished(runTimeout); + process->deleteLater(); } } void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { if (!ctxt.isValid()) return; - // Prepare for input const QString query = ctxt.query(); QJsonObject command; command.insert("operation", QJsonValue("match")); command.insert("query", QJsonValue(query)); const QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); + // Start all scripts parallel + QList processes; for (const QString &script : scripts) { - QProcess process; - process.setWorkingDirectory(cwd); - process.setProcessChannelMode(QProcess::ForwardedErrorChannel); - process.start("sh", QStringList() << "-c" << script); - - process.write(input); - process.closeWriteChannel(); + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start("python3", QStringList() << script << input); + processes.append(process); + } - KB_ASSERT_MSG(process.waitForFinished(matchTimeout), "Result retrieve timeout") + // Evaluate output of the scripts + // TODO Solve using signals + for (auto *process:processes) { + const QString script = process->program(); + KB_ASSERT_MSG(process->waitForFinished(matchTimeout), "Result retrieve timeout") // Retrieve output - if (process.exitStatus() == QProcess::CrashExit) - qDebug() << process.readAllStandardError().data(); + if (QProcess::CrashExit == process->exitStatus()) + qDebug() << process->readAllStandardError().data(); - const QByteArray output = process.readAllStandardOutput(); + const QByteArray output = process->readAllStandardOutput(); + process->deleteLater(); const QJsonDocument doc = QJsonDocument::fromJson(output); KB_ASSERT(doc.isObject()) @@ -90,6 +98,7 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { Plasma::QueryMatch m(this); + // Macro generates code that checks if the object has the key and writes it in the match #define MAP_PROPERTY(t, camel1, camel2) \ QJsonValue camel2 = obj.value(#camel2); \ if(camel2.is##t()) m.set##camel1(camel2.to##t()); diff --git a/krunner_bridge.desktop b/krunner_bridge.desktop index 5969857..e3cd99c 100644 --- a/krunner_bridge.desktop +++ b/krunner_bridge.desktop @@ -14,3 +14,5 @@ X-KDE-PluginInfo-Version=0.0.2 X-KDE-PluginInfo-License=LGPLv3 X-KDE-PluginInfo-EnabledByDefault=true +X-KRunner-Bridge-Run-Timeout=2000 +X-KRunner-Bridge-Match-Timeout=10000 diff --git a/python/krunner_bridge/__init__.py b/python/krunner_bridge/__init__.py index 2ddc730..d58aece 100644 --- a/python/krunner_bridge/__init__.py +++ b/python/krunner_bridge/__init__.py @@ -101,7 +101,7 @@ def run_handler(func): return func def exec(): - args = sys.stdin.read() + args = sys.argv[1] args = json.loads(args) op = args["operation"] From caf083a935dbd20c76a6f70d8176791117a542c6 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Mon, 27 Jan 2020 18:39:13 +0100 Subject: [PATCH 06/13] Implement config groups and new signals --- krunner_bridge.cc | 144 ++++++++++++++++++++++++++++++++++------------ krunner_bridge.h | 19 ++++-- krunner_script.h | 17 ++++++ 3 files changed, 138 insertions(+), 42 deletions(-) create mode 100644 krunner_script.h diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 4bbfe1f..65182ea 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -4,61 +4,128 @@ #include #include #include +#include #include "krunner_bridge.h" -#define KB_ASSERT(cond) {if(!(cond)) {qDebug().nospace() << "[" << script << "] Failed on " << #cond; return;}} -#define KB_ASSERT_MSG(cond, msg) {if(!(cond)) {qDebug().nospace() << "[" << script << "] " << msg; return;}} +#define KB_ASSERT(cond) {if(!(cond)) {qDebug().nospace() << "[" << script << "] Failed on " << #cond; continue;}} +#define KB_ASSERT_MSG(cond, msg) {if(!(cond)) {qDebug().nospace() << "[" << script << "] " << msg; continue;}} KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) : Plasma::AbstractRunner(parent, args) { - cwd = QDir::cleanPath(QDir::homePath() + QDir::separator() + ".local/share/kservices5"); if (!QDir(cwd).exists()) cwd = ""; + const QLatin1String krunnerBridgeScriptKey = QLatin1String("X-KRunner-Bridge-Script"); + const QLatin1String krunnerBridgeRunTimeoutKey = QLatin1String("X-KRunner-Bridge-Run-Timeout"); + const QLatin1String krunnerBridgeMatchTimeoutKey = QLatin1String("X-KRunner-Bridge-Match-Timeout"); // Read config from file for (const QString &kw : metadata().service()->propertyNames()) { - if (kw.startsWith("X-KRunner-Bridge-Script")) { + if (kw.startsWith(krunnerBridgeScriptKey)) { QString script = metadata().service()->property(kw, QVariant::String).toString(); // find the corresponding script in desktop file install path - const QString abs_script = QDir::cleanPath(cwd + QDir::separator() + script); - if (QFileInfo(abs_script).exists()) script = abs_script; - scripts.append(script); - } else if (kw.startsWith("X-KRunner-Bridge-Run-Timeout")) { + if (!QFile::exists(script)) { + const QString abs_script = QDir::cleanPath(cwd + QDir::separator() + script); + if (QFileInfo(abs_script).exists()) { + script = abs_script; + } else { + qWarning() << "Script " << script << " is not a file"; + continue; + } + } + KRunnerScript kRunnerScript; + kRunnerScript.filePath = script; + scripts.append(kRunnerScript); + } else if (kw == krunnerBridgeRunTimeoutKey) { runTimeout = metadata().service()->property(kw, QVariant::String).toInt(); if (runTimeout <= 0) runTimeout = 2000; - } else if (kw.startsWith("X-KRunner-Bridge-Match-Timeout")) { + } else if (kw == krunnerBridgeMatchTimeoutKey) { matchTimeout = metadata().service()->property(kw, QVariant::String).toInt(); if (matchTimeout <= 0) matchTimeout = 1000; } } + KSharedConfig::Ptr config = KSharedConfig::openConfig( + QDir::homePath() + QDir::separator() + ".local/share/kservices5/krunner_bridge.desktop"); + for (const QString &groupName:config->groupList()) { + if (groupName.startsWith(krunnerBridgeScriptKey)) { + const KConfigGroup group = config->group(groupName); + KRunnerScript script; + script.matchRegex = QRegularExpression(group.readEntry("MatchRegex", ".*")); + script.launchCommand = group.readEntry("LaunchCommand", "python3"); + script.filePath = group.readEntry("FilePath"); + if (script.filePath.isEmpty()) { + qWarning() << "No FilePath for " << groupName << " provided"; + continue; + } + script.initialize = group.readEntry("Initialize", true); + script.prepare = group.readEntry("Prepare", true); + script.teardown = group.readEntry("Teardown", true); + script.runDetatched = group.readEntry("RunDetatched ", true); + scripts.append(script); + } + } + scriptCount = scripts.count(); setSpeed(AbstractRunner::NormalSpeed); setPriority(HighestPriority); setHasRunOptions(true); - setDefaultSyntax(Plasma::RunnerSyntax( - QString::fromLatin1(":q:"), metadata().comment())); + setDefaultSyntax(Plasma::RunnerSyntax(QStringLiteral(":q:"), metadata().comment())); - const QByteArray json_init = R"({"operation":"init"})"; QList processes; - for (const QString &script : scripts) { + for (const KRunnerScript &script : qAsConst(scripts)) { auto *process = new QProcess(); process->setWorkingDirectory(cwd); - process->start("python3", QStringList() << script << json_init); - - process->write(json_init); - process->closeWriteChannel(); + process->start(script.launchCommand, QStringList() << script.filePath << json_init); processes.append(process); } - for (auto *process:processes) { + for (auto *process : qAsConst(processes)) { process->waitForFinished(runTimeout); process->deleteLater(); } + + connect(this, &KRunnerBridge::prepare, this, &KRunnerBridge::prepareForMatchSession); + connect(this, &KRunnerBridge::teardown, this, &KRunnerBridge::matchSessionFinished); } -void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { - if (!ctxt.isValid()) return; +void KRunnerBridge::prepareForMatchSession() { + QList processes; + for (const KRunnerScript &script : qAsConst(scripts)) { + if (!script.prepare) { + continue; + } + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start(script.launchCommand, QStringList() << script.filePath << json_prepare); + process->write(json_prepare); + process->closeWriteChannel(); + } + for (auto *process : qAsConst(processes)) { + process->waitForFinished(matchTimeout); + process->deleteLater(); + } +} + +void KRunnerBridge::matchSessionFinished() { + QList processes; + for (const KRunnerScript &script : qAsConst(scripts)) { + if (!script.prepare) { + continue; + } + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start(script.launchCommand, QStringList() << script.filePath << json_teardow); + } + for (auto *process : qAsConst(processes)) { + process->waitForFinished(matchTimeout); + process->deleteLater(); + } +} + +void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { + if (!ctxt.isValid()) { + return; + } const QString query = ctxt.query(); QJsonObject command; command.insert("operation", QJsonValue("match")); @@ -67,16 +134,17 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { // Start all scripts parallel QList processes; - for (const QString &script : scripts) { + for (const KRunnerScript &script : qAsConst(scripts)) { auto *process = new QProcess(); process->setWorkingDirectory(cwd); - process->start("python3", QStringList() << script << input); + process->start(script.launchCommand, QStringList() << script.filePath << input); processes.append(process); } // Evaluate output of the scripts // TODO Solve using signals - for (auto *process:processes) { + for (int i = 0; i < scriptCount; ++i) { + auto process = processes.at(i); const QString script = process->program(); KB_ASSERT_MSG(process->waitForFinished(matchTimeout), "Result retrieve timeout") @@ -113,8 +181,11 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { #undef MAP_PROPERTY QJsonValue data = obj.value("data"); - if (!data.isUndefined()) m.setData(QVariantList({script, data.toVariant()})); - else m.setData(QVariantList()); + if (!data.isUndefined()) { + m.setData(QVariantList({i, data.toVariant()})); + } else { + m.setData(QVariantList()); + } m.setType(relevance == 1 ? Plasma::QueryMatch::ExactMatch : Plasma::QueryMatch::CompletionMatch); ctxt.addMatch(m); @@ -126,24 +197,21 @@ void KRunnerBridge::run(const Plasma::RunnerContext &ctxt, const Plasma::QueryMa Q_UNUSED(ctxt) const QVariantList data = match.data().toList(); - if (data.size() != 2) return; - // Data should only be passed to script that generated the run option - const QString script = data.at(0).toString(); + const KRunnerScript &script = scripts.at(data.at(0).toInt()); QJsonObject command; command.insert("operation", QJsonValue("run")); command.insert("data", QJsonValue::fromVariant(data.at(1))); - QProcess process; - process.setWorkingDirectory(cwd); - process.setProcessChannelMode(QProcess::ForwardedErrorChannel); - process.start("sh", QStringList() << "-c" << script); - - const QByteArray input = QJsonDocument(command).toJson(QJsonDocument::Compact); - process.write(input); - process.closeWriteChannel(); - - KB_ASSERT_MSG(process.waitForFinished(runTimeout), "Running timeout"); + if (script.runDetatched) { + QProcess::startDetached(script.launchCommand, + QStringList() << script.filePath << QJsonDocument(command).toJson(QJsonDocument::Compact)); + } else { + QProcess process; + process.setWorkingDirectory(cwd); + process.start(script.launchCommand, QStringList() << script.filePath << QJsonDocument(command).toJson(QJsonDocument::Compact)); + process.waitForFinished(runTimeout); + } } K_EXPORT_PLASMA_RUNNER(krunner_bridge, KRunnerBridge) diff --git a/krunner_bridge.h b/krunner_bridge.h index 92fac35..f8ed37c 100644 --- a/krunner_bridge.h +++ b/krunner_bridge.h @@ -1,18 +1,23 @@ #ifndef KRUNNER_BRIDGE #define KRUNNER_BRIDGE -#include +#include +#include #include +#include "krunner_script.h" class KRunnerBridge : public Plasma::AbstractRunner { Q_OBJECT - QStringList scripts; - QString cwd; + QList scripts; + QString cwd = QDir::cleanPath(QDir::homePath() + QDir::separator() + QStringLiteral(".local/share/kservices5")); int matchTimeout = 1000; int runTimeout = 2000; - + int scriptCount; + // Hard coded JSON commands const QByteArray json_init = R"({"operation":"init"})"; + const QByteArray json_prepare = R"({"operation":"prepare"})"; + const QByteArray json_teardow = R"({"operation":"teardown"})"; public: KRunnerBridge(QObject *parent, const QVariantList &args); @@ -20,6 +25,12 @@ Q_OBJECT void match(Plasma::RunnerContext &) override; void run(const Plasma::RunnerContext &, const Plasma::QueryMatch &) override; + +protected Q_SLOTS: + + void prepareForMatchSession(); + + void matchSessionFinished(); }; #endif // KRUNNER_BRIDGE diff --git a/krunner_script.h b/krunner_script.h new file mode 100644 index 0000000..50a081d --- /dev/null +++ b/krunner_script.h @@ -0,0 +1,17 @@ +#ifndef KRUNNER_BRIDGE_KRUNNER_SCRIPT_H +#define KRUNNER_BRIDGE_KRUNNER_SCRIPT_H + +#include + +struct KRunnerScript { + + QRegularExpression matchRegex = QRegularExpression(".*"); + QString launchCommand = "python3"; + QString filePath; + bool initialize = true; + bool prepare = false; + bool teardown = false; + bool runDetatched = true; +}; + +#endif //KRUNNER_BRIDGE_KRUNNER_SCRIPT_H From 97a9775f08c10eb76b08d694582275b8b0b5a5b7 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Mon, 27 Jan 2020 19:08:00 +0100 Subject: [PATCH 07/13] Implement regex for match, optimize --- krunner_bridge.cc | 39 ++++++++++++++++++++++++++++++--------- 1 file changed, 30 insertions(+), 9 deletions(-) diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 65182ea..7064390 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -19,7 +19,8 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) const QLatin1String krunnerBridgeMatchTimeoutKey = QLatin1String("X-KRunner-Bridge-Match-Timeout"); // Read config from file - for (const QString &kw : metadata().service()->propertyNames()) { + const auto keyWords = metadata().service()->propertyNames(); + for (const QString &kw : keyWords) { if (kw.startsWith(krunnerBridgeScriptKey)) { QString script = metadata().service()->property(kw, QVariant::String).toString(); // find the corresponding script in desktop file install path @@ -45,7 +46,11 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) } KSharedConfig::Ptr config = KSharedConfig::openConfig( QDir::homePath() + QDir::separator() + ".local/share/kservices5/krunner_bridge.desktop"); - for (const QString &groupName:config->groupList()) { + bool hasPrepareScript = false; + bool hasTeardownScript = false; + + const auto entries = config->groupList(); + for (const QString &groupName : entries) { if (groupName.startsWith(krunnerBridgeScriptKey)) { const KConfigGroup group = config->group(groupName); KRunnerScript script; @@ -58,7 +63,13 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) } script.initialize = group.readEntry("Initialize", true); script.prepare = group.readEntry("Prepare", true); + if (script.prepare) { + hasPrepareScript = true; + } script.teardown = group.readEntry("Teardown", true); + if (script.teardown) { + hasTeardownScript = true; + } script.runDetatched = group.readEntry("RunDetatched ", true); scripts.append(script); } @@ -83,8 +94,15 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) process->deleteLater(); } - connect(this, &KRunnerBridge::prepare, this, &KRunnerBridge::prepareForMatchSession); - connect(this, &KRunnerBridge::teardown, this, &KRunnerBridge::matchSessionFinished); + // Connect only if at least one script requires the signal + if (hasPrepareScript) { + connect(this, &KRunnerBridge::prepare, this, &KRunnerBridge::prepareForMatchSession); + qInfo() << "connect prepare"; + } + if (hasTeardownScript) { + connect(this, &KRunnerBridge::teardown, this, &KRunnerBridge::matchSessionFinished); + qInfo() << "connect teardown"; + } } void KRunnerBridge::prepareForMatchSession() { @@ -135,15 +153,17 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { // Start all scripts parallel QList processes; for (const KRunnerScript &script : qAsConst(scripts)) { - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << input); - processes.append(process); + if (script.matchRegex.match(query).hasMatch()) { + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start(script.launchCommand, QStringList() << script.filePath << input); + processes.append(process); + } } // Evaluate output of the scripts // TODO Solve using signals - for (int i = 0; i < scriptCount; ++i) { + for (int i = 0, processCount = processes.count(); i < processCount; ++i) { auto process = processes.at(i); const QString script = process->program(); KB_ASSERT_MSG(process->waitForFinished(matchTimeout), "Result retrieve timeout") @@ -191,6 +211,7 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { ctxt.addMatch(m); } } + qDeleteAll(processes); } void KRunnerBridge::run(const Plasma::RunnerContext &ctxt, const Plasma::QueryMatch &match) { From c7acc3d3e29552d654b99473f5a2977b85357109 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Mon, 27 Jan 2020 21:18:37 +0100 Subject: [PATCH 08/13] Add example and update installer --- README.md | 11 +++++------ debug_helper.sh | 7 +++++++ install.sh | 26 ++++++++++++++++++++++++++ krunner_bridge.cc | 5 ----- krunner_bridge.desktop | 24 ++++++++++++++++++++++-- 5 files changed, 60 insertions(+), 13 deletions(-) create mode 100644 debug_helper.sh create mode 100755 install.sh diff --git a/README.md b/README.md index ea217e0..d477ff7 100644 --- a/README.md +++ b/README.md @@ -22,26 +22,26 @@ Requirements: * KF5 & Qt5 Debian/Ubuntu: -`sudo apt install cmake extra-cmake-modules build-essential libkf5runner-dev libkf5textwidgets-dev qtdeclarative5-dev gettext` +`sudo apt install cmake extra-cmake-modules build-essential libkf5runner-dev libkf5textwidgets-dev qtdeclarative5-dev gettext libnotify-bin` openSUSE: `sudo zypper install cmake extra-cmake-modules libQt5Widgets5 libQt5Core5 libqt5-qtlocation-devel ki18n-devel -ktextwidgets-devel kservice-devel krunner-devel gettext-tools` +ktextwidgets-devel kservice-devel krunner-devel gettext-tools libnotify-tools` Fedora: -`sudo dnf install cmake extra-cmake-modules kf5-ki18n-devel kf5-kservice-devel kf5-krunner-devel kf5-ktextwidgets-devel gettext` +`sudo dnf install cmake extra-cmake-modules kf5-ki18n-devel kf5-kservice-devel kf5-krunner-devel kf5-ktextwidgets-devel gettext libnotify` Clone this repository to local filesystem and cd into it. ```sh -./install_example.sh +./install.sh ``` ## Quick Start We will try to write a basic calculator using python's eval function. -Follow the installation instructions and then edit `~/.local/share/kservices5/example_calc.py`: +After installing the plugin you should have te file `~/.local/share/kservices5/example_calc.py`: ```python #!/usr/bin/env python3 @@ -65,7 +65,6 @@ if __name__ == "__main__": krunner_bridge.exec() ``` -Append one line to `~/.local/share/kservices5/krunner_bridge.desktop`, which tells krunner bridge where to find your script. ``` echo X-KRunner-Bridge-Script-1=example_calc.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop diff --git a/debug_helper.sh b/debug_helper.sh new file mode 100644 index 0000000..a146925 --- /dev/null +++ b/debug_helper.sh @@ -0,0 +1,7 @@ +#!/bin/bash + +# Just send the data as a notification +notify-send $1 + +# Display some hello world text inside of KRunner +echo '{"result":[{"text":"Hello World", "iconName":"planetkde"}]}' diff --git a/install.sh b/install.sh new file mode 100755 index 0000000..780d856 --- /dev/null +++ b/install.sh @@ -0,0 +1,26 @@ +#!/bin/bash + +# Exit immediately if something fails +set -e + +cd python +python3 setup.py install +cd .. + +if [[ ! -d build ]]; then + mkdir build +fi + +cd build +cmake -DCMAKE_BUILD_TYPE=Release .. +make -j $(nproc) +make install + +cd .. +install ./example_search.py $HOME/.local/share/kservices5 +install ./example_calc.py $HOME/.local/share/kservices5 +install ./debug_helper.sh $HOME/.local/share/kservices5 + +kquitapp5 krunner 2> /dev/null +kstart5 --windowclass krunner krunner > /dev/null 2>&1 & + diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 7064390..adc9c7e 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -97,11 +97,9 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) // Connect only if at least one script requires the signal if (hasPrepareScript) { connect(this, &KRunnerBridge::prepare, this, &KRunnerBridge::prepareForMatchSession); - qInfo() << "connect prepare"; } if (hasTeardownScript) { connect(this, &KRunnerBridge::teardown, this, &KRunnerBridge::matchSessionFinished); - qInfo() << "connect teardown"; } } @@ -114,9 +112,6 @@ void KRunnerBridge::prepareForMatchSession() { auto *process = new QProcess(); process->setWorkingDirectory(cwd); process->start(script.launchCommand, QStringList() << script.filePath << json_prepare); - - process->write(json_prepare); - process->closeWriteChannel(); } for (auto *process : qAsConst(processes)) { process->waitForFinished(matchTimeout); diff --git a/krunner_bridge.desktop b/krunner_bridge.desktop index e3cd99c..8368afc 100644 --- a/krunner_bridge.desktop +++ b/krunner_bridge.desktop @@ -14,5 +14,25 @@ X-KDE-PluginInfo-Version=0.0.2 X-KDE-PluginInfo-License=LGPLv3 X-KDE-PluginInfo-EnabledByDefault=true -X-KRunner-Bridge-Run-Timeout=2000 -X-KRunner-Bridge-Match-Timeout=10000 +X-KRunner-Bridge-Run-Timeout=5000 +X-KRunner-Bridge-Match-Timeout=5000 + +X-KRunner-Bridge-Script-1=example_search.py +X-KRunner-Bridge-Script-2=example_calc.py + +# This is an example entry to show how the config groups can be configured. +# With these groups you can get additional signals and avoid unnecessary file executions +[X-KRunner-Bridge-Script-Config-3] +# Regex used to determine if the script should be executed with the current query +MatchRegex=^hello +# Command that gets called with the script and input as parameters +LaunchCommand=bash +FilePath=debug_helper.sh +# Execute script when the KRunner plugins are initialized +Initialize=true +# Execute script if match session has started +Prepare=true +# Execute script if match session has finished +Teardown=true +# Execute script with the run command detached +RunDetatched=true From bcffce4d8752d1d2b975022696d95252b2a8ca85 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Tue, 28 Jan 2020 08:36:05 +0100 Subject: [PATCH 09/13] Create python API for new signals, add template --- README.md | 4 ---- python/krunner_bridge/__init__.py | 35 ++++++++++++++++++++++++------- template.py | 33 +++++++++++++++++++++++++++++ 3 files changed, 61 insertions(+), 11 deletions(-) create mode 100644 template.py diff --git a/README.md b/README.md index d477ff7..f8c274a 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,5 @@ # KRunner Bridge -### NOTE: This branch is currently developed and supports only python3 as a plugin language, -other languages and new features will come soon ! - - **Write krunner python plugins the quick way.** Plasma 5 stopped exposing KDE Framework API to script languages (except QML) for the purpose of so-called stability (but it is not at all stable, crashing from time to time). But this brings some horrible consequence that writing krunner plugins becomes time-consuming. You have to write long C++ code, configure your C++ building toolchain, and compile them each time you modify something. diff --git a/python/krunner_bridge/__init__.py b/python/krunner_bridge/__init__.py index d58aece..033ba71 100644 --- a/python/krunner_bridge/__init__.py +++ b/python/krunner_bridge/__init__.py @@ -82,18 +82,30 @@ def __repr__(self): return "".format( repr(self.text), repr(self.cmp)) -__MATCH_HANDLER = lambda query: [] -def match_handler(func): - global __MATCH_HANDLER - __MATCH_HANDLER = func - return func - __INIT_HANDLER = lambda: None def init_handler(func): global __INIT_HANDLER __INIT_HANDLER = func return func +__SETUP_HANDLER = lambda: None +def setup_handler(func): + global __SETUP_HANDLER + __SETUP_HANDLER = func + return func + +__TEARDOWN_HANDLER = lambda: None +def teardown_handler(func): + global __TEARDOWN_HANDLER + __TEARDOWN_HANDLER = func + return func + +__MATCH_HANDLER = lambda query: [] +def match_handler(func): + global __MATCH_HANDLER + __MATCH_HANDLER = func + return func + __RUN_HANDLER = lambda data: None def run_handler(func): global __RUN_HANDLER @@ -125,7 +137,16 @@ def exec(): print(json.dumps({ "result": result })) if op == "init": - __INIT_HANDLER(**args) + __INIT_HANDLER() + + if op == "setup": + __SETUP_HANDLER() + + if op == "match": + __MATCH_HANDLER(**args) + + if op == "teardown": + __TEARDOWN_HANDLER() if op == "run": __RUN_HANDLER(**args) diff --git a/template.py b/template.py new file mode 100644 index 0000000..95c4ad3 --- /dev/null +++ b/template.py @@ -0,0 +1,33 @@ +#!/usr/bin/env python3 + +import krunner_bridge + +# Make sure that you add this script to the config file at ~/.local/share/kservices5/krunner_bridge.desktop +# It is recommended to use the config group system, this allows you to enable/disable optional methods like setup/teardown + +@krunner_bridge.init_handler +def init(): + pass + +@krunner_bridge.match_handler +def match(query): + return krunner_bridge.datasource( + text="Hello There!", + icon="planetkde", + category="Python Calculator") + +@krunner_bridge.run_handler +def run(data): + pass + +@krunner_bridge.setup_handler +def setup(): + pass + +@krunner_bridge.teardown_handler +def teardown(): + pass + + +if __name__ == "__main__": + krunner_bridge.exec() From c8de6e6d78ae42c7a867c0f1dc3391c93a158abf Mon Sep 17 00:00:00 2001 From: alex1701c Date: Tue, 28 Jan 2020 19:28:20 +0100 Subject: [PATCH 10/13] Add more timeouts, update README.md --- README.md | 73 ++++++++++++++++++++++++++++------- krunner_bridge.cc | 88 ++++++++++++++++++++++++------------------ krunner_bridge.desktop | 11 ++++-- krunner_bridge.h | 17 ++++++-- 4 files changed, 130 insertions(+), 59 deletions(-) diff --git a/README.md b/README.md index f8c274a..c182da6 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # KRunner Bridge +TODOS: +- make some parts of plugin more reusable +- Use signals for processes +- Add debug option + **Write krunner python plugins the quick way.** Plasma 5 stopped exposing KDE Framework API to script languages (except QML) for the purpose of so-called stability (but it is not at all stable, crashing from time to time). But this brings some horrible consequence that writing krunner plugins becomes time-consuming. You have to write long C++ code, configure your C++ building toolchain, and compile them each time you modify something. @@ -8,7 +13,8 @@ No more pains with ONE plugin for all. ----- -UPDATE: A KDE maintainer has described a way that was newly introduced in KDE 5.11, to make use of DBus to achieve this. See this post: http://blog.davidedmundson.co.uk/blog/cross-process-runners/ +UPDATE: A KDE maintainer has described a way that was newly introduced in KDE 5.11, to make use of DBus to achieve this. See this post: http://blog.davidedmundson.co.uk/blog/cross-process-runners/ +There are also (unofficial) KDevelop templates for this: https://www.pling.com/c/1355251/ ## Installation @@ -35,9 +41,7 @@ Clone this repository to local filesystem and cd into it. ## Quick Start -We will try to write a basic calculator using python's eval function. - -After installing the plugin you should have te file `~/.local/share/kservices5/example_calc.py`: +By executing the installer you get a basic calculator using python's eval function at `~/.local/share/kservices5/example_calc.py`: ```python #!/usr/bin/env python3 @@ -62,24 +66,62 @@ if __name__ == "__main__": ``` -``` -echo X-KRunner-Bridge-Script-1=example_calc.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop -``` - -Kill and restart krunner. (NOTE: It would be more debuggable to run it in terminal than using `kstart5`. All stderr output from your python script will be forwarded and displayed.) That's what it will be like when all's done: +All stderr output from your python script will be forwarded and displayed in the console. +That's what it will be like when it is installed: ![](preview/screenshot-1.png) -For more practical examples, check out `example_search.py` and view the effects by running `./install_examples.sh`. It searches in my useful little scripts and applications, with far better fuzzy match algorithm and selection mechanism. As what shows below, when you type one more key `5` to form a query `kse5`, the 5th choice `KColorSchemeEditor` will automatically be selected. +For more practical examples, check out `example_search.py`. It searches in my useful little scripts and applications, with far better fuzzy match algorithm and selection mechanism. As what shows below, when you type one more key `5` to form a query `kse5`, the 5th choice `KColorSchemeEditor` will automatically be selected. ![](preview/screenshot-2.png) +## Configuration + +### Timeouts +In the `krunner_bridge.desktop` file are already the config entries for the timeouts configured, if you want them +to take indefinitely long, you can set the value to -1. + +### Simple Configuration +You can add python3 scripts by adding `X-KRunner-Bridge-Script###=`, +to the `/.local/share/kservices5/krunner_bridge.desktop` file where ### can be a number, an ID or anything unique. +This way the script is called for init, match and run operations. This is simple but it can be far more efficient to use the config groups. + +### Config Groups +With the config groups you can specify more parameters, an example entry looks like this: +``` +[X-KRunner-Bridge-Script-Config-3] +FilePath=debug_helper.sh +LaunchCommand=bash +MatchRegex=^hello +Initialize=true +Prepare=true +Teardown=true +RunDetached=true +``` +In the first line with in the [] you specify the name of the group, this has to start with `X-KRunner-Bridge-Script` and has to be unique. +Firstly you have to specify the file path, this path can be relative to `~/.local/share/kservices5/` or absolute. +All other keys are optional. +The `LaunchCommad` is the command that gets executed when executing the script, it defaults to `python3`. +The `MatchRegex` is a regular expression which determines if the match operation should be with the current query executed. +In this example the value is `^hello`, this means that the query has to start with `hello`, if not the script does not get called. +By using this you can avoid a lot of unnecessary plugin executions. It defaults to `.*` which always calls the script. +If you want to test your regular expressions https://regex101.com/ can be very useful. + +The `Initialize`, `Setup` and `Teardown` keys determine which lifecycle methods should be called. The Setup and Teardown keys refer +to the KRunner match session, for instance the setup operation gets called when a new KRunner match session is started (before text is typed). +By default only init is enabled. + +The `RunDetached` key determines, if the process calling the run method should be started attached or detached, +by default it is detached. If set to false you can set a timeout as described above. + ## API * `exec()`: The entry of a script * `match_handler`: Register a function having parameter `query` and returning a list of `datasource` as a match handler * `init_handler`: Register a function having no parameter as an init handler * `run_handler`: Register a function having parameter `data` as a run handler +* `setup_handler`: Register a function having no parameter as an setup handler. This function will be called when a new match session is started. +* `teardown_handler`: Register a function having no parameter as an teardown handler. This function will be called when a match session ended. * `datasource` - Properties: - data: Save a dict/array/string/numeric here for later use (in run handler) @@ -96,20 +138,23 @@ For more practical examples, check out `example_search.py` and view the effects ## FAQs * Q: How does it work actually? -* A: The C++ plugin just calls python scripts throw spawning subprocess, and passes parameters like `{"operation":"query","query":"kss"}` through standard input, while the script parses this and returns the result set through standard output, formatted in JSON likewise. This mean you can write the script in any language (even bash) as long as you can parse JSON. To note that the script is called everytime there is an action (run/query/init), so make your script finished as quickly as possible, and do not keep alive in background. +* A: The C++ plugin just calls python scripts throw spawning subprocess, and passes parameters like `{"operation":"query","query":"kss"}` through standard input, while the script parses this and returns the result set as an launch parameter, formatted in JSON likewise. This mean you can write the script in any language (even bash) as long as you can parse JSON. To note that the script is called everytime there is an action (run/query/init/setup/teardown), so make your script finished as quickly as possible, and do not keep alive in background. * Q: What if I want multiple scripts? -* A: Just append one more line `X-KRunner-Bridge-Script###=`, where ### can be a number, an ID or anything unique. KRunner bridge searches all properties starting with `X-KRunner-Bridge-Script` and run them one after another. Distinguish them with the category property. +* A: Just append one more config entry (line or group), where the key anything unique. +KRunner bridge searches all properties and groups starting with `X-KRunner-Bridge-Script`. ----- * Q: Is it possible to move my scripts somewhere else? -* A: Yes. Scripts are not required to be in the services directory, for this is just a default searching path. Just specify the right path, adn remember to quote special characters. +* A: Yes. Scripts are not required to be in the services directory, for this is just a default searching path. Just specify the right path, and remember to quote special characters. ----- * Q: How can I make some cache to speed up searching? -* A: Do initialization and slow tasks in `init`, And handle caches by your own. For example, `pickle` your data up and save them in `/tmp`. `datasource` the python class provide some method to generate results, which might be useful. +* A: Do initialization and slow tasks in `init`, And handle caches by your own. For example, `pickle` your data up and save them in `/tmp`. `datasource` the python class provide some method to generate results, which might be useful. +Additionally you can use the config groups instead of a single config line to provide additional information, for instance a regular expression. +The Configuration section explains this in detail. ----- diff --git a/krunner_bridge.cc b/krunner_bridge.cc index adc9c7e..3ea9c6c 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -5,6 +5,7 @@ #include #include #include +#include #include "krunner_bridge.h" @@ -13,12 +14,44 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) : Plasma::AbstractRunner(parent, args) { - if (!QDir(cwd).exists()) cwd = ""; - const QLatin1String krunnerBridgeScriptKey = QLatin1String("X-KRunner-Bridge-Script"); - const QLatin1String krunnerBridgeRunTimeoutKey = QLatin1String("X-KRunner-Bridge-Run-Timeout"); - const QLatin1String krunnerBridgeMatchTimeoutKey = QLatin1String("X-KRunner-Bridge-Match-Timeout"); - // Read config from file + setSpeed(AbstractRunner::NormalSpeed); + setPriority(HighestPriority); + setHasRunOptions(true); + setDefaultSyntax(Plasma::RunnerSyntax(QStringLiteral(":q:"), metadata().comment())); + + if (!QDir(cwd).exists()) { + cwd = QDir::homePath(); + } + + initializeTimeouts(); + parseKRunnerConfigLines(); + parseKRunnerConfigGroups(); + + QList processes; + for (const KRunnerScript &script : qAsConst(scripts)) { + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start(script.launchCommand, QStringList() << script.filePath << json_init); + processes.append(process); + } + for (auto *process : qAsConst(processes)) { + process->waitForFinished(initTimeout); + process->deleteLater(); + } + +} + +void KRunnerBridge::initializeTimeouts() { + initTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Init-Timeout"), QVariant::Int).toInt(); + setupTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Setup-Timeout"), QVariant::Int).toInt(); + teardownTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Teardown-Timeout"), QVariant::Int).toInt(); + runTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Run-Timeout"), QVariant::Int).toInt(); + matchTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Match-Timeout"), QVariant::Int).toInt(); +} + +void KRunnerBridge::parseKRunnerConfigLines() { + const QLatin1String krunnerBridgeScriptKey = QLatin1String("X-KRunner-Bridge-Script"); const auto keyWords = metadata().service()->propertyNames(); for (const QString &kw : keyWords) { if (kw.startsWith(krunnerBridgeScriptKey)) { @@ -36,20 +69,19 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) KRunnerScript kRunnerScript; kRunnerScript.filePath = script; scripts.append(kRunnerScript); - } else if (kw == krunnerBridgeRunTimeoutKey) { - runTimeout = metadata().service()->property(kw, QVariant::String).toInt(); - if (runTimeout <= 0) runTimeout = 2000; - } else if (kw == krunnerBridgeMatchTimeoutKey) { - matchTimeout = metadata().service()->property(kw, QVariant::String).toInt(); - if (matchTimeout <= 0) matchTimeout = 1000; } } - KSharedConfig::Ptr config = KSharedConfig::openConfig( - QDir::homePath() + QDir::separator() + ".local/share/kservices5/krunner_bridge.desktop"); +} + +void KRunnerBridge::parseKRunnerConfigGroups() { + KSharedConfig::Ptr config = KSharedConfig::openConfig(QDir::homePath() + % QDir::separator() + % QStringLiteral(".local/share/kservices5/krunner_bridge.desktop")); bool hasPrepareScript = false; bool hasTeardownScript = false; const auto entries = config->groupList(); + const QLatin1String krunnerBridgeScriptKey = QLatin1String("X-KRunner-Bridge-Script"); for (const QString &groupName : entries) { if (groupName.startsWith(krunnerBridgeScriptKey)) { const KConfigGroup group = config->group(groupName); @@ -70,29 +102,10 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) if (script.teardown) { hasTeardownScript = true; } - script.runDetatched = group.readEntry("RunDetatched ", true); + script.runDetatched = group.readEntry("RunDetached ", true); scripts.append(script); } } - scriptCount = scripts.count(); - - setSpeed(AbstractRunner::NormalSpeed); - setPriority(HighestPriority); - setHasRunOptions(true); - - setDefaultSyntax(Plasma::RunnerSyntax(QStringLiteral(":q:"), metadata().comment())); - - QList processes; - for (const KRunnerScript &script : qAsConst(scripts)) { - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << json_init); - processes.append(process); - } - for (auto *process : qAsConst(processes)) { - process->waitForFinished(runTimeout); - process->deleteLater(); - } // Connect only if at least one script requires the signal if (hasPrepareScript) { @@ -114,7 +127,7 @@ void KRunnerBridge::prepareForMatchSession() { process->start(script.launchCommand, QStringList() << script.filePath << json_prepare); } for (auto *process : qAsConst(processes)) { - process->waitForFinished(matchTimeout); + process->waitForFinished(setupTimeout); process->deleteLater(); } } @@ -127,10 +140,10 @@ void KRunnerBridge::matchSessionFinished() { } auto *process = new QProcess(); process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << json_teardow); + process->start(script.launchCommand, QStringList() << script.filePath << json_teardown); } for (auto *process : qAsConst(processes)) { - process->waitForFinished(matchTimeout); + process->waitForFinished(teardownTimeout); process->deleteLater(); } } @@ -177,7 +190,7 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { for (const auto &result :v_result.toArray()) { KB_ASSERT(result.isObject()); - QJsonObject obj = result.toObject(); + const QJsonObject obj = result.toObject(); Plasma::QueryMatch m(this); @@ -230,6 +243,7 @@ void KRunnerBridge::run(const Plasma::RunnerContext &ctxt, const Plasma::QueryMa } } + K_EXPORT_PLASMA_RUNNER(krunner_bridge, KRunnerBridge) #include "krunner_bridge.moc" diff --git a/krunner_bridge.desktop b/krunner_bridge.desktop index 8368afc..f0fb716 100644 --- a/krunner_bridge.desktop +++ b/krunner_bridge.desktop @@ -1,6 +1,6 @@ [Desktop Entry] Name=KRunner Bridge -Comment= +Comment=Utility to write KRunner plugins Type=Service Icon=utilities-terminal @@ -8,14 +8,17 @@ X-KDE-Library=krunner_bridge X-KDE-PluginInfo-Name=krunner_bridge X-KDE-ServiceTypes=Plasma/Runner -X-KDE-PluginInfo-Author=Shihira Fung +X-KDE-PluginInfo-Author=Shihira Fung, Alex1701c X-KDE-PluginInfo-Email=fengzhiping@hotmail.com X-KDE-PluginInfo-Version=0.0.2 X-KDE-PluginInfo-License=LGPLv3 X-KDE-PluginInfo-EnabledByDefault=true +X-KRunner-Bridge-Init-Timeout=3000 +X-KRunner-Bridge-Setup-Timeout=3000 +X-KRunner-Bridge-Teardown-Timeout=3000 +X-KRunner-Bridge-Match-Timeout=2000 X-KRunner-Bridge-Run-Timeout=5000 -X-KRunner-Bridge-Match-Timeout=5000 X-KRunner-Bridge-Script-1=example_search.py X-KRunner-Bridge-Script-2=example_calc.py @@ -35,4 +38,4 @@ Prepare=true # Execute script if match session has finished Teardown=true # Execute script with the run command detached -RunDetatched=true +RunDetached=true diff --git a/krunner_bridge.h b/krunner_bridge.h index f8ed37c..1fe293c 100644 --- a/krunner_bridge.h +++ b/krunner_bridge.h @@ -11,17 +11,26 @@ Q_OBJECT QList scripts; QString cwd = QDir::cleanPath(QDir::homePath() + QDir::separator() + QStringLiteral(".local/share/kservices5")); - int matchTimeout = 1000; - int runTimeout = 2000; - int scriptCount; + // Timeouts + int initTimeout; + int matchTimeout; + int runTimeout; + int setupTimeout; + int teardownTimeout; // Hard coded JSON commands const QByteArray json_init = R"({"operation":"init"})"; const QByteArray json_prepare = R"({"operation":"prepare"})"; - const QByteArray json_teardow = R"({"operation":"teardown"})"; + const QByteArray json_teardown = R"({"operation":"teardown"})"; public: KRunnerBridge(QObject *parent, const QVariantList &args); + void initializeTimeouts(); + + void parseKRunnerConfigLines(); + + void parseKRunnerConfigGroups(); + void match(Plasma::RunnerContext &) override; void run(const Plasma::RunnerContext &, const Plasma::QueryMatch &) override; From e777d9191ba681f8c06c6ab158b42197bc8feb4c Mon Sep 17 00:00:00 2001 From: Alexander Lohnau Date: Tue, 28 Jan 2020 19:32:41 +0100 Subject: [PATCH 11/13] Create LICENSE --- LICENSE | 674 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 674 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..f288702 --- /dev/null +++ b/LICENSE @@ -0,0 +1,674 @@ + GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Use with the GNU Affero General Public License. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU Affero General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU General Public License from time to time. Such new versions will +be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + + Copyright (C) + + 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 3 of the License, or + (at your option) any later version. + + 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 . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. From b83c490450aef39c30d766a430c082517cc50508 Mon Sep 17 00:00:00 2001 From: alex1701c Date: Fri, 31 Jan 2020 18:53:12 +0100 Subject: [PATCH 12/13] Include debug option, improve code --- README.md | 2 -- krunner_bridge.cc | 52 ++++++++++++++++++++++-------------------- krunner_bridge.desktop | 1 + krunner_bridge.h | 3 ++- krunner_script.h | 7 ++++++ 5 files changed, 37 insertions(+), 28 deletions(-) diff --git a/README.md b/README.md index c182da6..aa7e950 100644 --- a/README.md +++ b/README.md @@ -1,9 +1,7 @@ # KRunner Bridge TODOS: -- make some parts of plugin more reusable - Use signals for processes -- Add debug option **Write krunner python plugins the quick way.** diff --git a/krunner_bridge.cc b/krunner_bridge.cc index 3ea9c6c..a384b91 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -9,7 +9,7 @@ #include "krunner_bridge.h" -#define KB_ASSERT(cond) {if(!(cond)) {qDebug().nospace() << "[" << script << "] Failed on " << #cond; continue;}} +#define KB_ASSERT(cond) {if(!(cond)) {qDebug().nospace() << "[" << script << "] Failed on " << #cond << "JSON value was: \n" << output; continue;}} #define KB_ASSERT_MSG(cond, msg) {if(!(cond)) {qDebug().nospace() << "[" << script << "] " << msg; continue;}} KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) @@ -24,16 +24,13 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) cwd = QDir::homePath(); } - initializeTimeouts(); + initializeValues(); parseKRunnerConfigLines(); parseKRunnerConfigGroups(); QList processes; for (const KRunnerScript &script : qAsConst(scripts)) { - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << json_init); - processes.append(process); + processes.append(script.startProcess(json_init, cwd)); } for (auto *process : qAsConst(processes)) { process->waitForFinished(initTimeout); @@ -42,12 +39,13 @@ KRunnerBridge::KRunnerBridge(QObject *parent, const QVariantList &args) } -void KRunnerBridge::initializeTimeouts() { +void KRunnerBridge::initializeValues() { initTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Init-Timeout"), QVariant::Int).toInt(); setupTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Setup-Timeout"), QVariant::Int).toInt(); teardownTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Teardown-Timeout"), QVariant::Int).toInt(); runTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Run-Timeout"), QVariant::Int).toInt(); matchTimeout = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Match-Timeout"), QVariant::Int).toInt(); + debugOutput = metadata().service()->property(QStringLiteral("X-KRunner-Bridge-Debug"), QVariant::Bool).toBool(); } void KRunnerBridge::parseKRunnerConfigLines() { @@ -119,12 +117,9 @@ void KRunnerBridge::parseKRunnerConfigGroups() { void KRunnerBridge::prepareForMatchSession() { QList processes; for (const KRunnerScript &script : qAsConst(scripts)) { - if (!script.prepare) { - continue; + if (script.prepare) { + processes.append(script.startProcess(json_prepare, cwd)); } - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << json_prepare); } for (auto *process : qAsConst(processes)) { process->waitForFinished(setupTimeout); @@ -135,12 +130,9 @@ void KRunnerBridge::prepareForMatchSession() { void KRunnerBridge::matchSessionFinished() { QList processes; for (const KRunnerScript &script : qAsConst(scripts)) { - if (!script.prepare) { - continue; + if (script.prepare) { + processes.append(script.startProcess(json_teardown, cwd)); } - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << json_teardown); } for (auto *process : qAsConst(processes)) { process->waitForFinished(teardownTimeout); @@ -162,16 +154,22 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { QList processes; for (const KRunnerScript &script : qAsConst(scripts)) { if (script.matchRegex.match(query).hasMatch()) { - auto *process = new QProcess(); - process->setWorkingDirectory(cwd); - process->start(script.launchCommand, QStringList() << script.filePath << input); - processes.append(process); + processes.append(script.startProcess(input, cwd)); } } // Evaluate output of the scripts // TODO Solve using signals for (int i = 0, processCount = processes.count(); i < processCount; ++i) { + // Kill processes if context is not valid anymore + if (!ctxt.isValid()) { + for (auto p: qAsConst(processes)) { + p->kill(); + p->deleteLater(); + } + return; + } + auto process = processes.at(i); const QString script = process->program(); KB_ASSERT_MSG(process->waitForFinished(matchTimeout), "Result retrieve timeout") @@ -188,6 +186,11 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { QJsonValue v_result = doc.object().value("result"); KB_ASSERT(v_result.isArray()) + if (debugOutput) { + qInfo() << "Debug output for: " << script << " " << process->arguments().at(0); + qInfo().noquote() << doc.toJson(QJsonDocument::JsonFormat::Indented); + } + for (const auto &result :v_result.toArray()) { KB_ASSERT(result.isObject()); const QJsonObject obj = result.toObject(); @@ -236,10 +239,9 @@ void KRunnerBridge::run(const Plasma::RunnerContext &ctxt, const Plasma::QueryMa QProcess::startDetached(script.launchCommand, QStringList() << script.filePath << QJsonDocument(command).toJson(QJsonDocument::Compact)); } else { - QProcess process; - process.setWorkingDirectory(cwd); - process.start(script.launchCommand, QStringList() << script.filePath << QJsonDocument(command).toJson(QJsonDocument::Compact)); - process.waitForFinished(runTimeout); + QProcess *p = script.startProcess(QJsonDocument(command).toJson(QJsonDocument::Compact), cwd); + p->waitForFinished(runTimeout); + p->deleteLater(); } } diff --git a/krunner_bridge.desktop b/krunner_bridge.desktop index f0fb716..2c2110b 100644 --- a/krunner_bridge.desktop +++ b/krunner_bridge.desktop @@ -19,6 +19,7 @@ X-KRunner-Bridge-Setup-Timeout=3000 X-KRunner-Bridge-Teardown-Timeout=3000 X-KRunner-Bridge-Match-Timeout=2000 X-KRunner-Bridge-Run-Timeout=5000 +X-KRunner-Bridge-Debug=false X-KRunner-Bridge-Script-1=example_search.py X-KRunner-Bridge-Script-2=example_calc.py diff --git a/krunner_bridge.h b/krunner_bridge.h index 1fe293c..b0dbb98 100644 --- a/krunner_bridge.h +++ b/krunner_bridge.h @@ -11,6 +11,7 @@ Q_OBJECT QList scripts; QString cwd = QDir::cleanPath(QDir::homePath() + QDir::separator() + QStringLiteral(".local/share/kservices5")); + bool debugOutput; // Timeouts int initTimeout; int matchTimeout; @@ -25,7 +26,7 @@ Q_OBJECT public: KRunnerBridge(QObject *parent, const QVariantList &args); - void initializeTimeouts(); + void initializeValues(); void parseKRunnerConfigLines(); diff --git a/krunner_script.h b/krunner_script.h index 50a081d..7ef285a 100644 --- a/krunner_script.h +++ b/krunner_script.h @@ -12,6 +12,13 @@ struct KRunnerScript { bool prepare = false; bool teardown = false; bool runDetatched = true; + + QProcess *startProcess(const QByteArray &data, const QString &cwd) const { + auto *process = new QProcess(); + process->setWorkingDirectory(cwd); + process->start(launchCommand, QStringList() << filePath << data); + return process; + } }; #endif //KRUNNER_BRIDGE_KRUNNER_SCRIPT_H From 24607c12e446d50dd30777ca32b594c55292b31c Mon Sep 17 00:00:00 2001 From: alex1701c Date: Fri, 7 Feb 2020 13:49:27 +0100 Subject: [PATCH 13/13] Improve docs --- README.md | 11 ++++++++--- install.sh | 3 +-- install_example.sh | 20 -------------------- krunner_bridge.cc | 1 - 4 files changed, 9 insertions(+), 26 deletions(-) delete mode 100755 install_example.sh diff --git a/README.md b/README.md index aa7e950..cc65ebf 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,5 @@ # KRunner Bridge -TODOS: -- Use signals for processes - **Write krunner python plugins the quick way.** Plasma 5 stopped exposing KDE Framework API to script languages (except QML) for the purpose of so-called stability (but it is not at all stable, crashing from time to time). But this brings some horrible consequence that writing krunner plugins becomes time-consuming. You have to write long C++ code, configure your C++ building toolchain, and compile them each time you modify something. @@ -75,6 +72,7 @@ For more practical examples, check out `example_search.py`. It searches in my us ## Configuration +*Note: Whenever you change the config file KRunner has to be restarted: `kquitapp5 krunner;kstart5 krunner`* ### Timeouts In the `krunner_bridge.desktop` file are already the config entries for the timeouts configured, if you want them to take indefinitely long, you can set the value to -1. @@ -142,6 +140,13 @@ by default it is detached. If set to false you can set a timeout as described ab * A: Just append one more config entry (line or group), where the key anything unique. KRunner bridge searches all properties and groups starting with `X-KRunner-Bridge-Script`. +* Q: How can I update this plugin after with the new features from https://github.com/Shihira/krunner-bridge/pull/3 ? +* A: You should remove the python api file located at ~/.local/share/kservices5/krunner_bridge.py. +After this you can install the new version and add the scripts to the config file. +If you only use python scripts, they should be compatible, otherwise you have to change the json input +from standard input to the first program argument. + + ----- * Q: Is it possible to move my scripts somewhere else? diff --git a/install.sh b/install.sh index 780d856..d81658b 100755 --- a/install.sh +++ b/install.sh @@ -4,7 +4,7 @@ set -e cd python -python3 setup.py install +python3 setup.py install --user cd .. if [[ ! -d build ]]; then @@ -23,4 +23,3 @@ install ./debug_helper.sh $HOME/.local/share/kservices5 kquitapp5 krunner 2> /dev/null kstart5 --windowclass krunner krunner > /dev/null 2>&1 & - diff --git a/install_example.sh b/install_example.sh deleted file mode 100755 index c06963f..0000000 --- a/install_example.sh +++ /dev/null @@ -1,20 +0,0 @@ -#!/bin/bash - -cd python -python3 setup.py install --user -cd .. - -if [[ ! -d build ]]; then - mkdir build -fi - -cd build -cmake -DCMAKE_BUILD_TYPE=Release .. -make -make install - -install ../example_search.py $HOME/.local/share/kservices5 -install ../example_calc.py $HOME/.local/share/kservices5 - -echo X-KRunner-Bridge-Script-1=example_search.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop -echo X-KRunner-Bridge-Script-2=example_calc.py >> $HOME/.local/share/kservices5/krunner_bridge.desktop diff --git a/krunner_bridge.cc b/krunner_bridge.cc index a384b91..742b5b3 100644 --- a/krunner_bridge.cc +++ b/krunner_bridge.cc @@ -159,7 +159,6 @@ void KRunnerBridge::match(Plasma::RunnerContext &ctxt) { } // Evaluate output of the scripts - // TODO Solve using signals for (int i = 0, processCount = processes.count(); i < processCount; ++i) { // Kill processes if context is not valid anymore if (!ctxt.isValid()) {