]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/PBSClient.pm
cgroup: cpu quota: fix resetting period length for v1
[pve-common.git] / src / PVE / PBSClient.pm
index 75b3b507ec82cebd5f5e3ff4dc5334db3b367a60..21dc36393706f96ef5fa52c4645ab6c4c9e10e8b 100644 (file)
@@ -5,12 +5,41 @@ use strict;
 use warnings;
 
 use Fcntl qw(F_GETFD F_SETFD FD_CLOEXEC);
+use File::Temp qw(tempdir);
 use IO::File;
 use JSON;
-use POSIX qw(strftime ENOENT);
+use POSIX qw(mkfifo strftime ENOENT);
 
 use PVE::JSONSchema qw(get_standard_option);
-use PVE::Tools qw(run_command file_set_contents file_get_contents file_read_firstline);
+use PVE::Tools qw(run_command file_set_contents file_get_contents file_read_firstline $IPV6RE);
+
+# returns a repository string suitable for proxmox-backup-client, pbs-restore, etc.
+# $scfg must have the following structure:
+# {
+#     datastore
+#     server
+#     port        (optional defaults to 8007)
+#     username    (optional defaults to 'root@pam')
+# }
+sub get_repository {
+    my ($scfg) = @_;
+
+    my $server = $scfg->{server};
+    die "no server given\n" if !defined($server);
+
+    $server = "[$server]" if $server =~ /^$IPV6RE$/;
+
+    if (my $port = $scfg->{port}) {
+       $server .= ":$port" if $port != 8007;
+    }
+
+    my $datastore = $scfg->{datastore};
+    die "no datastore given\n" if !defined($datastore);
+
+    my $username = $scfg->{username} // 'root@pam';
+
+    return "$username\@$server:$datastore";
+}
 
 sub new {
     my ($class, $scfg, $storeid, $sdir) = @_;
@@ -101,24 +130,28 @@ my sub open_encryption_key {
 }
 
 my $USE_CRYPT_PARAMS = {
-    backup => 1,
-    restore => 1,
-    'upload-log' => 1,
+    'proxmox-backup-client' => {
+       backup => 1,
+       restore => 1,
+       'upload-log' => 1,
+    },
+    'proxmox-file-restore' => {
+       list => 1,
+       extract => 1,
+    },
 };
 
 my sub do_raw_client_cmd {
     my ($self, $client_cmd, $param, %opts) = @_;
 
-    my $use_crypto = $USE_CRYPT_PARAMS->{$client_cmd};
+    my $client_bin = (delete $opts{binary}) || 'proxmox-backup-client';
+    my $use_crypto = $USE_CRYPT_PARAMS->{$client_bin}->{$client_cmd} // 0;
 
-    my $client_exe = '/usr/bin/proxmox-backup-client';
-    die "executable not found '$client_exe'! Proxmox backup client not installed?\n"
-       if ! -x $client_exe;
+    my $client_exe = "/usr/bin/$client_bin";
+    die "executable not found '$client_exe'! $client_bin not installed?\n" if ! -x $client_exe;
 
     my $scfg = $self->{scfg};
-    my $server = $scfg->{server};
-    my $datastore = $scfg->{datastore};
-    my $username = $scfg->{username} // 'root@pam';
+    my $repo = get_repository($scfg);
 
     my $userns_cmd = delete $opts{userns_cmd};
 
@@ -144,7 +177,7 @@ my sub do_raw_client_cmd {
 
     push @$cmd, @$param if defined($param);
 
-    push @$cmd, "--repository", "$username\@$server:$datastore";
+    push @$cmd, "--repository", $repo;
 
     local $ENV{PBS_PASSWORD} = $self->get_password();
 
@@ -167,22 +200,25 @@ my sub run_raw_client_cmd {
 }
 
 my sub run_client_cmd {
-    my ($self, $client_cmd, $param, $no_output) = @_;
+    my ($self, $client_cmd, $param, $no_output, $binary) = @_;
 
     my $json_str = '';
     my $outfunc = sub { $json_str .= "$_[0]\n" };
 
+    $binary //= 'proxmox-backup-client';
+
     $param = [] if !defined($param);
     $param = [ $param ] if !ref($param);
 
     $param = [@$param, '--output-format=json'] if !$no_output;
 
     do_raw_client_cmd(
-        $self,
-        $client_cmd,
-        $param,
-        outfunc => $outfunc,
-        errmsg => 'proxmox-backup-client failed'
+       $self,
+       $client_cmd,
+       $param,
+       outfunc => $outfunc,
+       errmsg => "$binary failed",
+       binary => $binary,
     );
 
     return undef if $no_output;
@@ -212,27 +248,24 @@ sub get_snapshots {
     return run_client_cmd($self, "snapshots", $param);
 };
 
-sub backup_tree {
-    my ($self, $opts) = @_;
+# create a new PXAR backup of a FS directory tree - doesn't cross FS boundary
+# by default.
+sub backup_fs_tree {
+    my ($self, $root, $id, $pxarname, $cmd_opts) = @_;
 
-    my $type = delete $opts->{type};
-    die "backup-type not provided\n" if !defined($type);
-    my $id = delete $opts->{id};
     die "backup-id not provided\n" if !defined($id);
-    my $root = delete $opts->{root};
-    die "root dir not provided\n" if !defined($root);
-    my $pxarname = delete $opts->{pxarname};
+    die "backup root dir not provided\n" if !defined($root);
     die "archive name not provided\n" if !defined($pxarname);
-    my $time = delete $opts->{time};
 
     my $param = [
        "$pxarname.pxar:$root",
-       '--backup-type', $type,
+       '--backup-type', 'host',
        '--backup-id', $id,
     ];
-    push @$param, '--backup-time', $time if defined($time);
 
-    return run_raw_client_cmd($self, 'backup', $param, %$opts);
+    $cmd_opts //= {};
+
+    return run_raw_client_cmd($self, 'backup', $param, %$cmd_opts);
 };
 
 sub restore_pxar {
@@ -308,4 +341,68 @@ sub status {
     return ($total, $free, $used, $active);
 };
 
+sub file_restore_list {
+    my ($self, $snapshot, $filepath, $base64) = @_;
+    return run_client_cmd(
+       $self,
+       "list",
+       [ $snapshot, $filepath, "--base64", $base64 ? 1 : 0 ],
+       0,
+       "proxmox-file-restore",
+    );
+}
+
+# call sync from API, returns a fifo path for streaming data to clients,
+# pass it to file_restore_extract to start transfering data
+sub file_restore_extract_prepare {
+    my ($self) = @_;
+
+    my $tmpdir = tempdir();
+    mkfifo("$tmpdir/fifo", 0600)
+       or die "creating file download fifo '$tmpdir/fifo' failed: $!\n";
+
+    # allow reading data for proxy user
+    my $wwwid = getpwnam('www-data') ||
+       die "getpwnam failed";
+    chown $wwwid, -1, "$tmpdir"
+       or die "changing permission on fifo dir '$tmpdir' failed: $!\n";
+    chown $wwwid, -1, "$tmpdir/fifo"
+       or die "changing permission on fifo '$tmpdir/fifo' failed: $!\n";
+
+    return "$tmpdir/fifo";
+}
+
+# this blocks while data is transfered, call this from a background worker
+sub file_restore_extract {
+    my ($self, $output_file, $snapshot, $filepath, $base64) = @_;
+
+    my $ret = eval {
+       local $SIG{ALRM} = sub { die "got timeout\n" };
+       alarm(30);
+       sysopen(my $fh, "$output_file", O_WRONLY)
+           or die "open target '$output_file' for writing failed: $!\n";
+       alarm(0);
+
+       my $fn = fileno($fh);
+       my $errfunc = sub { print $_[0], "\n"; };
+
+       return run_raw_client_cmd(
+           $self,
+            "extract",
+           [ $snapshot, $filepath, "-", "--base64", $base64 ? 1 : 0 ],
+           binary => "proxmox-file-restore",
+           errfunc => $errfunc,
+           output => ">&$fn",
+       );
+    };
+    my $err = $@;
+
+    unlink($output_file);
+    $output_file =~ s/fifo$//;
+    rmdir($output_file) if -d $output_file;
+
+    die "file restore task failed: $err" if $err;
+    return $ret;
+}
+
 1;