[pve-devel] [PATCH proxmox 04/18] notification: implement gotify endpoint

[Lukas Wagner]

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.wagner at proxmox.com>
---
 proxmox-notification/src/config.rs           |  9 +++
 proxmox-notification/src/endpoints/gotify.rs | 80 ++++++++++++++++++++
 proxmox-notification/src/endpoints/mod.rs    |  1 +
 proxmox-notification/src/filter.rs           |  1 +
 proxmox-notification/src/lib.rs              | 13 +++-
 5 files changed, 103 insertions(+), 1 deletion(-)
 create mode 100644 proxmox-notification/src/endpoints/gotify.rs

diff --git a/proxmox-notification/src/config.rs b/proxmox-notification/src/config.rs
index 939bdb6..e2454b6 100644
--- a/proxmox-notification/src/config.rs
+++ b/proxmox-notification/src/config.rs
@@ -3,6 +3,8 @@ use lazy_static::lazy_static;
 use proxmox_schema::{const_regex, ApiStringFormat, ApiType, ObjectSchema, Schema, StringSchema};
 use proxmox_section_config::{SectionConfig, SectionConfigData, SectionConfigPlugin};
 
+use crate::endpoints::gotify::GotifyConfig;
+use crate::endpoints::gotify::GOTIFY_TYPENAME;
 use crate::endpoints::sendmail::SendmailConfig;
 use crate::endpoints::sendmail::SENDMAIL_TYPENAME;
 use crate::filter::{FilterConfig, FILTER_TYPENAME};
@@ -33,6 +35,7 @@ fn init() -> SectionConfig {
     let mut config = SectionConfig::new(&BACKEND_NAME_SCHEMA);
 
     const SENDMAIL_SCHEMA: &ObjectSchema = SendmailConfig::API_SCHEMA.unwrap_object_schema();
+    const GOTIFY_SCHEMA: &ObjectSchema = GotifyConfig::API_SCHEMA.unwrap_object_schema();
 
     const FILTER_SCHEMA: &ObjectSchema = FilterConfig::API_SCHEMA.unwrap_object_schema();
 
@@ -42,6 +45,12 @@ fn init() -> SectionConfig {
         SENDMAIL_SCHEMA,
     ));
 
+    config.register_plugin(SectionConfigPlugin::new(
+        GOTIFY_TYPENAME.to_string(),
+        Some(String::from("name")),
+        GOTIFY_SCHEMA,
+    ));
+
     config.register_plugin(SectionConfigPlugin::new(
         FILTER_TYPENAME.to_string(),
         Some(String::from("name")),
diff --git a/proxmox-notification/src/endpoints/gotify.rs b/proxmox-notification/src/endpoints/gotify.rs
new file mode 100644
index 0000000..3972bfe
--- /dev/null
+++ b/proxmox-notification/src/endpoints/gotify.rs
@@ -0,0 +1,80 @@
+use std::collections::HashMap;
+
+use crate::{Endpoint, Notification, Severity};
+use anyhow::Error;
+
+use proxmox_schema::{api, Updater};
+use serde::{Deserialize, Serialize};
+
+use proxmox_http::client::sync::Client;
+use proxmox_http::{HttpClient, HttpOptions};
+
+#[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()]
+#[derive(Serialize, Deserialize, Updater)]
+#[serde(rename_all = "kebab-case")]
+/// Config for  Gotify notification endpoints
+pub struct GotifyConfig {
+    /// Name of the endpoint
+    pub name: String,
+    /// Gotify Server URL
+    pub server: String,
+    /// Authentication token
+    pub token: String,
+    /// Filter to apply
+    #[serde(skip_serializing_if = "Option::is_none")]
+    pub filter: Option<String>,
+}
+
+impl Endpoint for GotifyConfig {
+    fn send(&self, notification: &Notification) -> Result<(), Error> {
+        // TODO: What about proxy configuration?
+        let client = Client::new(HttpOptions::default());
+
+        let uri = format!("{}/message", self.server);
+
+        let body = GotifyMessageBody {
+            title: &notification.title,
+            message: &notification.body,
+            priority: severity_to_priority(notification.severity),
+        };
+
+        let body = serde_json::to_vec(&body)?;
+        let extra_headers =
+            HashMap::from([("Authorization".into(), format!("Bearer {}", self.token))]);
+
+        client.post(
+            &uri,
+            Some(body.as_slice()),
+            Some("application/json"),
+            Some(&extra_headers),
+        )?;
+
+        Ok(())
+    }
+
+    fn name(&self) -> &str {
+        &self.name
+    }
+
+    fn filter(&self) -> Option<&str> {
+        self.filter.as_deref()
+    }
+}
diff --git a/proxmox-notification/src/endpoints/mod.rs b/proxmox-notification/src/endpoints/mod.rs
index 2d7b9ba..481d75b 100644
--- a/proxmox-notification/src/endpoints/mod.rs
+++ b/proxmox-notification/src/endpoints/mod.rs
@@ -1 +1,2 @@
+pub(crate) mod gotify;
 pub(crate) mod sendmail;
diff --git a/proxmox-notification/src/filter.rs b/proxmox-notification/src/filter.rs
index 9846e93..3b7b19d 100644
--- a/proxmox-notification/src/filter.rs
+++ b/proxmox-notification/src/filter.rs
@@ -74,6 +74,7 @@ pub struct FilterConfig {
     pub name: String,
 
     /// Minimum severity to match
+    #[serde(skip_serializing_if = "Option::is_none")]
     pub min_severity: Option<Severity>,
 
     /// Subfilter, allows arbitrary nesting (no recursion allowed)
diff --git a/proxmox-notification/src/lib.rs b/proxmox-notification/src/lib.rs
index c688a10..fc724dd 100644
--- a/proxmox-notification/src/lib.rs
+++ b/proxmox-notification/src/lib.rs
@@ -2,6 +2,8 @@ use std::collections::HashMap;
 
 use anyhow::Error;
 
+use endpoints::gotify::GotifyConfig;
+use endpoints::gotify::GOTIFY_TYPENAME;
 use endpoints::sendmail::SendmailConfig;
 use endpoints::sendmail::SENDMAIL_TYPENAME;
 use filter::{FilterConfig, FilterMatcher, FILTER_TYPENAME};
@@ -11,7 +13,7 @@ use serde::{Deserialize, Serialize};
 
 mod config;
 mod endpoints;
-mod filter;
+pub mod filter;
 
 #[api()]
 #[derive(Clone, Debug, Copy, Serialize, Deserialize, PartialEq, Eq, PartialOrd)]
@@ -86,6 +88,8 @@ impl Config {
         let sendmail_endpoints: Vec<SendmailConfig> =
             self.0.convert_to_typed_array(SENDMAIL_TYPENAME)?;
 
+        let gotify_endpoints: Vec<GotifyConfig> = self.0.convert_to_typed_array(GOTIFY_TYPENAME)?;
+
         endpoints.extend(
             sendmail_endpoints
                 .into_iter()
@@ -93,6 +97,13 @@ impl Config {
                 .map(|e| e as Box<dyn Endpoint>),
         );
 
+        endpoints.extend(
+            gotify_endpoints
+                .into_iter()
+                .map(Box::new)
+                .map(|e| e as Box<dyn Endpoint>),
+        );
+
         let filters = self.0.convert_to_typed_array(FILTER_TYPENAME)?;
 
         Ok(Bus { endpoints, filters })
-- 
2.30.2