all lists on 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 28/51] tree-wide: simplify recently refactored parsing logic
Date: Tue, 17 Nov 2026 21:39:00 +0100	[thread overview]
Message-ID: <20261117203953.913035-29-m.carrara@proxmox.com> (raw)
In-Reply-To: <20261117203953.913035-1-m.carrara@proxmox.com>

PVE::API2::Storage::Status:

In the parsing helper for file transfers, it is not necessary to
handle the parsing of each volume type individually anymore, since we
use `assert_can_transfer_files()` beforehand and also raise an
exception if parsing fails in general.

Therefore, pull out the common parts of the branches for individual
volume types. Retain only the special case for the `import` type where
we do not accept `.ovf` files.

PVE::Storage:

Merge the branches in `path_to_volume_id()` for all volume types,
except `images`, since they all do the same thing now. Strip the
volume type subdirectory from the given file path only for the
`images` volume type.

PVE::Storage::Plugin:

Condense all of the if-clauses as much as possible in the
`parse_volname()` and `get_subdir_files()` subs.

In `parse_volname()`, extend the error message of the final `die` at
the end of the method, stating that the volume type is unhandled.

The guard clause after the `parse_volname_as_parts()` call already
`die`s on parsing failure, so that final `die` should never be hit
unless we introduce a new volume type and happen to forget to handle
it in this method.

In `get_subdir_files()`, do not strip the volume type subdirectory
from the beginning of the current path anymore, because that is
handled by the `parse_abs_path_as_volid_parts()` parsing function, which
left `$filename` unused.

Signed-off-by: Max R. Carrara <m.carrara@proxmox.com>
---
 src/PVE/API2/Storage/Status.pm | 40 ++++--------------
 src/PVE/Storage.pm             | 44 ++++++--------------
 src/PVE/Storage/Plugin.pm      | 76 ++++++++++++----------------------
 3 files changed, 45 insertions(+), 115 deletions(-)

diff --git a/src/PVE/API2/Storage/Status.pm b/src/PVE/API2/Storage/Status.pm
index 15ba1fe3..24213f79 100644
--- a/src/PVE/API2/Storage/Status.pm
+++ b/src/PVE/API2/Storage/Status.pm
@@ -71,49 +71,23 @@ my sub assert_can_transfer_files : prototype($$$) {
 }
 
 my sub parse_transferred_file_path_extension : prototype($$) {
     my ($path, $vtype) = @_;
 
-    if ($vtype eq 'iso') {
-        my $parts = parse_rel_path_as_volname_parts($path, $vtype);
+    my $parts = parse_rel_path_as_volname_parts($path, $vtype);
 
-        if (!defined($parts)) {
-            raise_param_exc({ filename => "wrong file extension" });
-        }
-
-        my $ext = $parts->{ext};
-        return $ext;
+    if (!defined($parts)) {
+        raise_param_exc({ filename => "invalid filename or wrong file extension" });
     }
 
-    if ($vtype eq 'vztmpl') {
-        my $parts = parse_rel_path_as_volname_parts($path, $vtype);
+    my $ext = $parts->{ext};
 
-        if (!defined($parts)) {
-            raise_param_exc({ filename => "wrong file extension" });
-        }
-
-        my $ext = $parts->{ext};
-        return $ext;
+    if ($vtype eq 'import' && $ext eq 'ovf') {
+        raise_param_exc({ filename => "wrong file extension" });
     }
 
-    if ($vtype eq 'import') {
-        my $parts = parse_rel_path_as_volname_parts($path, $vtype);
-
-        if (!defined($parts)) {
-            raise_param_exc({ filename => "invalid filename or wrong extension" });
-        }
-
-        my $ext = $parts->{ext};
-
-        if ($ext eq 'ovf') {
-            raise_param_exc({ filename => "wrong file extension" });
-        }
-
-        return $ext;
-    }
-
-    die "upload / download: failed to parse '$path' - unhandled content type '$vtype'\n";
+    return $ext;
 }
 
 my sub assert_file_transfer_contents_valid : prototype($$$) {
     my ($path, $vtype, $extension) = @_;
 
diff --git a/src/PVE/Storage.pm b/src/PVE/Storage.pm
index 46578989..f3d1298d 100755
--- a/src/PVE/Storage.pm
+++ b/src/PVE/Storage.pm
@@ -795,22 +795,22 @@ sub path_to_volume_id {
     };
 
     my $parse_volid_from_file_path = sub {
         my ($plugin, $sid, $scfg, $vtype) = @_;
 
-        # FIXME: Call plugin_get_vtype_subdir() instead of $plugin->get_subdir()
-        # on the next APIAGE reset.
-        my $vtype_subdir = $plugin->get_subdir($scfg, $vtype);
-
-        # 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') {
+            # FIXME: Call plugin_get_vtype_subdir() instead of $plugin->get_subdir()
+            # on the next APIAGE reset.
+            my $vtype_subdir = $plugin->get_subdir($scfg, $vtype);
+
+            # 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;
+            }
+
             return if $filename !~ m!^/(\d+)/([^/\s]+)$!;
             my $vmid = $1;
             my $name = $2;
 
             my $vollist = $plugin->list_images($sid, $scfg, $vmid);
@@ -824,31 +824,11 @@ sub path_to_volume_id {
             }
 
             return;
         }
 
-        if ($vtype eq 'iso') {
-            return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
-        }
-
-        if ($vtype eq 'vztmpl') {
-            return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
-        }
-
-        if ($vtype eq 'backup') {
-            return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
-        }
-
-        if ($vtype eq 'snippets') {
-            return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
-        }
-
-        if ($vtype eq 'import') {
-            return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
-        }
-
-        return;
+        return ($vtype, parse_abs_path_as_volid($sid, $scfg, $path, $vtype));
     };
 
     for my $sid (keys $ids->%*) {
         my $scfg = $ids->{$sid};
         next if !$scfg->{path};
diff --git a/src/PVE/Storage/Plugin.pm b/src/PVE/Storage/Plugin.pm
index 8707219f..0d44224f 100644
--- a/src/PVE/Storage/Plugin.pm
+++ b/src/PVE/Storage/Plugin.pm
@@ -20,10 +20,11 @@ use PVE::Storage::Common qw(
     plugin_get_vtype_subdir
 );
 use PVE::Storage::Common::Parse qw(
     parse_volname_as_parts
     parse_abs_path_as_volid_parts
+    parse_volid_as_parts
 );
 
 use JSON;
 
 use base qw(PVE::SectionConfig);
@@ -470,12 +471,12 @@ sub verify_options {
 PVE::JSONSchema::register_format('pve-volume-id', \&parse_volume_id);
 
 sub parse_volume_id {
     my ($volid, $noerr) = @_;
 
-    if ($volid =~ m/^([a-z][a-z0-9\-\_\.]*[a-z0-9]):(.+)$/i) {
-        return wantarray ? ($1, $2) : $1;
+    if (defined(my $parts = parse_volid_as_parts($volid))) {
+        return wantarray ? ($parts->{storeid}, $parts->{volname}) : $parts->{storeid};
     }
     return undef if $noerr;
     die "unable to parse volume ID '$volid'\n";
 }
 
@@ -899,41 +900,35 @@ sub parse_volname {
         my (undef, $format, $isBase) = parse_name_dir($name);
         my $vtype = $class->guest_volume_vtype($format, $name);
         return ($vtype, $name, $vmid, undef, undef, $isBase, $format);
     }
 
-    if (defined(my $parts = parse_volname_as_parts($volname))) {
-        my ($vtype, $volume_path) = $parts->@{qw(vtype path)};
+    my $parts = parse_volname_as_parts($volname);
+    die "unable to parse directory volume name '$volname'\n"
+        if !defined($parts);
 
-        if ($vtype eq 'iso') {
-            return ($vtype, $volume_path, undef, undef, undef, undef, 'raw');
-        }
+    my ($vtype, $volume_path) = $parts->@{qw(vtype path)};
 
-        if ($vtype eq 'vztmpl') {
-            return ($vtype, $volume_path, undef, undef, undef, undef, 'raw');
-        }
-
-        if ($vtype eq 'backup') {
-            return ($vtype, $volume_path, $parts->{vmid}, undef, undef, undef, 'raw');
-        }
-
-        if ($vtype eq 'snippets') {
-            return ($vtype, $volume_path, undef, undef, undef, undef, 'raw');
-        }
-
-        if ($vtype eq 'import') {
-            my $format = $parts->{ext};
-
-            if (defined(my $content_ext = $parts->{'content-ext'})) {
-                $format .= "+$content_ext";
-            }
-
-            return ($vtype, $volume_path, undef, undef, undef, undef, $format);
-        }
+    if ($vtype eq 'iso' || $vtype eq 'vztmpl' || $vtype eq 'snippets') {
+        return ($vtype, $volume_path, undef, undef, undef, undef, 'raw');
     }
 
-    die "unable to parse directory volume name '$volname'\n";
+    if ($vtype eq 'backup') {
+        return ($vtype, $volume_path, $parts->{vmid}, undef, undef, undef, 'raw');
+    }
+
+    if ($vtype eq 'import') {
+        my $format = $parts->{ext};
+
+        if (defined(my $content_ext = $parts->{'content-ext'})) {
+            $format .= "+$content_ext";
+        }
+
+        return ($vtype, $volume_path, undef, undef, undef, undef, $format);
+    }
+
+    die "unable to parse directory volume name '$volname' - unhandled volume type '$vtype'\n";
 }
 
 =head3 get_parsed_format
 
 Return the disk format encoded in the given volume name, or C<undef> if the name does not spell one
@@ -1882,44 +1877,31 @@ my sub get_subdir_files {
     my $res = [];
 
     my $get_subdir_file_info = sub {
         my ($path, $st) = @_;
 
-        # 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;
-        }
+        my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
+        return if !defined($parts);
 
         if ($vtype eq 'iso') {
-            my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
-            return if !defined($parts);
-
             return {
                 volid => $parts->{volid},
                 format => 'iso', # always 'iso' even if we have a file ending in .img
             };
         }
 
         if ($vtype eq 'vztmpl') {
-            my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
-            return if !defined($parts);
-
             my ($ext_archive, $ext_compression) = $parts->@{qw(ext-archive ext-compression)};
             my $format = defined($ext_compression) ? "t$ext_compression" : $ext_archive;
 
             return {
                 volid => $parts->{volid},
                 format => $format,
             };
         }
 
         if ($vtype eq 'backup') {
-            my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
-            return if !defined($parts);
-
             my $format = $parts->{ext};
             my $volume_path = $parts->{path};
 
             # Check if parsed VMID matched provided VMID in order to avoid
             # false positives (VMID in parent directory name)
@@ -1957,23 +1939,17 @@ my sub get_subdir_files {
 
             return $info;
         }
 
         if ($vtype eq 'snippets') {
-            my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
-            return if !defined($parts);
-
             return {
                 volid => $parts->{volid},
                 format => 'snippet',
             };
         }
 
         if ($vtype eq 'import') {
-            my $parts = parse_abs_path_as_volid_parts($storeid, $scfg, $path, $vtype);
-            return if !defined($parts);
-
             return {
                 volid => $parts->{volid},
                 format => $parts->{ext},
             };
         }
-- 
2.47.3





  parent reply	other threads:[~2026-11-17 20:44 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 ` [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 ` Max R. Carrara [this message]
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-29-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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal