Implement native hud notifications on Linux, enable by default

Author: Exidex

Cargo.lock

@@ -6,3 +6,6 @@
 #main_window_surface = "xdg_shell"
 global_shortcuts_api = "legacy_x11_api"
 #global_shortcuts_api = "none"
+
+[linux]
+native_hud = true

dev_data/config/config.toml

@@ -44,6 +44,7 @@ url = "2.5"
 ureq = "2.10"
 dark-light = "1.1.1"
 schemars = "0.8"
+ashpd = "0.11"
 
 [features]
 release = ["gauntlet-common/release", "gauntlet-plugin-runtime/release"]

rust/server/Cargo.toml

@@ -1,6 +1,8 @@
 use std::collections::HashMap;
 use std::fs::File;
 use std::sync::Arc;
+use std::time::Duration;
+use std::vec;
 
 use anyhow::Context;
 use anyhow::anyhow;
@@ -50,6 +52,7 @@ use serde::Serialize;
 use tokio::sync::Mutex;
 
 use crate::model::IntermediateUiEvent;
+use crate::plugins::Settings;
 use crate::plugins::binary_data_gatherer::BinaryDataGatherer;
 use crate::plugins::clipboard::Clipboard;
 use crate::plugins::data_db_repository::DataDbRepository;
@@ -78,6 +81,7 @@ pub struct PluginRuntimeData {
     pub db_repository: DataDbRepository,
     pub search_index: SearchIndex,
     pub icon_cache: IconCache,
+    pub settings: Settings,
     pub frontend_api: FrontendApiProxy,
     pub dirs: Dirs,
     pub clipboard: Clipboard,
@@ -159,6 +163,7 @@ pub async fn start_plugin_runtime(data: PluginRuntimeData, run_status_guard: Run
         data.search_index,
         data.clipboard,
         data.frontend_api,
+        data.settings,
         data.uuid.clone(),
         data.id.clone(),
         data.name,
@@ -601,6 +606,7 @@ pub struct BackendForPluginRuntimeApiImpl {
     search_index: SearchIndex,
     clipboard: Clipboard,
     frontend_api: FrontendApiProxy,
+    settings: Settings,
     #[allow(unused)]
     plugin_uuid: String,
     plugin_id: PluginId,
@@ -614,6 +620,7 @@ impl BackendForPluginRuntimeApiImpl {
         search_index: SearchIndex,
         clipboard: Clipboard,
         frontend_api: FrontendApiProxy,
+        settings: Settings,
         plugin_uuid: String,
         plugin_id: PluginId,
         plugin_name: String,
@@ -624,6 +631,7 @@ impl BackendForPluginRuntimeApiImpl {
             search_index,
             clipboard,
             frontend_api,
+            settings,
             plugin_uuid,
             plugin_id,
             plugin_name,
@@ -961,7 +969,16 @@ impl BackendForPluginRuntimeApi for BackendForPluginRuntimeApiImpl {
     }
 
     async fn ui_show_hud(&self, display: String) -> RequestResult<()> {
-        self.frontend_api.show_hud(display).await?;
+        if cfg!(target_os = "linux") {
+            if self.settings.config().linux_native_hud {
+                #[cfg(target_os = "linux")]
+                show_linux_native_hud(display).await?;
+            } else {
+                self.frontend_api.show_hud(display).await?;
+            }
+        } else {
+            self.frontend_api.show_hud(display).await?;
+        }
 
         Ok(())
     }
@@ -1201,3 +1218,27 @@ fn any_preferences_missing_value(
 
     false
 }
+
+#[cfg(target_os = "linux")]
+async fn show_linux_native_hud(display: String) -> anyhow::Result<()> {
+    use ashpd::desktop::notification::DisplayHint;
+    use ashpd::desktop::notification::Notification;
+    use ashpd::desktop::notification::NotificationProxy;
+    use ashpd::desktop::notification::Priority;
+
+    let proxy = NotificationProxy::new().await?;
+
+    let notification_id = "sh.gauntlet.Hud";
+    let notification = Notification::new(&display)
+        .priority(Priority::Urgent)
+        .display_hint(vec![DisplayHint::Transient, DisplayHint::ShowAsNew]);
+
+    proxy.add_notification(notification_id, notification).await?;
+
+    tokio::spawn(async move {
+        tokio::time::sleep(Duration::from_secs(2)).await;
+        let _ = proxy.remove_notification(notification_id).await;
+    });
+
+    Ok(())
+}

rust/server/src/plugins/js.rs

@@ -919,6 +919,7 @@ impl ApplicationManager {
             search_index: self.search_index.clone(),
             icon_cache: self.icon_cache.clone(),
             frontend_api: self.frontend_api.clone(),
+            settings: self.settings.clone(),
             dirs: self.dirs.clone(),
             clipboard: self.clipboard.clone(),
         };

rust/server/src/plugins/mod.rs

@@ -5,6 +5,7 @@ use serde::Deserialize;
 pub struct ApplicationConfig {
     pub main_window: Option<ApplicationWindowConfig>,
     pub wayland: Option<WaylandConfig>,
+    pub linux: Option<LinuxConfig>,
 }
 
 #[derive(Deserialize, Debug, Default)]
@@ -18,6 +19,11 @@ pub struct WaylandConfig {
     pub global_shortcuts_api: Option<WaylandGlobalShortcutConfig>,
 }
 
+#[derive(Deserialize, Debug, Default)]
+pub struct LinuxConfig {
+    pub native_hud: Option<bool>,
+}
+
 #[derive(Deserialize, Debug)]
 pub enum WaylandMainWindowConfig {
     #[serde(rename = "prefer_wlr_layer_shell")] // default
@@ -40,4 +46,5 @@ pub struct EffectiveConfig {
     pub close_on_unfocus: bool,
     pub layer_shell: bool,
     pub wayland_use_legacy_x11_api: bool,
+    pub linux_native_hud: bool,
 }

rust/server/src/plugins/settings/config.rs

@@ -298,8 +298,10 @@ impl Settings {
 fn effective_config(config: ApplicationConfig, layer_shell_supported: bool) -> EffectiveConfig {
     let window_config = config.main_window.unwrap_or_default();
     let wayland_config = config.wayland.unwrap_or_default();
+    let linux_config = config.linux.unwrap_or_default();
 
     let close_on_unfocus = window_config.close_on_unfocus.unwrap_or(true);
+    let linux_native_hud = linux_config.native_hud.unwrap_or(true);
 
     let main_window_surface = wayland_config
         .main_window_surface
@@ -324,5 +326,6 @@ fn effective_config(config: ApplicationConfig, layer_shell_supported: bool) -> E
         close_on_unfocus,
         layer_shell,
         wayland_use_legacy_x11_api,
+        linux_native_hud,
     }
 }