1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
//! Install launchers like Web Application from your browser or Steam.
//!
//! # Examples
//!
//! ```rust,no_run
//! use std::io::Read;
//! use ashpd::{
//! desktop::{
//! dynamic_launcher::{DynamicLauncherProxy, PrepareInstallOptions},
//! Icon,
//! },
//! WindowIdentifier,
//! };
//!
//! async fn run() -> ashpd::Result<()> {
//! let proxy = DynamicLauncherProxy::new().await?;
//!
//! let filename = "/home/bilalelmoussaoui/Projects/ashpd/ashpd-demo/data/icons/com.belmoussaoui.ashpd.demo.svg";
//! let mut f = std::fs::File::open(&filename).expect("no file found");
//! let metadata = std::fs::metadata(&filename).expect("unable to read metadata");
//! let mut buffer = vec![0; metadata.len() as usize];
//! f.read(&mut buffer).expect("buffer overflow");
//!
//! let icon = Icon::Bytes(buffer);
//! let response = proxy
//! .prepare_install(
//! &WindowIdentifier::default(),
//! "SomeApp",
//! icon,
//! PrepareInstallOptions::default()
//! )
//! .await?
//! .response()?;
//! let token = response.token();
//!
//!
//! // Name and Icon will be overwritten from what we provided above
//! // Exec will be overridden to call `flatpak run our-app` if the application is sandboxed
//! let desktop_entry = r#"
//! [Desktop Entry]
//! Comment=My Web App
//! Type=Application
//! "#;
//! proxy
//! .install(&token, "some_file.desktop", desktop_entry)
//! .await?;
//!
//! proxy.uninstall("some_file.desktop").await?;
//! Ok(())
//! }
//! ```
use std::collections::HashMap;
use enumflags2::{bitflags, BitFlags};
use serde::{Deserialize, Serialize};
use serde_repr::{Deserialize_repr, Serialize_repr};
use zbus::zvariant::{self, DeserializeDict, OwnedValue, SerializeDict, Type, Value};
use super::{HandleToken, Icon, Request};
use crate::{proxy::Proxy, ActivationToken, Error, WindowIdentifier};
#[bitflags]
#[derive(Default, Serialize_repr, Deserialize_repr, PartialEq, Eq, Debug, Copy, Clone, Type)]
#[repr(u32)]
#[doc(alias = "XdpLauncherType")]
/// The type of the launcher.
pub enum LauncherType {
#[doc(alias = "XDP_LAUNCHER_APPLICATION")]
#[default]
/// A launcher that represents an application
Application,
#[doc(alias = "XDP_LAUNCHER_WEBAPP")]
/// A launcher that represents a web application
WebApplication,
}
#[cfg_attr(feature = "glib", derive(glib::Enum))]
#[cfg_attr(feature = "glib", enum_type(name = "AshpdIconType"))]
#[derive(Debug, Clone, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd, Ord, Type)]
#[zvariant(signature = "s")]
#[serde(rename_all = "lowercase")]
/// The icon format.
pub enum IconType {
/// PNG.
Png,
/// JPEG.
Jpeg,
/// SVG.
Svg,
}
#[derive(Debug, Deserialize, Type)]
#[zvariant(signature = "(vsu)")]
/// The icon of the launcher.
pub struct LauncherIcon(zvariant::OwnedValue, IconType, u32);
impl LauncherIcon {
/// The actual icon.
pub fn icon(&self) -> Icon {
Icon::try_from(&self.0).unwrap()
}
/// The icon type.
pub fn type_(&self) -> IconType {
self.1
}
/// The icon size.
pub fn size(&self) -> u32 {
self.2
}
}
#[derive(Debug, Default, SerializeDict, Type)]
#[zvariant(signature = "dict")]
/// Options to pass to [`DynamicLauncherProxy::prepare_install`]
pub struct PrepareInstallOptions {
handle_token: HandleToken,
modal: Option<bool>,
launcher_type: LauncherType,
target: Option<String>,
editable_name: Option<bool>,
editable_icon: Option<bool>,
}
impl PrepareInstallOptions {
/// Sets whether the dialog should be a modal.
pub fn modal(mut self, modal: impl Into<Option<bool>>) -> Self {
self.modal = modal.into();
self
}
/// Sets the launcher type.
pub fn launcher_type(mut self, launcher_type: LauncherType) -> Self {
self.launcher_type = launcher_type;
self
}
/// The URL for a [`LauncherType::WebApplication`] otherwise it is not
/// needed.
pub fn target<'a>(mut self, target: impl Into<Option<&'a str>>) -> Self {
self.target = target.into().map(ToOwned::to_owned);
self
}
/// Sets whether the name should be editable.
pub fn editable_name(mut self, editable_name: impl Into<Option<bool>>) -> Self {
self.editable_name = editable_name.into();
self
}
/// Sets whether the icon should be editable.
pub fn editable_icon(mut self, editable_icon: impl Into<Option<bool>>) -> Self {
self.editable_icon = editable_icon.into();
self
}
}
#[derive(DeserializeDict, Type)]
#[zvariant(signature = "dict")]
/// A response of [`DynamicLauncherProxy::prepare_install`]
pub struct PrepareInstallResponse {
name: String,
icon: OwnedValue,
token: String,
}
impl PrepareInstallResponse {
/// The user defined name or a predefined one
pub fn name(&self) -> &str {
&self.name
}
/// A token to pass to [`DynamicLauncherProxy::install`]
pub fn token(&self) -> &str {
&self.token
}
/// The user selected icon or a predefined one
pub fn icon(&self) -> Icon {
let inner = self.icon.downcast_ref::<Value>().unwrap();
Icon::try_from(inner).unwrap()
}
}
impl std::fmt::Debug for PrepareInstallResponse {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.debug_struct("PrepareInstallResponse")
.field("name", &self.name())
.field("icon", &self.icon())
.field("token", &self.token())
.finish()
}
}
#[derive(SerializeDict, Type, Debug, Default)]
#[zvariant(signature = "dict")]
/// Options to pass to [`DynamicLauncherProxy::launch`]
pub struct LaunchOptions {
activation_token: Option<ActivationToken>,
}
impl LaunchOptions {
/// Sets the token that can be used to activate the chosen application.
#[must_use]
pub fn activation_token(
mut self,
activation_token: impl Into<Option<ActivationToken>>,
) -> Self {
self.activation_token = activation_token.into();
self
}
}
#[derive(Debug)]
/// Wrong type of [`crate::desktop::Icon`] was used.
pub struct UnexpectedIconError;
impl std::error::Error for UnexpectedIconError {}
impl std::fmt::Display for UnexpectedIconError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
f.write_str("Unexpected icon type. Only Icon::Bytes is supported")
}
}
/// The interface lets sandboxed applications install launchers like Web
/// Application from your browser or Steam.
///
/// Wrapper of the DBus interface: [`org.freedesktop.portal.DynamicLauncher`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html).
#[derive(Debug)]
#[doc(alias = "org.freedesktop.portal.DynamicLauncher")]
pub struct DynamicLauncherProxy<'a>(Proxy<'a>);
impl<'a> DynamicLauncherProxy<'a> {
/// Create a new instance of [`DynamicLauncherProxy`].
pub async fn new() -> Result<DynamicLauncherProxy<'a>, Error> {
let proxy = Proxy::new_desktop("org.freedesktop.portal.DynamicLauncher").await?;
Ok(Self(proxy))
}
/// *Note* Only `Icon::Bytes` is accepted.
///
/// # Specifications
///
/// See also [`PrepareInstall`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-prepareinstall).
#[doc(alias = "PrepareInstall")]
#[doc(alias = "xdp_portal_dynamic_launcher_prepare_install")]
#[doc(alias = "xdp_portal_dynamic_launcher_prepare_install_finish")]
pub async fn prepare_install(
&self,
parent_window: &WindowIdentifier,
name: &str,
icon: Icon,
options: PrepareInstallOptions,
) -> Result<Request<PrepareInstallResponse>, Error> {
if !icon.is_bytes() {
return Err(UnexpectedIconError {}.into());
}
self.0
.request(
&options.handle_token,
"PrepareInstall",
&(parent_window, name, icon.as_value(), &options),
)
.await
}
/// *Note* Only `Icon::Bytes` is accepted.
///
/// # Specifications
///
/// See also [`RequestInstallToken`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-requestinstalltoken).
#[doc(alias = "RequestInstallToken")]
#[doc(alias = "xdp_portal_dynamic_launcher_request_install_token")]
pub async fn request_install_token(&self, name: &str, icon: Icon) -> Result<String, Error> {
if !icon.is_bytes() {
return Err(UnexpectedIconError {}.into());
}
// No supported options for now
let options: HashMap<&str, zvariant::Value<'_>> = HashMap::new();
self.0
.call::<String>("RequestInstallToken", &(name, icon.as_value(), options))
.await
}
/// # Specifications
///
/// See also [`Install`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-install).
#[doc(alias = "Install")]
#[doc(alias = "xdp_portal_dynamic_launcher_install")]
pub async fn install(
&self,
token: &str,
desktop_file_id: &str,
desktop_entry: &str,
) -> Result<(), Error> {
// No supported options for now
let options: HashMap<&str, zvariant::Value<'_>> = HashMap::new();
self.0
.call::<()>("Install", &(token, desktop_file_id, desktop_entry, options))
.await
}
/// # Specifications
///
/// See also [`Uninstall`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-uninstall).
#[doc(alias = "Uninstall")]
#[doc(alias = "xdp_portal_dynamic_launcher_uninstall")]
pub async fn uninstall(&self, desktop_file_id: &str) -> Result<(), Error> {
// No supported options for now
let options: HashMap<&str, zvariant::Value<'_>> = HashMap::new();
self.0
.call::<()>("Uninstall", &(desktop_file_id, options))
.await
}
/// # Specifications
///
/// See also [`GetDesktopEntry`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-getdesktopentry).
#[doc(alias = "GetDesktopEntry")]
#[doc(alias = "xdp_portal_dynamic_launcher_get_desktop_entry")]
pub async fn desktop_entry(&self, desktop_file_id: &str) -> Result<String, Error> {
self.0.call("GetDesktopEntry", &(desktop_file_id)).await
}
/// # Specifications
///
/// See also [`GetIcon`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-geticon).
#[doc(alias = "GetIcon")]
#[doc(alias = "xdp_portal_dynamic_launcher_get_icon")]
pub async fn icon(&self, desktop_file_id: &str) -> Result<LauncherIcon, Error> {
self.0.call("GetIcon", &(desktop_file_id)).await
}
/// # Specifications
///
/// See also [`Launch`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-launch).
#[doc(alias = "Launch")]
#[doc(alias = "xdp_portal_dynamic_launcher_launch")]
pub async fn launch(&self, desktop_file_id: &str, options: LaunchOptions) -> Result<(), Error> {
self.0.call("Launch", &(desktop_file_id, &options)).await
}
/// # Specifications
///
/// See also [`SupportedLauncherTypes`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.DynamicLauncher.html#org-freedesktop-portal-dynamiclauncher-supportedlaunchertypes).
#[doc(alias = "SupportedLauncherTypes")]
pub async fn supported_launcher_types(&self) -> Result<BitFlags<LauncherType>, Error> {
self.0
.property::<BitFlags<LauncherType>>("SupportedLauncherTypes")
.await
}
}
impl<'a> std::ops::Deref for DynamicLauncherProxy<'a> {
type Target = zbus::Proxy<'a>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_icon_signature() {
let signature = LauncherIcon::signature();
assert_eq!(signature.as_str(), "(vsu)");
let icon = vec![IconType::Png];
assert_eq!(serde_json::to_string(&icon).unwrap(), "[\"png\"]");
}
}