Evaluate background apps using systemd

(This commit also holds any squashed changes from rebases)

Author: joshuamegnauth54

examples/background.rs

@@ -70,7 +70,7 @@ impl cosmic::Application for App {
             })
             .width(Length::Fill)
             .into(),
-            widget::button("Run in background")
+            widget::button::standard("Run in background")
                 .on_press(Message::RequestBackground)
                 .padding(8.0)
                 .into(),

src/app.rs

@@ -155,7 +155,7 @@ impl cosmic::Application for CosmicPortal {
                     screencast_dialog::cancel(self, handle).map(cosmic::Action::App)
                 }
                 subscription::Event::Background(args) => {
-                    background::update_args(self, args).map(cosmic::app::Message::App)
+                    background::update_args(self, args).map(cosmic::Action::App)
                 }
                 subscription::Event::Config(config) => self.update(Msg::ConfigSubUpdate(config)),
                 subscription::Event::Accent(_)

src/background.rs

@@ -2,6 +2,8 @@
 
 use std::{
     borrow::Cow,
+    collections::HashSet,
+    hash::{Hash, Hasher},
     io,
     path::Path,
     sync::{Arc, Condvar, Mutex},
@@ -21,7 +23,7 @@ use zbus::{fdo, object_server::SignalContext, zvariant};
 use crate::{
     app::CosmicPortal,
     config::{self, background::PermissionDialog},
-    fl, subscription,
+    fl, subscription, systemd,
     wayland::WaylandHelper,
     PortalResponse,
 };
@@ -80,7 +82,7 @@ impl Background {
     /// The primary purpose of this function is to ease error handling.
     async fn write_autostart(
         autostart_entry: &Path,
-        desktop_entry: &freedesktop_desktop_entry::DesktopEntry<'_>,
+        desktop_entry: &freedesktop_desktop_entry::DesktopEntry,
     ) -> io::Result<()> {
         let mut file = fs::OpenOptions::new()
             .create(true)
@@ -92,46 +94,64 @@ impl Background {
             .await?;
 
         file.write_all(desktop_entry.to_string().as_bytes()).await?;
-        /// Shouldn't be needed, but the file never seemed to flush to disk until I did it manually
+        // Shouldn't be needed, but the file never seemed to flush to disk until I did it manually
         file.flush().await
     }
 }
 
 #[zbus::interface(name = "org.freedesktop.impl.portal.Background")]
 impl Background {
     /// Status on running apps (active, running, or background)
-    async fn get_app_state(&self) -> fdo::Result<AppStates> {
-        let apps: Vec<_> = self
+    async fn get_app_state(
+        &self,
+        #[zbus(connection)] connection: &zbus::Connection,
+    ) -> fdo::Result<AppStates> {
+        let apps: HashSet<_> = self
             .wayland_helper
             .toplevels()
             .into_iter()
-            .map(|(_, info)| {
+            // Evaluate apps with open top levels first as our initial state
+            .map(|info| {
                 let status = if info
                     .state
                     .contains(&zcosmic_toplevel_handle_v1::State::Activated)
                 {
+                    // Focused top levels
                     AppStatus::Active
-                } else if !info.state.is_empty() {
-                    AppStatus::Running
                 } else {
-                    // xxx Is this the correct way to determine if a program is running in the
-                    // background? If a toplevel exists but isn't running, activated, et cetera,
-                    // then it logically must be in the background (?)
-                    AppStatus::Background
+                    // Unfocused top levels
+                    AppStatus::Running
                 };
 
                 AppState {
                     app_id: info.app_id,
                     status,
                 }
             })
+            .chain(
+                systemd::Systemd1Proxy::new(connection)
+                    .await?
+                    .list_units()
+                    .await?
+                    .into_iter()
+                    // Apps launched by COSMIC/Flatpak are considered to be running in the
+                    // background by default as they don't have open top levels
+                    .filter_map(|unit| {
+                        unit.cosmic_flatpak_name().map(|app_id| AppState {
+                            app_id: app_id.to_owned(),
+                            status: AppStatus::Background,
+                        })
+                    }),
+            )
             .collect();
 
-        log::debug!("GetAppState returning {} toplevels", apps.len());
+        log::debug!("GetAppState is returning {} open apps", apps.len());
         #[cfg(debug_assertions)]
-        log::trace!("App status: {apps:#?}");
+        log::trace!("App statuses: {apps:#?}");
 
-        Ok(AppStates { apps })
+        Ok(AppStates {
+            apps: apps.into_iter().collect(),
+        })
     }
 
     /// Notifies the user that an app is running in the background
@@ -145,7 +165,10 @@ impl Background {
 
         // Request a copy of the config from the main app instance
         // This is also cleaner than storing the config because it's difficult to keep it
-        // updated without synch primitives and we also avoid &mut self
+        // updated without synch primitives and we also avoid &mut self.
+        //
+        // &mut self with Zbus can lead to deadlocks.
+        // See: https://dbus2.github.io/zbus/faq.html#1-a-interface-method-that-takes-a-mut-self-argument-is-taking-too-long
         let config = self.rx_conf.borrow().background;
 
         match config.default_perm {
@@ -192,7 +215,7 @@ impl Background {
     ///
     /// Deprecated in terms of the portal but seemingly still in use
     /// Spec: https://specifications.freedesktop.org/autostart-spec/latest/
-    pub async fn enable_autostart(
+    async fn enable_autostart(
         &self,
         appid: String,
         enable: bool,
@@ -250,13 +273,13 @@ impl Background {
             }
 
             let mut autostart_fde = freedesktop_desktop_entry::DesktopEntry {
-                appid: Cow::Borrowed(&appid),
+                appid: appid.clone(),
                 path: Default::default(),
                 groups: Default::default(),
                 ubuntu_gettext_domain: None,
             };
-            autostart_fde.add_desktop_entry("Type", "Application");
-            autostart_fde.add_desktop_entry("Name", &appid);
+            autostart_fde.add_desktop_entry("Type".into(), "Application".into());
+            autostart_fde.add_desktop_entry("Name".into(), appid.clone());
 
             log::debug!("{appid} autostart command line: {exec:?}");
             let exec = match shlex::try_join(exec.iter().map(|term| term.as_str())) {
@@ -267,17 +290,17 @@ impl Background {
                 }
             };
             log::debug!("{appid} sanitized autostart command line: {exec}");
-            autostart_fde.add_desktop_entry("Exec", &exec);
+            autostart_fde.add_desktop_entry("Exec".into(), exec);
 
-            /// xxx Replace with enumflags later when it's added as a dependency instead of adding
-            /// it now for one bit (literally)
+            // TODO: Replace with enumflags later when it's added as a dependency instead of adding
+            // it now for one bit (literally)
             let dbus_activation = flags & 0x1 == 1;
             if dbus_activation {
-                autostart_fde.add_desktop_entry("DBusActivatable", "true");
+                autostart_fde.add_desktop_entry("DBusActivatable".into(), "true".into());
             }
 
             // GNOME and KDE both set this key
-            autostart_fde.add_desktop_entry("X-Flatpak", &appid);
+            autostart_fde.add_desktop_entry("X-Flatpak".into(), appid.clone());
 
             Self::write_autostart(&launch_entry, &autostart_fde)
                 .inspect_err(|e| {
@@ -297,9 +320,9 @@ impl Background {
     pub async fn running_applications_changed(context: &SignalContext<'_>) -> zbus::Result<()>;
 }
 
-#[derive(Clone, Copy, Debug, PartialEq, Eq, serde::Serialize, zvariant::Type)]
+#[derive(Clone, Copy, Debug, PartialEq, Eq, Hash, serde::Serialize, zvariant::Type)]
 #[zvariant(signature = "u")]
-pub enum AppStatus {
+enum AppStatus {
     /// No open windows
     Background = 0,
     /// At least one opened window
@@ -314,17 +337,29 @@ struct AppStates {
     apps: Vec<AppState>,
 }
 
-#[derive(Clone, Debug, zvariant::SerializeDict, zvariant::Type)]
+#[derive(Clone, Debug, Eq, zvariant::SerializeDict, zvariant::Type)]
 #[zvariant(signature = "{sv}")]
 struct AppState {
     app_id: String,
     status: AppStatus,
 }
 
+impl Hash for AppState {
+    fn hash<H: Hasher>(&self, state: &mut H) {
+        state.write(self.app_id.as_bytes());
+    }
+}
+
+impl PartialEq for AppState {
+    fn eq(&self, other: &Self) -> bool {
+        self.app_id == other.app_id
+    }
+}
+
 /// Result vardict for [`Background::notify_background`]
 #[derive(Clone, Debug, zvariant::SerializeDict, zvariant::Type)]
 #[zvariant(signature = "a{sv}")]
-pub struct NotifyBackgroundResult {
+struct NotifyBackgroundResult {
     result: PermissionResponse,
 }
 
@@ -376,7 +411,8 @@ pub(crate) fn view(portal: &CosmicPortal, id: window::Id) -> cosmic::Element<Msg
         .unwrap_or("Invalid window id");
 
     // TODO: Add cancel
-    widget::dialog(fl!("bg-dialog-title"))
+    widget::dialog()
+        .title(fl!("bg-dialog-title"))
         .body(fl!("bg-dialog-body", appname = name))
         .icon(widget::icon::from_name("dialog-warning-symbolic").size(64))
         .primary_action(
@@ -401,7 +437,7 @@ pub(crate) fn view(portal: &CosmicPortal, id: window::Id) -> cosmic::Element<Msg
 }
 
 /// Update Background dialog args for a specific window
-pub fn update_args(portal: &mut CosmicPortal, args: Args) -> cosmic::Command<crate::app::Msg> {
+pub fn update_args(portal: &mut CosmicPortal, args: Args) -> cosmic::Task<crate::app::Msg> {
     if let Some(old) = portal.background_prompts.insert(args.id, args) {
         // xxx Can this even happen?
         log::trace!(
@@ -412,10 +448,10 @@ pub fn update_args(portal: &mut CosmicPortal, args: Args) -> cosmic::Command<cra
         )
     }
 
-    cosmic::Command::none()
+    cosmic::Task::none()
 }
 
-pub fn update_msg(portal: &mut CosmicPortal, msg: Msg) -> cosmic::Command<crate::app::Msg> {
+pub fn update_msg(portal: &mut CosmicPortal, msg: Msg) -> cosmic::Task<crate::app::Msg> {
     match msg {
         Msg::Response { id, choice } => {
             let Some(Args {
@@ -426,7 +462,7 @@ pub fn update_msg(portal: &mut CosmicPortal, msg: Msg) -> cosmic::Command<crate:
             }) = portal.background_prompts.remove(&id)
             else {
                 log::warn!("Window {id:?} doesn't exist for some reason");
-                return cosmic::Command::none();
+                return cosmic::Task::none();
             };
 
             log::trace!(
@@ -455,7 +491,7 @@ pub fn update_msg(portal: &mut CosmicPortal, msg: Msg) -> cosmic::Command<crate:
             }) = portal.background_prompts.remove(&id)
             else {
                 log::warn!("Window {id:?} doesn't exist for some reason");
-                return cosmic::Command::none();
+                return cosmic::Task::none();
             };
 
             log::trace!(
@@ -472,5 +508,5 @@ pub fn update_msg(portal: &mut CosmicPortal, msg: Msg) -> cosmic::Command<crate:
         }
     }
 
-    cosmic::Command::none()
+    cosmic::Task::none()
 }

src/main.rs

@@ -17,6 +17,7 @@ mod screencast_dialog;
 mod screencast_thread;
 mod screenshot;
 mod subscription;
+mod systemd;
 mod wayland;
 mod widget;