From: Dominik Csapak <d.csapak@proxmox.com>
Date: Thu, 12 Nov 2020 15:26:02 +0000 (+0100)
Subject: storage: get subdirectory files: read .comment files for comments
X-Git-Url: https://git.proxmox.com/?p=pve-storage.git;a=commitdiff_plain;h=d260b9f357629345ce113140d345c08e9cb23b42

storage: get subdirectory files: read .comment files for comments

we have no way of setting them yet via the API, but we can read them
now

Signed-off-by: Dominik Csapak <d.csapak@proxmox.com>
---

diff --git a/PVE/Storage/Plugin.pm b/PVE/Storage/Plugin.pm
index a046640..00ce9cb 100644
--- a/PVE/Storage/Plugin.pm
+++ b/PVE/Storage/Plugin.pm
@@ -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
@@ -987,8 +989,18 @@ my $get_subdir_files = sub {
 
     my $res = [];
 
+    my $has_comment = {};
+
     foreach my $fn (<$path/*>) {
 
+	if (COMMENT_EXT eq substr($fn, -length(COMMENT_EXT))) {
+	    my $real_fn = substr($fn, 0, length($fn) -  length(COMMENT_EXT));
+	    if (!defined($has_comment->{$real_fn})) {
+		$has_comment->{$real_fn} = (-f $fn);
+	    }
+	    next; # we do not need to do anything with comments themselves
+	}
+
 	my $st = File::stat::stat($fn);
 
 	next if (!$st || S_ISDIR($st->mode));
@@ -1008,6 +1020,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 };
@@ -1020,6 +1033,16 @@ my $get_subdir_files = sub {
 		$info->{vmid} = $vmid // $1;
 	    }
 
+	    my $comment_fn = $original.COMMENT_EXT;
+	    if (!defined($has_comment->{$original})) {
+		$has_comment->{$original} = (-f $comment_fn);
+	    }
+
+	    if ($has_comment->{$original}) {
+		my $comment = PVE::Tools::file_read_firstline($comment_fn);
+		$info->{comment} = $comment if defined($comment);
+	    }
+
 	} elsif ($tt eq 'snippets') {
 
 	    $info = {