From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <s.reiter@proxmox.com>
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 3BD217522C
for <pve-devel@lists.proxmox.com>; Wed, 21 Apr 2021 13:23:58 +0200 (CEST)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 2F806E00C
for <pve-devel@lists.proxmox.com>; Wed, 21 Apr 2021 13:23:58 +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 C6BCFDFCA
for <pve-devel@lists.proxmox.com>; Wed, 21 Apr 2021 13:23:55 +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 A92A4462A6
for <pve-devel@lists.proxmox.com>; Wed, 21 Apr 2021 13:15:46 +0200 (CEST)
From: Stefan Reiter <s.reiter@proxmox.com>
To: pve-devel@lists.proxmox.com
Date: Wed, 21 Apr 2021 13:15:38 +0200
Message-Id: <20210421111539.29261-10-s.reiter@proxmox.com>
X-Mailer: git-send-email 2.20.1
In-Reply-To: <20210421111539.29261-1-s.reiter@proxmox.com>
References: <20210421111539.29261-1-s.reiter@proxmox.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-SPAM-LEVEL: Spam detection results: 0
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. [filerestore.pm, scan.pm, status.pm, prunebackups.pm, config.pm,
content.pm]
Subject: [pve-devel] [PATCH storage 09/10] 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 <pve-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pve-devel/>
List-Post: <mailto:pve-devel@lists.proxmox.com>
List-Help: <mailto:pve-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel>,
<mailto:pve-devel-request@lists.proxmox.com?subject=subscribe>
X-List-Received-Date: Wed, 21 Apr 2021 11:23:58 -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 <s.reiter@proxmox.com>
---
Requires updated pve-common, pve-http-server.
PVE/API2/Storage/FileRestore.pm | 163 ++++++++++++++++++++++++++++++++
PVE/API2/Storage/Makefile | 2 +-
PVE/API2/Storage/Status.pm | 6 ++
3 files changed, 170 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..a0b5e88
--- /dev/null
+++ b/PVE/API2/Storage/FileRestore.pm
@@ -0,0 +1,163 @@
+package PVE::API2::Storage::FileRestore;
+
+use strict;
+use warnings;
+
+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 => "Requires 'VM.Backup' permission on the VM being accessed, and " .
+ "'Datastore.Audit' on the datastore being restored from.",
+ user => 'all', # checked explicitly
+ },
+ description => "List files and directories for single file restore under the given path.",
+ protected => 1,
+ 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,
+ },
+ },
+ },
+ },
+ 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";
+ my (undef, undef, $ownervm) = PVE::Storage::parse_volname($cfg, $volid);
+ $rpcenv->check($user, "/storage/$storeid", ['Datastore.Audit']);
+ $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
+
+ 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 => "Requires 'VM.Backup' permission on the VM being accessed, and " .
+ "'Datastore.Audit' on the datastore being restored from.",
+ user => 'all', # checked explicitly
+ },
+ 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 being listed.',
+ 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";
+ my (undef, undef, $ownervm) = PVE::Storage::parse_volname($cfg, $volid);
+ $rpcenv->check($user, "/storage/$storeid", ['Datastore.Audit']);
+ $rpcenv->check($user, "/vms/$ownervm", ['VM.Backup']);
+
+ my $client = PVE::PBSClient->new($scfg, $storeid);
+ my $fifo = $client->file_restore_extract_prepare();
+
+ $rpcenv->fork_worker('pbs-download', undef, $user, sub {
+ $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