Add an endpoint for Gotify [1], showing the how easy it is to add new endpoint implementations.
[1] https://gotify.net/ Signed-off-by: Lukas Wagner <l.wag...@proxmox.com> --- proxmox-notify/Cargo.toml | 6 +- proxmox-notify/src/config.rs | 22 +++++ proxmox-notify/src/endpoints/gotify.rs | 116 +++++++++++++++++++++++++ proxmox-notify/src/endpoints/mod.rs | 2 + proxmox-notify/src/lib.rs | 17 +++- 5 files changed, 160 insertions(+), 3 deletions(-) create mode 100644 proxmox-notify/src/endpoints/gotify.rs diff --git a/proxmox-notify/Cargo.toml b/proxmox-notify/Cargo.toml index f7329295..738674ae 100644 --- a/proxmox-notify/Cargo.toml +++ b/proxmox-notify/Cargo.toml @@ -12,6 +12,7 @@ handlebars = { workspace = true, optional = true } lazy_static.workspace = true log.workspace = true openssl.workspace = true +proxmox-http = { workspace = true, features = ["client-sync"], optional = true } proxmox-schema = { workspace = true, features = ["api-macro"]} proxmox-section-config = { workspace = true } proxmox-sys = { workspace = true, optional = true } @@ -20,5 +21,6 @@ serde = { workspace = true, features = ["derive"]} serde_json.workspace = true [features] -default = ["sendmail"] -sendmail = ["dep:handlebars", "dep:proxmox-sys"] \ No newline at end of file +default = ["sendmail", "gotify"] +sendmail = ["dep:handlebars", "dep:proxmox-sys"] +gotify = ["dep:proxmox-http"] diff --git a/proxmox-notify/src/config.rs b/proxmox-notify/src/config.rs index 2ef237fa..a73b7849 100644 --- a/proxmox-notify/src/config.rs +++ b/proxmox-notify/src/config.rs @@ -25,7 +25,17 @@ fn config_init() -> SectionConfig { SENDMAIL_SCHEMA, )); } + #[cfg(feature = "gotify")] + { + use crate::endpoints::gotify::{GotifyConfig, GOTIFY_TYPENAME}; + const GOTIFY_SCHEMA: &ObjectSchema = GotifyConfig::API_SCHEMA.unwrap_object_schema(); + config.register_plugin(SectionConfigPlugin::new( + GOTIFY_TYPENAME.to_string(), + Some(String::from("name")), + GOTIFY_SCHEMA, + )); + } const CHANNEL_SCHEMA: &ObjectSchema = ChannelConfig::API_SCHEMA.unwrap_object_schema(); config.register_plugin(SectionConfigPlugin::new( @@ -40,6 +50,18 @@ fn config_init() -> SectionConfig { fn private_config_init() -> SectionConfig { let mut config = SectionConfig::new(&BACKEND_NAME_SCHEMA); + #[cfg(feature = "gotify")] + { + use crate::endpoints::gotify::{GotifyPrivateConfig, GOTIFY_TYPENAME}; + + const GOTIFY_SCHEMA: &ObjectSchema = GotifyPrivateConfig::API_SCHEMA.unwrap_object_schema(); + config.register_plugin(SectionConfigPlugin::new( + GOTIFY_TYPENAME.to_string(), + Some(String::from("name")), + GOTIFY_SCHEMA, + )); + } + config } diff --git a/proxmox-notify/src/endpoints/gotify.rs b/proxmox-notify/src/endpoints/gotify.rs new file mode 100644 index 00000000..74dd4868 --- /dev/null +++ b/proxmox-notify/src/endpoints/gotify.rs @@ -0,0 +1,116 @@ +use std::collections::HashMap; + +use crate::schema::{COMMENT_SCHEMA, ENTITY_NAME_SCHEMA}; +use crate::{Endpoint, Error, Notification, Severity}; + +use serde::{Deserialize, Serialize}; + +use proxmox_http::client::sync::Client; +use proxmox_http::{HttpClient, HttpOptions}; +use proxmox_schema::{api, Updater}; + +#[derive(Serialize)] +struct GotifyMessageBody<'a> { + title: &'a str, + message: &'a str, + priority: u32, +} + +fn severity_to_priority(level: Severity) -> u32 { + match level { + Severity::Info => 1, + Severity::Notice => 3, + Severity::Warning => 5, + Severity::Error => 9, + } +} + +pub(crate) const GOTIFY_TYPENAME: &str = "gotify"; + +#[api( + properties: { + name: { + schema: ENTITY_NAME_SCHEMA, + }, + comment: { + optional: true, + schema: COMMENT_SCHEMA, + }, + } +)] +#[derive(Serialize, Deserialize, Updater)] +#[serde(rename_all = "kebab-case")] +/// Config for Gotify notification endpoints +pub struct GotifyConfig { + /// Name of the endpoint + #[updater(skip)] + pub name: String, + /// Gotify Server URL + pub server: String, + /// Comment + #[serde(skip_serializing_if = "Option::is_none")] + pub comment: Option<String>, +} + +#[api()] +#[derive(Serialize, Deserialize, Clone, Updater)] +#[serde(rename_all = "kebab-case")] +/// Private configuration for Gotify notification endpoints. +/// This config will be saved to a separate configuration file with stricter +/// permissions (root:root 0600) +pub struct GotifyPrivateConfig { + /// Name of the endpoint + #[updater(skip)] + pub name: String, + /// Authentication token + pub token: String, +} + +/// A Gotify notification endpoint. +pub struct GotifyEndpoint { + pub config: GotifyConfig, + pub private_config: GotifyPrivateConfig, +} + +#[derive(Serialize, Deserialize)] +#[serde(rename_all = "kebab-case")] +pub enum DeleteableGotifyProperty { + Comment, +} + +impl Endpoint for GotifyEndpoint { + fn send(&self, notification: &Notification) -> Result<(), Error> { + // TODO: What about proxy configuration? + let client = Client::new(HttpOptions::default()); + + let uri = format!("{}/message", self.config.server); + + let body = GotifyMessageBody { + title: ¬ification.title, + message: ¬ification.body, + priority: severity_to_priority(notification.severity), + }; + + let body = serde_json::to_vec(&body) + .map_err(|err| Error::NotifyFailed(self.name().to_string(), err.into()))?; + let extra_headers = HashMap::from([( + "Authorization".into(), + format!("Bearer {}", self.private_config.token), + )]); + + client + .post( + &uri, + Some(body.as_slice()), + Some("application/json"), + Some(&extra_headers), + ) + .map_err(|err| Error::NotifyFailed(self.name().to_string(), err.into()))?; + + Ok(()) + } + + fn name(&self) -> &str { + &self.config.name + } +} diff --git a/proxmox-notify/src/endpoints/mod.rs b/proxmox-notify/src/endpoints/mod.rs index dd80d9bc..d1cec654 100644 --- a/proxmox-notify/src/endpoints/mod.rs +++ b/proxmox-notify/src/endpoints/mod.rs @@ -1,2 +1,4 @@ +#[cfg(feature = "gotify")] +pub mod gotify; #[cfg(feature = "sendmail")] pub mod sendmail; diff --git a/proxmox-notify/src/lib.rs b/proxmox-notify/src/lib.rs index ee89d100..147dbc3c 100644 --- a/proxmox-notify/src/lib.rs +++ b/proxmox-notify/src/lib.rs @@ -213,7 +213,6 @@ impl Bus { let mut endpoints = Vec::new(); // Instantiate endpoints - #[cfg(feature = "sendmail")] { use endpoints::sendmail::SENDMAIL_TYPENAME; @@ -229,6 +228,22 @@ impl Bus { ); } + #[cfg(features = "gotify")] + { + use endpoints::sendmail::GOTIFY_TYPENAME; + use endpoints::sendmail::{GotifyConfig, GotifyEndpoint, GotifyPriateConfig}; + endpoints.extend( + parse_endpoints_with_private_config!( + config, + GotifyConfig, + GotifyPrivateConfig, + GotifyEndpoint, + GOTIFY_TYPENAME + )? + .into_iter(), + ); + } + let channels = config .config .convert_to_typed_array(CHANNEL_TYPENAME) -- 2.30.2 _______________________________________________ pve-devel mailing list pve-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
