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 15/51] storage: clean up code that was moved into helper in path_to_volume_id
Date: Tue, 17 Nov 2026 21:38:47 +0100	[thread overview]
Message-ID: <20261117203953.913035-16-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261117203953.913035-1-m.carrara@proxmox.com>

In order to make the parsing logic in `path_to_volume_id()` both
simpler and more manageable for future changes, do the following:

1. Iterate over a list of vtypes that store their contents in
   subdirectories and fetch said subdirectories dynamically instead of
   hardcoding them.

2. Explicitly exclude the `rootdir` vtype in this list of vtypes, as
   its subdirectory is currently not used. Since content directories
   may be nested inside one another, check the vtypes with the longest
   subdirectory first, so that a path belongs to the vtype whose
   subdirectory contains it most closely.

3. Strip the vtype subdirectory from the beginning of the path in
   order to make matching on the file name easier. Return early as a
   safeguard if this fails.

4. Adapt the original regexes in the parsing helper to not include the
   vtype subdir anymore, since this is now being stripped. Anchor them
   at the start of the remainder, so that files in subdirectories of a
   vtype subdir do not resolve to a volume directly inside it.

Additionally, it is necessary to still return a (vtype, volid) pair in
the new helper, because of the new `vm-vol`, `vm-state`, and
`ct-vol` volume types. This only matters for the `images` case.

Note that the parsing logic of the `parse_volid_from_file_path()`
helper inside `path_to_volume_id()` now is very similar to the parsing
logic of the `get_subdir_file_info()` closure in the
`get_subdir_files()` helper inside `Plugin.pm`. This opens up further
simplification / code de-duplication in the future, so that our
parsing logic can eventually be kept in one place only.

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

diff --git a/src/PVE/Storage.pm b/src/PVE/Storage.pm
index f5c866db..39e72933 100755
--- a/src/PVE/Storage.pm
+++ b/src/PVE/Storage.pm
@@ -23,11 +23,13 @@ use PVE::JSONSchema;
 use PVE::INotify;
 use PVE::RPCEnvironment;
 use PVE::SSHInfo;
 use PVE::RESTEnvironment qw(log_warn);
 
-use PVE::Storage::Common;
+use PVE::Storage::Common qw(
+    plugin_get_default_vtype_subdirs
+);
 use PVE::Storage::Plugin;
 use PVE::Storage::DirPlugin;
 use PVE::Storage::LVMPlugin;
 use PVE::Storage::LvmThinPlugin;
 use PVE::Storage::NFSPlugin;
@@ -734,74 +736,123 @@ sub path_to_volume_id {
 
     # Note: abs_path() return undef if $path doesn not exist
     # for example when nfs storage is not mounted
     $path = abs_path($path) || $path;
 
+    my $get_vtypes_to_check = sub {
+        my ($plugin, $scfg) = @_;
+
+        # TODO: vtype split: handle directory for 'rootdir' type.
+        # CTs currently use the same dir as VMs --> the dir for the 'images' type.
+        # Directory is therefore unused right now, so exclude it.
+        my $vtypes = [grep { $_ ne 'rootdir' } keys plugin_get_default_vtype_subdirs()->%*];
+
+        my $dir_lengths = {};
+        for my $vtype ($vtypes->@*) {
+            # FIXME: Call plugin_get_vtype_subdir() instead of
+            # $plugin->get_subdir() on the next APIAGE reset.
+            my $subdir = $plugin->get_subdir($scfg, $vtype);
+
+            # Note that we simply use the length of the directory without "/"
+            # separators here, because something like `foo/bar` is always
+            # longer than `foo`. IOW, a contained directory always has strictly
+            # more components.
+            # For "sibling" subdirs, e.g. `foo/bar` and `foo/baz`, the order
+            # doesn't matter.
+            #
+            # This is equivalent to counting the components of a path, but this
+            # method here should be faster.
+            $dir_lengths->{$vtype} = length($subdir =~ s!/+$!!r);
+        }
+
+        my $order = { map { $vtypes->[$_] => $_ } 0 .. $vtypes->$#* };
+
+        return [
+            sort {
+                $dir_lengths->{$b} <=> $dir_lengths->{$a} || $order->{$a} <=> $order->{$b}
+            } $vtypes->@*
+        ];
+    };
+
     my $parse_volid_from_file_path = sub {
-        my ($plugin, $sid, $scfg) = @_;
+        my ($plugin, $sid, $scfg, $vtype) = @_;
 
         # FIXME: Call plugin_get_vtype_subdir() instead of $plugin->get_subdir()
         # on the next APIAGE reset.
-        my $imagedir = $plugin->get_subdir($scfg, 'images');
-        my $isodir = $plugin->get_subdir($scfg, 'iso');
-        my $tmpldir = $plugin->get_subdir($scfg, 'vztmpl');
-        my $backupdir = $plugin->get_subdir($scfg, 'backup');
-        my $snippetsdir = $plugin->get_subdir($scfg, 'snippets');
-        my $importdir = $plugin->get_subdir($scfg, 'import');
+        my $vtype_subdir = $plugin->get_subdir($scfg, $vtype);
 
-        if ($path =~ m!^\Q$imagedir\E/(\d+)/([^/\s]+)$!) {
+        # 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 'images') {
+            return if $filename !~ m!^/(\d+)/([^/\s]+)$!;
             my $vmid = $1;
             my $name = $2;
 
             my $vollist = $plugin->list_images($sid, $scfg, $vmid);
             for my $info ($vollist->@*) {
                 my ($storeid, $volname) = parse_volume_id($info->{volid});
                 my $volpath = $plugin->path($scfg, $volname, $storeid);
                 if ($volpath eq $path) {
-                    my ($vtype) = $plugin->parse_volname($volname);
-                    return ($vtype, $info->{volid});
+                    my ($parsed_vtype) = $plugin->parse_volname($volname);
+                    return ($parsed_vtype, $info->{volid});
                 }
             }
 
-            return ('');
+            return;
         }
 
-        if ($path =~ m!^\Q$isodir\E/([^/]+$ISO_EXT_RE_0)$!) {
+        if ($vtype eq 'iso') {
+            return if $filename !~ m!^/([^/]+$ISO_EXT_RE_0)$!;
             my $name = $1;
-            return ('iso', "$sid:iso/$name");
+            return ($vtype, "$sid:iso/$name");
         }
 
-        if ($path =~ m!^\Q$tmpldir\E/([^/]+$VZTMPL_EXT_RE_1)$!) {
+        if ($vtype eq 'vztmpl') {
+            return if $filename !~ m!^/([^/]+$VZTMPL_EXT_RE_1)$!;
             my $name = $1;
-            return ('vztmpl', "$sid:vztmpl/$name");
+            return ($vtype, "$sid:vztmpl/$name");
         }
 
-        if ($path =~ m!^\Q$backupdir\E/([^/]+$BACKUP_EXT_RE_2)$!) {
+        if ($vtype eq 'backup') {
+            return if $filename !~ m!^/([^/]+$BACKUP_EXT_RE_2)$!;
             my $name = $1;
-            return ('backup', "$sid:backup/$name");
+            return ($vtype, "$sid:backup/$name");
         }
 
-        if ($path =~ m!^\Q$snippetsdir\E/([^/]+)$!) {
+        if ($vtype eq 'snippets') {
+            return if $filename !~ m!^/([^/]+)$!;
             my $name = $1;
-            return ('snippets', "$sid:snippets/$name");
+            return ($vtype, "$sid:snippets/$name");
         }
 
-        if ($path =~ m!^\Q$importdir\E/(${SAFE_CHAR_CLASS_RE}+${IMPORT_EXT_RE_1})$!) {
+        if ($vtype eq 'import') {
+            return if $filename !~ m!^/(${SAFE_CHAR_CLASS_RE}+${IMPORT_EXT_RE_1})$!;
             my $name = $1;
-            return ('import', "$sid:import/$name");
+            return ($vtype, "$sid:import/$name");
         }
 
-        return ('');
+        return;
     };
 
     for my $sid (keys $ids->%*) {
         my $scfg = $ids->{$sid};
         next if !$scfg->{path};
         my $plugin = PVE::Storage::Plugin->lookup($scfg->{type});
 
-        my ($vtype, $volid) = $parse_volid_from_file_path->($plugin, $sid, $scfg);
-        return ($vtype, $volid) if $vtype;
+        for my $vtype ($get_vtypes_to_check->($plugin, $scfg)->@*) {
+            my ($actual_vtype, $volid) =
+                $parse_volid_from_file_path->($plugin, $sid, $scfg, $vtype);
+
+            if (defined($volid)) {
+                return ($actual_vtype, $volid);
+            }
+        }
     }
 
     # can't map path to volume id
     return ('');
 }
-- 
2.47.3





  parent reply	other threads:[~2026-11-17 20:42 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 ` [PATCH pve-storage v3 08/51] plugin: adapt get_subdir_files helper of list_volumes API method Max R. Carrara
2026-11-17 20:38 ` [PATCH pve-storage v3 09/51] plugin: update code style of list_volumes plugin " 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 ` Max R. Carrara [this message]
2026-11-17 20:38 ` [PATCH pve-storage v3 16/51] api: status: move content type assert for up-/downloads " 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-16-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