public inbox for pve-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: "Max R. Carrara" <m.carrara@proxmox.com>
To: pve-devel@lists.proxmox.com
Cc: Wolfgang Bumiller <w.bumiller@proxmox.com>
Subject: [PATCH pve-storage v3 08/51] plugin: adapt get_subdir_files helper of list_volumes API method
Date: Tue, 17 Nov 2026 21:38:40 +0100	[thread overview]
Message-ID: <20261117203953.913035-9-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261117203953.913035-1-m.carrara@proxmox.com>

Pull the body of the loop inside `get_subdir_files()` out into a
closure and break up the if-elsif chain into more readable if-clauses.

Strip the vtype subdirectory from the beginning of the file paths
being worked on inside that closure. This does not have an effect on
how any of the subsequent regexes match on the path / file name,
because they match at the end of a given path.

Additionally, take the storage config hash `$scfg` instead of the
volume type subdir `$path` as parameter. Passing `$scfg` along makes
it possible to obtain the subdir for the given `$vtype` inside the
helper directly instead of passing both the vtype and its associated
subdirectory along.

Also, pass the `$class` parameter along because it is still necessary
to call the deprecated `get_subdir()` method for backwards compat.

All of these things make future changes easier to manage.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/Storage/Plugin.pm | 102 +++++++++++++++++++++++++-------------
 1 file changed, 67 insertions(+), 35 deletions(-)

diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm
index d316caac..bbed4eb4 100644
--- a/src/PVE/Storage/Plugin.pm
+++ b/src/PVE/Storage/Plugin.pm
@@ -1870,44 +1870,59 @@ sub list_images {
     return $res;
 }
 
 # $vtype = <iso|vztmpl|backup|snippets|import>
 my sub get_subdir_files {
-    my ($storeid, $path, $vtype, $vmid) = @_;
+    my ($class, $storeid, $scfg, $vtype, $vmid) = @_;
 
+    # FIXME: Call plugin_get_vtype_subdir() instead of $class->get_subdir()
+    # and remove the $class parameter on the next APIAGE reset.
+    my $vtype_subdir = $class->get_subdir($scfg, $vtype);
     my $res = [];
 
-    for my $filename (<$path/*>) {
-        # A volume ID cannot represent a name with a newline, see parse_volume_id().
-        next if $filename =~ m/\n/;
+    my $get_subdir_file_info = sub {
+        my ($path, $st) = @_;
 
-        my $st = File::stat::stat($filename);
-
-        next if (!$st || S_ISDIR($st->mode));
-
-        my $info;
+        # Strip the vtype subdir from beginning of the current path
+        # so that we don't have to take it into account when parsing the file name
+        my $filename = $path;
+        if ($filename !~ s!^\Q$vtype_subdir\E(?=/)!!) {
+            return;
+        }
 
         if ($vtype eq 'iso') {
-            next if $filename !~ m!/([^/]+$PVE::Storage::ISO_EXT_RE_0)$!i;
+            return if $filename !~ m!/([^/]+$PVE::Storage::ISO_EXT_RE_0)$!i;
 
-            $info = { volid => "$storeid:iso/$1", format => 'iso' };
+            return {
+                volid => "$storeid:iso/$1",
+                format => 'iso',
+            };
+        }
 
-        } elsif ($vtype eq 'vztmpl') {
-            next if $filename !~ m!/([^/]+$PVE::Storage::VZTMPL_EXT_RE_1)$!;
+        if ($vtype eq 'vztmpl') {
+            return if $filename !~ m!/([^/]+$PVE::Storage::VZTMPL_EXT_RE_1)$!;
 
-            $info = { volid => "$storeid:vztmpl/$1", format => $2 eq 'tar' ? $2 : "t$2" };
+            return {
+                volid => "$storeid:vztmpl/$1",
+                format => $2 eq 'tar' ? $2 : "t$2",
+            };
+        }
 
-        } elsif ($vtype eq 'backup') {
-            next if $filename !~ m!/([^/]+$PVE::Storage::BACKUP_EXT_RE_2)$!;
-            my $original = $filename;
+        if ($vtype eq 'backup') {
+            return if $filename !~ m!/([^/]+$PVE::Storage::BACKUP_EXT_RE_2)$!;
+
+            my $original = $path;
             my $format = $2;
             $filename = $1;
 
             # Attribute archives to a guest like parse_volname() does, which the access checks use.
             next if defined($vmid) && $filename !~ m/^vzdump-(?:openvz|lxc|qemu)-\Q$vmid\E-/;
 
-            $info = { volid => "$storeid:backup/$filename", format => $format };
+            my $info = {
+                volid => "$storeid:backup/$filename",
+                format => $format,
+            };
 
             my $archive_info = eval { PVE::Storage::archive_info($filename) } // {};
 
             $info->{ctime} = $archive_info->{ctime} if defined($archive_info->{ctime});
             $info->{subtype} = $archive_info->{type} // 'unknown';
@@ -1922,28 +1937,49 @@ my sub get_subdir_files {
                 $info->{notes} = eval { decode('UTF-8', $notes, 1) } // $notes
                     if defined($notes);
             }
 
             $info->{protected} = 1 if -e PVE::Storage::protection_file_path($original);
-        } elsif ($vtype eq 'snippets') {
 
-            $info = {
+            return $info;
+        }
+
+        if ($vtype eq 'snippets') {
+            return {
                 volid => "$storeid:snippets/" . basename($filename),
                 format => 'snippet',
             };
-        } elsif ($vtype eq 'import') {
-            next
+        }
+
+        if ($vtype eq 'import') {
+            return
                 if $filename !~
                 m!/(${PVE::Storage::SAFE_CHAR_CLASS_RE}+$PVE::Storage::IMPORT_EXT_RE_1)$!i;
 
-            $info = { volid => "$storeid:import/$1", format => "$2" };
+            return {
+                volid => "$storeid:import/$1",
+                format => "$2",
+            };
         }
 
-        $info->{size} = $st->size;
-        $info->{ctime} //= $st->ctime;
+        return;
+    };
 
-        push @$res, $info;
+    for my $path (<$vtype_subdir/*>) {
+        my $st = File::stat::stat($path);
+
+        # A volume ID cannot represent a name with a newline, see parse_volume_id().
+        next if $path =~ m/\n/;
+
+        next if (!$st || S_ISDIR($st->mode));
+
+        if (defined(my $info = $get_subdir_file_info->($path, $st))) {
+            $info->{size} = $st->size;
+            $info->{ctime} //= $st->ctime;
+
+            push $res->@*, $info;
+        }
     }
 
     return $res;
 }
 
@@ -1958,24 +1994,20 @@ sub list_volumes {
         my $data;
 
         if ($type eq 'images' || $type eq 'rootdir') {
             $data = $class->list_images($storeid, $scfg, $vmid);
         } elsif ($scfg->{path}) {
-            # FIXME: Call plugin_get_vtype_subdir() instead of
-            # $plugin->get_subdir() on the next APIAGE reset.
-            my $path = $class->get_subdir($scfg, $type);
-
             if ($type eq 'iso' && !defined($vmid)) {
-                $data = get_subdir_files($storeid, $path, 'iso');
+                $data = get_subdir_files($class, $storeid, $scfg, 'iso', undef);
             } elsif ($type eq 'vztmpl' && !defined($vmid)) {
-                $data = get_subdir_files($storeid, $path, 'vztmpl');
+                $data = get_subdir_files($class, $storeid, $scfg, 'vztmpl', undef);
             } elsif ($type eq 'backup') {
-                $data = get_subdir_files($storeid, $path, 'backup', $vmid);
+                $data = get_subdir_files($class, $storeid, $scfg, 'backup', $vmid);
             } elsif ($type eq 'snippets') {
-                $data = get_subdir_files($storeid, $path, 'snippets');
+                $data = get_subdir_files($class, $storeid, $scfg, 'snippets', undef);
             } elsif ($type eq 'import') {
-                $data = get_subdir_files($storeid, $path, 'import');
+                $data = get_subdir_files($class, $storeid, $scfg, 'import', undef);
             }
         }
 
         next if !$data;
 
-- 
2.47.3





  parent reply	other threads:[~2026-11-17 20:41 UTC|newest]

Thread overview: 52+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-11-17 20:38 [PATCH manager/storage v3 00/51] Fix #2884: Implement Subdirectory Scanning for Dir-Based Storage Types Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 01/51] test: plugin tests: run tests with at most 4 jobs Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 02/51] plugin, common: remove superfluous use of =pod command paragraph Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 03/51] common: use Exporter module for PVE::Storage::Common Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 04/51] plugin: make get_subdir_files a proper subroutine and update style Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 05/51] plugin api: replace subdir helper methods with standalone functions Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 06/51] common: prevent autovivification in plugin_get_vtype_subdir helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 07/51] plugin: break up if-elsif chain into separate if-blocks Max R. Carrara
2026-11-17 20:38 ` Max R. Carrara [this message]
2026-11-17 20:38 ` [PATCH pve-storage v3 09/51] plugin: update code style of list_volumes plugin API method Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 10/51] plugin: use closure for obtaining raw volume data in list_volumes Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 11/51] plugin: use closure for inner loop logic " Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 12/51] storage: update code style in function path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 13/51] storage: break up if-elsif chain in path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 14/51] storage: heave vtype file path parsing logic inside loop into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 15/51] storage: clean up code that was moved into helper in path_to_volume_id Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 16/51] api: status: move content type assert for up-/downloads into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 17/51] api: status: use get_subdir helper method to get content directory Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 18/51] api: status: move up-/download file path parsing code into helper Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 19/51] api: status: simplify file content assertion logic for up-/download Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 20/51] test: guest import: add tests for PVE::GuestImport Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 21/51] tree-wide: introduce parsing module and replace usages of ISO_EXT_RE_0 Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 22/51] common: test: set up parser testing code, add tests for 'iso' vtype Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 23/51] tree-wide: replace usages of VZTMPL_EXT_RE_1 with parsing functions Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 24/51] tree-wide: replace usages of BACKUP_EXT_RE_2 " Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 25/51] tree-wide: replace usages of inline regexes for snippets with parsers Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 26/51] tree-wide: partially replace usages of regexes for 'import' vtype Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 27/51] tree-wide: replace remaining " Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 28/51] tree-wide: simplify recently refactored parsing logic Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 29/51] test: list volumes: reorganize and modernize test running code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 30/51] test: list volumes: fix broken test checking for vmlist modifications Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 31/51] test: list volumes: introduce new format for test cases Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 32/51] test: list volumes: remove legacy code and migrate cases to new format Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 33/51] plugin: do not return volumes of undeclared content types anymore Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 34/51] plugin: correct comment in get_subdir_files helper Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 35/51] test: parse volname: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 36/51] test: parse volname: adapt tests regarding 'import' volume type Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 37/51] test: parse volname: move VM disk test creation into separate block Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 38/51] test: parse volname: move backup file test creation into sep. block Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 39/51] test: parse volname: parameterize test case creation for some vtypes Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 40/51] test: volume id: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 41/51] test: volume id: rename 'volname' test case parameter to 'file' Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 42/51] test: filesystem path: modernize code Max R. Carrara
2026-11-17 20:39 ` [PATCH pve-storage v3 43/51] plugin: list content directories without globbing Max R. Carrara
2026-11-18  9:12 ` [PATCH pve-storage v3 44/51] fix #2884: implement nested subdir scanning and support 'iso' vtype Max R. Carrara
2026-11-18  9:14 ` [PATCH pve-storage v3 45/51] fix #2884: support nested subdir scanning for 'vztmpl' volume type Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 46/51] fix #2884: support nested subdir scanning for 'snippets' vtype Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 47/51] test: add more tests for 'import' vtype & guard against nested subdirs Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 48/51] test: add tests guarding against subdir scanning for vtypes Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 49/51] storage: resolve images in content dir overrides ending with a slash Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-storage v3 50/51] bump the storage plugin API version Max R. Carrara
2026-11-18  9:14   ` [PATCH pve-manager v3 51/51] fix #2884: ui: storage: add field for 'max-scan-depth' property Max R. Carrara

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20261117203953.913035-9-m.carrara@proxmox.com \
    --to=m.carrara@proxmox.com \
    --cc=pve-devel@lists.proxmox.com \
    --cc=w.bumiller@proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal