use std::os::unix::io::RawFd; use std::path::{Path, PathBuf}; use std::str::FromStr; use anyhow::{bail, format_err, Error}; use pbs_api_types::{ BACKUP_ID_REGEX, BACKUP_TYPE_REGEX, BACKUP_DATE_REGEX, GROUP_PATH_REGEX, SNAPSHOT_PATH_REGEX, BACKUP_FILE_REGEX, GroupFilter, }; use super::manifest::MANIFEST_BLOB_NAME; /// BackupGroup is a directory containing a list of BackupDir #[derive(Debug, Eq, PartialEq, Hash, Clone)] pub struct BackupGroup { /// Type of backup backup_type: String, /// Unique (for this type) ID backup_id: String, } impl std::cmp::Ord for BackupGroup { fn cmp(&self, other: &Self) -> std::cmp::Ordering { let type_order = self.backup_type.cmp(&other.backup_type); if type_order != std::cmp::Ordering::Equal { return type_order; } // try to compare IDs numerically let id_self = self.backup_id.parse::(); let id_other = other.backup_id.parse::(); match (id_self, id_other) { (Ok(id_self), Ok(id_other)) => id_self.cmp(&id_other), (Ok(_), Err(_)) => std::cmp::Ordering::Less, (Err(_), Ok(_)) => std::cmp::Ordering::Greater, _ => self.backup_id.cmp(&other.backup_id), } } } impl std::cmp::PartialOrd for BackupGroup { fn partial_cmp(&self, other: &Self) -> Option { Some(self.cmp(other)) } } impl BackupGroup { pub fn new, U: Into>(backup_type: T, backup_id: U) -> Self { Self { backup_type: backup_type.into(), backup_id: backup_id.into(), } } pub fn backup_type(&self) -> &str { &self.backup_type } pub fn backup_id(&self) -> &str { &self.backup_id } pub fn group_path(&self) -> PathBuf { let mut relative_path = PathBuf::new(); relative_path.push(&self.backup_type); relative_path.push(&self.backup_id); relative_path } pub fn list_backups(&self, base_path: &Path) -> Result, Error> { let mut list = vec![]; let mut path = base_path.to_owned(); path.push(self.group_path()); proxmox_sys::fs::scandir( libc::AT_FDCWD, &path, &BACKUP_DATE_REGEX, |l2_fd, backup_time, file_type| { if file_type != nix::dir::Type::Directory { return Ok(()); } let backup_dir = BackupDir::with_rfc3339(&self.backup_type, &self.backup_id, backup_time)?; let files = list_backup_files(l2_fd, backup_time)?; let protected = backup_dir.is_protected(base_path.to_owned()); list.push(BackupInfo { backup_dir, files, protected }); Ok(()) }, )?; Ok(list) } pub fn last_successful_backup(&self, base_path: &Path) -> Result, Error> { let mut last = None; let mut path = base_path.to_owned(); path.push(self.group_path()); proxmox_sys::fs::scandir( libc::AT_FDCWD, &path, &BACKUP_DATE_REGEX, |l2_fd, backup_time, file_type| { if file_type != nix::dir::Type::Directory { return Ok(()); } let mut manifest_path = PathBuf::from(backup_time); manifest_path.push(MANIFEST_BLOB_NAME); use nix::fcntl::{openat, OFlag}; match openat( l2_fd, &manifest_path, OFlag::O_RDONLY, nix::sys::stat::Mode::empty(), ) { Ok(rawfd) => { /* manifest exists --> assume backup was successful */ /* close else this leaks! */ nix::unistd::close(rawfd)?; } Err(nix::Error::Sys(nix::errno::Errno::ENOENT)) => { return Ok(()); } Err(err) => { bail!("last_successful_backup: unexpected error - {}", err); } } let timestamp = proxmox_time::parse_rfc3339(backup_time)?; if let Some(last_timestamp) = last { if timestamp > last_timestamp { last = Some(timestamp); } } else { last = Some(timestamp); } Ok(()) }, )?; Ok(last) } pub fn matches(&self, filter: &GroupFilter) -> bool { match filter { GroupFilter::Group(backup_group) => match BackupGroup::from_str(backup_group) { Ok(group) => &group == self, Err(_) => false, // shouldn't happen if value is schema-checked }, GroupFilter::BackupType(backup_type) => self.backup_type() == backup_type, GroupFilter::Regex(regex) => regex.is_match(&self.to_string()), } } } impl std::fmt::Display for BackupGroup { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { let backup_type = self.backup_type(); let id = self.backup_id(); write!(f, "{}/{}", backup_type, id) } } impl std::str::FromStr for BackupGroup { type Err = Error; /// Parse a backup group path /// /// This parses strings like `vm/100". fn from_str(path: &str) -> Result { let cap = GROUP_PATH_REGEX .captures(path) .ok_or_else(|| format_err!("unable to parse backup group path '{}'", path))?; Ok(Self { backup_type: cap.get(1).unwrap().as_str().to_owned(), backup_id: cap.get(2).unwrap().as_str().to_owned(), }) } } /// Uniquely identify a Backup (relative to data store) /// /// We also call this a backup snaphost. #[derive(Debug, Eq, PartialEq, Clone)] pub struct BackupDir { /// Backup group group: BackupGroup, /// Backup timestamp backup_time: i64, // backup_time as rfc3339 backup_time_string: String, } impl BackupDir { pub fn new(backup_type: T, backup_id: U, backup_time: i64) -> Result where T: Into, U: Into, { let group = BackupGroup::new(backup_type.into(), backup_id.into()); BackupDir::with_group(group, backup_time) } pub fn with_rfc3339( backup_type: T, backup_id: U, backup_time_string: V, ) -> Result where T: Into, U: Into, V: Into, { let backup_time_string = backup_time_string.into(); let backup_time = proxmox_time::parse_rfc3339(&backup_time_string)?; let group = BackupGroup::new(backup_type.into(), backup_id.into()); Ok(Self { group, backup_time, backup_time_string, }) } pub fn with_group(group: BackupGroup, backup_time: i64) -> Result { let backup_time_string = Self::backup_time_to_string(backup_time)?; Ok(Self { group, backup_time, backup_time_string, }) } pub fn group(&self) -> &BackupGroup { &self.group } pub fn backup_time(&self) -> i64 { self.backup_time } pub fn backup_time_string(&self) -> &str { &self.backup_time_string } pub fn relative_path(&self) -> PathBuf { let mut relative_path = self.group.group_path(); relative_path.push(self.backup_time_string.clone()); relative_path } pub fn protected_file(&self, mut path: PathBuf) -> PathBuf { path.push(self.relative_path()); path.push(".protected"); path } pub fn is_protected(&self, base_path: PathBuf) -> bool { let path = self.protected_file(base_path); path.exists() } pub fn backup_time_to_string(backup_time: i64) -> Result { // fixme: can this fail? (avoid unwrap) Ok(proxmox_time::epoch_to_rfc3339_utc(backup_time)?) } } impl std::str::FromStr for BackupDir { type Err = Error; /// Parse a snapshot path /// /// This parses strings like `host/elsa/2020-06-15T05:18:33Z". fn from_str(path: &str) -> Result { let cap = SNAPSHOT_PATH_REGEX .captures(path) .ok_or_else(|| format_err!("unable to parse backup snapshot path '{}'", path))?; BackupDir::with_rfc3339( cap.get(1).unwrap().as_str(), cap.get(2).unwrap().as_str(), cap.get(3).unwrap().as_str(), ) } } impl std::fmt::Display for BackupDir { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { let backup_type = self.group.backup_type(); let id = self.group.backup_id(); write!(f, "{}/{}/{}", backup_type, id, self.backup_time_string) } } /// Detailed Backup Information, lists files inside a BackupDir #[derive(Debug, Clone)] pub struct BackupInfo { /// the backup directory pub backup_dir: BackupDir, /// List of data files pub files: Vec, /// Protection Status pub protected: bool, } impl BackupInfo { pub fn new(base_path: &Path, backup_dir: BackupDir) -> Result { let mut path = base_path.to_owned(); path.push(backup_dir.relative_path()); let files = list_backup_files(libc::AT_FDCWD, &path)?; let protected = backup_dir.is_protected(base_path.to_owned()); Ok(BackupInfo { backup_dir, files, protected }) } /// Finds the latest backup inside a backup group pub fn last_backup( base_path: &Path, group: &BackupGroup, only_finished: bool, ) -> Result, Error> { let backups = group.list_backups(base_path)?; Ok(backups .into_iter() .filter(|item| !only_finished || item.is_finished()) .max_by_key(|item| item.backup_dir.backup_time())) } pub fn sort_list(list: &mut Vec, ascendending: bool) { if ascendending { // oldest first list.sort_unstable_by(|a, b| a.backup_dir.backup_time.cmp(&b.backup_dir.backup_time)); } else { // newest first list.sort_unstable_by(|a, b| b.backup_dir.backup_time.cmp(&a.backup_dir.backup_time)); } } pub fn list_files(base_path: &Path, backup_dir: &BackupDir) -> Result, Error> { let mut path = base_path.to_owned(); path.push(backup_dir.relative_path()); let files = list_backup_files(libc::AT_FDCWD, &path)?; Ok(files) } pub fn list_backup_groups(base_path: &Path) -> Result, Error> { let mut list = Vec::new(); proxmox_sys::fs::scandir( libc::AT_FDCWD, base_path, &BACKUP_TYPE_REGEX, |l0_fd, backup_type, file_type| { if file_type != nix::dir::Type::Directory { return Ok(()); } proxmox_sys::fs::scandir( l0_fd, backup_type, &BACKUP_ID_REGEX, |_, backup_id, file_type| { if file_type != nix::dir::Type::Directory { return Ok(()); } list.push(BackupGroup::new(backup_type, backup_id)); Ok(()) }, ) }, )?; Ok(list) } pub fn is_finished(&self) -> bool { // backup is considered unfinished if there is no manifest self.files .iter() .any(|name| name == MANIFEST_BLOB_NAME) } } fn list_backup_files( dirfd: RawFd, path: &P, ) -> Result, Error> { let mut files = vec![]; proxmox_sys::fs::scandir(dirfd, path, &BACKUP_FILE_REGEX, |_, filename, file_type| { if file_type != nix::dir::Type::File { return Ok(()); } files.push(filename.to_owned()); Ok(()) })?; Ok(files) }