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.rei...@proxmox.com>
---
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
_______________________________________________
pve-devel mailing list
pve-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pve-devel
