Merge pull request #168 from devmobasa/fix/gnome-logout-portal-race

Fix GNOME portal shortcut shutdown handling

Author: devmobasa

configurator/Cargo.toml

@@ -4,7 +4,8 @@ version = "0.9.13"
 edition = "2024"
 
 [dependencies]
-wayscriber = { path = "..", default-features = false }
+# Keep configurator-side runtime/status logic aligned with the daemon's portal-capable builds.
+wayscriber = { path = "..", default-features = false, features = ["portal"] }
 iced = { version = "0.12", features = ["tokio", "canvas"] }
 
 [features]

configurator/src/app/daemon_setup/mod.rs

@@ -9,9 +9,10 @@ use crate::models::{
 use command::command_available;
 use service::{
     SERVICE_NAME, detect_service_unit_path, install_or_update_user_service, query_service_active,
-    query_service_enabled, require_systemctl_available, run_systemctl_user,
+    query_service_enabled, remove_portal_shortcut_dropin_if_gnome, require_systemctl_available,
+    run_systemctl_user,
 };
-use shortcut::{apply_shortcut, read_configured_shortcut};
+use shortcut::{apply_shortcut, read_configured_shortcut, read_portal_shortcut_dropin_state};
 
 pub(super) async fn load_daemon_runtime_status() -> Result<DaemonRuntimeStatus, String> {
     load_daemon_runtime_status_sync()
@@ -33,10 +34,23 @@ fn perform_daemon_action_sync(
     match action {
         DaemonAction::RefreshStatus => Ok("Daemon status refreshed.".to_string()),
         DaemonAction::InstallOrUpdateService => {
+            let desktop = DesktopEnvironment::detect_current();
             let service_path = install_or_update_user_service()?;
+            let removed_dropin = remove_portal_shortcut_dropin_if_gnome(desktop)?;
+            if command_available("systemctl") && removed_dropin {
+                run_systemctl_user(&["daemon-reload"])?;
+                if query_service_active() {
+                    run_systemctl_user(&["restart", SERVICE_NAME])?;
+                }
+            }
             Ok(format!(
-                "Installed/updated user service at {}",
-                service_path.display()
+                "Installed/updated user service at {}{}",
+                service_path.display(),
+                if removed_dropin {
+                    "; removed stale GNOME portal shortcut drop-in"
+                } else {
+                    ""
+                }
             ))
         }
         DaemonAction::EnableAndStartService => {
@@ -64,7 +78,12 @@ fn load_daemon_runtime_status_sync() -> Result<DaemonRuntimeStatus, String> {
     let systemctl_available = command_available("systemctl");
     let gsettings_available = command_available("gsettings");
     let shortcut_backend =
-        ShortcutBackend::from_environment(desktop, gsettings_available, systemctl_available);
+        ShortcutBackend::from_runtime_inputs(desktop, read_portal_shortcut_dropin_state());
+    let shortcut_apply_capability = crate::models::ShortcutApplyCapability::from_environment(
+        desktop,
+        gsettings_available,
+        systemctl_available,
+    );
     let service_unit_path = detect_service_unit_path(systemctl_available);
     let service_installed = service_unit_path.is_some();
     let service_enabled = if systemctl_available {
@@ -82,6 +101,7 @@ fn load_daemon_runtime_status_sync() -> Result<DaemonRuntimeStatus, String> {
     Ok(DaemonRuntimeStatus {
         desktop,
         shortcut_backend,
+        shortcut_apply_capability,
         systemctl_available,
         gsettings_available,
         service_installed,

configurator/src/app/daemon_setup/service.rs

@@ -2,6 +2,7 @@ use std::env;
 use std::fs;
 use std::path::{Path, PathBuf};
 
+use crate::models::DesktopEnvironment;
 use wayscriber::systemd_user_service::{
     USER_SERVICE_NAME, escape_systemd_env_value as shared_escape_systemd_env_value,
     portal_shortcut_dropin_path as shared_portal_shortcut_dropin_path, render_user_service_unit,
@@ -121,6 +122,32 @@ pub(super) fn install_or_update_user_service() -> Result<PathBuf, String> {
     Ok(service_path)
 }
 
+pub(super) fn remove_portal_shortcut_dropin_if_gnome(
+    desktop: DesktopEnvironment,
+) -> Result<bool, String> {
+    if desktop != DesktopEnvironment::Gnome {
+        return Ok(false);
+    }
+    remove_portal_shortcut_dropin()
+}
+
+pub(super) fn remove_portal_shortcut_dropin() -> Result<bool, String> {
+    let Some(path) = portal_shortcut_dropin_path() else {
+        return Ok(false);
+    };
+    if !path.exists() {
+        return Ok(false);
+    }
+    fs::remove_file(&path).map_err(|err| {
+        format!(
+            "Failed to remove portal shortcut drop-in {}: {}",
+            path.display(),
+            err
+        )
+    })?;
+    Ok(true)
+}
+
 fn package_service_paths() -> Vec<PathBuf> {
     vec![
         PathBuf::from("/usr/lib/systemd/user").join(SERVICE_NAME),

configurator/src/app/daemon_setup/shortcut.rs

@@ -1,16 +1,18 @@
 use std::fs;
 
-use crate::models::{DesktopEnvironment, ShortcutBackend};
+use crate::models::{DesktopEnvironment, ShortcutApplyCapability, ShortcutBackend};
 use wayscriber::shortcut_hint::{
     GNOME_MEDIA_KEYS_KEY, GNOME_MEDIA_KEYS_SCHEMA, GNOME_WAYSCRIBER_KEYBINDING_PATH,
-    gnome_effective_shortcut, gnome_shortcut_schema_with_path, normalize_shortcut_hint,
-    parse_gsettings_path_list,
+    PORTAL_APP_ID_ENV, PORTAL_SHORTCUT_ENV, PORTAL_SHORTCUT_OPT_IN_ENV, PortalShortcutDropInState,
+    gnome_effective_shortcut, gnome_shortcut_schema_with_path, parse_gsettings_path_list,
+    parse_portal_shortcut_dropin_state,
+    parse_portal_shortcut_from_dropin as shared_parse_portal_shortcut_from_dropin,
 };
 
 use super::command::{command_available, run_command, run_command_checked};
 use super::service::{
     escape_systemd_env_value, portal_shortcut_dropin_path, query_service_active,
-    require_systemctl_available, run_systemctl_user,
+    remove_portal_shortcut_dropin_if_gnome, require_systemctl_available, run_systemctl_user,
 };
 
 const PORTAL_APP_ID: &str = "wayscriber";
@@ -25,21 +27,38 @@ pub(super) fn read_configured_shortcut(backend: ShortcutBackend) -> Option<Strin
     }
 }
 
+pub(super) fn read_portal_shortcut_dropin_state() -> PortalShortcutDropInState {
+    let Some(path) = portal_shortcut_dropin_path() else {
+        return PortalShortcutDropInState::default();
+    };
+    let Ok(content) = fs::read_to_string(path) else {
+        return PortalShortcutDropInState::default();
+    };
+    parse_portal_shortcut_dropin_state(&content)
+}
+
 pub(super) fn apply_shortcut(shortcut_input: &str) -> Result<String, String> {
     let desktop = DesktopEnvironment::detect_current();
-    let backend = ShortcutBackend::from_environment(
+    let apply_capability = ShortcutApplyCapability::from_environment(
         desktop,
         command_available("gsettings"),
         command_available("systemctl"),
     );
 
-    match backend {
-        ShortcutBackend::GnomeCustomShortcut => {
+    match apply_capability {
+        ShortcutApplyCapability::GnomeCustomShortcut => {
             let normalized = normalize_shortcut_for_gnome(shortcut_input)?;
             apply_gnome_custom_shortcut(&normalized)?;
+            let removed_dropin = remove_portal_shortcut_dropin_if_gnome(desktop)?;
+            if command_available("systemctl") {
+                run_systemctl_user(&["daemon-reload"])?;
+                if removed_dropin && query_service_active() {
+                    run_systemctl_user(&["restart", "wayscriber.service"])?;
+                }
+            }
             Ok(format!("Configured GNOME shortcut: {normalized}"))
         }
-        ShortcutBackend::PortalServiceDropIn => {
+        ShortcutApplyCapability::PortalServiceDropIn => {
             require_systemctl_available()?;
             let normalized = normalize_shortcut_for_portal(shortcut_input)?;
             let dropin_path = write_portal_shortcut_dropin(&normalized)?;
@@ -52,7 +71,7 @@ pub(super) fn apply_shortcut(shortcut_input: &str) -> Result<String, String> {
                 dropin_path.display()
             ))
         }
-        ShortcutBackend::Manual => Err(
+        ShortcutApplyCapability::Manual => Err(
             "Automatic shortcut setup is not available in this desktop session; bind `pkill -SIGUSR1 wayscriber` manually."
                 .to_string(),
         ),
@@ -160,9 +179,7 @@ fn write_portal_shortcut_dropin(shortcut: &str) -> Result<std::path::PathBuf, St
 
     let escaped_shortcut = escape_systemd_env_value(shortcut);
     let escaped_app_id = escape_systemd_env_value(PORTAL_APP_ID);
-    let contents = format!(
-        "[Service]\nEnvironment=\"WAYSCRIBER_PORTAL_SHORTCUT={escaped_shortcut}\"\nEnvironment=\"WAYSCRIBER_PORTAL_APP_ID={escaped_app_id}\"\n"
-    );
+    let contents = render_portal_shortcut_dropin(&escaped_shortcut, &escaped_app_id);
     fs::write(&dropin_path, contents).map_err(|err| {
         format!(
             "Failed to write portal shortcut drop-in {}: {}",
@@ -173,23 +190,20 @@ fn write_portal_shortcut_dropin(shortcut: &str) -> Result<std::path::PathBuf, St
     Ok(dropin_path)
 }
 
+fn render_portal_shortcut_dropin(escaped_shortcut: &str, escaped_app_id: &str) -> String {
+    format!(
+        "[Service]\nEnvironment=\"{PORTAL_SHORTCUT_OPT_IN_ENV}=1\"\nEnvironment=\"{PORTAL_SHORTCUT_ENV}={escaped_shortcut}\"\nEnvironment=\"{PORTAL_APP_ID_ENV}={escaped_app_id}\"\n"
+    )
+}
+
 fn read_portal_shortcut_from_dropin() -> Option<String> {
     let path = portal_shortcut_dropin_path()?;
     let content = fs::read_to_string(path).ok()?;
     parse_portal_shortcut_from_dropin(&content)
 }
 
 fn parse_portal_shortcut_from_dropin(content: &str) -> Option<String> {
-    content.lines().find_map(|line| {
-        let trimmed = line.trim();
-        let prefix = "Environment=\"WAYSCRIBER_PORTAL_SHORTCUT=";
-        if !trimmed.starts_with(prefix) || !trimmed.ends_with('"') {
-            return None;
-        }
-        let inner = &trimmed[prefix.len()..trimmed.len() - 1];
-        let unescaped = inner.replace("\\\"", "\"").replace("\\\\", "\\");
-        normalize_shortcut_hint(Some(&unescaped))
-    })
+    shared_parse_portal_shortcut_from_dropin(content)
 }
 
 fn serialize_gsettings_path_list(paths: &[String]) -> String {
@@ -343,6 +357,14 @@ mod tests {
         assert_eq!(parse_portal_shortcut_from_dropin(content), None);
     }
 
+    #[test]
+    fn render_portal_shortcut_dropin_includes_explicit_opt_in_marker() {
+        let rendered = render_portal_shortcut_dropin("<Ctrl><Shift>g", PORTAL_APP_ID);
+        assert!(rendered.contains("Environment=\"WAYSCRIBER_ENABLE_PORTAL_SHORTCUTS=1\""));
+        assert!(rendered.contains("Environment=\"WAYSCRIBER_PORTAL_SHORTCUT=<Ctrl><Shift>g\""));
+        assert!(rendered.contains("Environment=\"WAYSCRIBER_PORTAL_APP_ID=wayscriber\""));
+    }
+
     #[test]
     fn resolve_gnome_shortcut_requires_registered_path() {
         let custom_keybindings =

configurator/src/app/update/daemon.rs

@@ -159,7 +159,7 @@ fn action_pending_message(action: DaemonAction) -> String {
 #[cfg(test)]
 mod tests {
     use super::*;
-    use crate::models::{DesktopEnvironment, ShortcutBackend};
+    use crate::models::{DesktopEnvironment, ShortcutApplyCapability, ShortcutBackend};
 
     #[test]
     fn daemon_status_loaded_sets_default_shortcut_when_missing() {
@@ -168,6 +168,7 @@ mod tests {
         let status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: false,
@@ -208,6 +209,7 @@ mod tests {
         let status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: false,
@@ -235,6 +237,7 @@ mod tests {
         let status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: false,
@@ -264,6 +267,7 @@ mod tests {
         let stale_status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: false,
@@ -305,6 +309,7 @@ mod tests {
         let old_status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: false,
@@ -316,6 +321,7 @@ mod tests {
         let new_status = DaemonRuntimeStatus {
             desktop: DesktopEnvironment::Kde,
             shortcut_backend: ShortcutBackend::PortalServiceDropIn,
+            shortcut_apply_capability: ShortcutApplyCapability::PortalServiceDropIn,
             systemctl_available: true,
             gsettings_available: false,
             service_installed: true,

configurator/src/app/view/daemon.rs

@@ -3,7 +3,7 @@ use iced::theme;
 use iced::widget::{button, column, horizontal_rule, row, scrollable, text, text_input};
 
 use crate::messages::Message;
-use crate::models::{DaemonAction, ShortcutBackend};
+use crate::models::{DaemonAction, ShortcutApplyCapability};
 
 use super::super::state::ConfiguratorApp;
 
@@ -157,14 +157,20 @@ impl ConfiguratorApp {
             .into();
         }
 
-        let placeholder = match self.daemon_status.as_ref().map(|s| s.shortcut_backend) {
-            Some(ShortcutBackend::GnomeCustomShortcut) => "e.g. Super+G or <Super>g",
-            Some(ShortcutBackend::PortalServiceDropIn) => "e.g. Ctrl+Shift+G or <Ctrl><Shift>g",
+        let apply_capability = self
+            .daemon_status
+            .as_ref()
+            .map(|s| s.shortcut_apply_capability);
+        let placeholder = match apply_capability {
+            Some(ShortcutApplyCapability::GnomeCustomShortcut) => "e.g. Super+G or <Super>g",
+            Some(ShortcutApplyCapability::PortalServiceDropIn) => {
+                "e.g. Ctrl+Shift+G or <Ctrl><Shift>g"
+            }
             _ => "e.g. Ctrl+Shift+G",
         };
 
         let mut shortcut_button = button("Apply Shortcut").style(theme::Button::Primary);
-        if !busy {
+        if !busy && apply_capability != Some(ShortcutApplyCapability::Manual) {
             shortcut_button = shortcut_button
                 .on_press(Message::DaemonActionRequested(DaemonAction::ApplyShortcut));
         }
@@ -192,6 +198,14 @@ impl ConfiguratorApp {
             );
         }
 
+        if apply_capability == Some(ShortcutApplyCapability::Manual) {
+            step = step.push(
+                text("Automatic shortcut setup is unavailable here. Add a manual keybind for `pkill -SIGUSR1 wayscriber`.")
+                    .size(12)
+                    .style(theme::Text::Color(iced::Color::from_rgb(0.95, 0.8, 0.3))),
+            );
+        }
+
         step = step.push(
             text_input(placeholder, &self.daemon_shortcut_input)
                 .on_input(Message::DaemonShortcutInputChanged)
@@ -293,6 +307,11 @@ impl ConfiguratorApp {
                     .size(12)
                     .style(theme::Text::Color(iced::Color::from_rgb(0.6, 0.6, 0.6))),
             );
+            details = details.push(
+                text(status.shortcut_apply_capability.friendly_label())
+                    .size(12)
+                    .style(theme::Text::Color(iced::Color::from_rgb(0.6, 0.6, 0.6))),
+            );
 
             if let Some(path) = status.service_unit_path.as_deref() {
                 details = details.push(