]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage/Plugin.pm
prune: allow having all prune options zero/missing
[pve-storage.git] / PVE / Storage / Plugin.pm
index 7f04e85ae8cd00748f3286a6fdaae64992ff22d8..fe56864cc177e512bbe3e50df2f688700cd708a3 100644 (file)
@@ -10,7 +10,7 @@ use File::Basename;
 use File::stat qw();
 
 use PVE::Tools qw(run_command);
-use PVE::JSONSchema qw(get_standard_option);
+use PVE::JSONSchema qw(get_standard_option register_standard_option);
 use PVE::Cluster qw(cfs_register_file);
 
 use JSON;
@@ -19,6 +19,8 @@ use base qw(PVE::SectionConfig);
 
 use constant COMPRESSOR_RE => 'gz|lzo|zst';
 
+use constant COMMENT_EXT => ".comment";
+
 our @COMMON_TAR_FLAGS = qw(
     --one-file-system
     -p --sparse --numeric-owner --acls
@@ -43,6 +45,54 @@ cfs_register_file ('storage.cfg',
                   sub { __PACKAGE__->parse_config(@_); },
                   sub { __PACKAGE__->write_config(@_); });
 
+my %prune_option = (
+    optional => 1,
+    type => 'integer', minimum => '0',
+    format_description => 'N',
+);
+
+our $prune_backups_format = {
+    'keep-last' => {
+       %prune_option,
+       description => 'Keep the last <N> backups.',
+    },
+    'keep-hourly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different hours. If there is more' .
+                      'than one backup for a single hour, only the latest one is kept.'
+    },
+    'keep-daily' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different days. If there is more' .
+                      'than one backup for a single day, only the latest one is kept.'
+    },
+    'keep-weekly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different weeks. If there is more' .
+                      'than one backup for a single week, only the latest one is kept.'
+    },
+    'keep-monthly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different months. If there is more' .
+                      'than one backup for a single month, only the latest one is kept.'
+    },
+    'keep-yearly' => {
+       %prune_option,
+       description => 'Keep backups for the last <N> different years. If there is more' .
+                      'than one backup for a single year, only the latest one is kept.'
+    },
+};
+PVE::JSONSchema::register_format('prune-backups', $prune_backups_format);
+register_standard_option('prune-backups', {
+    description => "The retention options with shorter intervals are processed first " .
+                  "with --keep-last being the very first one. Each option covers a " .
+                  "specific period of time. We say that backups within this period " .
+                  "are covered by this option. The next option does not take care " .
+                  "of already covered backups and only considers older backups.",
+    optional => 1,
+    type => 'string',
+    format => 'prune-backups',
+});
 
 my $defaultData = {
     propertyList => {
@@ -68,6 +118,7 @@ my $defaultData = {
            minimum => 0,
            optional => 1,
        },
+       'prune-backups' => get_standard_option('prune-backups'),
        shared => {
            description => "Mark storage as shared.",
            type => 'boolean',
@@ -726,6 +777,12 @@ sub file_size_info {
 
     my $st = File::stat::stat($filename);
 
+    if (!defined($st)) {
+       my $extramsg = -l $filename ? ' - dangling symlink?' : '';
+       warn "failed to stat '$filename'$extramsg\n";
+       return undef;
+    }
+
     if (S_ISDIR($st->mode)) {
        return wantarray ? (0, 'subvol', 0, undef, $st->ctime) : 1;
     }
@@ -825,6 +882,10 @@ sub volume_snapshot_delete {
     return undef;
 }
 
+sub volume_snapshot_needs_fsfreeze {
+
+    return 0;
+}
 sub storage_can_replicate {
     my ($class, $scfg, $storeid, $format) = @_;
 
@@ -921,7 +982,6 @@ my $get_subdir_files = sub {
     my $res = [];
 
     foreach my $fn (<$path/*>) {
-
        my $st = File::stat::stat($fn);
 
        next if (!$st || S_ISDIR($st->mode));
@@ -941,6 +1001,7 @@ my $get_subdir_files = sub {
        } elsif ($tt eq 'backup') {
            next if defined($vmid) && $fn !~  m/\S+-$vmid-\S+/;
            next if $fn !~ m!/([^/]+\.(tgz|(?:(?:tar|vma)(?:\.(${\COMPRESSOR_RE}))?)))$!;
+           my $original = $fn;
            my $format = $2;
            $fn = $1;
            $info = { volid => "$sid:backup/$fn", format => $format };
@@ -953,6 +1014,12 @@ my $get_subdir_files = sub {
                $info->{vmid} = $vmid // $1;
            }
 
+           my $comment_fn = $original.COMMENT_EXT;
+           if (-f $comment_fn) {
+               my $comment = PVE::Tools::file_read_firstline($comment_fn);
+               $info->{comment} = $comment if defined($comment);
+           }
+
        } elsif ($tt eq 'snippets') {
 
            $info = {
@@ -1117,6 +1184,71 @@ sub check_connection {
     return 1;
 }
 
+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']);
+
+    my $backup_groups = {};
+    my $prune_list = [];
+
+    foreach my $backup (@{$backups}) {
+       my $volid = $backup->{volid};
+       my $backup_vmid = $backup->{vmid};
+       my $archive_info = eval { PVE::Storage::archive_info($volid) } // {};
+       my $backup_type = $archive_info->{type} // 'unknown';
+
+       next if defined($type) && $type ne $backup_type;
+
+       my $prune_entry = {
+           ctime => $backup->{ctime},
+           type => $backup_type,
+           volid => $volid,
+       };
+
+       $prune_entry->{vmid} = $backup_vmid if defined($backup_vmid);
+
+       if ($archive_info->{is_std_name}) {
+           $prune_entry->{ctime} = $archive_info->{ctime};
+           my $group = "$backup_type/$backup_vmid";
+           push @{$backup_groups->{$group}}, $prune_entry;
+       } else {
+           # ignore backups that don't use the standard naming scheme
+           $prune_entry->{mark} = 'protected';
+       }
+
+       push @{$prune_list}, $prune_entry;
+    }
+
+    foreach my $backup_group (values %{$backup_groups}) {
+       PVE::Storage::prune_mark_backup_group($backup_group, $keep);
+    }
+
+    my $failed;
+    if (!$dryrun) {
+       foreach my $prune_entry (@{$prune_list}) {
+           next if $prune_entry->{mark} ne 'remove';
+
+           my $volid = $prune_entry->{volid};
+           $logfunc->('info', "removing backup '$volid'");
+           eval {
+               my (undef, $volname) = parse_volume_id($volid);
+               my $archive_path = $class->filesystem_path($scfg, $volname);
+               PVE::Storage::archive_remove($archive_path);
+           };
+           if (my $err = $@) {
+               $logfunc->('err', "error when removing backup '$volid' - $err\n");
+               $failed = 1;
+           }
+       }
+    }
+    die "error pruning backups - check log\n" if $failed;
+
+    return $prune_list;
+}
+
 # Import/Export interface:
 #   Any path based storage is assumed to support 'raw' and 'tar' streams, so
 #   the default implementations will return this if $scfg->{path} is set,