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
#[cfg(all(unix, not(target_os = "macos")))]
use crate::{
hints::{CustomHintType, Hint},
urgency::Urgency,
xdg,
};
#[cfg(all(unix, not(target_os = "macos"), feature = "images"))]
use crate::image::Image;
#[cfg(all(unix, target_os = "macos"))]
use crate::macos;
#[cfg(target_os = "windows")]
use crate::windows;
use crate::{error::*, timeout::Timeout};
#[cfg(all(unix, not(target_os = "macos")))]
use std::collections::{HashMap, HashSet};
// Returns the name of the current executable, used as a default for `Notification.appname`.
fn exe_name() -> String {
std::env::current_exe()
.unwrap()
.file_name()
.unwrap()
.to_str()
.unwrap()
.to_owned()
}
/// Desktop notification.
///
/// A desktop notification is configured via builder pattern, before it is launched with `show()`.
///
/// # Example
/// ``` no_run
/// # use notify_rust::*;
/// # fn _doc() -> Result<(), Box<dyn std::error::Error>> {
/// Notification::new()
/// .summary("☝️ A notification")
/// .show()?;
/// # Ok(())
/// # }
/// ```
#[derive(Debug, Clone)]
#[non_exhaustive]
pub struct Notification {
/// Filled by default with executable name.
pub appname: String,
/// Single line to summarize the content.
pub summary: String,
/// Subtitle for macOS
pub subtitle: Option<String>,
/// Multiple lines possible, may support simple markup,
/// check out `get_capabilities()` -> `body-markup` and `body-hyperlinks`.
pub body: String,
/// Use a file:// URI or a name in an icon theme, must be compliant freedesktop.org.
pub icon: String,
/// Check out `Hint`
///
/// # warning
/// this does not hold all hints, [`Hint::Custom`] and [`Hint::CustomInt`] are held elsewhere,
// /// please access hints via [`Notification::get_hints`].
#[cfg(all(unix, not(target_os = "macos")))]
pub hints: HashSet<Hint>,
#[cfg(all(unix, not(target_os = "macos")))]
pub(crate) hints_unique: HashMap<(String, CustomHintType), Hint>,
/// See `Notification::actions()` and `Notification::action()`
pub actions: Vec<String>,
#[cfg(target_os = "macos")]
pub(crate) sound_name: Option<String>,
#[cfg(target_os = "windows")]
pub(crate) sound_name: Option<String>,
#[cfg(target_os = "windows")]
pub(crate) path_to_image: Option<String>,
#[cfg(target_os = "windows")]
pub(crate) app_id: Option<String>,
#[cfg(all(unix, not(target_os = "macos")))]
pub(crate) bus: xdg::NotificationBus,
/// Lifetime of the Notification in ms. Often not respected by server, sorry.
pub timeout: Timeout, // both gnome and galago want allow for -1
/// Only to be used on the receive end. Use Notification hand for updating.
pub(crate) id: Option<u32>,
}
impl Notification {
/// Constructs a new Notification.
///
/// Most fields are empty by default, only `appname` is initialized with the name of the current
/// executable.
/// The appname is used by some desktop environments to group notifications.
pub fn new() -> Notification {
Notification::default()
}
/// This is for testing purposes only and will not work with actual implementations.
#[cfg(all(unix, not(target_os = "macos")))]
#[doc(hidden)]
#[deprecated(note = "this is a test only feature")]
pub fn at_bus(sub_bus: &str) -> Notification {
let bus = xdg::NotificationBus::custom(sub_bus)
.ok_or("invalid subpath")
.unwrap();
Notification {
bus,
..Notification::default()
}
}
/// Overwrite the appname field used for Notification.
///
/// # Platform Support
/// Please note that this method has no effect on macOS. Here you can only set the application via [`set_application()`](fn.set_application.html)
pub fn appname(&mut self, appname: &str) -> &mut Notification {
appname.clone_into(&mut self.appname);
self
}
/// Set the `summary`.
///
/// Often acts as title of the notification. For more elaborate content use the `body` field.
pub fn summary(&mut self, summary: &str) -> &mut Notification {
summary.clone_into(&mut self.summary);
self
}
/// Set the `subtitle`.
///
/// This is only useful on macOS, it's not part of the XDG specification and will therefore be eaten by gremlins under your CPU 😈🤘.
pub fn subtitle(&mut self, subtitle: &str) -> &mut Notification {
self.subtitle = Some(subtitle.to_owned());
self
}
/// Manual wrapper for `Hint::ImageData`
#[cfg(all(feature = "images", unix, not(target_os = "macos")))]
pub fn image_data(&mut self, image: Image) -> &mut Notification {
self.hint(Hint::ImageData(image));
self
}
/// Wrapper for `Hint::ImagePath`
#[cfg(all(unix, not(target_os = "macos")))]
pub fn image_path(&mut self, path: &str) -> &mut Notification {
self.hint(Hint::ImagePath(path.to_string()));
self
}
/// Wrapper for `NotificationHint::ImagePath`
#[cfg(target_os = "windows")]
pub fn image_path(&mut self, path: &str) -> &mut Notification {
self.path_to_image = Some(path.to_string());
self
}
/// app's System.AppUserModel.ID
#[cfg(target_os = "windows")]
pub fn app_id(&mut self, app_id: &str) -> &mut Notification {
self.app_id = Some(app_id.to_string());
self
}
/// Wrapper for `Hint::ImageData`
#[cfg(all(feature = "images", unix, not(target_os = "macos")))]
pub fn image<T: AsRef<std::path::Path> + Sized>(
&mut self,
path: T,
) -> Result<&mut Notification> {
let img = Image::open(&path)?;
self.hint(Hint::ImageData(img));
Ok(self)
}
/// Wrapper for `Hint::SoundName`
#[cfg(all(unix, not(target_os = "macos")))]
pub fn sound_name(&mut self, name: &str) -> &mut Notification {
self.hint(Hint::SoundName(name.to_owned()));
self
}
/// Set the `sound_name` for the `NSUserNotification`
#[cfg(any(target_os = "macos", target_os = "windows"))]
pub fn sound_name(&mut self, name: &str) -> &mut Notification {
self.sound_name = Some(name.to_owned());
self
}
/// Set the content of the `body` field.
///
/// Multiline textual content of the notification.
/// Each line should be treated as a paragraph.
/// Simple html markup should be supported, depending on the server implementation.
pub fn body(&mut self, body: &str) -> &mut Notification {
body.clone_into(&mut self.body);
self
}
/// Set the `icon` field.
///
/// You can use common icon names here, usually those in `/usr/share/icons`
/// can all be used.
/// You can also use an absolute path to file.
///
/// # Platform support
/// macOS does not have support manually setting the icon. However you can pretend to be another app using [`set_application()`](fn.set_application.html)
pub fn icon(&mut self, icon: &str) -> &mut Notification {
icon.clone_into(&mut self.icon);
self
}
/// Set the `icon` field automatically.
///
/// This looks at your binary's name and uses it to set the icon.
///
/// # Platform support
/// macOS does not support manually setting the icon. However you can pretend to be another app using [`set_application()`](fn.set_application.html)
pub fn auto_icon(&mut self) -> &mut Notification {
self.icon = exe_name();
self
}
/// Adds a hint.
///
/// This method will add a hint to the internal hint [`HashSet`].
/// Hints must be of type [`Hint`].
///
/// Many of these are again wrapped by more convenient functions such as:
///
/// * `sound_name(...)`
/// * `urgency(...)`
/// * [`image(...)`](#method.image) or
/// * [`image_data(...)`](#method.image_data)
/// * [`image_path(...)`](#method.image_path)
///
/// ```no_run
/// # use notify_rust::Notification;
/// # use notify_rust::Hint;
/// Notification::new().summary("Category:email")
/// .body("This should not go away until you acknowledge it.")
/// .icon("thunderbird")
/// .appname("thunderbird")
/// .hint(Hint::Category("email".to_owned()))
/// .hint(Hint::Resident(true))
/// .show();
/// ```
///
/// # Platform support
/// Most of these hints don't even have an effect on the big XDG Desktops, they are completely tossed on macOS.
#[cfg(all(unix, not(target_os = "macos")))]
pub fn hint(&mut self, hint: Hint) -> &mut Notification {
match hint {
Hint::CustomInt(k, v) => {
self.hints_unique
.insert((k.clone(), CustomHintType::Int), Hint::CustomInt(k, v));
}
Hint::Custom(k, v) => {
self.hints_unique
.insert((k.clone(), CustomHintType::String), Hint::Custom(k, v));
}
_ => {
self.hints.insert(hint);
}
}
self
}
#[cfg(all(unix, not(target_os = "macos")))]
pub(crate) fn get_hints(&self) -> impl Iterator<Item = &Hint> {
self.hints.iter().chain(self.hints_unique.values())
}
/// Set the `timeout`.
///
/// Accepts multiple types that implement `Into<Timeout>`.
///
/// ## `i31`
///
/// This sets the time (in milliseconds) from the time the notification is displayed until it is
/// closed again by the Notification Server.
/// According to [specification](https://developer.gnome.org/notification-spec/)
/// -1 will leave the timeout to be set by the server and
/// 0 will cause the notification never to expire.
/// ## [Duration](`std::time::Duration`)
///
/// When passing a [`Duration`](`std::time::Duration`) we will try convert it into milliseconds.
///
///
/// ```
/// # use std::time::Duration;
/// # use notify_rust::Timeout;
/// assert_eq!(Timeout::from(Duration::from_millis(2000)), Timeout::Milliseconds(2000));
/// ```
/// ### Caveats!
///
/// 1. If the duration is zero milliseconds then the original behavior will apply and the notification will **Never** timeout.
/// 2. Should the number of milliseconds not fit within an [`i32`] then we will fall back to the default timeout.
/// ```
/// # use std::time::Duration;
/// # use notify_rust::Timeout;
/// assert_eq!(Timeout::from(Duration::from_millis(0)), Timeout::Never);
/// assert_eq!(Timeout::from(Duration::from_millis(u64::MAX)), Timeout::Default);
/// ```
///
/// # Platform support
/// This only works on XDG Desktops, macOS does not support manually setting the timeout.
pub fn timeout<T: Into<Timeout>>(&mut self, timeout: T) -> &mut Notification {
self.timeout = timeout.into();
self
}
/// Set the `urgency`.
///
/// Pick between Medium, Low and High.
///
/// # Platform support
/// Most Desktops on linux and bsd are far too relaxed to pay any attention to this.
/// In macOS this does not exist
#[cfg(all(unix, not(target_os = "macos")))]
pub fn urgency(&mut self, urgency: Urgency) -> &mut Notification {
self.hint(Hint::Urgency(urgency)); // TODO impl as T where T: Into<Urgency>
self
}
/// Set `actions`.
///
/// To quote <http://www.galago-project.org/specs/notification/0.9/x408.html#command-notify>
///
/// > Actions are sent over as a list of pairs.
/// > Each even element in the list (starting at index 0) represents the identifier for the action.
/// > Each odd element in the list is the localized string that will be displayed to the user.y
///
/// There is nothing fancy going on here yet.
/// **Careful! This replaces the internal list of actions!**
///
/// (xdg only)
#[deprecated(note = "please use .action() only")]
pub fn actions(&mut self, actions: Vec<String>) -> &mut Notification {
self.actions = actions;
self
}
/// Add an action.
///
/// This adds a single action to the internal list of actions.
///
/// (xdg only)
pub fn action(&mut self, identifier: &str, label: &str) -> &mut Notification {
self.actions.push(identifier.to_owned());
self.actions.push(label.to_owned());
self
}
/// Set an Id ahead of time
///
/// Setting the id ahead of time allows overriding a known other notification.
/// Though if you want to update a notification, it is easier to use the `update()` method of
/// the `NotificationHandle` object that `show()` returns.
///
/// (xdg only)
pub fn id(&mut self, id: u32) -> &mut Notification {
self.id = Some(id);
self
}
/// Finalizes a Notification.
///
/// Part of the builder pattern, returns a complete copy of the built notification.
pub fn finalize(&self) -> Notification {
self.clone()
}
/// Schedules a Notification
///
/// Sends a Notification at the specified date.
#[cfg(all(target_os = "macos", feature = "chrono"))]
pub fn schedule<T: chrono::TimeZone>(
&self,
delivery_date: chrono::DateTime<T>,
) -> Result<macos::NotificationHandle> {
macos::schedule_notification(self, delivery_date.timestamp() as f64)
}
/// Schedules a Notification
///
/// Sends a Notification at the specified timestamp.
/// This is a raw `f64`, if that is a bit too raw for you please activate the feature `"chrono"`,
/// then you can use `Notification::schedule()` instead, which accepts a `chrono::DateTime<T>`.
#[cfg(target_os = "macos")]
pub fn schedule_raw(&self, timestamp: f64) -> Result<macos::NotificationHandle> {
macos::schedule_notification(self, timestamp)
}
/// Sends Notification to D-Bus.
///
/// Returns a handle to a notification
#[cfg(all(unix, not(target_os = "macos")))]
pub fn show(&self) -> Result<xdg::NotificationHandle> {
xdg::show_notification(self)
}
/// Sends Notification to D-Bus.
///
/// Returns a handle to a notification
#[cfg(all(unix, not(target_os = "macos")))]
#[cfg(all(feature = "async", feature = "zbus"))]
pub async fn show_async(&self) -> Result<xdg::NotificationHandle> {
xdg::show_notification_async(self).await
}
/// Sends Notification to D-Bus.
///
/// Returns a handle to a notification
#[cfg(all(unix, not(target_os = "macos")))]
#[cfg(feature = "async")]
// #[cfg(test)]
pub async fn show_async_at_bus(&self, sub_bus: &str) -> Result<xdg::NotificationHandle> {
let bus = xdg::NotificationBus::custom(sub_bus).ok_or("invalid subpath")?;
xdg::show_notification_async_at_bus(self, bus).await
}
/// Sends Notification to `NSUserNotificationCenter`.
///
/// Returns an `Ok` no matter what, since there is currently no way of telling the success of
/// the notification.
#[cfg(target_os = "macos")]
pub fn show(&self) -> Result<macos::NotificationHandle> {
macos::show_notification(self)
}
/// Sends Notification to `NSUserNotificationCenter`.
///
/// Returns an `Ok` no matter what, since there is currently no way of telling the success of
/// the notification.
#[cfg(target_os = "windows")]
pub fn show(&self) -> Result<()> {
windows::show_notification(self)
}
/// Wraps [`Notification::show()`] but prints notification to stdout.
#[cfg(all(unix, not(target_os = "macos")))]
#[deprecated = "this was never meant to be public API"]
pub fn show_debug(&mut self) -> Result<xdg::NotificationHandle> {
println!(
"Notification:\n{appname}: ({icon}) {summary:?} {body:?}\nhints: [{hints:?}]\n",
appname = self.appname,
summary = self.summary,
body = self.body,
hints = self.hints,
icon = self.icon,
);
self.show()
}
}
impl Default for Notification {
#[cfg(all(unix, not(target_os = "macos")))]
fn default() -> Notification {
Notification {
appname: exe_name(),
summary: String::new(),
subtitle: None,
body: String::new(),
icon: String::new(),
hints: HashSet::new(),
hints_unique: HashMap::new(),
actions: Vec::new(),
timeout: Timeout::Default,
bus: Default::default(),
id: None,
}
}
#[cfg(target_os = "macos")]
fn default() -> Notification {
Notification {
appname: exe_name(),
summary: String::new(),
subtitle: None,
body: String::new(),
icon: String::new(),
actions: Vec::new(),
timeout: Timeout::Default,
sound_name: Default::default(),
id: None,
}
}
#[cfg(target_os = "windows")]
fn default() -> Notification {
Notification {
appname: exe_name(),
summary: String::new(),
subtitle: None,
body: String::new(),
icon: String::new(),
actions: Vec::new(),
timeout: Timeout::Default,
sound_name: Default::default(),
id: None,
path_to_image: None,
app_id: None,
}
}
}