Merge pull request #20 from InputActions/scripting

add scripting

Author: taj-ny

.github/workflows/test.yml

@@ -17,7 +17,7 @@ jobs:
         run: pacman -Syu --noconfirm
 
       - name: Install dependencies
-        run: pacman -S --needed --noconfirm base-devel git extra-cmake-modules qt6-tools yaml-cpp gtest
+        run: pacman -S --needed --noconfirm base-devel git extra-cmake-modules qt6-declarative qt6-tools yaml-cpp gtest
 
       - name: Check out repository
         uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2

CMakeLists.txt

@@ -23,6 +23,7 @@ include(KDECMakeSettings)
 find_package(Qt6 ${QT_MIN_VERSION} CONFIG REQUIRED COMPONENTS
     Core
     DBus
+    Qml
 )
 
 find_package(PkgConfig REQUIRED)

src/CMakeLists.txt

@@ -18,6 +18,7 @@ set(libinputactions_SRCS
     libinputactions/config/parsers/flags.cpp
     libinputactions/config/parsers/NodeParser.h
     libinputactions/config/parsers/qt.cpp
+    libinputactions/config/parsers/scripting.cpp
     libinputactions/config/parsers/separated-string.h
     libinputactions/config/parsers/std.cpp
     libinputactions/config/parsers/triggers.cpp
@@ -80,6 +81,13 @@ set(libinputactions_SRCS
     libinputactions/interfaces/TextInput.cpp
     libinputactions/interfaces/Window.h
     libinputactions/interfaces/WindowProvider.cpp
+    libinputactions/scripting/modules/core/CoreModule.cpp
+    libinputactions/scripting/modules/fs/File.cpp
+    libinputactions/scripting/FunctionWrapper.cpp
+    libinputactions/scripting/JSFunctionAction.cpp
+    libinputactions/scripting/JSFunctionCondition.cpp
+    libinputactions/scripting/Promise.cpp
+    libinputactions/scripting/ScriptingEngine.cpp
     libinputactions/triggers/core/DirectionalMotionTriggerCore.cpp
     libinputactions/triggers/core/MotionTriggerCore.cpp
     libinputactions/triggers/core/StrokeTriggerCore.cpp
@@ -133,6 +141,7 @@ target_link_libraries(libinputactions PUBLIC
     libevdev-cpp
     Qt6::Core
     Qt6::DBus
+    Qt6::Qml
     ${LIBEVDEV_LIBRARIES}
 )
 target_compile_definitions(libinputactions PUBLIC TEST_VIRTUAL=$<IF:$<BOOL:${BUILD_TESTS}>,virtual,>)

src/libinputactions/InputActionsMain.cpp

@@ -22,6 +22,7 @@
 #include "interfaces/implementations/DBusPlasmaGlobalShortcutInvoker.h"
 #include "interfaces/implementations/FileConfigProvider.h"
 #include "interfaces/implementations/ProcessRunnerImpl.h"
+#include "scripting/ScriptingEngine.h"
 #include "variables/VariableRegistry.h"
 #include <QFile>
 #include <QStandardPaths>
@@ -53,6 +54,7 @@ InputActionsMain::~InputActionsMain()
     g_globalConfig.reset();
     g_configProvider.reset();
     g_inputBackend.reset();
+    g_scriptingEngine.reset();
     g_strokeRecorder.reset();
     g_variableRegistry.reset();
 }
@@ -98,6 +100,7 @@ void InputActionsMain::setMissingImplementations()
     setMissingImplementation(g_configLoader);
     setMissingImplementation(g_globalConfig);
     setMissingImplementation(g_inputBackend);
+    setMissingImplementation(g_scriptingEngine);
     setMissingImplementation(g_strokeRecorder);
     setMissingImplementation(g_variableRegistry);
 }

src/libinputactions/PointF.cpp

@@ -48,6 +48,11 @@ bool PointF::isNull() const
     return !m_x && !m_y;
 }
 
+PointF PointF::clone() const
+{
+    return {m_x, m_y};
+}
+
 bool PointF::operator==(const PointF &other) const
 {
     return m_x == other.m_x && m_y == other.m_y;

src/libinputactions/PointF.h

@@ -46,6 +46,8 @@ class PointF
 
     Q_INVOKABLE double hypot() const;
 
+    Q_INVOKABLE PointF clone() const;
+
     bool operator==(const PointF &other) const;
     bool operator!=(const PointF &other) const;
 

src/libinputactions/config/ConfigIssue.cpp

@@ -21,6 +21,8 @@
 #include "Node.h"
 #include <QRegularExpression>
 #include <libinputactions/ansi-escape-codes.h>
+#include <libinputactions/helpers/QString.h>
+#include <libinputactions/scripting/ScriptingEngine.h>
 
 namespace InputActions
 {
@@ -183,6 +185,17 @@ QString UnusedPropertyConfigIssue::message() const
     return QString("Property '%1' does not exist or has no effect in this context.").arg(m_property);
 }
 
+UncaughtScriptErrorConfigIssue::UncaughtScriptErrorConfigIssue(const Node *node, QJSValue error)
+    : ConfigIssue(node)
+    , m_message(g_scriptingEngine->errorToString(error))
+{
+}
+
+QString UncaughtScriptErrorConfigIssue::message() const
+{
+    return QString("Uncaught script error\n\n%1").arg(m_message);
+}
+
 MissingRequiredPropertyConfigException::MissingRequiredPropertyConfigException(const Node *node, QString property)
     : ConfigException(node)
     , m_property(std::move(property))
@@ -194,6 +207,17 @@ QString MissingRequiredPropertyConfigException::message() const
     return QString("Required property '%1' was not specified.").arg(m_property);
 }
 
+UncaughtScriptErrorConfigException::UncaughtScriptErrorConfigException(const Node *node, QJSValue error)
+    : ConfigException(node)
+    , m_message(g_scriptingEngine->errorToString(error))
+{
+}
+
+QString UncaughtScriptErrorConfigException::message() const
+{
+    return QString("Uncaught script error\n\n%1").arg(m_message);
+}
+
 YamlCppConfigException::YamlCppConfigException(TextPosition position, QString message)
     : ConfigException(position)
     , m_message(std::move(message))
@@ -203,4 +227,14 @@ YamlCppConfigException::YamlCppConfigException(TextPosition position, QString me
     m_message += ".";
 }
 
+ScriptingDisabledConfigException::ScriptingDisabledConfigException()
+    : ConfigException(TextPosition())
+{
+}
+
+QString ScriptingDisabledConfigException::message() const
+{
+    return "Scripting is currently not available in the standalone implementation for security reasons. Remove all scripts from the configuration.";
+}
+
 }

src/libinputactions/config/ConfigIssue.h

@@ -19,6 +19,7 @@
 #pragma once
 
 #include "TextPosition.h"
+#include <QJSValue>
 #include <QString>
 #include <libinputactions/helpers/Copyable.h>
 
@@ -121,6 +122,19 @@ class UnusedPropertyConfigIssue
     QString m_property;
 };
 
+class UncaughtScriptErrorConfigIssue
+    : public ConfigIssue
+    , public virtual Copyable<UncaughtScriptErrorConfigIssue, ConfigIssue>
+{
+public:
+    UncaughtScriptErrorConfigIssue(const Node *node, QJSValue error);
+
+    QString message() const override;
+
+private:
+    QString m_message;
+};
+
 class DuplicateSetItemConfigException
     : public ConfigException
     , public virtual Copyable<DuplicateSetItemConfigException, ConfigIssue>
@@ -212,6 +226,19 @@ class MissingRequiredPropertyConfigException
     QString m_property;
 };
 
+class UncaughtScriptErrorConfigException
+    : public ConfigException
+    , public virtual Copyable<UncaughtScriptErrorConfigException, ConfigIssue>
+{
+public:
+    UncaughtScriptErrorConfigException(const Node *node, QJSValue error);
+
+    QString message() const override;
+
+private:
+    QString m_message;
+};
+
 class YamlCppConfigException
     : public ConfigException
     , public virtual Copyable<YamlCppConfigException, ConfigIssue>
@@ -225,4 +252,14 @@ class YamlCppConfigException
     QString m_message;
 };
 
+class ScriptingDisabledConfigException
+    : public ConfigException
+    , public virtual Copyable<ScriptingDisabledConfigException, ConfigIssue>
+{
+public:
+    ScriptingDisabledConfigException();
+
+    QString message() const override;
+};
+
 }

src/libinputactions/config/ConfigLoader.cpp

@@ -20,6 +20,7 @@
 #include "ConfigIssueManager.h"
 #include "GlobalConfig.h"
 #include "Node.h"
+#include "config/ConfigIssue.h"
 #include "interfaces/ConfigProvider.h"
 #include "parsers/containers.h"
 #include "parsers/core.h"
@@ -33,6 +34,7 @@
 #include <libinputactions/input/backends/LibevdevComplementaryInputBackend.h>
 #include <libinputactions/input/devices/InputDeviceRule.h>
 #include <libinputactions/interfaces/NotificationManager.h>
+#include <libinputactions/scripting/ScriptingEngine.h>
 
 namespace InputActions
 {
@@ -61,14 +63,17 @@ void ConfigLoader::loadEmpty()
 
 bool ConfigLoader::load(const ConfigLoadSettings &settings)
 {
+    auto scriptingEngine = g_scriptingEngine;
     try {
         qCDebug(INPUTACTIONS, "Reloading config");
         const auto rawConfig = settings.config.value_or(g_configProvider->currentConfig());
 
         g_configIssueManager = std::make_shared<ConfigIssueManager>(rawConfig);
+        g_scriptingEngine = std::make_shared<ScriptingEngine>();
         auto config = createConfig(rawConfig);
         activateConfig(std::move(config), true);
     } catch (const ConfigException &e) {
+        g_scriptingEngine = scriptingEngine;
         g_configIssueManager->addIssue(e);
     }
 
@@ -97,6 +102,20 @@ Config ConfigLoader::createConfig(const QString &raw)
     }
 
     Config config;
+
+    if (const auto *scriptingNode = root->mapAt("scripting")) {
+        if (const auto *scriptsNode = scriptingNode->at("scripts")) {
+            for (const auto *scriptNode : scriptsNode->sequenceItems()) {
+                const auto *sourceNode = scriptNode->at("source", true);
+                const auto source = sourceNode->as<QString>();
+                const auto result = g_scriptingEngine->evaluate(sourceNode->as<QString>());
+                if (result.isError()) {
+                    throw UncaughtScriptErrorConfigException(sourceNode, result);
+                }
+            }
+        }
+    }
+
     loadMember(config.autoReload, root->at("autoreload"));
     loadMember(config.allowExternalVariableAccess, root->at("external_variable_access"));
     if (const auto *notificationsNode = root->mapAt("notifications")) {

src/libinputactions/config/parsers/core.cpp

@@ -20,6 +20,7 @@
 #include "containers.h"
 #include "flags.h"
 #include "globals.h"
+#include "scripting.h"
 #include "separated-string.h"
 #include "triggers.h"
 #include "utils.h"
@@ -39,6 +40,7 @@
 #include <libinputactions/conditions/VariableCondition.h>
 #include <libinputactions/config/ConfigIssue.h>
 #include <libinputactions/config/ConfigIssueManager.h>
+#include <libinputactions/config/ConfigLoader.h>
 #include <libinputactions/config/Node.h>
 #include <libinputactions/handlers/KeyboardTriggerHandler.h>
 #include <libinputactions/handlers/MouseTriggerHandler.h>
@@ -51,6 +53,9 @@
 #include <libinputactions/input/backends/InputBackend.h>
 #include <libinputactions/input/devices/InputDeviceRule.h>
 #include <libinputactions/interfaces/CursorShapeProvider.h>
+#include <libinputactions/scripting/JSFunctionAction.h>
+#include <libinputactions/scripting/JSFunctionCondition.h>
+#include <libinputactions/scripting/ScriptingEngine.h>
 #include <libinputactions/triggers/core/StrokeTriggerCore.h>
 #include <libinputactions/triggers/keyboard/KeyboardShortcutTrigger.h>
 #include <libinputactions/triggers/mouse/MouseTrigger.h>
@@ -149,6 +154,8 @@ void NodeParser<std::unique_ptr<Action>>::parse(const Node *node, std::unique_pt
         auto action = std::make_unique<CommandAction>(commandNode->as<Value<QString>>());
         loadSetter(action, &CommandAction::setWait, node->at("wait"));
         result = std::move(action);
+    } else if (const auto *functionNode = node->at("function")) {
+        result = std::make_unique<JSFunctionAction>(parseFunction(functionNode), functionNode->shared_from_this());
     } else if (const auto *inputNode = node->at("input")) {
         auto action = std::make_unique<InputAction>(inputNode->as<std::vector<InputActionItem>>());
         loadSetter(action, &InputAction::setDelay, node->at("delay"));
@@ -225,6 +232,9 @@ std::shared_ptr<Condition> parseCondition(const Node *node, const VariableRegist
         if (const auto *canReplaceTextNode = node->at("can_replace_text")) {
             return std::make_shared<CanReplaceTextCondition>(canReplaceTextNode->as<std::vector<TextSubstitutionRule>>(true));
         }
+        if (const auto *functionNode = node->at("function")) {
+            return std::make_shared<JSFunctionCondition>(parseFunction(functionNode), functionNode->shared_from_this());
+        }
 
         if (isLegacy(node)) {
             g_configIssueManager->addIssue(DeprecatedFeatureConfigIssue(node, DeprecatedFeature::LegacyConditions));