experimental Lua backend

Author: aloneguid

.github/workflows/build.yml

@@ -5,7 +5,7 @@ env:
   BUILD_TYPE: Release
   ARCH: x64
   VCPKG_CONFIG: Release
-  VCPKG_HASH: 1dc5ee30eb1032221d29f281f4a94b73f06b4284
+  VCPKG_HASH: e590c2b30c08caf1dd8d612ec602a003f9784b7d
   DOC_INSTANCE: wrs/bt
   DOC_ARTIFACT: webHelpBT2-all.zip
   DOC_ALGOLIA_ARTIFACT: algolia-indexes-BT.zip

CMakeLists.txt

@@ -38,5 +38,6 @@ if(MSVC AND CMAKE_BUILD_TYPE MATCHES Release)
 endif()
 
 add_subdirectory(grey/grey)
+add_subdirectory(grey/demo/desktop)
 add_subdirectory(bt)
 add_subdirectory(test)

bt/CMakeLists.txt

@@ -12,6 +12,7 @@ find_package(fmt CONFIG REQUIRED)
 find_package(nlohmann_json CONFIG REQUIRED)
 find_path(P_RANAV_CSV2_INCLUDE_DIRS "csv2/mio.hpp")
 find_package(tinyxml2 CONFIG REQUIRED)
+find_package(Lua REQUIRED)
 
 file(GLOB core_src CONFIGURE_DEPENDS
     "app/*.cpp"
@@ -55,8 +56,13 @@ target_link_libraries(bt
 	fmt::fmt-header-only
 	nlohmann_json::nlohmann_json
     tinyxml2::tinyxml2
+    ${LUA_LIBRARIES}
 )
-target_include_directories(${APP_NAME} PRIVATE "../common" "../grey/grey" ${P_RANAV_CSV2_INCLUDE_DIRS})
+target_include_directories(${APP_NAME} PRIVATE
+    "../common"
+    "../grey/grey"
+    ${P_RANAV_CSV2_INCLUDE_DIRS}
+    ${LUA_INCLUDE_DIR})
 
 target_sources(bt PRIVATE dpi-aware.manifest)
 

bt/app/script_site.cpp

@@ -0,0 +1,101 @@
+#include "script_site.h"
+#include <fstream>
+
+using namespace std;
+
+namespace bt {
+
+    const string FileName = "rules.lua";
+
+    script_site::script_site(const string& path_or_code, bool is_path) :
+        path_or_code{path_or_code}, is_path{is_path} {
+        reload();
+    }
+
+    script_site::~script_site() {
+        if(L) {
+            lua_close(L);
+        }
+    }
+
+    void script_site::reload() {
+        error.clear();
+
+        // reinintialise interpreter
+        if(L) {
+            lua_close(L);
+            L = nullptr;
+        }
+
+        L = luaL_newstate();
+        luaL_openlibs(L);
+
+        // load code into string
+        {
+            if(is_path) {
+                ifstream fs(path_or_code);
+                if(fs.is_open()) {
+                    code = string(istreambuf_iterator<char>(fs), istreambuf_iterator<char>());
+                }
+            } else {
+                code = path_or_code;
+            }
+        }
+
+        // load code into interpreter
+        if(luaL_loadstring(L, code.c_str()) || lua_pcall(L, 0, 0, 0)) {
+            error = lua_tostring(L, -1);
+            // pop error message from the stack
+            lua_pop(L, 1);
+            return;
+        }
+    }
+
+    void script_site::set_code(const std::string& code) {
+        // save code to file
+        {
+            if(is_path) {
+                ofstream fs(path_or_code);
+                if(fs.is_open()) {
+                    fs << code;
+                }
+            }
+        }
+
+        reload();
+    }
+
+    bool script_site::call_rule(url_payload& up, const string& function_name) {
+
+        // set global table "p" with 3 members: url, window_title, process_name
+        lua_newtable(L);
+        lua_pushstring(L, up.match_url.c_str());
+        lua_setfield(L, -2, "url");
+        lua_pushstring(L, up.window_title.c_str());
+        lua_setfield(L, -2, "wt");
+        lua_pushstring(L, up.process_name.c_str());
+        lua_setfield(L, -2, "pn");
+        lua_setglobal(L, "p");
+
+        // call function
+        lua_getglobal(L, function_name.c_str());
+        if(lua_pcall(L, 0, 1, 0)) {
+            // get error message from the stack
+            error = lua_tostring(L, -1);
+            lua_pop(L, 1);
+            return false;
+        }
+
+        // read return value
+        bool r = lua_toboolean(L, -1);
+        lua_pop(L, 1);
+
+        // read back "url" from global table "p" (in case it's changed)
+        lua_getglobal(L, "p");
+        lua_getfield(L, -1, "url");
+        //up.match_url = lua_tostring(L, -1);
+        lua_pop(L, 1);
+
+        return r;
+    }
+}

bt/app/script_site.h

@@ -0,0 +1,32 @@
+#pragma once
+#include "lua.hpp"
+#include <string>
+#include "url_payload.h"
+
+namespace bt {
+    class script_site {
+    public:
+        script_site(const std::string& path_or_code, bool is_path);
+        ~script_site();
+
+        void reload();
+
+        std::string get_path() const { return is_path ? path_or_code : ""; }
+        std::string get_error() const { return error; }
+
+        // code as string manipulation
+        std::string get_code() const { return code; }
+        void set_code(const std::string& code);
+
+        // bt specific functions
+        bool call_rule(url_payload& up, const std::string& function_name);
+
+
+    private:
+        bool is_path;
+        std::string path_or_code;
+        std::string code;
+        std::string error;
+        lua_State* L{nullptr};
+    };
+}

bt/app/ui/config_app.cpp

@@ -23,19 +23,18 @@ namespace bt::ui {
         title{string{APP_LONG_NAME} + " " + APP_VERSION},
         wnd_config{title, &is_open},
         wnd_about{"About"},
-        wnd_subs{"Substitutions", &show_subs} {
+        wnd_subs{"Substitutions", &show_subs},
+        wnd_scripting{"Scripting", &show_scripting} {
 
-        app = grey::app::make(title, 900, 450);
+        app = grey::app::make(title, 900, 500);
         app->initial_theme_id = g_config.theme_id;
         app->win32_can_resize = false;
         app->win32_center_on_screen = true;
 
         wnd_config
-            //.size(900, 450)
             .has_menubar()
             .no_titlebar()
-            //.center()
-            .no_border()
+            .border(0)
             .no_resize()
             .no_collapse()
             .fill_viewport()
@@ -44,12 +43,19 @@ namespace bt::ui {
         wnd_about
             .size(310, 355)
             .center()
+            .border(1)
             .no_resize();
 
         wnd_subs
             .size(600, 300)
+            .border(1)
             .center();
 
+        wnd_scripting
+            .size(600, 600)
+            .border(1)
+            .no_scroll();
+
         float padding_bottom = 20 * app->scale;
         w_left_panel = w::container{250 * app->scale, -padding_bottom};
         w_right_panel = w::container{0, -padding_bottom}.border();
@@ -124,6 +130,9 @@ namespace bt::ui {
         if(show_subs)
             render_subs_window();
 
+        if(show_scripting)
+            render_scripting_window();
+
         render_dashboard();
 
         w::notify_render_frame();
@@ -239,6 +248,9 @@ namespace bt::ui {
                 if(w::mi("Substitutions...", true, ICON_MD_FIND_REPLACE)) {
                     show_subs = !show_subs;
                 }
+                if(w::mi("Scripting...", true, ICON_MD_CODE)) {
+                    show_scripting = !show_scripting;
+                }
             }
 
             if(w::menu m{"Help"}; m) {
@@ -510,7 +522,7 @@ It super fast, extremely light on resources, completely free and open source.)",
             w::tooltip("URL that will be opened in the browser");
         }
 
-        w::sl(820 * app->scale);
+        w::sl(800 * app->scale);
         if (w::button(ICON_MD_CLEAR_ALL " clear", w::emphasis::error)) {
             url_tester_up.clear();
         }
@@ -527,6 +539,31 @@ It super fast, extremely light on resources, completely free and open source.)",
             test_url();
         }
     }
+
+    void config_app::render_scripting_window() {
+        w::guard gw{wnd_scripting};
+
+        if(!script_initialised) {
+            script_editor.set_text(g_script.get_code());
+            script_initialised = true;
+        }
+
+        if(!g_script.get_error().empty()) {
+            w::label(g_script.get_error(), w::emphasis::error);
+        }
+
+        if(w::accordion("Test")) {
+            w::input(scripting_up.url, ICON_MD_LINK " URL", true);
+            w::input(scripting_up.window_title, ICON_MD_WINDOW " window", true);
+            w::input(scripting_up.process_name, ICON_MD_MEMORY " process", true);
+        }
+
+        if(w::button(ICON_MD_SAVE " save", w::emphasis::primary)) {
+            g_script.set_code(script_editor.get_text());
+        }
+
+        script_editor.render();
+    }
 
     void config_app::render_status_bar() {
         w::status_bar sb;

bt/app/ui/config_app.h

@@ -60,10 +60,17 @@ namespace bt::ui {
 
         // "Substitutions" window
         bool show_subs{false};
-        grey::widgets::window wnd_subs{"Substitutions"};
+        grey::widgets::window wnd_subs;
         std::vector<std::string> replacer_kinds{"string", "regex"};
         url_payload url_subs_up;
 
+        // "Script" window
+        bool show_scripting{false};
+        bool script_initialised{false};
+        grey::widgets::window wnd_scripting{"Scripting"};
+        grey::widgets::text_editor script_editor;
+        url_payload scripting_up;
+
         // URL Tester
         bool show_url_tester{false};
         size_t url_tester_payload_version{0};
@@ -86,6 +93,7 @@ namespace bt::ui {
         void render_subs_window();
         void render_dashboard();
         void render_url_tester_input();
+        void render_scripting_window();
 
         void render_status_bar();
         void render_no_browsers();

bt/app/ui/picker_app.cpp

@@ -75,7 +75,7 @@ namespace bt::ui {
                 //.size(wnd_width, wnd_height_normal)
                 .no_titlebar()
                 .no_resize()
-                .no_border()
+                .border(0)
                 .fill_viewport()
                 .no_scroll();
         };

bt/app/url_pipeline.h

@@ -1,5 +1,4 @@
 #pragma once
-#include <string>
 #include <memory>
 #include <vector>
 #include "url_pipeline_step.h"

bt/bt.cpp

@@ -18,6 +18,7 @@
 alg::tracker t{APP_SHORT_NAME, APP_VERSION};
 bt::config g_config;
 bt::url_pipeline g_pipeline{g_config};
+bt::script_site g_script{bt::config::get_data_file_path("rules.lua"), true};
 
 using namespace std;
 

bt/globals.h

@@ -2,6 +2,7 @@
 #include <string>
 #include "app/url_pipeline.h"
 #include "app/config.h"
+#include "app/script_site.h"
 #include "../common/ext/alg_tracker.h"
 
 const std::string AppDescription("Redirects open URLs to a browser of your choice.");
@@ -22,4 +23,6 @@ extern alg::tracker t;
 
 extern bt::config g_config;
 
-extern bt::url_pipeline g_pipeline;
+extern bt::url_pipeline g_pipeline;
+
+extern bt::script_site g_script;

docs/release-notes.md

@@ -1,3 +1,9 @@
+## 5.0.0
+
+### New features
+- BT can write log file (todo: docs)
+- Lua scripting.
+
 ## 4.0.3
 
 New features:

grey

@@ -5,6 +5,7 @@ set(CMAKE_CXX_STANDARD_REQUIRED ON)
 project(test)
 
 find_package(fmt CONFIG REQUIRED)
+find_package(Lua REQUIRED)
 find_package(GTest CONFIG REQUIRED)
 
 # For Windows: Prevent overriding the parent project's compiler/linker settings
@@ -16,7 +17,8 @@ file(GLOB cpps CONFIGURE_DEPENDS
     "*.cpp"
     "../common/*.cpp"
     "../bt/app/match_rule.cpp"
-    "../bt/app/security/*.cpp")
+    "../bt/app/security/*.cpp"
+    "../bt/app/script_site.cpp")
 
 add_executable(test ${cpps})
 
@@ -25,6 +27,9 @@ gtest_discover_tests(test)
 
 target_link_libraries(test PRIVATE
     fmt::fmt-header-only
-    GTest::gtest GTest::gtest_main GTest::gmock GTest::gmock_main)
+    GTest::gtest GTest::gtest_main GTest::gmock GTest::gmock_main
+    ${LUA_LIBRARIES})
 
-target_include_directories(test PRIVATE "../common")
+target_include_directories(test PRIVATE
+    "../common"
+    ${LUA_INCLUDE_DIR})

test/CMakeLists.txt

@@ -0,0 +1,34 @@
+-- initial payload for testing
+p = {
+    url = "https://microsoft.com/other",
+    wt = "Slack",
+    pn = "slack.exe"
+}
+
+function work_slack()
+
+    -- extract domain part from p.url
+    domain = string.match(p.url, "https://(.-)/")
+    print("domain is " .. domain)
+
+    -- check if domain is microsoft.com and process name is slack.exe, then return true
+    if domain == "microsoft.com" and p.pn == "slack.exe" then
+        p.url = p.url .. "?authuser=3"
+        return true
+    end
+
+    return false
+end
+
+print("--- Before: ---")
+print("url: " .. p.url)
+print("wt:  " .. p.wt)
+print("pn:  " .. p.pn)
+
+matches = work_slack()
+print("matches: " .. tostring(matches))
+
+print("--- After: ---")
+print("url: " .. p.url)
+print("wt:  " .. p.wt)
+print("pn:  " .. p.pn)

test/playground.lua

@@ -0,0 +1,24 @@
+#include <gtest/gtest.h>
+#include "../bt/app/script_site.h"
+
+using namespace std;
+using namespace bt;
+
+TEST(Script, Loads) {
+    bt::script_site ss{R"()", false};
+    EXPECT_EQ(ss.get_error(), "");
+}
+
+TEST(Script, SimpleMatch) {
+    bt::script_site ss{R"(
+function test1()
+    return true;
+end
+)", false};
+
+    EXPECT_EQ(ss.get_error(), "");
+
+    url_payload up{"http://test.com"};
+    bool matches = ss.call_rule(up, "test1");
+    EXPECT_TRUE(matches);
+}

test/script_site.cpp

@@ -1,7 +1,7 @@
 {
     "default-registry": {
         "kind": "git",
-        "baseline": "1dc5ee30eb1032221d29f281f4a94b73f06b4284",
+        "baseline": "e590c2b30c08caf1dd8d612ec602a003f9784b7d",
         "repository": "https://github.com/microsoft/vcpkg"
     },
     "registries": [

vcpkg-configuration.json

@@ -30,6 +30,7 @@
         "simpleini",
         "p-ranav-csv2",
         "tinyxml2",
+        "lua",
         "gtest"
     ]
 }

vcpkg.json

@@ -18,6 +18,7 @@
     <toc-element topic="rules.md"/>
     <toc-element topic="picker.md"/>
     <toc-element topic="url-proc.md">
+        <toc-element topic="url-proc-scripting.md"/>
     </toc-element>
     <toc-element topic="commandline.md"/>
     <toc-element topic="Browser-Extensions.md">

wrs/bt.tree

@@ -0,0 +1,3 @@
+# Scripting
+
+Start typing here...

wrs/images/audit00.png

@@ -6,6 +6,27 @@ The functionality is available from the **Pipeline** menu.
 
 <img src="url-pipeline-menu.png" height="120" alt="URL Pipeline menu"/>
 
+To understand how URL processing works, let's see how %product% processes URLs:
+
+```mermaid
+stateDiagram-v2
+    direction LR
+    RP: Rule processor
+    B: Open browser
+    state Pipeline {
+        O365 --> Unshorten
+        Unshorten --> Substitute
+    }
+    [*] --> Pipeline
+    Pipeline --> RP
+    RP --> B
+    B --> [*]
+```
+
+Every time you click on a link, it first goes via a "Pipeline" that makes optional transformations on it. This includes unwrapping Office 365 links, un-shortening URLs, and applying substitutions, all described below.
+
+Rule processor then applies rules to the URL and opens the browser based on the rule.
+
 ## Un-shortening
 
 <warning>