notify: rename PVE::RS::Notify to Proxmox::RS::Notify

Also splitting PVE-specific context into its own file.

Suggested-by: Wolfgang Bumiller <w.bumiller@proxmox.com>
Signed-off-by: Lukas Wagner <l.wagner@proxmox.com>
This commit is contained in:
Lukas Wagner 2023-07-24 13:26:57 +02:00 committed by Wolfgang Bumiller
parent 69d2eb953d
commit 703cfbd212
5 changed files with 124 additions and 124 deletions

View File

@ -25,6 +25,7 @@ Proxmox/RS/CalendarEvent.pm:
$(PERLMOD_GENPACKAGE) \
Proxmox::RS::APT::Repositories \
Proxmox::RS::CalendarEvent \
Proxmox::RS::Notify \
Proxmox::RS::Subscription
all: Proxmox/RS/CalendarEvent.pm

View File

@ -1,4 +1,5 @@
pub mod apt;
mod calendar_event;
pub mod logger;
pub mod notify;
mod subscription;

View File

@ -1,123 +1,4 @@
use std::path::Path;
use log;
use proxmox_notify::context::Context;
// Some helpers borrowed and slightly adapted from `proxmox-mail-forward`
fn normalize_for_return(s: Option<&str>) -> Option<String> {
match s?.trim() {
"" => None,
s => Some(s.to_string()),
}
}
fn attempt_file_read<P: AsRef<Path>>(path: P) -> Option<String> {
match proxmox_sys::fs::file_read_optional_string(path) {
Ok(contents) => contents,
Err(err) => {
log::error!("{err}");
None
}
}
}
fn lookup_mail_address(content: &str, user: &str) -> Option<String> {
normalize_for_return(content.lines().find_map(|line| {
let fields: Vec<&str> = line.split(':').collect();
#[allow(clippy::get_first)] // to keep expression style consistent
match fields.get(0)?.trim() == "user" && fields.get(1)?.trim() == user {
true => fields.get(6).copied(),
false => None,
}
}))
}
fn lookup_datacenter_config_key(content: &str, key: &str) -> Option<String> {
let key_prefix = format!("{key}:");
normalize_for_return(
content
.lines()
.find_map(|line| line.strip_prefix(&key_prefix)),
)
}
#[derive(Debug)]
struct PVEContext;
impl Context for PVEContext {
fn lookup_email_for_user(&self, user: &str) -> Option<String> {
let content = attempt_file_read("/etc/pve/user.cfg");
content.and_then(|content| lookup_mail_address(&content, user))
}
fn default_sendmail_author(&self) -> String {
"Proxmox VE".into()
}
fn default_sendmail_from(&self) -> String {
let content = attempt_file_read("/etc/pve/datacenter.cfg");
content
.and_then(|content| lookup_datacenter_config_key(&content, "mail_from"))
.unwrap_or_else(|| String::from("root"))
}
fn http_proxy_config(&self) -> Option<String> {
let content = attempt_file_read("/etc/pve/datacenter.cfg");
content.and_then(|content| lookup_datacenter_config_key(&content, "http_proxy"))
}
}
#[cfg(test)]
mod tests {
use crate::notify::{lookup_datacenter_config_key, lookup_mail_address};
const USER_CONFIG: &str = "
user:root@pam:1:0:::root@example.com:::
user:test@pve:1:0:::test@example.com:::
user:no-mail@pve:1:0::::::
";
#[test]
fn test_parse_mail() {
assert_eq!(
lookup_mail_address(USER_CONFIG, "root@pam"),
Some("root@example.com".to_string())
);
assert_eq!(
lookup_mail_address(USER_CONFIG, "test@pve"),
Some("test@example.com".to_string())
);
assert_eq!(lookup_mail_address(USER_CONFIG, "no-mail@pve"), None);
}
const DC_CONFIG: &str = "
email_from: user@example.com
http_proxy: http://localhost:1234
keyboard: en-us
";
#[test]
fn test_parse_dc_config() {
assert_eq!(
lookup_datacenter_config_key(DC_CONFIG, "email_from"),
Some("user@example.com".to_string())
);
assert_eq!(
lookup_datacenter_config_key(DC_CONFIG, "http_proxy"),
Some("http://localhost:1234".to_string())
);
assert_eq!(lookup_datacenter_config_key(DC_CONFIG, "foo"), None);
}
}
static CONTEXT: PVEContext = PVEContext;
pub fn init() {
proxmox_notify::context::set_context(&CONTEXT)
}
#[perlmod::package(name = "PVE::RS::Notify")]
#[perlmod::package(name = "Proxmox::RS::Notify")]
mod export {
use anyhow::{bail, Error};
use perlmod::Value;
@ -141,7 +22,7 @@ mod export {
config: Mutex<Config>,
}
perlmod::declare_magic!(Box<NotificationConfig> : &NotificationConfig as "PVE::RS::Notify");
perlmod::declare_magic!(Box<NotificationConfig> : &NotificationConfig as "Proxmox::RS::Notify");
/// Support `dclone` so this can be put into the `ccache` of `PVE::Cluster`.
#[export(name = "STORABLE_freeze", raw_return)]

View File

@ -4,18 +4,18 @@
pub mod common;
pub mod apt;
pub mod notify;
pub mod notify_context;
pub mod openid;
pub mod resource_scheduling;
pub mod tfa;
#[perlmod::package(name = "Proxmox::Lib::PVE", lib = "pve_rs")]
mod export {
use crate::{common, notify};
use crate::{common, notify_context};
#[export]
pub fn init() {
common::logger::init("PVE_LOG", "info");
notify::init();
notify_context::init();
}
}

View File

@ -0,0 +1,117 @@
use log;
use std::path::Path;
use proxmox_notify::context::Context;
// Some helpers borrowed and slightly adapted from `proxmox-mail-forward`
fn normalize_for_return(s: Option<&str>) -> Option<String> {
match s?.trim() {
"" => None,
s => Some(s.to_string()),
}
}
fn attempt_file_read<P: AsRef<Path>>(path: P) -> Option<String> {
match proxmox_sys::fs::file_read_optional_string(path) {
Ok(contents) => contents,
Err(err) => {
log::error!("{err}");
None
}
}
}
fn lookup_mail_address(content: &str, user: &str) -> Option<String> {
normalize_for_return(content.lines().find_map(|line| {
let fields: Vec<&str> = line.split(':').collect();
#[allow(clippy::get_first)] // to keep expression style consistent
match fields.get(0)?.trim() == "user" && fields.get(1)?.trim() == user {
true => fields.get(6).copied(),
false => None,
}
}))
}
fn lookup_datacenter_config_key(content: &str, key: &str) -> Option<String> {
let key_prefix = format!("{key}:");
normalize_for_return(
content
.lines()
.find_map(|line| line.strip_prefix(&key_prefix)),
)
}
#[derive(Debug)]
struct PVEContext;
impl Context for PVEContext {
fn lookup_email_for_user(&self, user: &str) -> Option<String> {
let content = attempt_file_read("/etc/pve/user.cfg");
content.and_then(|content| lookup_mail_address(&content, user))
}
fn default_sendmail_author(&self) -> String {
"Proxmox VE".into()
}
fn default_sendmail_from(&self) -> String {
let content = attempt_file_read("/etc/pve/datacenter.cfg");
content
.and_then(|content| lookup_datacenter_config_key(&content, "mail_from"))
.unwrap_or_else(|| String::from("root"))
}
fn http_proxy_config(&self) -> Option<String> {
let content = attempt_file_read("/etc/pve/datacenter.cfg");
content.and_then(|content| lookup_datacenter_config_key(&content, "http_proxy"))
}
}
#[cfg(test)]
mod tests {
use super::*;
const USER_CONFIG: &str = "
user:root@pam:1:0:::root@example.com:::
user:test@pve:1:0:::test@example.com:::
user:no-mail@pve:1:0::::::
";
#[test]
fn test_parse_mail() {
assert_eq!(
lookup_mail_address(USER_CONFIG, "root@pam"),
Some("root@example.com".to_string())
);
assert_eq!(
lookup_mail_address(USER_CONFIG, "test@pve"),
Some("test@example.com".to_string())
);
assert_eq!(lookup_mail_address(USER_CONFIG, "no-mail@pve"), None);
}
const DC_CONFIG: &str = "
email_from: user@example.com
http_proxy: http://localhost:1234
keyboard: en-us
";
#[test]
fn test_parse_dc_config() {
assert_eq!(
lookup_datacenter_config_key(DC_CONFIG, "email_from"),
Some("user@example.com".to_string())
);
assert_eq!(
lookup_datacenter_config_key(DC_CONFIG, "http_proxy"),
Some("http://localhost:1234".to_string())
);
assert_eq!(lookup_datacenter_config_key(DC_CONFIG, "foo"), None);
}
}
static CONTEXT: PVEContext = PVEContext;
pub fn init() {
proxmox_notify::context::set_context(&CONTEXT)
}