initial plugin system

src/config/config.swift

@@ -103,6 +103,9 @@ private func jsonToOption(_ json: JSON, _ type: String) throws -> any Option {
     if let appIM = json["AppIM"].string, appIM == "True" {
       return try ListOption<AppIMOption>.decode(json: json)
     }
+    if let plugin = json["Plugin"].string, plugin == "True" {
+      return try ListOption<PluginOption>.decode(json: json)
+    }
     return try ListOption<StringOption>.decode(json: json)
   } else if type == "List|Key" {
     return try ListOption<KeyOption>.decode(json: json)

src/config/optionmodels.swift

@@ -333,6 +333,8 @@ class UserThemeOption: StringOption {}
 
 class CssOption: StringOption {}
 
+class PluginOption: StringOption {}
+
 private func bundleIdentifier(_ appPath: String) -> String {
   guard let bundle = Bundle(path: appPath) else {
     return ""

src/config/optionviews.swift

@@ -207,6 +207,9 @@ struct ExternalOptionView: OptionView {
       case "UserDataDir":
         mkdirP(rimeLocalDir.localPath())
         NSWorkspace.shared.open(rimeLocalDir)
+      case "PluginDir":
+        mkdirP(pluginDir.localPath())
+        NSWorkspace.shared.open(pluginDir)
       case "CustomPhrase":
         showCustomPhrase = true
       case "DictManager":
@@ -547,6 +550,8 @@ func buildViewImpl(label: String, option: any Option) -> any OptionView {
     return CssOptionView(label: label, model: option)
   } else if let option = option as? AppIMOption {
     return AppIMOptionView(label: label, model: option)
+  } else if let option = option as? PluginOption {
+    return PluginOptionView(label: label, model: option)
   } else if let option = option as? KeyOption {
     return KeyOptionView(label: label, model: option)
   } else if let option = option as? StringOption {
@@ -565,6 +570,8 @@ func buildViewImpl(label: String, option: any Option) -> any OptionView {
     return ListOptionView<FontOption>(label: label, model: option)
   } else if let option = option as? ListOption<AppIMOption> {
     return ListOptionView<AppIMOption>(label: label, model: option)
+  } else if let option = option as? ListOption<PluginOption> {
+    return ListOptionView<PluginOption>(label: label, model: option)
   } else if let option = option as? ListOption<KeyOption> {
     return ListOptionView<KeyOption>(label: label, model: option)
   } else if let option = option as? ListOption<StringOption> {

src/config/pluginoptionview.swift

@@ -0,0 +1,34 @@
+import Logging
+import SwiftUI
+
+struct PluginOptionView: OptionView {
+  let label: String
+  let overrideLabel: String? = nil
+  @ObservedObject var model: PluginOption
+  @State private var availablePlugins = [String]()
+
+  var body: some View {
+    Picker("", selection: $model.value) {
+      ForEach(availablePlugins, id: \.self) { plugin in
+        Text(plugin)
+      }
+    }.onAppear {
+      for fileName in getFileNamesWithExtension(pluginDir.localPath()) {
+        let url = pluginDir.appendingPathComponent(fileName)
+        if !url.isDirectory {
+          continue
+        }
+        let packageJsonURL = url.appendingPathComponent("package.json")
+        if let json = readJSON(packageJsonURL) {
+          if json["license"].stringValue.hasPrefix("GPL-3.0") {
+            availablePlugins.append(fileName)
+          } else {
+            FCITX_WARN("Rejecting plugin \(fileName) which is not GPLv3")
+          }
+        } else {
+          FCITX_WARN("Invalid package.json for plugin \(fileName)")
+        }
+      }
+    }
+  }
+}

src/config/util.swift

@@ -8,6 +8,7 @@ let cacheDir = libraryDir.appendingPathComponent("cache")
 let configDir = homeDir.appendingPathComponent(".config/fcitx5")
 let localDir = homeDir.appendingPathComponent(".local/share/fcitx5")
 let wwwDir = localDir.appendingPathComponent("www")
+let pluginDir = wwwDir.appendingPathComponent("plugin")
 let imLocalDir = localDir.appendingPathComponent("inputmethod")
 let pinyinLocalDir = localDir.appendingPathComponent("pinyin")
 let tableLocalDir = localDir.appendingPathComponent("table")

webpanel/webpanel.cpp

@@ -231,9 +231,13 @@ void WebPanel::updateConfig() {
     window_->set_style(style.c_str());
     if (auto web = dynamic_cast<candidate_window::WebviewCandidateWindow *>(
             window_.get())) {
+        web->unload_plugins();
         using namespace candidate_window;
         uint64_t apis = (config_.advanced->unsafeAPI->curl.value() ? kCurl : 0);
         web->set_api(apis);
+        if (*config_.advanced->pluginNotice) {
+            web->load_plugins({*config_.advanced->plugins});
+        }
     }
 }
 

webpanel/webpanel.h

@@ -63,6 +63,14 @@ struct CssAnnotation {
     }
 };
 
+struct PluginAnnotation {
+    bool skipDescription() { return false; }
+    bool skipSave() { return false; }
+    void dumpDescription(RawConfig &config) {
+        config.setValueByPath("Plugin", "True");
+    }
+};
+
 FCITX_CONFIGURATION(
     BasicConfig,
     Option<bool> followCursor{this, "FollowCursor", _("Follow cursor"), false};
@@ -287,6 +295,12 @@ FCITX_CONFIGURATION(
     OptionWithAnnotation<std::string, CssAnnotation> userCss{
         this, "UserCss", _("User CSS"), {}};
     Option<KeyList> copyHtml{this, "CopyHtml", _("Copy HTML"), {}};
+    ExternalOption pluginDir{this, "PluginDir", _("Plugin dir"), ""};
+    Option<bool> pluginNotice{this, "PluginNotice",
+                              _("I know there may be risks for using plugins"),
+                              false};
+    OptionWithAnnotation<std::vector<std::string>, PluginAnnotation> plugins{
+        this, "Plugins", _("Plugins"), {}};
     Option<UnsafeAPI> unsafeAPI{this, "UnsafeAPI",
                                 _("Dangerous API for JavaScript plugins")};);