From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 0F57664C6C; Fri, 4 Mar 2022 12:32:19 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 049823B0C; Fri, 4 Mar 2022 12:32:19 +0100 (CET) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 857413A6E; Fri, 4 Mar 2022 12:32:14 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 50F0746EC7; Fri, 4 Mar 2022 12:32:14 +0100 (CET) From: Stefan Sterz To: pbs-devel@lists.proxmox.com, pve-devel@lists.proxmox.com Date: Fri, 4 Mar 2022 12:31:57 +0100 Message-Id: <20220304113202.4137916-2-s.sterz@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220304113202.4137916-1-s.sterz@proxmox.com> References: <20220304113202.4137916-1-s.sterz@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.000 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pve-devel] [PATCH proxmox-backup v3 1/6] fix #3067: api: add support for multi-line comments in node.cfg X-BeenThere: pve-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox VE development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Fri, 04 Mar 2022 11:32:19 -0000 add support for multi-line comments to node.cfg and the api, similar to how pve handles multi-line comments Signed-off-by: Stefan Sterz --- pbs-api-types/src/lib.rs | 9 +++++++ src/api2/node/config.rs | 4 +++ src/config/node.rs | 14 +++++++++- src/tools/config.rs | 56 ++++++++++++++++++++++++++++++++++++++-- 4 files changed, 80 insertions(+), 3 deletions(-) diff --git a/pbs-api-types/src/lib.rs b/pbs-api-types/src/lib.rs index 754e7b22..3b1fad2c 100644 --- a/pbs-api-types/src/lib.rs +++ b/pbs-api-types/src/lib.rs @@ -137,6 +137,8 @@ const_regex! { pub SINGLE_LINE_COMMENT_REGEX = r"^[[:^cntrl:]]*$"; + pub MULTI_LINE_COMMENT_REGEX = r"(?m)^([[:^cntrl:]]*)$"; + pub BACKUP_REPO_URL_REGEX = concat!( r"^^(?:(?:(", USER_ID_REGEX_STR!(), "|", APITOKEN_ID_REGEX_STR!(), @@ -273,6 +275,13 @@ pub const SINGLE_LINE_COMMENT_SCHEMA: Schema = StringSchema::new("Comment (singl .format(&SINGLE_LINE_COMMENT_FORMAT) .schema(); +pub const MULTI_LINE_COMMENT_FORMAT: ApiStringFormat = + ApiStringFormat::Pattern(&MULTI_LINE_COMMENT_REGEX); + +pub const MULTI_LINE_COMMENT_SCHEMA: Schema = StringSchema::new("Comment (multiple lines).") + .format(&MULTI_LINE_COMMENT_FORMAT) + .schema(); + pub const SUBSCRIPTION_KEY_SCHEMA: Schema = StringSchema::new("Proxmox Backup Server subscription key.") .format(&SUBSCRIPTION_KEY_FORMAT) .min_length(15) diff --git a/src/api2/node/config.rs b/src/api2/node/config.rs index 0a119354..3b267adc 100644 --- a/src/api2/node/config.rs +++ b/src/api2/node/config.rs @@ -64,6 +64,8 @@ pub enum DeletableProperty { ciphers_tls_1_2, /// Delete the default-lang property. default_lang, + /// Delete any description + description, } #[api( @@ -124,6 +126,7 @@ pub fn update_node_config( DeletableProperty::ciphers_tls_1_3 => { config.ciphers_tls_1_3 = None; }, DeletableProperty::ciphers_tls_1_2 => { config.ciphers_tls_1_2 = None; }, DeletableProperty::default_lang => { config.default_lang = None; }, + DeletableProperty::description => { config.description = None; }, } } } @@ -139,6 +142,7 @@ pub fn update_node_config( if update.ciphers_tls_1_3.is_some() { config.ciphers_tls_1_3 = update.ciphers_tls_1_3; } if update.ciphers_tls_1_2.is_some() { config.ciphers_tls_1_2 = update.ciphers_tls_1_2; } if update.default_lang.is_some() { config.default_lang = update.default_lang; } + if update.description.is_some() { config.description = update.description; } crate::config::node::save_config(&config)?; diff --git a/src/config/node.rs b/src/config/node.rs index 0ba87450..ac6774e3 100644 --- a/src/config/node.rs +++ b/src/config/node.rs @@ -8,7 +8,11 @@ use proxmox_schema::{api, ApiStringFormat, ApiType, Updater}; use proxmox_http::ProxyConfig; -use pbs_api_types::{EMAIL_SCHEMA, OPENSSL_CIPHERS_TLS_1_2_SCHEMA, OPENSSL_CIPHERS_TLS_1_3_SCHEMA}; +use pbs_api_types::{ + EMAIL_SCHEMA, MULTI_LINE_COMMENT_SCHEMA, OPENSSL_CIPHERS_TLS_1_2_SCHEMA, + OPENSSL_CIPHERS_TLS_1_3_SCHEMA, +}; + use pbs_buildcfg::configdir; use pbs_config::{open_backup_lockfile, BackupLockGuard}; @@ -167,6 +171,10 @@ pub enum Translation { "default-lang" : { schema: Translation::API_SCHEMA, optional: true, + }, + "description" : { + optional: true, + schema: MULTI_LINE_COMMENT_SCHEMA, } }, )] @@ -210,6 +218,10 @@ pub struct NodeConfig { /// Default language used in the GUI #[serde(skip_serializing_if = "Option::is_none")] pub default_lang: Option, + + /// Node description + #[serde(skip_serializing_if = "Option::is_none")] + pub description: Option, } impl NodeConfig { diff --git a/src/tools/config.rs b/src/tools/config.rs index f666a8ab..cc722094 100644 --- a/src/tools/config.rs +++ b/src/tools/config.rs @@ -31,8 +31,19 @@ pub fn value_from_str(input: &str, schema: &'static Schema) -> Result Result, /// Note: the object must have already been verified at this point. fn object_to_writer(output: &mut dyn Write, object: &Object) -> Result<(), Error> { + // special key `description` for multi-line notes, must be written before everything else + if let Some(Value::String(description)) = object.get("description") { + for lines in description.lines() { + writeln!(output, "#{}", lines)?; + } + } + for (key, value) in object.iter() { match value { - Value::Null => continue, // delete this entry + _ if key == "description" => continue, // skip description as we handle it above + Value::Null => continue, // delete this entry Value::Bool(v) => writeln!(output, "{}: {}", key, v)?, Value::String(v) => { if v.as_bytes().contains(&b'\n') { @@ -172,3 +191,36 @@ fn test() { assert_eq!(config, NODE_CONFIG.as_bytes()); } + +#[test] +fn test_with_comment() { + use proxmox_schema::ApiType; + + // let's just reuse some schema we actually have available: + use crate::config::node::NodeConfig; + + const NODE_INPUT: &str = "\ + #this should\n\ + #be included\n\ + acme: account=pebble\n\ + # this should not\n\ + acmedomain0: test1.invalid.local,plugin=power\n\ + acmedomain1: test2.invalid.local\n\ + "; + + const NODE_OUTPUT: &str = "\ + #this should\n\ + #be included\n\ + acme: account=pebble\n\ + acmedomain0: test1.invalid.local,plugin=power\n\ + acmedomain1: test2.invalid.local\n\ + "; + + let data: NodeConfig = from_str(NODE_INPUT, &NodeConfig::API_SCHEMA) + .expect("failed to parse multi-line notes node config"); + + let config = to_bytes(&data, &NodeConfig::API_SCHEMA) + .expect("failed to serialize multi-line notes node config"); + + assert_eq!(config, NODE_OUTPUT.as_bytes()); +} -- 2.30.2