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
//! Open a URI or a directory.
//!
//! Wrapper of the DBus interface: [`org.freedesktop.portal.OpenURI`](https://flatpak.github.io/xdg-desktop-portal/docs/doc-org.freedesktop.portal.OpenURI.html).
//!
//! # Examples
//!
//! ## Open a file
//!
//! ```rust,no_run
//! use std::{fs::File, os::fd::AsFd};
//!
//! use ashpd::desktop::open_uri::OpenFileRequest;
//!
//! async fn run() -> ashpd::Result<()> {
//! let file = File::open("/home/bilelmoussaoui/adwaita-day.jpg").unwrap();
//! OpenFileRequest::default()
//! .ask(true)
//! .send_file(&file.as_fd())
//! .await?;
//! Ok(())
//! }
//! ```
//!
//! ## Open a file from a URI
//!
//!
//! ```rust,no_run
//! use ashpd::desktop::open_uri::OpenFileRequest;
//!
//! async fn run() -> ashpd::Result<()> {
//! let uri =
//! url::Url::parse("file:///home/bilelmoussaoui/Downloads/adwaita-night.jpg").unwrap();
//! OpenFileRequest::default().ask(true).send_uri(&uri).await?;
//! Ok(())
//! }
//! ```
//!
//! ## Open a directory
//!
//! ```rust,no_run
//! use std::{fs::File, os::fd::AsFd};
//!
//! use ashpd::desktop::open_uri::OpenDirectoryRequest;
//!
//! async fn run() -> ashpd::Result<()> {
//! let directory = File::open("/home/bilelmoussaoui/Downloads").unwrap();
//! OpenDirectoryRequest::default()
//! .send(&directory.as_fd())
//! .await?;
//! Ok(())
//! }
//! ```
use std::os::fd::BorrowedFd;
use url::Url;
use zbus::zvariant::{Fd, SerializeDict, Type};
use super::{HandleToken, Request};
use crate::{proxy::Proxy, ActivationToken, Error, WindowIdentifier};
#[derive(SerializeDict, Type, Debug, Default)]
#[zvariant(signature = "dict")]
struct OpenDirOptions {
handle_token: HandleToken,
activation_token: Option<ActivationToken>,
}
#[derive(SerializeDict, Type, Debug, Default)]
#[zvariant(signature = "dict")]
struct OpenFileOptions {
handle_token: HandleToken,
writeable: Option<bool>,
ask: Option<bool>,
activation_token: Option<ActivationToken>,
}
#[derive(Debug)]
struct OpenURIProxy<'a>(Proxy<'a>);
impl<'a> OpenURIProxy<'a> {
pub async fn new() -> Result<OpenURIProxy<'a>, Error> {
let proxy = Proxy::new_desktop("org.freedesktop.portal.OpenURI").await?;
Ok(Self(proxy))
}
pub async fn open_directory(
&self,
identifier: &WindowIdentifier,
directory: &BorrowedFd<'_>,
options: OpenDirOptions,
) -> Result<Request<()>, Error> {
self.0
.empty_request(
&options.handle_token,
"OpenDirectory",
&(&identifier, Fd::from(directory), &options),
)
.await
}
pub async fn open_file(
&self,
identifier: &WindowIdentifier,
file: &BorrowedFd<'_>,
options: OpenFileOptions,
) -> Result<Request<()>, Error> {
self.0
.empty_request(
&options.handle_token,
"OpenFile",
&(&identifier, Fd::from(file), &options),
)
.await
}
pub async fn open_uri(
&self,
identifier: &WindowIdentifier,
uri: &url::Url,
options: OpenFileOptions,
) -> Result<Request<()>, Error> {
self.0
.empty_request(
&options.handle_token,
"OpenURI",
&(&identifier, uri, &options),
)
.await
}
}
impl<'a> std::ops::Deref for OpenURIProxy<'a> {
type Target = zbus::Proxy<'a>;
fn deref(&self) -> &Self::Target {
&self.0
}
}
#[derive(Debug, Default)]
#[doc(alias = "org.freedesktop.portal.OpenURI")]
#[doc(alias = "xdp_portal_open_uri")]
/// A [builder-pattern] type to open a file.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
pub struct OpenFileRequest {
identifier: WindowIdentifier,
options: OpenFileOptions,
}
impl OpenFileRequest {
#[must_use]
/// Sets a window identifier.
pub fn identifier(mut self, identifier: impl Into<Option<WindowIdentifier>>) -> Self {
self.identifier = identifier.into().unwrap_or_default();
self
}
#[must_use]
/// Whether the file should be writeable or not.
pub fn writeable(mut self, writeable: impl Into<Option<bool>>) -> Self {
self.options.writeable = writeable.into();
self
}
#[must_use]
/// Whether to always ask the user which application to use or not.
pub fn ask(mut self, ask: impl Into<Option<bool>>) -> Self {
self.options.ask = ask.into();
self
}
/// 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.options.activation_token = activation_token.into();
self
}
/// Send the request for a file.
pub async fn send_file(self, file: &BorrowedFd<'_>) -> Result<Request<()>, Error> {
let proxy = OpenURIProxy::new().await?;
proxy.open_file(&self.identifier, file, self.options).await
}
/// Send the request for a URI.
pub async fn send_uri(self, uri: &Url) -> Result<Request<()>, Error> {
let proxy = OpenURIProxy::new().await?;
proxy.open_uri(&self.identifier, uri, self.options).await
}
}
#[derive(Debug, Default)]
#[doc(alias = "xdp_portal_open_directory")]
#[doc(alias = "org.freedesktop.portal.OpenURI")]
/// A [builder-pattern] type to open a directory.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
pub struct OpenDirectoryRequest {
identifier: WindowIdentifier,
options: OpenDirOptions,
}
impl OpenDirectoryRequest {
#[must_use]
/// Sets a window identifier.
pub fn identifier(mut self, identifier: impl Into<Option<WindowIdentifier>>) -> Self {
self.identifier = identifier.into().unwrap_or_default();
self
}
/// 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.options.activation_token = activation_token.into();
self
}
/// Send the request.
pub async fn send(self, directory: &BorrowedFd<'_>) -> Result<Request<()>, Error> {
let proxy = OpenURIProxy::new().await?;
proxy
.open_directory(&self.identifier, directory, self.options)
.await
}
}