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 A44DC75DB8; Thu, 22 Apr 2021 17:35:39 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 40B3C1EBFB; Thu, 22 Apr 2021 17:35:14 +0200 (CEST) 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 667211EB37; Thu, 22 Apr 2021 17:35:05 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 3FC2B46351; Thu, 22 Apr 2021 17:35:05 +0200 (CEST) From: Stefan Reiter To: pve-devel@lists.proxmox.com, pbs-devel@lists.proxmox.com Date: Thu, 22 Apr 2021 17:34:54 +0200 Message-Id: <20210422153457.12265-11-s.reiter@proxmox.com> X-Mailer: git-send-email 2.20.1 In-Reply-To: <20210422153457.12265-1-s.reiter@proxmox.com> References: <20210422153457.12265-1-s.reiter@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.028 Adjusted score from AWL reputation of From: address 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. [status.pm, filerestore.pm, scan.pm, content.pm, config.pm, prunebackups.pm] Subject: [pve-devel] [PATCH v2 storage 10/13] add FileRestore API for PBS 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: Thu, 22 Apr 2021 15:35:40 -0000 Includes list and restore calls. Requires VM.Backup and Datastore.Audit permissions, for the accessed VM/CT and containing datastore respectively. Signed-off-by: Stefan Reiter --- Requires updated pve-common, pve-http-server. v2: * use same permissions as regular backup access, check with check_volume_access Note: I didn't add the "snapshot -> volume ID" change for now, but AFAICT this should be a drop-in replacement (maybe aside from the parameter name). The $real_volume_id sub in Content.pm should handle that just fine? Well, it would need the "backup/" prefix to become a volid, but again, should be fine. Feel free to adapt this though if you like the other way better, no hard feelings tbh... PVE/API2/Storage/FileRestore.pm | 160 ++++++++++++++++++++++++++++++++ PVE/API2/Storage/Makefile | 2 +- PVE/API2/Storage/Status.pm | 6 ++ 3 files changed, 167 insertions(+), 1 deletion(-) create mode 100644 PVE/API2/Storage/FileRestore.pm diff --git a/PVE/API2/Storage/FileRestore.pm b/PVE/API2/Storage/FileRestore.pm new file mode 100644 index 0000000..68f81eb --- /dev/null +++ b/PVE/API2/Storage/FileRestore.pm @@ -0,0 +1,160 @@ +package PVE::API2::Storage::FileRestore; + +use strict; +use warnings; + +use MIME::Base64; +use PVE::JSONSchema qw(get_standard_option); +use PVE::PBSClient; +use PVE::Storage; +use PVE::Tools qw(extract_param); + +use PVE::RESTHandler; +use base qw(PVE::RESTHandler); + +__PACKAGE__->register_method ({ + name => 'list', + path => 'list', + method => 'GET', + proxyto => 'node', + permissions => { + description => "You need read access for the volume.", + user => 'all', + }, + description => "List files and directories for single file restore under the given path.", + parameters => { + additionalProperties => 0, + properties => { + node => get_standard_option('pve-node'), + storage => get_standard_option('pve-storage-id'), + snapshot => { + description => "Backup snapshot identifier.", + type => 'string', + }, + filepath => { + description => 'base64-path to the directory or file being listed, or "/".', + type => 'string', + }, + }, + }, + returns => { + type => 'array', + items => { + type => "object", + properties => { + filepath => { + description => "base64 path of the current entry", + type => 'string', + }, + type => { + description => "Entry type.", + type => 'string', + }, + text => { + description => "Entry display text.", + type => 'string', + }, + leaf => { + description => "If this entry is a leaf in the directory graph.", + type => 'any', # JSON::PP::Boolean gets passed through + }, + size => { + description => "Entry file size.", + type => 'integer', + optional => 1, + }, + mtime => { + description => "Entry last-modified time (unix timestamp).", + type => 'integer', + optional => 1, + }, + }, + }, + }, + protected => 1, + code => sub { + my ($param) = @_; + + my $rpcenv = PVE::RPCEnvironment::get(); + my $user = $rpcenv->get_user(); + + my $path = extract_param($param, 'filepath') || "/"; + my $base64 = $path ne "/"; + my $snap = extract_param($param, 'snapshot'); + my $storeid = extract_param($param, 'storage'); + my $cfg = PVE::Storage::config(); + my $scfg = PVE::Storage::storage_config($cfg, $storeid); + + my $volid = "$storeid:backup/$snap"; + PVE::Storage::check_volume_access($rpcenv, $user, $cfg, undef, $volid); + + my $client = PVE::PBSClient->new($scfg, $storeid); + my $ret = $client->file_restore_list($snap, $path, $base64); + + return $ret; + }}); + +__PACKAGE__->register_method ({ + name => 'download', + path => 'download', + method => 'GET', + proxyto => 'node', + permissions => { + description => "You need read access for the volume.", + user => 'all', + }, + description => "Extract a file or directory (as zip archive) from a PBS backup.", + parameters => { + additionalProperties => 0, + properties => { + node => get_standard_option('pve-node'), + storage => get_standard_option('pve-storage-id'), + snapshot => { + description => "Backup snapshot identifier.", + type => 'string', + }, + filepath => { + description => 'base64-path to the directory or file to download.', + type => 'string', + }, + }, + }, + returns => { + type => 'any', # download + }, + protected => 1, + code => sub { + my ($param) = @_; + + my $rpcenv = PVE::RPCEnvironment::get(); + my $user = $rpcenv->get_user(); + + my $path = extract_param($param, 'filepath'); + my $snap = extract_param($param, 'snapshot'); + my $storeid = extract_param($param, 'storage'); + my $cfg = PVE::Storage::config(); + my $scfg = PVE::Storage::storage_config($cfg, $storeid); + + my $volid = "$storeid:backup/$snap"; + PVE::Storage::check_volume_access($rpcenv, $user, $cfg, undef, $volid); + + my $client = PVE::PBSClient->new($scfg, $storeid); + my $fifo = $client->file_restore_extract_prepare(); + + $rpcenv->fork_worker('pbs-download', undef, $user, sub { + my $name = decode_base64($path); + print "Starting download of file: $name\n"; + $client->file_restore_extract($fifo, $snap, $path, 1); + }); + + my $ret = { + download => { + path => $fifo, + stream => 1, + 'content-type' => 'application/octet-stream', + }, + }; + return $ret; + }}); + +1; diff --git a/PVE/API2/Storage/Makefile b/PVE/API2/Storage/Makefile index 690b437..1705080 100644 --- a/PVE/API2/Storage/Makefile +++ b/PVE/API2/Storage/Makefile @@ -1,5 +1,5 @@ -SOURCES= Content.pm Status.pm Config.pm PruneBackups.pm Scan.pm +SOURCES= Content.pm Status.pm Config.pm PruneBackups.pm Scan.pm FileRestore.pm .PHONY: install install: diff --git a/PVE/API2/Storage/Status.pm b/PVE/API2/Storage/Status.pm index d12643f..897b4a7 100644 --- a/PVE/API2/Storage/Status.pm +++ b/PVE/API2/Storage/Status.pm @@ -12,6 +12,7 @@ use PVE::RRD; use PVE::Storage; use PVE::API2::Storage::Content; use PVE::API2::Storage::PruneBackups; +use PVE::API2::Storage::FileRestore; use PVE::RESTHandler; use PVE::RPCEnvironment; use PVE::JSONSchema qw(get_standard_option); @@ -32,6 +33,11 @@ __PACKAGE__->register_method ({ path => '{storage}/content', }); +__PACKAGE__->register_method ({ + subclass => "PVE::API2::Storage::FileRestore", + path => '{storage}/file-restore', +}); + __PACKAGE__->register_method ({ name => 'index', path => '', -- 2.20.1