feat: add volume keys for page turning, closes #471 (#982)

2026-04-28 19:42:21 +00:00 · 2025-04-28 18:36:24 +08:00 · 2025-04-28 18:36:24 +08:00 · 4275508ccd
commit 4275508ccd
parent a424ae8b15
45 changed files with 692 additions and 174 deletions
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/android/src/main/java/NativeBridgePlugin.kt
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/android/src/main/java/NativeBridgePlugin.kt
@ -6,6 +6,7 @@ import android.net.Uri
 import android.util.Log
 import android.os.Build
 import android.view.View
+import android.view.KeyEvent
 import android.view.WindowInsets
 import android.view.WindowManager
 import android.view.WindowInsetsController
@ -49,6 +50,17 @@ class SetSystemUIVisibilityRequestArgs {
  var darkMode: Boolean? = false
 }

+@InvokeArg
+class InterceptKeysRequestArgs {
+  var volumeKeys: Boolean? = null
+  var backKey: Boolean? = null
+}
+
+interface KeyDownInterceptor {
+    fun interceptVolumeKeys(enabled: Boolean)
+    fun interceptBackKey(enabled: Boolean)
+}
+
@TauriPlugin
 class NativeBridgePlugin(private val activity: Activity): Plugin(activity) {
    private val implementation = NativeBridge()
@ -289,4 +301,24 @@ class NativeBridgePlugin(private val activity: Activity): Plugin(activity) {
        }
        invoke.resolve(ret)
    }
+
+    @Command
+    fun intercept_keys(invoke: Invoke) {
+        val args = invoke.parseArgs(InterceptKeysRequestArgs::class.java)
+        if (activity is KeyDownInterceptor) {
+          when (args.backKey) {
+              true -> (activity as KeyDownInterceptor).interceptBackKey(true)
+              false -> (activity as KeyDownInterceptor).interceptBackKey(false)
+              else -> {}
+          }
+          when (args.volumeKeys) {
+              true -> (activity as KeyDownInterceptor).interceptVolumeKeys(true)
+              false -> (activity as KeyDownInterceptor).interceptVolumeKeys(false)
+              else -> {}
+          }
+        } else {
+            Log.e("NativeBridgePlugin", "Activity does not implement KeyDownInterceptor")
+        }
+        invoke.resolve()
+    }
 }
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/build.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/build.rs
@ -7,6 +7,7 @@ const COMMANDS: &[&str] = &[
    "set_system_ui_visibility",
    "get_status_bar_height",
    "get_sys_fonts_list",
+    "intercept_keys",
 ];

 fn main() {
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/ios/Sources/NativeBridgePlugin.swift
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/ios/Sources/NativeBridgePlugin.swift
@ -2,6 +2,7 @@ import AVFoundation
 import AuthenticationServices
 import CoreText
 import MediaPlayer
+import ObjectiveC
 import SwiftRs
 import Tauri
 import UIKit
@ -35,8 +36,140 @@ class SetSystemUIVisibilityRequestArgs: Decodable {
  let darkMode: Bool
 }

+class InterceptKeysRequestArgs: Decodable {
+  let backKey: Bool?
+  let volumeKeys: Bool?
+}
+
+class VolumeKeyHandler: NSObject {
+  private var audioSession: AVAudioSession?
+  private var originalVolume: Float = 0.0
+  private var volumeView: MPVolumeView?
+  private var isIntercepting = false
+  private var webView: WKWebView?
+  private var volumeSlider: UISlider?
+
+  func startInterception(webView: WKWebView) {
+    if isIntercepting {
+      return
+    }
+
+    self.webView = webView
+    isIntercepting = true
+
+    audioSession = AVAudioSession.sharedInstance()
+    do {
+      try audioSession?.setActive(true)
+    } catch {
+      print("Failed to activate audio session: \(error)")
+    }
+
+    originalVolume = audioSession?.outputVolume ?? 0.1
+
+    DispatchQueue.main.async { [weak self] in
+      self?.setupHiddenVolumeView()
+    }
+
+    audioSession?.addObserver(self, forKeyPath: "outputVolume", options: [.new], context: nil)
+  }
+
+  func stopInterception() {
+    if !isIntercepting {
+      return
+    }
+
+    isIntercepting = false
+    audioSession?.removeObserver(self, forKeyPath: "outputVolume")
+    DispatchQueue.main.async { [weak self] in
+      self?.setSystemVolume(self?.originalVolume ?? 0.1)
+      self?.volumeView?.removeFromSuperview()
+      self?.volumeView = nil
+      self?.volumeSlider = nil
+    }
+
+    do {
+      try audioSession?.setActive(false)
+    } catch {
+      print("Failed to deactivate audio session: \(error)")
+    }
+  }
+
+  private func setSystemVolume(_ volume: Float) {
+    DispatchQueue.main.async { [weak self] in
+      self?.volumeSlider?.value = volume
+    }
+  }
+
+  private func setupHiddenVolumeView() {
+    assert(Thread.isMainThread, "setupHiddenVolumeView must be called on main thread")
+
+    let frame = CGRect(x: -1000, y: -1000, width: 1, height: 1)
+    volumeView = MPVolumeView(frame: frame)
+    volumeSlider = volumeView?.subviews.first(where: { $0 is UISlider }) as? UISlider
+    if let window = UIApplication.shared.windows.first {
+      window.addSubview(volumeView!)
+    }
+    setSystemVolume(originalVolume)
+  }
+
+  override func observeValue(
+    forKeyPath keyPath: String?, of object: Any?, change: [NSKeyValueChangeKey: Any]?,
+    context: UnsafeMutableRawPointer?
+  ) {
+    if keyPath == "outputVolume", let audioSession = self.audioSession, isIntercepting {
+      let currentVolume = audioSession.outputVolume
+
+      if currentVolume > originalVolume {
+        DispatchQueue.main.async { [weak self] in
+          self?.webView?.evaluateJavaScript(
+            "window.onNativeKeyDown('VolumeUp');", completionHandler: nil)
+          self?.setSystemVolume(self?.originalVolume ?? 0.1)
+        }
+      } else if currentVolume < originalVolume {
+        DispatchQueue.main.async { [weak self] in
+          self?.webView?.evaluateJavaScript(
+            "window.onNativeKeyDown('VolumeDown');", completionHandler: nil)
+          self?.setSystemVolume(self?.originalVolume ?? 0.1)
+        }
+      }
+    }
+  }
+}
+
 class NativeBridgePlugin: Plugin {
  private var authSession: ASWebAuthenticationSession?
+  private var webView: WKWebView?
+
+  @objc public override func load(webview: WKWebView) {
+    self.webView = webview
+    print("NativeBridgePlugin loaded")
+  }
+
+  private struct AssociatedKeys {
+    static var volumeKeyHandler = "volumeKeyHandler"
+    static var interceptingVolumeKeys = "interceptingVolumeKeys"
+  }
+
+  private var volumeKeyHandler: VolumeKeyHandler? {
+    get {
+      return objc_getAssociatedObject(self, &AssociatedKeys.volumeKeyHandler) as? VolumeKeyHandler
+    }
+    set {
+      objc_setAssociatedObject(
+        self, &AssociatedKeys.volumeKeyHandler, newValue, .OBJC_ASSOCIATION_RETAIN)
+    }
+  }
+
+  private var interceptingVolumeKeys: Bool {
+    get {
+      return objc_getAssociatedObject(self, &AssociatedKeys.interceptingVolumeKeys) as? Bool
+        ?? false
+    }
+    set {
+      objc_setAssociatedObject(
+        self, &AssociatedKeys.interceptingVolumeKeys, newValue, .OBJC_ASSOCIATION_RETAIN)
+    }
+  }

  @objc public func use_background_audio(_ invoke: Invoke) {
    do {
@ -130,6 +263,38 @@ class NativeBridgePlugin: Plugin {

    invoke.resolve(["fonts": fontList])
  }
+
+  private func interceptVolumeKeys(_ intercept: Bool) {
+    interceptingVolumeKeys = intercept
+
+    if intercept {
+      if volumeKeyHandler == nil {
+        volumeKeyHandler = VolumeKeyHandler()
+      }
+
+      if let webView = self.webView {
+        volumeKeyHandler?.startInterception(webView: webView)
+      }
+    } else {
+      volumeKeyHandler?.stopInterception()
+    }
+  }
+
+  @objc public func intercept_keys(_ invoke: Invoke) {
+    do {
+      let args = try invoke.parseArgs(InterceptKeysRequestArgs.self)
+
+      if let volumeKeys = args.volumeKeys {
+        DispatchQueue.main.async { [weak self] in
+          self?.interceptVolumeKeys(volumeKeys)
+        }
+      }
+
+      invoke.resolve()
+    } catch {
+      invoke.reject(error.localizedDescription)
+    }
+  }
 }

@_cdecl("init_plugin_native_bridge")
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/autogenerated/commands/intercept_keys.toml
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/autogenerated/commands/intercept_keys.toml
@ -0,0 +1,13 @@
+# Automatically generated - DO NOT EDIT!
+
+"$schema" = "../../schemas/schema.json"
+
+[[permission]]
+identifier = "allow-intercept-keys"
+description = "Enables the intercept_keys command without any pre-configured scope."
+commands.allow = ["intercept_keys"]
+
+[[permission]]
+identifier = "deny-intercept-keys"
+description = "Denies the intercept_keys command without any pre-configured scope."
+commands.deny = ["intercept_keys"]
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/autogenerated/reference.md
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/autogenerated/reference.md
@ -12,6 +12,7 @@ Default permissions for the plugin
 - `allow-set-system-ui-visibility`
 - `allow-get-status-bar-height`
 - `allow-get-sys-fonts-list`
+- `allow-intercept-keys`

 ## Permission Table

@ -181,6 +182,32 @@ Denies the install_package command without any pre-configured scope.
 <tr>
 <td>

+`native-bridge:allow-intercept-keys`
+
+</td>
+<td>
+
+Enables the intercept_keys command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
+`native-bridge:deny-intercept-keys`
+
+</td>
+<td>
+
+Denies the intercept_keys command without any pre-configured scope.
+
+</td>
+</tr>
+
+<tr>
+<td>
+
 `native-bridge:allow-set-system-ui-visibility`

 </td>
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/default.toml
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/default.toml
@ -9,4 +9,5 @@ permissions = [
  "allow-set-system-ui-visibility",
  "allow-get-status-bar-height",
  "allow-get-sys-fonts-list",
+  "allow-intercept-keys",
 ]
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/schemas/schema.json
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/permissions/schemas/schema.json
@ -366,6 +366,18 @@
          "const": "deny-install-package",
          "markdownDescription": "Denies the install_package command without any pre-configured scope."
        },
+        {
+          "description": "Enables the intercept_keys command without any pre-configured scope.",
+          "type": "string",
+          "const": "allow-intercept-keys",
+          "markdownDescription": "Enables the intercept_keys command without any pre-configured scope."
+        },
+        {
+          "description": "Denies the intercept_keys command without any pre-configured scope.",
+          "type": "string",
+          "const": "deny-intercept-keys",
+          "markdownDescription": "Denies the intercept_keys command without any pre-configured scope."
+        },
        {
          "description": "Enables the set_system_ui_visibility command without any pre-configured scope.",
          "type": "string",
@ -391,10 +403,10 @@
          "markdownDescription": "Denies the use_background_audio command without any pre-configured scope."
        },
        {
-          "description": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-auth-with-safari`\n- `allow-auth-with-custom-tab`\n- `allow-copy-uri-to-path`\n- `allow-use-background-audio`\n- `allow-install-package`\n- `allow-set-system-ui-visibility`\n- `allow-get-status-bar-height`\n- `allow-get-sys-fonts-list`",
+          "description": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-auth-with-safari`\n- `allow-auth-with-custom-tab`\n- `allow-copy-uri-to-path`\n- `allow-use-background-audio`\n- `allow-install-package`\n- `allow-set-system-ui-visibility`\n- `allow-get-status-bar-height`\n- `allow-get-sys-fonts-list`\n- `allow-intercept-keys`",
          "type": "string",
          "const": "default",
-          "markdownDescription": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-auth-with-safari`\n- `allow-auth-with-custom-tab`\n- `allow-copy-uri-to-path`\n- `allow-use-background-audio`\n- `allow-install-package`\n- `allow-set-system-ui-visibility`\n- `allow-get-status-bar-height`\n- `allow-get-sys-fonts-list`"
+          "markdownDescription": "Default permissions for the plugin\n#### This default permission set includes:\n\n- `allow-auth-with-safari`\n- `allow-auth-with-custom-tab`\n- `allow-copy-uri-to-path`\n- `allow-use-background-audio`\n- `allow-install-package`\n- `allow-set-system-ui-visibility`\n- `allow-get-status-bar-height`\n- `allow-get-sys-fonts-list`\n- `allow-intercept-keys`"
        }
      ]
    }
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/commands.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/commands.rs
@ -65,3 +65,11 @@ pub(crate) async fn get_sys_fonts_list<R: Runtime>(
 ) -> Result<GetSysFontsListResponse> {
    app.native_bridge().get_sys_fonts_list()
 }
+
+#[command]
+pub(crate) async fn intercept_keys<R: Runtime>(
+    app: AppHandle<R>,
+    payload: InterceptKeysRequest,
+) -> Result<()> {
+    app.native_bridge().intercept_keys(payload)
+}
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/desktop.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/desktop.rs
@ -56,4 +56,8 @@ impl<R: Runtime> NativeBridge<R> {
        }
        Ok(GetSysFontsListResponse { fonts, error: None })
    }
+
+    pub fn intercept_keys(&self, _payload: InterceptKeysRequest) -> crate::Result<()> {
+        Err(crate::Error::UnsupportedPlatformError)
+    }
 }
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/lib.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/lib.rs
@ -45,6 +45,7 @@ pub fn init<R: Runtime>() -> TauriPlugin<R> {
            commands::set_system_ui_visibility,
            commands::get_status_bar_height,
            commands::get_sys_fonts_list,
+            commands::intercept_keys,
        ])
        .setup(|app, api| {
            #[cfg(mobile)]
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/mobile.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/mobile.rs
@ -93,3 +93,11 @@ impl<R: Runtime> NativeBridge<R> {
            .map_err(Into::into)
    }
 }
+
+impl<R: Runtime> NativeBridge<R> {
+    pub fn intercept_keys(&self, payload: InterceptKeysRequest) -> crate::Result<()> {
+        self.0
+            .run_mobile_plugin("intercept_keys", payload)
+            .map_err(Into::into)
+    }
+}
--- a/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/models.rs
+++ b/apps/readest-app/src-tauri/plugins/tauri-plugin-native-bridge/src/models.rs
@ -72,3 +72,10 @@ pub struct GetSysFontsListResponse {
    pub fonts: Vec<String>,
    pub error: Option<String>,
 }
+
+#[derive(Debug, Deserialize, Serialize)]
+#[serde(rename_all = "camelCase")]
+pub struct InterceptKeysRequest {
+    pub volume_keys: Option<bool>,
+    pub back_key: Option<bool>,
+}