]> git.proxmox.com Git - pve-storage.git/blobdiff - PVE/Storage/Plugin.pm
Add prune_backups to storage API
[pve-storage.git] / PVE / Storage / Plugin.pm
index dba6eb9adf7520f633c1e67b3292bc41fbb37b06..8a58ff4050ae516af4ffe708a196e8bf274a704a 100644 (file)
@@ -8,16 +8,17 @@ use File::chdir;
 use File::Path;
 use File::Basename;
 use File::stat qw();
-use Time::Local qw(timelocal);
 
 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;
 
 use base qw(PVE::SectionConfig);
 
+use constant COMPRESSOR_RE => 'gz|lzo|zst';
+
 our @COMMON_TAR_FLAGS = qw(
     --one-file-system
     -p --sparse --numeric-owner --acls
@@ -42,6 +43,62 @@ 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',
+);
+
+my $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, \&validate_prune_backups);
+sub validate_prune_backups {
+    my ($keep) = @_;
+
+    die "at least one keep-option must be set and positive\n"
+       if !grep { $_ } values %{$keep};
+
+    return $keep;
+}
+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 => {
@@ -67,6 +124,7 @@ my $defaultData = {
            minimum => 0,
            optional => 1,
        },
+       'prune-backups' => get_standard_option('prune-backups'),
        shared => {
            description => "Mark storage as shared.",
            type => 'boolean',
@@ -435,7 +493,7 @@ sub parse_volname {
        return ('vztmpl', $1);
     } elsif ($volname =~ m!^rootdir/(\d+)$!) {
        return ('rootdir', $1, $1);
-    } elsif ($volname =~ m!^backup/([^/]+(\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo)))$!) {
+    } elsif ($volname =~ m!^backup/([^/]+(?:\.(?:tgz|(?:(?:tar|vma)(?:\.(?:${\COMPRESSOR_RE}))?))))$!) {
        my $fn = $1;
        if ($fn =~ m/^vzdump-(openvz|lxc|qemu)-(\d+)-.+/) {
            return ('backup', $fn, $2);
@@ -457,6 +515,10 @@ my $vtype_subdirs = {
     snippets => 'snippets',
 };
 
+sub get_vtype_subdirs {
+    return $vtype_subdirs;
+}
+
 sub get_subdir {
     my ($class, $scfg, $vtype) = @_;
 
@@ -919,7 +981,7 @@ my $get_subdir_files = sub {
 
        my $st = File::stat::stat($fn);
 
-       next if S_ISDIR($st->mode);
+       next if (!$st || S_ISDIR($st->mode));
 
        my $info;
 
@@ -935,21 +997,19 @@ my $get_subdir_files = sub {
 
        } elsif ($tt eq 'backup') {
            next if defined($vmid) && $fn !~  m/\S+-$vmid-\S+/;
-           next if $fn !~ m!/([^/]+\.(tar|tar\.gz|tar\.lzo|tgz|vma|vma\.gz|vma\.lzo))$!;
-
+           next if $fn !~ m!/([^/]+\.(tgz|(?:(?:tar|vma)(?:\.(${\COMPRESSOR_RE}))?)))$!;
            my $format = $2;
-           $info = { volid => "$sid:backup/$1", format => $format };
+           $fn = $1;
+           $info = { volid => "$sid:backup/$fn", format => $format };
 
-           if ($fn =~ m!^vzdump\-(?:lxc|qemu)\-(?:[1-9][0-9]{2,8})\-(\d{4})_(\d{2})_(\d{2})\-(\d{2})_(\d{2})_(\d{2})\.${format}$!) {
-               my $epoch = timelocal($6, $5, $4, $3, $2-1, $1 - 1900);
-               $info->{ctime} = $epoch;
-           }
+           my $archive_info = eval { PVE::Storage::archive_info($fn) } // {};
+
+           $info->{ctime} = $archive_info->{ctime} if defined($archive_info->{ctime});
 
            if (defined($vmid) || $fn =~ m!\-([1-9][0-9]{2,8})\-[^/]+\.${format}$!) {
                $info->{vmid} = $vmid // $1;
            }
 
-
        } elsif ($tt eq 'snippets') {
 
            $info = {
@@ -1114,6 +1174,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,