public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
* [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore
@ 2024-04-30 13:39 Christian Ebner
  2024-04-30 15:19 ` Gabriel Goller
  2024-04-30 15:59 ` Christian Ebner
  0 siblings, 2 replies; 4+ messages in thread
From: Christian Ebner @ 2024-04-30 13:39 UTC (permalink / raw)
  To: pbs-devel

When the user is only interested in a subset of the entries stored in
a file-level backup, it is convenient to be able to provide a list of
match patterns for the entries intended to be restored.

The required restore logic is already in place. Therefore, expose it
for the `proxmox-backup-client restore` command by adding the optional
array of patterns as command line argument and parse these before
passing them via the pxar restore options to the archive extractor.

Link to bugtracker issue:
https://bugzilla.proxmox.com/show_bug.cgi?id=2996

Signed-off-by: Christian Ebner <c.ebner@proxmox.com>
---
 proxmox-backup-client/src/main.rs | 27 +++++++++++++++++++++++++--
 1 file changed, 25 insertions(+), 2 deletions(-)

diff --git a/proxmox-backup-client/src/main.rs b/proxmox-backup-client/src/main.rs
index 32fe914c4..1f1dac151 100644
--- a/proxmox-backup-client/src/main.rs
+++ b/proxmox-backup-client/src/main.rs
@@ -1186,6 +1186,15 @@ We do not extract '.pxar' archives when writing to standard output.
 
 "###
             },
+            "matches": {
+                type: Array,
+                description: "Only restore entries matching given paths or patterns.",
+                optional: true,
+                items: {
+                    type: String,
+                    description: "Path or match pattern.",
+                },
+            },
             rate: {
                 schema: TRAFFIC_CONTROL_RATE_SCHEMA,
                 optional: true,
@@ -1306,6 +1315,20 @@ async fn restore(
     let target = json::required_string_param(&param, "target")?;
     let target = if target == "-" { None } else { Some(target) };
 
+    let mut match_list = Vec::new();
+    if let Some(patterns) = param["matches"].as_array() {
+        for pattern in patterns {
+            if let Some(pattern) = pattern.as_str() {
+                let match_entry = MatchEntry::parse_pattern(
+                    pattern,
+                    PatternFlag::PATH_NAME,
+                    MatchType::Include
+                )?;
+                match_list.push(match_entry);
+            }
+        }
+    };
+
     let crypto = crypto_parameters(&param)?;
 
     let crypt_config = match crypto.enc_key {
@@ -1429,8 +1452,8 @@ async fn restore(
         }
 
         let options = pbs_client::pxar::PxarExtractOptions {
-            match_list: &[],
-            extract_match_default: true,
+            match_list: match_list.as_slice(),
+            extract_match_default: match_list.is_empty(),
             allow_existing_dirs,
             overwrite_flags,
             on_error,
-- 
2.39.2



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore
  2024-04-30 13:39 [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore Christian Ebner
@ 2024-04-30 15:19 ` Gabriel Goller
  2024-04-30 15:35   ` Christian Ebner
  2024-04-30 15:59 ` Christian Ebner
  1 sibling, 1 reply; 4+ messages in thread
From: Gabriel Goller @ 2024-04-30 15:19 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion

Gave this a quick spin and it worked quite good!

The only thing that didn't work was when I used '-' as a target, which
should print everything to stdout. When using it, the --matches
parameter is simply ignored and it dumps the whole archive on stdout.
E.g.:

    proxmox-backup-client restore --matches README.rst host/debian/2024-04-30T15:08:06Z test.pxar.didx -

Not sure if this is in the scope of this patch or not though.

If it isn't, you can consider: 

Tested-by: Gabriel Goller <g.goller@proxmox.com>



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore
  2024-04-30 15:19 ` Gabriel Goller
@ 2024-04-30 15:35   ` Christian Ebner
  0 siblings, 0 replies; 4+ messages in thread
From: Christian Ebner @ 2024-04-30 15:35 UTC (permalink / raw)
  To: Proxmox Backup Server development discussion, Gabriel Goller

> On 30.04.2024 17:19 CEST Gabriel Goller <g.goller@proxmox.com> wrote:
> 
>  
> Gave this a quick spin and it worked quite good!
> 
> The only thing that didn't work was when I used '-' as a target, which
> should print everything to stdout. When using it, the --matches
> parameter is simply ignored and it dumps the whole archive on stdout.
> E.g.:
> 
>     proxmox-backup-client restore --matches README.rst host/debian/2024-04-30T15:08:06Z test.pxar.didx -
> 
> Not sure if this is in the scope of this patch or not though.
> 
> If it isn't, you can consider: 
> 
> Tested-by: Gabriel Goller <g.goller@proxmox.com>

Thanks a lot for testing and good catch! This should indeed not be possible and I need to add a check to disallow this combination of the `matches` being set and the `target` being stdout. Will send a new version.

Cheers,
Chris


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 4+ messages in thread

* Re: [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore
  2024-04-30 13:39 [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore Christian Ebner
  2024-04-30 15:19 ` Gabriel Goller
@ 2024-04-30 15:59 ` Christian Ebner
  1 sibling, 0 replies; 4+ messages in thread
From: Christian Ebner @ 2024-04-30 15:59 UTC (permalink / raw)
  To: pbs-devel

Superseded by version 2 
https://lists.proxmox.com/pipermail/pbs-devel/2024-April/009170.html


_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2024-04-30 16:00 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2024-04-30 13:39 [pbs-devel] [PATCH proxmox-backup] fix #2996: client: allow optional match pattens for restore Christian Ebner
2024-04-30 15:19 ` Gabriel Goller
2024-04-30 15:35   ` Christian Ebner
2024-04-30 15:59 ` Christian Ebner

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal