From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68])
by lore.proxmox.com (Postfix) with ESMTPS id 05B8E1FF2D5
for <inbox@lore.proxmox.com>; Wed, 10 Jul 2024 09:49:01 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 8F7603DCF;
Wed, 10 Jul 2024 09:49:23 +0200 (CEST)
From: Christian Ebner <c.ebner@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Wed, 10 Jul 2024 09:48:53 +0200
Message-Id: <20240710074856.27706-3-c.ebner@proxmox.com>
X-Mailer: git-send-email 2.39.2
In-Reply-To: <20240710074856.27706-1-c.ebner@proxmox.com>
References: <20240710074856.27706-1-c.ebner@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.021 Adjusted score from AWL reputation of From: address
BAYES_00 -1.9 Bayes spam probability is 0 to 1%
DMARC_MISSING 0.1 Missing DMARC policy
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
URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See
http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more
information. [self.name, datastore.rs]
Subject: [pbs-devel] [PATCH v2 proxmox-backup 2/5] api types: introduce
`BackupArchiveName` type
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>
Introduces a dedicated wrapper type to be used for backup archive
names instead of String.
Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
changes since version 1:
- add missing check for invalid archive names ending in '/'
- import traits at top
- inlined variable names in format strings
pbs-api-types/src/datastore.rs | 107 ++++++++++++++++++++++++++++++++-
1 file changed, 106 insertions(+), 1 deletion(-)
diff --git a/pbs-api-types/src/datastore.rs b/pbs-api-types/src/datastore.rs
index dfa6bb259..e9e51419a 100644
--- a/pbs-api-types/src/datastore.rs
+++ b/pbs-api-types/src/datastore.rs
@@ -1,5 +1,7 @@
use std::fmt;
use std::path::{Path, PathBuf};
+use std::str::FromStr;
+use std::convert::{AsRef, TryFrom};
use anyhow::{bail, format_err, Error};
use const_format::concatcp;
@@ -1570,7 +1572,7 @@ pub fn print_store_and_ns(store: &str, ns: &BackupNamespace) -> String {
}
}
-#[derive(PartialEq, Eq)]
+#[derive(Clone, PartialEq, Eq)]
/// Allowed variants of backup archives to be contained in a snapshot's manifest
pub enum ArchiveType {
FixedIndex,
@@ -1590,3 +1592,106 @@ impl ArchiveType {
Ok(archive_type)
}
}
+
+#[derive(Clone, PartialEq, Eq)]
+/// Name of archive files contained in snapshot's manifest
+pub struct BackupArchiveName {
+ // archive name including the `.fidx`, `.didx` or `.blob` extension
+ name: String,
+ // type parsed based on given extension
+ ty: ArchiveType,
+}
+
+impl fmt::Display for BackupArchiveName {
+ fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
+ write!(f, "{name}", name = self.name)
+ }
+}
+
+serde_plain::derive_deserialize_from_fromstr!(BackupArchiveName, "archive name");
+
+impl FromStr for BackupArchiveName {
+ type Err = Error;
+
+ fn from_str(name: &str) -> Result<Self, Self::Err> {
+ Self::try_from(name)
+ }
+}
+
+serde_plain::derive_serialize_from_display!(BackupArchiveName);
+
+impl TryFrom<&str> for BackupArchiveName {
+ type Error = anyhow::Error;
+
+ fn try_from(value: &str) -> Result<Self, Self::Error> {
+ let (name, ty) = Self::parse_archive_type(value)?;
+ Ok(Self { name, ty })
+ }
+}
+
+impl AsRef<str> for BackupArchiveName {
+ fn as_ref(&self) -> &str {
+ &self.name
+ }
+}
+
+impl BackupArchiveName {
+ pub fn from_path(path: impl AsRef<Path>) -> Result<Self, Error> {
+ let path = path.as_ref();
+ if path.as_os_str().as_encoded_bytes().last() == Some(&b'/') {
+ bail!("invalid archive name, got directory");
+ }
+ let file_name = path
+ .file_name()
+ .ok_or_else(|| format_err!("invalid archive name"))?;
+ let name = file_name
+ .to_str()
+ .ok_or_else(|| format_err!("archive name not valid UTF-8"))?;
+
+ Self::try_from(name)
+ }
+
+ pub fn archive_type(&self) -> ArchiveType {
+ self.ty.clone()
+ }
+
+ pub fn ends_with(&self, postfix: &str) -> bool {
+ self.name.ends_with(postfix)
+ }
+
+ pub fn has_pxar_filename_extension(&self) -> bool {
+ self.name.ends_with(".pxar.didx")
+ || self.name.ends_with(".mpxar.didx")
+ || self.name.ends_with(".ppxar.didx")
+ }
+
+ pub fn without_type_extension(&self) -> String {
+ match self.ty {
+ ArchiveType::DynamicIndex => self.name.strip_suffix(".didx").unwrap().into(),
+ ArchiveType::FixedIndex => self.name.strip_suffix(".fidx").unwrap().into(),
+ ArchiveType::Blob => self.name.strip_suffix(".blob").unwrap().into(),
+ }
+ }
+
+ fn parse_archive_type(archive_name: &str) -> Result<(String, ArchiveType), Error> {
+ if archive_name.ends_with(".didx")
+ || archive_name.ends_with(".fidx")
+ || archive_name.ends_with(".blob")
+ {
+ Ok((archive_name.into(), ArchiveType::from_path(archive_name)?))
+ } else if archive_name.ends_with(".pxar")
+ || archive_name.ends_with(".mpxar")
+ || archive_name.ends_with(".ppxar")
+ {
+ Ok((format!("{archive_name}.didx"), ArchiveType::DynamicIndex))
+ } else if archive_name.ends_with(".img") {
+ Ok((format!("{archive_name}.fidx"), ArchiveType::FixedIndex))
+ } else {
+ Ok((format!("{archive_name}.blob"), ArchiveType::Blob))
+ }
+ }
+}
+
+impl ApiType for BackupArchiveName {
+ const API_SCHEMA: Schema = BACKUP_ARCHIVE_NAME_SCHEMA;
+}
--
2.39.2
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel