feat: tray menu deploy and sync

Author: amorphobia

.github/workflows/ci.yaml

@@ -36,7 +36,7 @@ jobs:
           cp Lib/librime-ahk/rime_api.ahk Lib/librime-ahk/LICENSE temp/Lib/librime-ahk/
           cp Lib/*.ahk temp/Lib/
           cp -r SharedSupport temp/
-          cp dist/lib/rime.dll Rabbit.ahk Rabbit.exe Rabbit.ico LICENSE temp/
+          cp dist/lib/rime.dll Rabbit.ahk Rabbit.exe Rabbit.ico RabbitDeployer.ahk LICENSE temp/
           cd temp && zip -r -q ../rabbit.zip *
 
       - name: Upload Artifacts

Lib/RabbitCommon.ahk

@@ -22,6 +22,31 @@ global rime := RimeApi()
 global RABBIT_IME_NAME := "玉兔毫"
 global RABBIT_CODE_NAME := "Rabbit"
 global RABBIT_VERSION := "0.1.0"
+global RABBIT_NO_MAINTENANCE := "0"
+global RABBIT_PARTIAL_MAINTENANCE := "1"
+global RABBIT_FULL_MAINTENANCE := "2"
+
+global ERROR_ALREADY_EXISTS := 183
+
+class RabbitMutex {
+    handle := 0
+    errmsg := ""
+    Create() {
+        this.errmsg := ""
+        this.handle := DllCall("CreateMutex", "Ptr", 0, "Int", true, "Str", "RabbitDeployerMutex")
+        if DllCall("GetLastError") == ERROR_ALREADY_EXISTS {
+            this.Close()
+            this.errmsg := "mutex already exists"
+        }
+        return this.handle
+    }
+    Close() {
+        if this.handle {
+            DllCall("CloseHandle", "Ptr", this.handle)
+            this.handle := 0
+        }
+    }
+}
 
 CreateTraits() {
     traits := RimeTraits()

Lib/RabbitTrayMenu.ahk

@@ -16,20 +16,38 @@
  *
  */
 
+global TRAY_MENU_GRAYOUT
+
 TraySetIcon("Rabbit.ico") ; https://www.freepik.com/icon/rabbit_4905239
 A_TrayMenu.Delete()
 ; A_TrayMenu.add("输入法设定")
 ; A_TrayMenu.add("用户词典管理")
-A_TrayMenu.add("用户资料同步", (*) => false)
+A_TrayMenu.add("用户资料同步", (*) => Sync())
 A_TrayMenu.add()
 A_TrayMenu.add("用户文件夹", (*) => Run(A_ScriptDir . "\Rime"))
 A_TrayMenu.add("脚本文件夹", (*) => Run(A_ScriptDir))
 A_TrayMenu.add()
 A_TrayMenu.add("仓库主页", (*) => Run("https://github.com/amorphobia/rabbit"))
 A_TrayMenu.add()
-A_TrayMenu.add("重新部署", (*) => Reload())
+A_TrayMenu.add("重新部署", (*) => Deploy())
 A_TrayMenu.add("退出玉兔毫", (*) => ExitApp())
 
-; A_TrayMenu.Disable("输入法设定")
-; A_TrayMenu.Disable("用户词典管理")
-A_TrayMenu.Disable("用户资料同步")
+Sync() {
+    Run(A_AhkPath . " " . A_ScriptDir . "\RabbitDeployer.ahk sync 1")
+    ExitApp()
+}
+Deploy() {
+    Run(A_AhkPath . " " . A_ScriptDir . "\RabbitDeployer.ahk deploy 1")
+    ExitApp()
+}
+
+if TRAY_MENU_GRAYOUT {
+    ; A_TrayMenu.Disable("输入法设定")
+    ; A_TrayMenu.Disable("用户词典管理")
+    A_TrayMenu.Disable("用户资料同步")
+    A_TrayMenu.Disable("用户文件夹")
+    A_TrayMenu.Disable("脚本文件夹")
+    A_TrayMenu.Disable("仓库主页")
+    A_TrayMenu.Disable("重新部署")
+    A_TrayMenu.Disable("退出玉兔毫")
+}

Lib/librime-ahk

@@ -18,6 +18,8 @@
 #Requires AutoHotkey v2.0 32-bit
 #SingleInstance Ignore
 
+global TRAY_MENU_GRAYOUT := false
+
 #Include <RabbitCommon>
 #Include <RabbitKeyTable>
 #Include <RabbitCandidateBox>
@@ -27,21 +29,43 @@
 
 global session_id := 0
 global box := Gui()
+global mutex := RabbitMutex()
+
+global STATUS_TOOLTIP := 2
 
 RegisterHotKeys()
-RabbitMain()
+RabbitMain(A_Args)
 
-RabbitMain() {
+RabbitMain(args) {
     local layout := DllCall("GetKeyboardLayout", "UInt", 0)
     SetDefaultKeyboard()
 
+    fail_count := 0
+    while not mutex.Create() {
+        fail_count++
+        if fail_count > 500 {
+            TrayTip()
+            TrayTip("有其他进程正在使用 RIME，启动失败")
+            Sleep(2000)
+            ExitApp()
+        }
+    }
+
     rabbit_traits := CreateTraits()
     global rime
     rime.setup(rabbit_traits)
     rime.set_notification_handler(OnMessage, 0)
     rime.initialize(rabbit_traits)
-    if rime.start_maintenace(true)
-        rime.join_maintenance_thread()
+
+    local m := (args.Length == 0) ? RABBIT_PARTIAL_MAINTENANCE : args[1]
+    if m != RABBIT_NO_MAINTENANCE {
+        if rime.start_maintenance(m == RABBIT_FULL_MAINTENANCE)
+            rime.join_maintenance_thread()
+    } else {
+        TrayTip()
+        TrayTip("维护完成", RABBIT_IME_NAME)
+        SetTimer(TrayTip, -2000)
+    }
 
     global session_id := rime.create_session()
     if not session_id {
@@ -75,10 +99,15 @@ SetDefaultKeyboard(locale_id := 0x0409) {
 
 ExitRabbit(layout, reason, code) {
     SetDefaultKeyboard(layout)
+    TrayTip()
+    ToolTip()
+    ToolTip(, , , STATUS_TOOLTIP)
     if session_id {
         rime.destroy_session(session_id)
         rime.finalize()
     }
+    if mutex
+        mutex.Close()
 }
 
 RegisterHotKeys() {
@@ -169,7 +198,6 @@ ProcessKey(key, mask, this_hotkey) {
     if not code
         return
 
-    static STATUS_TOOLTIP := 2
     if status := rime.get_status(session_id) {
         local old_ascii_mode := status.is_ascii_mode
         local old_full_shape := status.is_full_shape

Rabbit.ahk

@@ -16,33 +16,55 @@
  *
  */
 #Requires AutoHotkey v2.0 32-bit
-; #NoTrayIcon
+
+global TRAY_MENU_GRAYOUT := true
 
 #Include <RabbitCommon>
+#Include <RabbitTrayMenu>
 #Include <librime-ahk\rime_levers_api>
 
 global rime
 global ERROR_ALREADY_EXISTS := 183
 global INVALID_FILE_ATTRIBUTES := -1
 global FILE_ATTRIBUTE_DIRECTORY := 0x00000010
 
-arg := A_Args.Length > 0 ? A_Args[1] : ""
-RunDeployer(arg)
+OnExit(ExitRabbitDeployer)
+
+RunDeployer(A_Args)
+
+RunDeployer(args) {
+    TrayTip()
+    TrayTip("维护中", RABBIT_IME_NAME)
 
-RunDeployer(command) {
+    command := args.Length > 0 ? args[1] : ""
     conf := Configurator()
     conf.Initialize()
-    deployment_scheduled := command == "deploy"
-    if deployment_scheduled
-        return conf.UpdateWorkspace()
-    dict_management := command == "dict"
-    if dict_management
-        return 0 ; return conf.DictManagement()
-    sync_user_dict := command == "sync"
-    if sync_user_dict
-        return conf.SyncUserData()
-    installing := command == "install"
-    return conf.Run(installing)
+    switch command {
+        case "deploy":
+            res := conf.UpdateWorkspace()
+            opt := RABBIT_NO_MAINTENANCE
+        case "dict":
+            res := 0 ; conf.DictManagement()
+            opt := RABBIT_PARTIAL_MAINTENANCE
+        case "sync":
+            res := conf.SyncUserData()
+            opt := RABBIT_PARTIAL_MAINTENANCE
+        default:
+            res := conf.Run(command = "install")
+            opt := RABBIT_PARTIAL_MAINTENANCE ; TODO: check if need maintenance
+    }
+
+    if args.Length > 1 {
+        sp := " "
+        target := A_AhkPath . sp . A_ScriptDir . "\Rabbit.ahk"
+        Run(target . sp . opt . sp . String(res))
+        ExitApp()
+    }
+    return res
+}
+
+ExitRabbitDeployer(reason, code) {
+    TrayTip()
 }
 
 CreateFileIfNotExist(filename) {
@@ -87,12 +109,9 @@ class Configurator extends Class {
     }
 
     UpdateWorkspace(report_errors := false) {
-        hMutex := DllCall("CreateMutex", "Ptr", 0, "Int", true, "Str", "RabbitDeployerMutex")
-        if not hMutex {
-            return 1
-        }
-        if DllCall("GetLastError") == ERROR_ALREADY_EXISTS {
-            DllCall("CloseHandle", "Ptr", hMutex)
+        mutex := RabbitMutex()
+        if not mutex.Create() {
+            ; TODO: log error
             return 1
         }
 
@@ -101,32 +120,29 @@ class Configurator extends Class {
             ; rime.deploy_config_file("rabbit.yaml", "config_version")
         }
 
-        DllCall("CloseHandle", "Ptr", hMutex)
+        mutex.Close()
 
         return 0
     }
 
     ; DictManagement()
 
     SyncUserData() {
-        hMutex := DllCall("CreateMutex", "Ptr", 0, "Int", true, "Str", "RabbitDeployerMutex")
-        if not hMutex {
-            return 1
-        }
-        if DllCall("GetLastError") == ERROR_ALREADY_EXISTS {
-            DllCall("CloseHandle", "Ptr", hMutex)
+        mutex := RabbitMutex()
+        if not mutex.Create() {
+            ; TODO: log error
             return 1
         }
 
         {
             if not rime.sync_user_data() {
-                DllCall("CloseHandle", "Ptr", hMutex)
+                mutex.Close()
                 return 1
             }
             rime.join_maintenance_thread()
         }
 
-        DllCall("CloseHandle", "Ptr", hMutex)
+        mutex.Close()
 
         return 0
     }