[pbs-devel] [PATCH proxmox-backup 2/3] client: add helper to dump catalog from metadata archive

[Christian Ebner]

Implements the methods to dump the contents of a metadata pxar
archive using the same output format as used by the catalog dump.

Signed-off-by: Christian Ebner <c.ebner at proxmox.com>
---
 pbs-client/src/tools/mod.rs | 85 ++++++++++++++++++++++++++++++++++++-
 1 file changed, 83 insertions(+), 2 deletions(-)

diff --git a/pbs-client/src/tools/mod.rs b/pbs-client/src/tools/mod.rs
index f2d2f48dc..48ef43696 100644
--- a/pbs-client/src/tools/mod.rs
+++ b/pbs-client/src/tools/mod.rs
@@ -1,12 +1,15 @@
 //! Shared tools useful for common CLI clients.
+use pxar::accessor::aio::FileEntry;
 use std::collections::HashMap;
 use std::env::VarError::{NotPresent, NotUnicode};
 use std::ffi::OsStr;
 use std::fs::File;
+use std::future::Future;
 use std::io::{BufRead, BufReader};
 use std::os::unix::ffi::OsStrExt;
 use std::os::unix::io::FromRawFd;
 use std::path::PathBuf;
+use std::pin::Pin;
 use std::process::Command;
 use std::sync::Arc;
 
@@ -20,12 +23,12 @@ use proxmox_schema::*;
 use proxmox_sys::fs::file_get_json;
 
 use pbs_api_types::{Authid, BackupNamespace, RateLimitConfig, UserWithTokens, BACKUP_REPO_URL};
-use pbs_datastore::catalog::{ArchiveEntry, DirEntryAttribute};
+use pbs_datastore::catalog::{ArchiveEntry, CatalogEntryType, DirEntryAttribute};
 use pbs_datastore::dynamic_index::{BufferedDynamicReader, LocalDynamicReadAt};
 use pbs_datastore::index::IndexFile;
 use pbs_datastore::BackupManifest;
 use pbs_tools::crypt_config::CryptConfig;
-use pxar::accessor::aio::Accessor;
+use pxar::accessor::aio::{Accessor, Directory};
 use pxar::accessor::ReadAt;
 use pxar::format::SignedDuration;
 use pxar::{mode, EntryKind};
@@ -765,3 +768,81 @@ pub async fn pxar_metadata_catalog_lookup<T: Clone + ReadAt>(
 
     Ok(entries)
 }
+
+fn pxar_metadata_catalog_dump_entry<'future, T: Clone + Send + Sync + ReadAt + 'future>(
+    entry: FileEntry<T>,
+    path_prefix: &'future str,
+) -> Pin<Box<dyn Future<Output = Result<(), Error>> + Send + 'future>> {
+    let mut entry_path = PathBuf::from(&path_prefix);
+    match entry.path().strip_prefix("/") {
+        Ok(path) => entry_path.push(path),
+        Err(_) => entry_path.push(entry.path()),
+    }
+
+    Box::pin(async move {
+        match entry.kind() {
+            EntryKind::Version(_) | EntryKind::Prelude(_) | EntryKind::GoodbyeTable => {
+                return Ok(())
+            }
+            EntryKind::Directory => {
+                log::info!("{} {entry_path:?}", CatalogEntryType::Directory);
+                let dir_entry = entry.enter_directory().await?;
+                pxar_metadata_catalog_dump_dir(dir_entry, path_prefix).await?;
+            }
+            EntryKind::File { size, .. } => {
+                let mtime = match entry.metadata().mtime_as_duration() {
+                    SignedDuration::Positive(val) => i64::try_from(val.as_secs())?,
+                    SignedDuration::Negative(val) => -i64::try_from(val.as_secs())?,
+                };
+                let mut mtime_string = mtime.to_string();
+                if let Ok(s) = proxmox_time::strftime_local("%FT%TZ", mtime) {
+                    mtime_string = s;
+                }
+                log::info!(
+                    "{} {entry_path:?} {size} {mtime_string}",
+                    CatalogEntryType::File
+                );
+            }
+            EntryKind::Device(_) => match entry.metadata().file_type() {
+                mode::IFBLK => log::info!("{} {entry_path:?}", CatalogEntryType::BlockDevice),
+                mode::IFCHR => log::info!("{} {entry_path:?}", CatalogEntryType::CharDevice),
+                _ => bail!("encountered unknown device type"),
+            },
+            EntryKind::Symlink(_) => log::info!("{} {entry_path:?}", CatalogEntryType::Symlink),
+            EntryKind::Hardlink(_) => log::info!("{} {entry_path:?}", CatalogEntryType::Hardlink),
+            EntryKind::Fifo => log::info!("{} {entry_path:?}", CatalogEntryType::Fifo),
+            EntryKind::Socket => log::info!("{} {entry_path:?}", CatalogEntryType::Socket),
+        }
+
+        Ok(())
+    })
+}
+
+async fn pxar_metadata_catalog_dump_dir<T: Clone + Send + Sync + ReadAt>(
+    parent_dir: Directory<T>,
+    path_prefix: &str,
+) -> Result<(), Error> {
+    let mut entries_iter = parent_dir.read_dir();
+    let mut entries = Vec::new();
+    while let Some(entry) = entries_iter.next().await {
+        let entry = entry?.decode_entry().await?;
+        entries.push(entry);
+    }
+    entries.sort_unstable_by(|a, b| a.path().cmp(b.path()));
+
+    for entry in entries {
+        pxar_metadata_catalog_dump_entry(entry, path_prefix).await?;
+    }
+
+    Ok(())
+}
+
+pub async fn pxar_metadata_catalog_dump<T: Clone + Send + Sync + ReadAt>(
+    accessor: Accessor<T>,
+    path_prefix: &str,
+) -> Result<(), Error> {
+    let path_prefix = format!("./{path_prefix}");
+    let root = accessor.open_root().await?;
+    pxar_metadata_catalog_dump_dir(root, &path_prefix).await?;
+    Ok(())
+}
-- 
2.39.2