cosmic-applets/cosmic-applet-status-area/src/subscriptions/status_notifier_item.rs

// Copyright 2023 System76 <info@system76.com>
// SPDX-License-Identifier: GPL-3.0-only

use std::hash::Hash;
use std::path::PathBuf;

use cosmic::iced::{self, Subscription};
use futures::{FutureExt, StreamExt};
use rustc_hash::FxHashMap;
use zbus::zvariant::{self, OwnedValue};

#[derive(Clone, Debug)]
pub struct StatusNotifierItem {
    name: String,
    is_menu: bool,
    item_proxy: StatusNotifierItemProxy<'static>,
    menu_proxy: Option<DBusMenuProxy<'static>>,
}

#[derive(Clone, Debug, zvariant::Value)]
pub struct Icon {
    pub width: i32,
    pub height: i32,
    pub bytes: Vec<u8>,
}

#[derive(Clone, Debug)]
pub struct IconUpdate {
    pub name: Option<String>,
    pub pixmap: Option<Vec<Icon>>,
    pub theme_path: Option<PathBuf>,
}

impl StatusNotifierItem {
    pub async fn new(connection: &zbus::Connection, name: String) -> zbus::Result<Self> {
        let (dest, path) = if let Some(idx) = name.find('/') {
            (&name[..idx], &name[idx..])
        } else {
            (name.as_str(), "/StatusNotifierItem")
        };

        let item_proxy = StatusNotifierItemProxy::builder(connection)
            // Status icons don't seem to report property changes the normal way...
            .cache_properties(zbus::proxy::CacheProperties::No)
            .destination(dest.to_string())?
            .path(path.to_string())?
            .build()
            .await?;

        let is_menu = item_proxy.item_is_menu().await.unwrap_or(false);

        let menu_proxy = if let Ok(menu_path) = item_proxy.menu().await {
            Some(
                DBusMenuProxy::builder(connection)
                    .destination(dest.to_string())?
                    .path(menu_path)?
                    .build()
                    .await?,
            )
        } else {
            None
        };

        Ok(Self {
            name,
            is_menu,
            item_proxy,
            menu_proxy,
        })
    }

    pub fn name(&self) -> &str {
        &self.name
    }

    // TODO: Only fetch changed part of layout, if that's any faster
    pub fn layout_subscription(&self) -> iced::Subscription<Result<Layout, String>> {
        let Some(menu_proxy) = self.menu_proxy.clone() else {
            return Subscription::none();
        };
        struct Wrapper {
            menu_proxy: DBusMenuProxy<'static>,
            name: String,
        }
        impl Hash for Wrapper {
            fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
                self.name.hash(state);
            }
        }
        Subscription::run_with(
            Wrapper {
                menu_proxy,
                name: format!("status-notifier-item-layout-{}", &self.name),
            },
            |Wrapper { menu_proxy, .. }| {
                let menu_proxy = menu_proxy.clone();
                async move {
                    let initial = futures::stream::once(get_layout(menu_proxy.clone()));

                    let layout_updated = menu_proxy.receive_layout_updated().await.unwrap();
                    let props_updated =
                        menu_proxy.receive_items_properties_updated().await.unwrap();

                    // Merge both streams - any update triggers a layout refetch
                    let updates = futures::stream_select!(
                        layout_updated.map(|_| ()),
                        props_updated.map(|_| ())
                    )
                    .then(move |()| get_layout(menu_proxy.clone()));

                    initial.chain(updates)
                }
                .flatten_stream()
            },
        )
    }

    pub fn icon_subscription(&self) -> iced::Subscription<IconUpdate> {
        async fn icon_events(item_proxy: StatusNotifierItemProxy<'static>) -> IconUpdate {
            let icon_name = item_proxy.icon_name().await;
            let icon_pixmap = item_proxy.icon_pixmap().await;
            let icon_theme_path = item_proxy.icon_theme_path().await.map(PathBuf::from);
            IconUpdate {
                name: icon_name.ok(),
                pixmap: icon_pixmap.ok(),
                theme_path: icon_theme_path.ok().filter(|x| !x.as_os_str().is_empty()),
            }
        }

        let item_proxy = self.item_proxy.clone();
        struct Wrapper {
            item_proxy: StatusNotifierItemProxy<'static>,
            name: String,
        }
        impl Hash for Wrapper {
            fn hash<H: std::hash::Hasher>(&self, state: &mut H) {
                self.name.hash(state);
            }
        }
        Subscription::run_with(
            Wrapper {
                item_proxy,
                name: format!("status-notifier-item-icon-{}", &self.name),
            },
            |Wrapper { item_proxy, .. }| {
                let item_proxy = item_proxy.clone();
                async move {
                    let new_icon_stream = item_proxy.receive_new_icon().await.unwrap();
                    futures::stream::once(async {})
                        .chain(new_icon_stream.map(|_| ()))
                        .then(move |()| icon_events(item_proxy.clone()))
                }
                .flatten_stream()
            },
        )
    }

    /// Item is only a menu, with no `Activate` action
    pub fn is_menu(&self) -> bool {
        self.is_menu
    }

    pub fn menu_proxy(&self) -> Option<&DBusMenuProxy<'static>> {
        self.menu_proxy.as_ref()
    }

    pub fn item_proxy(&self) -> &StatusNotifierItemProxy<'static> {
        &self.item_proxy
    }
}

async fn get_layout(menu_proxy: DBusMenuProxy<'static>) -> Result<Layout, String> {
    match menu_proxy.get_layout(0, -1, &[]).await {
        Ok((_, layout)) => Ok(layout),
        Err(err) => Err(err.to_string()),
    }
}

#[zbus::proxy(interface = "org.kde.StatusNotifierItem")]
pub trait StatusNotifierItem {
    #[zbus(property)]
    fn icon_name(&self) -> zbus::Result<String>;

    #[zbus(property)]
    fn icon_theme_path(&self) -> zbus::Result<String>;

    // https://www.freedesktop.org/wiki/Specifications/StatusNotifierItem/Icons
    #[zbus(property)]
    fn icon_pixmap(&self) -> zbus::Result<Vec<Icon>>;

    #[zbus(property)]
    fn menu(&self) -> zbus::Result<zvariant::OwnedObjectPath>;

    #[zbus(property)]
    fn item_is_menu(&self) -> zbus::Result<bool>;

    #[zbus(signal)]
    fn new_icon(&self) -> zbus::Result<()>;

    fn provide_xdg_activation_token(&self, token: String) -> zbus::Result<()>;

    fn activate(&self, x: i32, y: i32) -> zbus::Result<()>;

    fn secondary_activate(&self, x: i32, y: i32) -> zbus::Result<()>;

    fn scroll(&self, delta: i32, orientation: &str) -> zbus::Result<()>;
}

#[derive(Clone, Debug)]
pub struct Layout(i32, LayoutProps, Vec<Layout>);

impl<'a> serde::Deserialize<'a> for Layout {
    fn deserialize<D: serde::Deserializer<'a>>(deserializer: D) -> Result<Self, D::Error> {
        let (id, props, children) =
            <(i32, LayoutProps, Vec<(zvariant::Signature, Self)>)>::deserialize(deserializer)?;
        Ok(Self(id, props, children.into_iter().map(|x| x.1).collect()))
    }
}

impl zvariant::Type for Layout {
    const SIGNATURE: &zvariant::Signature = <(
        i32,
        FxHashMap<String, zvariant::Value>,
        Vec<zvariant::Value>,
    )>::SIGNATURE;
}

#[derive(Clone, Debug, zvariant::DeserializeDict)]
pub struct LayoutProps {
    #[zvariant(rename = "accessible-desc")]
    accessible_desc: Option<String>,
    #[zvariant(rename = "children-display")]
    children_display: Option<String>,
    label: Option<String>,
    enabled: Option<bool>,
    visible: Option<bool>,
    #[zvariant(rename = "type")]
    type_: Option<String>,
    #[zvariant(rename = "toggle-type")]
    toggle_type: Option<String>,
    #[zvariant(rename = "toggle-state")]
    toggle_state: Option<i32>,
    #[zvariant(rename = "icon-data")]
    icon_data: Option<Vec<u8>>,
    #[zvariant(rename = "icon-name")]
    icon_name: Option<String>,
    disposition: Option<String>,
    // If this field has a different type, this causes the whole type to fail
    // to parse, due to a zvariant bug.
    // https://github.com/dbus2/zbus/issues/856
    // shortcut: Option<String>,
}

impl zvariant::Type for LayoutProps {
    const SIGNATURE: &zvariant::Signature = <FxHashMap<String, zvariant::Value>>::SIGNATURE;
}

#[allow(dead_code)]
impl Layout {
    pub fn id(&self) -> i32 {
        self.0
    }

    pub fn children(&self) -> &[Self] {
        &self.2
    }

    pub fn accessible_desc(&self) -> Option<&str> {
        self.1.accessible_desc.as_deref()
    }

    pub fn children_display(&self) -> Option<&str> {
        self.1.children_display.as_deref()
    }

    pub fn label(&self) -> Option<&str> {
        self.1.label.as_deref()
    }

    pub fn enabled(&self) -> bool {
        self.1.enabled.unwrap_or(true)
    }

    pub fn visible(&self) -> bool {
        self.1.visible.unwrap_or(true)
    }

    pub fn type_(&self) -> Option<&str> {
        self.1.type_.as_deref()
    }

    pub fn toggle_type(&self) -> Option<&str> {
        self.1.toggle_type.as_deref()
    }

    pub fn toggle_state(&self) -> Option<i32> {
        self.1.toggle_state
    }

    pub fn icon_data(&self) -> Option<&[u8]> {
        self.1.icon_data.as_deref()
    }

    pub fn icon_name(&self) -> Option<&str> {
        self.1.icon_name.as_deref()
    }

    pub fn disposition(&self) -> Option<&str> {
        self.1.disposition.as_deref()
    }
}

#[zbus::proxy(interface = "com.canonical.dbusmenu")]
pub trait DBusMenu {
    fn get_layout(
        &self,
        parent_id: i32,
        recursion_depth: i32,
        property_names: &[&str],
    ) -> zbus::Result<(u32, Layout)>;

    fn event(&self, id: i32, event_id: &str, data: &OwnedValue, timestamp: u32)
    -> zbus::Result<()>;

    fn about_to_show(&self, id: i32) -> zbus::Result<bool>;

    #[zbus(signal)]
    fn layout_updated(&self, revision: u32, parent: i32) -> zbus::Result<()>;

    #[zbus(signal)]
    fn items_properties_updated(
        &self,
        updated_props: Vec<(i32, std::collections::HashMap<String, zvariant::OwnedValue>)>,
        removed_props: Vec<(i32, Vec<String>)>,
    ) -> zbus::Result<()>;
}