api: content listing: add comment and verification fields

[pve-storage.git] / PVE / Storage / PBSPlugin.pm

diff --git a/PVE/Storage/PBSPlugin.pm b/PVE/Storage/PBSPlugin.pm
index dd648703d75a9a38e5aa9319da940a960dcb5437..f3bf01620de4161836aebeb3bacaee9afd1febd8 100644 (file)
--- a/PVE/Storage/PBSPlugin.pm
+++ b/PVE/Storage/PBSPlugin.pm
@@ -4,6 +4,7 @@ package PVE::Storage::PBSPlugin;
 
 use strict;
 use warnings;
+
 use Fcntl qw(F_GETFD F_SETFD FD_CLOEXEC);
 use HTTP::Request;
 use IO::File;
@@ -11,9 +12,10 @@ use JSON;
 use LWP::UserAgent;
 use POSIX qw(strftime ENOENT);
 
-use PVE::Tools qw(run_command file_read_firstline trim dir_glob_regex dir_glob_foreach);
-use PVE::Storage::Plugin;
 use PVE::JSONSchema qw(get_standard_option);
+use PVE::Network;
+use PVE::Storage::Plugin;
+use PVE::Tools qw(run_command file_read_firstline trim dir_glob_regex dir_glob_foreach $IPV6RE);
 
 use base qw(PVE::Storage::Plugin);
 
@@ -32,7 +34,7 @@ sub plugindata {
 sub properties {
     return {
        datastore => {
-           description => "Proxmox backup server datastore name.",
+           description => "Proxmox Backup Server datastore name.",
            type => 'string',
        },
        # openssl s_client -connect <host>:8007 2>&1 |openssl x509 -fingerprint -sha256
@@ -41,6 +43,13 @@ sub properties {
            description => "Encryption key. Use 'autogen' to generate one automatically without passphrase.",
            type => 'string',
        },
+       port => {
+           description => "For non default port.",
+           type => 'integer',
+           minimum => 1,
+           maximum => 65535,
+           default => 8007,
+       }
     };
 }
 
@@ -48,6 +57,7 @@ sub options {
     return {
        server => { fixed => 1 },
        datastore => { fixed => 1 },
+       port => { optional => 1 },
        nodes => { optional => 1},
        disable => { optional => 1},
        content => { optional => 1},
@@ -113,7 +123,11 @@ sub pbs_delete_encryption_key {
 
     my $pwfile = pbs_encryption_key_file_name($scfg, $storeid);
 
-    unlink $pwfile;
+    if (!unlink $pwfile) {
+       return if $! == ENOENT;
+       die "failed to delete encryption key! $!\n";
+    }
+    delete $scfg->{'encryption-key'};
 }
 
 sub pbs_get_encryption_key {
@@ -148,6 +162,18 @@ sub print_volid {
     return "${storeid}:${volname}";
 }
 
+my sub get_server_with_port {
+    my ($scfg) = @_;
+
+    my $server = $scfg->{server};
+    $server = "[$server]" if $server =~ /^$IPV6RE$/;
+
+    if (my $port = $scfg->{port}) {
+       $server .= ":$port" if $port != 8007;
+    }
+    return $server;
+}
+
 my $USE_CRYPT_PARAMS = {
     backup => 1,
     restore => 1,
@@ -163,7 +189,7 @@ my sub do_raw_client_cmd {
     die "executable not found '$client_exe'! Proxmox backup client not installed?\n"
        if ! -x $client_exe;
 
-    my $server = $scfg->{server};
+    my $server = get_server_with_port($scfg);
     my $datastore = $scfg->{datastore};
     my $username = $scfg->{username} // 'root@pam';
 
@@ -266,10 +292,80 @@ sub extract_vzdump_config {
     return $config;
 }
 
+sub prune_backups {
+    my ($class, $scfg, $storeid, $keep, $vmid, $type, $dryrun, $logfunc) = @_;
+
+    $logfunc //= sub { print "$_[1]\n" };
+
+    my $backups = $class->list_volumes($storeid, $scfg, $vmid, ['backup']);
+
+    $type = 'vm' if defined($type) && $type eq 'qemu';
+    $type = 'ct' if defined($type) && $type eq 'lxc';
+
+    my $backup_groups = {};
+    foreach my $backup (@{$backups}) {
+       (my $backup_type = $backup->{format}) =~ s/^pbs-//;
+
+       next if defined($type) && $backup_type ne $type;
+
+       my $backup_group = "$backup_type/$backup->{vmid}";
+       $backup_groups->{$backup_group} = 1;
+    }
+
+    my @param;
+    foreach my $opt (keys %{$keep}) {
+       push @param, "--$opt";
+       push @param, "$keep->{$opt}";
+    }
+
+    push @param, '--dry-run' if $dryrun;
+
+    my $prune_list = [];
+    my $failed;
+
+    foreach my $backup_group (keys %{$backup_groups}) {
+       $logfunc->('info', "running 'proxmox-backup-client prune' for '$backup_group'")
+           if !$dryrun;
+       eval {
+           my $res = run_client_cmd($scfg, $storeid, 'prune', [ $backup_group, @param ]);
+
+           foreach my $backup (@{$res}) {
+               die "result from proxmox-backup-client is not as expected\n"
+                   if !defined($backup->{'backup-time'})
+                   || !defined($backup->{'backup-type'})
+                   || !defined($backup->{'backup-id'})
+                   || !defined($backup->{'keep'});
+
+               my $ctime = $backup->{'backup-time'};
+               my $type = $backup->{'backup-type'};
+               my $vmid = $backup->{'backup-id'};
+               my $volid = print_volid($storeid, $type, $vmid, $ctime);
+
+               push @{$prune_list}, {
+                   ctime => $ctime,
+                   mark => $backup->{keep} ? 'keep' : 'remove',
+                   type => $type eq 'vm' ? 'qemu' : 'lxc',
+                   vmid => $vmid,
+                   volid => $volid,
+               };
+           }
+       };
+       if (my $err = $@) {
+           $logfunc->('err', "prune '$backup_group': $err\n");
+           $failed = 1;
+       }
+    }
+    die "error pruning backups - check log\n" if $failed;
+
+    return $prune_list;
+}
+
 my $autogen_encryption_key = sub {
     my ($scfg, $storeid) = @_;
     my $encfile = pbs_encryption_key_file_name($scfg, $storeid);
-    run_command(['proxmox-backup-client', 'key', 'create', '--kdf', 'none', $encfile]);
+    my $cmd = ['proxmox-backup-client', 'key', 'create', '--kdf', 'none', $encfile];
+    run_command($cmd, errmsg => 'failed to create encryption key');
+    return PVE::Tools::file_get_contents($encfile);
 };
 
 sub on_add_hook {
@@ -287,6 +383,7 @@ sub on_add_hook {
        } else {
            pbs_set_encryption_key($scfg, $storeid, $encryption_key);
        }
+       $scfg->{'encryption-key'} = 1;
     } else {
        pbs_delete_encryption_key($scfg, $storeid);
     }
@@ -310,6 +407,7 @@ sub on_update_hook {
            } else {
                pbs_set_encryption_key($scfg, $storeid, $encryption_key);
            }
+           $scfg->{'encryption-key'} = 1;
        } else {
            pbs_delete_encryption_key($scfg, $storeid);
        }
@@ -352,7 +450,7 @@ sub path {
 
     my ($vtype, $name, $vmid) = $class->parse_volname($volname);
 
-    my $server = $scfg->{server};
+    my $server = get_server_with_port($scfg);
     my $datastore = $scfg->{datastore};
     my $username = $scfg->{username} // 'root@pam';
 
@@ -427,6 +525,9 @@ sub list_volumes {
            ctime => $epoch,
        };
 
+       $info->{verification} = $item->{verification} if defined($item->{verification});
+       $info->{comment} = $item->{comment} if defined($item->{comment});
+
        push @$res, $info;
     }
 
@@ -459,7 +560,11 @@ sub status {
 sub activate_storage {
     my ($class, $storeid, $scfg, $cache) = @_;
 
-    run_client_cmd($scfg, $storeid, "status");
+    # a 'status' client command is to expensive here
+    # TODO: use a dummy ping API call to ensure the PBS API daemon is available for real
+    my $server = $scfg->{server};
+    my $port = $scfg->{port} // 8007;
+    PVE::Network::tcp_ping($server, $port, 2);
 
     return 1;
 }