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 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605
//! This module contains `XDG` and `DBus` specific code.
//!
//! it should not be available under any platform other than `(unix, not(target_os = "macos"))`
#[cfg(feature = "dbus")]
use dbus::ffidisp::Connection as DbusConnection;
#[cfg(feature = "zbus")]
use zbus::{block_on, zvariant};
use crate::{error::*, notification::Notification};
use std::ops::{Deref, DerefMut};
#[cfg(feature = "dbus")]
mod dbus_rs;
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
use dbus_rs::bus;
#[cfg(feature = "zbus")]
mod zbus_rs;
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
use zbus_rs::bus;
#[cfg(all(feature = "dbus", feature = "zbus"))]
mod bus;
// #[cfg(all(feature = "server", feature = "dbus", unix, not(target_os = "macos")))]
// pub mod server_dbus;
// #[cfg(all(feature = "server", feature = "zbus", unix, not(target_os = "macos")))]
// pub mod server_zbus;
// #[cfg(all(feature = "server", unix, not(target_os = "macos")))]
// pub mod server;
#[cfg(not(feature = "debug_namespace"))]
#[doc(hidden)]
pub static NOTIFICATION_DEFAULT_BUS: &str = "org.freedesktop.Notifications";
#[cfg(feature = "debug_namespace")]
#[doc(hidden)]
// #[deprecated]
pub static NOTIFICATION_DEFAULT_BUS: &str = "de.hoodie.Notifications";
#[doc(hidden)]
pub static NOTIFICATION_INTERFACE: &str = "org.freedesktop.Notifications";
#[doc(hidden)]
pub static NOTIFICATION_OBJECTPATH: &str = "/org/freedesktop/Notifications";
pub(crate) use bus::NotificationBus;
#[derive(Debug)]
enum NotificationHandleInner {
#[cfg(feature = "dbus")]
Dbus(dbus_rs::DbusNotificationHandle),
#[cfg(feature = "zbus")]
Zbus(zbus_rs::ZbusNotificationHandle),
}
/// A handle to a shown notification.
///
/// This keeps a connection alive to ensure actions work on certain desktops.
#[derive(Debug)]
pub struct NotificationHandle {
inner: NotificationHandleInner,
}
#[allow(dead_code)]
impl NotificationHandle {
#[cfg(feature = "dbus")]
pub(crate) fn for_dbus(
id: u32,
connection: DbusConnection,
notification: Notification,
) -> NotificationHandle {
NotificationHandle {
inner: dbus_rs::DbusNotificationHandle::new(id, connection, notification).into(),
}
}
#[cfg(feature = "zbus")]
pub(crate) fn for_zbus(
id: u32,
connection: zbus::Connection,
notification: Notification,
) -> NotificationHandle {
NotificationHandle {
inner: zbus_rs::ZbusNotificationHandle::new(id, connection, notification).into(),
}
}
/// Waits for the user to act on a notification and then calls
/// `invocation_closure` with the name of the corresponding action.
pub fn wait_for_action<F>(self, invocation_closure: F)
where
F: FnOnce(&str),
{
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(inner) => {
inner.wait_for_action(|action: &ActionResponse| match action {
ActionResponse::Custom(action) => invocation_closure(action),
ActionResponse::Closed(_reason) => invocation_closure("__closed"), // FIXME: remove backward compatibility with 5.0
});
}
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(inner) => {
block_on(
inner.wait_for_action(|action: &ActionResponse| match action {
ActionResponse::Custom(action) => invocation_closure(action),
ActionResponse::Closed(_reason) => invocation_closure("__closed"), // FIXME: remove backward compatibility with 5.0
}),
);
}
};
}
/// Manually close the notification
///
/// # Example
///
/// ```no_run
/// # use notify_rust::*;
/// let handle: NotificationHandle = Notification::new()
/// .summary("oh no")
/// .hint(notify_rust::Hint::Transient(true))
/// .body("I'll be here till you close me!")
/// .hint(Hint::Resident(true)) // does not work on kde
/// .timeout(Timeout::Never) // works on kde and gnome
/// .show()
/// .unwrap();
/// // ... and then later
/// handle.close();
/// ```
pub fn close(self) {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(inner) => inner.close(),
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(inner) => block_on(inner.close()),
}
}
/// Executes a closure after the notification has closed.
///
/// ## Example 1: *I don't care about why it closed* (the good ole API)
///
/// ```no_run
/// # use notify_rust::Notification;
/// Notification::new().summary("Time is running out")
/// .body("This will go away.")
/// .icon("clock")
/// .show()
/// .unwrap()
/// .on_close(|| println!("closed"));
/// ```
///
/// ## Example 2: *I **do** care about why it closed* (added in v4.5.0)
///
/// ```no_run
/// # use notify_rust::Notification;
/// Notification::new().summary("Time is running out")
/// .body("This will go away.")
/// .icon("clock")
/// .show()
/// .unwrap()
/// .on_close(|reason| println!("closed: {:?}", reason));
/// ```
pub fn on_close<A>(self, handler: impl CloseHandler<A>) {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(inner) => {
inner.wait_for_action(|action: &ActionResponse| {
if let ActionResponse::Closed(reason) = action {
handler.call(*reason);
}
});
}
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(inner) => {
block_on(inner.wait_for_action(|action: &ActionResponse| {
if let ActionResponse::Closed(reason) = action {
handler.call(*reason);
}
}));
}
};
}
/// Replace the original notification with an updated version
/// ## Example
/// ```no_run
/// # use notify_rust::Notification;
/// let mut notification = Notification::new().summary("Latest News")
/// .body("Bayern Dortmund 3:2")
/// .show()
/// .unwrap();
///
/// std::thread::sleep_ms(1_500);
///
/// notification.summary("Latest News (Correction)")
/// .body("Bayern Dortmund 3:3");
///
/// notification.update();
/// ```
/// Watch out for different implementations of the
/// notification server! On plasma5 for instance, you should also change the appname, so the old
/// message is really replaced and not just amended. Xfce behaves well, all others have not
/// been tested by the developer.
pub fn update(&mut self) {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(ref mut inner) => inner.update(),
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(ref mut inner) => inner.update(),
}
}
/// Returns the Handle's id.
pub fn id(&self) -> u32 {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(ref inner) => inner.id,
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(ref inner) => inner.id,
}
}
}
/// Required for `DerefMut`
impl Deref for NotificationHandle {
type Target = Notification;
fn deref(&self) -> &Notification {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(ref inner) => &inner.notification,
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(ref inner) => &inner.notification,
}
}
}
/// Allow you to easily modify notification properties
impl DerefMut for NotificationHandle {
fn deref_mut(&mut self) -> &mut Notification {
match self.inner {
#[cfg(feature = "dbus")]
NotificationHandleInner::Dbus(ref mut inner) => &mut inner.notification,
#[cfg(feature = "zbus")]
NotificationHandleInner::Zbus(ref mut inner) => &mut inner.notification,
}
}
}
#[cfg(feature = "dbus")]
impl From<dbus_rs::DbusNotificationHandle> for NotificationHandleInner {
fn from(handle: dbus_rs::DbusNotificationHandle) -> NotificationHandleInner {
NotificationHandleInner::Dbus(handle)
}
}
#[cfg(feature = "zbus")]
impl From<zbus_rs::ZbusNotificationHandle> for NotificationHandleInner {
fn from(handle: zbus_rs::ZbusNotificationHandle) -> NotificationHandleInner {
NotificationHandleInner::Zbus(handle)
}
}
#[cfg(feature = "dbus")]
impl From<dbus_rs::DbusNotificationHandle> for NotificationHandle {
fn from(handle: dbus_rs::DbusNotificationHandle) -> NotificationHandle {
NotificationHandle {
inner: handle.into(),
}
}
}
#[cfg(feature = "zbus")]
impl From<zbus_rs::ZbusNotificationHandle> for NotificationHandle {
fn from(handle: zbus_rs::ZbusNotificationHandle) -> NotificationHandle {
NotificationHandle {
inner: handle.into(),
}
}
}
// here be public functions
// TODO: breaking change, wait for 5.0
// #[cfg(all(feature = "dbus", feature = "zbus"))]
//compile_error!("the z and d features are mutually exclusive");
#[cfg(all(
not(any(feature = "dbus", feature = "zbus")),
unix,
not(target_os = "macos")
))]
compile_error!("you have to build with either zbus or dbus turned on");
/// Which Dbus implementation are we using?
#[derive(Copy, Clone, Debug)]
pub enum DbusStack {
/// using [dbus-rs](https://docs.rs/dbus-rs)
Dbus,
/// using [zbus](https://docs.rs/zbus)
Zbus,
}
#[cfg(all(feature = "dbus", feature = "zbus"))]
const DBUS_SWITCH_VAR: &str = "DBUSRS";
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
pub(crate) fn show_notification(notification: &Notification) -> Result<NotificationHandle> {
block_on(zbus_rs::connect_and_send_notification(notification)).map(Into::into)
}
#[cfg(all(feature = "async", feature = "zbus"))]
pub(crate) async fn show_notification_async(
notification: &Notification,
) -> Result<NotificationHandle> {
zbus_rs::connect_and_send_notification(notification)
.await
.map(Into::into)
}
#[cfg(all(feature = "async", feature = "zbus"))]
pub(crate) async fn show_notification_async_at_bus(
notification: &Notification,
bus: NotificationBus,
) -> Result<NotificationHandle> {
zbus_rs::connect_and_send_notification_at_bus(notification, bus)
.await
.map(Into::into)
}
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
pub(crate) fn show_notification(notification: &Notification) -> Result<NotificationHandle> {
dbus_rs::connect_and_send_notification(notification).map(Into::into)
}
#[cfg(all(feature = "dbus", feature = "zbus"))]
pub(crate) fn show_notification(notification: &Notification) -> Result<NotificationHandle> {
if std::env::var(DBUS_SWITCH_VAR).is_ok() {
dbus_rs::connect_and_send_notification(notification).map(Into::into)
} else {
block_on(zbus_rs::connect_and_send_notification(notification)).map(Into::into)
}
}
/// Get the currently used [`DbusStack`]
///
/// (zbus only)
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
pub fn dbus_stack() -> Option<DbusStack> {
Some(DbusStack::Zbus)
}
/// Get the currently used [`DbusStack`]
///
/// (dbus-rs only)
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
pub fn dbus_stack() -> Option<DbusStack> {
Some(DbusStack::Dbus)
}
/// Get the currently used [`DbusStack`]
///
/// both dbus-rs and zbus, switch via `$ZBUS_NOTIFICATION`
#[cfg(all(feature = "dbus", feature = "zbus"))]
pub fn dbus_stack() -> Option<DbusStack> {
Some(if std::env::var(DBUS_SWITCH_VAR).is_ok() {
DbusStack::Dbus
} else {
DbusStack::Zbus
})
}
/// Get the currently used [`DbusStack`]
///
/// neither zbus nor dbus-rs are configured
#[cfg(all(not(feature = "dbus"), not(feature = "zbus")))]
pub fn dbus_stack() -> Option<DbusStack> {
None
}
/// Get list of all capabilities of the running notification server.
///
/// (zbus only)
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
pub fn get_capabilities() -> Result<Vec<String>> {
block_on(zbus_rs::get_capabilities())
}
/// Get list of all capabilities of the running notification server.
///
/// (dbus-rs only)
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
pub fn get_capabilities() -> Result<Vec<String>> {
dbus_rs::get_capabilities()
}
/// Get list of all capabilities of the running notification server.
///
/// both dbus-rs and zbus, switch via `$ZBUS_NOTIFICATION`
#[cfg(all(feature = "dbus", feature = "zbus"))]
pub fn get_capabilities() -> Result<Vec<String>> {
if std::env::var(DBUS_SWITCH_VAR).is_ok() {
dbus_rs::get_capabilities()
} else {
block_on(zbus_rs::get_capabilities())
}
}
/// Returns a struct containing `ServerInformation`.
///
/// This struct contains `name`, `vendor`, `version` and `spec_version` of the notification server
/// running.
///
/// (zbus only)
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
pub fn get_server_information() -> Result<ServerInformation> {
block_on(zbus_rs::get_server_information())
}
/// Returns a struct containing `ServerInformation`.
///
/// This struct contains `name`, `vendor`, `version` and `spec_version` of the notification server
/// running.
///
/// (dbus-rs only)
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
pub fn get_server_information() -> Result<ServerInformation> {
dbus_rs::get_server_information()
}
/// Returns a struct containing `ServerInformation`.
///
/// This struct contains `name`, `vendor`, `version` and `spec_version` of the notification server
/// running.
///
/// both dbus-rs and zbus, switch via `$ZBUS_NOTIFICATION`
#[cfg(all(feature = "dbus", feature = "zbus"))]
pub fn get_server_information() -> Result<ServerInformation> {
if std::env::var(DBUS_SWITCH_VAR).is_ok() {
dbus_rs::get_server_information()
} else {
block_on(zbus_rs::get_server_information())
}
}
/// Return value of `get_server_information()`.
#[derive(Debug)]
#[cfg_attr(feature = "serde", derive(serde::Deserialize))]
#[cfg_attr(feature = "zbus", derive(zvariant::Type))]
pub struct ServerInformation {
/// The product name of the server.
pub name: String,
/// The vendor name.
pub vendor: String,
/// The server's version string.
pub version: String,
/// The specification version the server is compliant with.
pub spec_version: String,
}
// /// Strictly internal.
// /// The NotificationServer implemented here exposes a "Stop" function.
// /// stops the notification server
// #[cfg(all(feature = "server", unix, not(target_os = "macos")))]
// #[doc(hidden)]
// pub fn stop_server() {
// #[cfg(feature = "dbus")]
// dbus_rs::stop_server()
// }
/// Listens for the `ActionInvoked(UInt32, String)` Signal.
///
/// No need to use this, check out [`NotificationHandle::wait_for_action`]
/// (xdg only)
#[cfg(all(feature = "zbus", not(feature = "dbus")))]
// #[deprecated(note="please use [`NotificationHandle::wait_for_action`]")]
pub fn handle_action<F>(id: u32, func: F)
where
F: FnOnce(&ActionResponse),
{
block_on(zbus_rs::handle_action(id, func));
}
/// Listens for the `ActionInvoked(UInt32, String)` Signal.
///
/// No need to use this, check out [`NotificationHandle::wait_for_action`]
/// (xdg only)
#[cfg(all(feature = "dbus", not(feature = "zbus")))]
// #[deprecated(note="please use `NotificationHandle::wait_for_action`")]
pub fn handle_action<F>(id: u32, func: F)
where
F: FnOnce(&ActionResponse),
{
dbus_rs::handle_action(id, func);
}
/// Listens for the `ActionInvoked(UInt32, String)` Signal.
///
/// No need to use this, check out [`NotificationHandle::wait_for_action`]
/// both dbus-rs and zbus, switch via `$ZBUS_NOTIFICATION`
#[cfg(all(feature = "dbus", feature = "zbus"))]
// #[deprecated(note="please use `NotificationHandle::wait_for_action`")]
pub fn handle_action<F>(id: u32, func: F)
where
F: FnOnce(&ActionResponse),
{
if std::env::var(DBUS_SWITCH_VAR).is_ok() {
dbus_rs::handle_action(id, func);
} else {
block_on(zbus_rs::handle_action(id, func));
}
}
/// Reason passed to `NotificationClosed` Signal
///
/// ## Specification
/// As listed under [Table 8. `NotificationClosed` Parameters](https://specifications.freedesktop.org/notification-spec/latest/ar01s09.html#idm46350804042704)
#[derive(Copy, Clone, Debug)]
pub enum CloseReason {
/// The notification expired
Expired,
/// The notification was dismissed by the user
Dismissed,
/// The notification was closed by a call to `CloseNotification`
CloseAction,
/// Undefined/Reserved reason
Other(u32),
}
impl From<u32> for CloseReason {
fn from(raw_reason: u32) -> Self {
match raw_reason {
1 => CloseReason::Expired,
2 => CloseReason::Dismissed,
3 => CloseReason::CloseAction,
other => CloseReason::Other(other),
}
}
}
/// Helper Trait implemented by `Fn()`
pub trait ActionResponseHandler {
fn call(self, response: &ActionResponse);
}
// impl<F: Send + Sync + 'static> ActionResponseHandler for F
impl<F> ActionResponseHandler for F
where
F: FnOnce(&ActionResponse),
{
fn call(self, res: &ActionResponse) {
(self)(res);
}
}
/// Response to an action
pub enum ActionResponse<'a> {
/// Custom Action configured by the Notification.
Custom(&'a str),
/// The Notification was closed.
Closed(CloseReason),
}
impl<'a> From<&'a str> for ActionResponse<'a> {
fn from(raw: &'a str) -> Self {
Self::Custom(raw)
}
}
/// Your handy callback for the `Close` signal of your Notification.
///
/// This is implemented by `Fn()` and `Fn(CloseReason)`, so there is probably no good reason for you to manually implement this trait.
/// Should you find one anyway, please notify me and I'll gladly remove this obviously redundant comment.
pub trait CloseHandler<T> {
/// This is called with the [`CloseReason`].
fn call(&self, reason: CloseReason);
}
impl<F> CloseHandler<CloseReason> for F
where
F: Fn(CloseReason),
{
fn call(&self, reason: CloseReason) {
self(reason);
}
}
impl<F> CloseHandler<()> for F
where
F: Fn(),
{
fn call(&self, _: CloseReason) {
self();
}
}