rest/cli: rename param mapping related variable to shorter versions

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 414caa5d8c25ee4835ef7d1756e69fa98a2f144e..1e1e611c91d464b06f137961655cd90fbaf59fcf 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -67,6 +67,31 @@ sub get_standard_mapping {
     return $res;
 }
 
+my $gen_param_mapping_func = sub {
+    my ($cli_handler_class) = @_;
+
+    my $param_mapping = $cli_handler_class->can('param_mapping');
+
+    if (!$param_mapping) {
+       my $read_password = $cli_handler_class->can('read_password');
+       my $string_param_mapping = $cli_handler_class->can('string_param_file_mapping');
+
+       return $string_param_mapping if !$read_password;
+
+       $param_mapping = sub {
+           my ($name) = @_;
+
+           my $password_map = get_standard_mapping('pve-password', {
+               func => $read_password
+           });
+           my $map = $string_param_mapping ? $string_param_mapping->($name) : [];
+           return [@$map, $password_map];
+       };
+    }
+
+    return $param_mapping;
+};
+
 my $assert_initialized = sub {
     my @caller = caller;
     die "$caller[0]:$caller[2] - not initialized\n"
@@ -159,9 +184,7 @@ sub generate_usage_str {
     $separator //= '';
     $indent //= '';
 
-    my $read_password_func = $cli_handler_class->can('read_password');
-    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
-       $cli_handler_class->can('string_param_file_mapping');
+    my $param_cb = $gen_param_mapping_func->($cli_handler_class);
 
     my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
     $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
@@ -181,8 +204,7 @@ sub generate_usage_str {
                    $str .= $separator if $oldclass && $oldclass ne $class;
                    $str .= $indent;
                    $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
-                                             $fixed_param, $format,
-                                             $read_password_func, $param_mapping_func);
+                                             $fixed_param, $format, $param_cb);
                    $oldclass = $class;
 
                } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
@@ -205,8 +227,7 @@ sub generate_usage_str {
            $abort->("unknown command '$cmd'") if !$class;
 
            $str .= $indent;
-           $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
-                                     $read_password_func, $param_mapping_func);
+           $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb);
        }
        return $str;
     };
@@ -445,15 +466,15 @@ sub data_to_text {
 # $data - the data to print (array of objects)
 # $returnprops -json schema property description
 # $props_to_print - ordered list of properties to print
-# $sort_key is either a column name, or integer 1 which simply
-# sorts the output according to the leftmost column not containing
-# any undef. if not specified, we do not change order.
+# $sort_key can be used to sort after a column, if it isn't set we sort
+#   after the leftmost column (with no undef value in $data) this can be
+#   turned off by passing 0 as $sort_key
 sub print_text_table {
     my ($data, $returnprops, $props_to_print, $sort_key) = @_;
 
-    my $autosort = 0;
-    if (defined($sort_key) && ($sort_key eq 1)) {
-       $autosort = 1;
+    my $autosort = 1;
+    if (defined($sort_key) && $sort_key eq 0) {
+       $autosort = 0;
        $sort_key = undef;
     }
 
@@ -464,8 +485,7 @@ sub print_text_table {
 
     for (my $i = 0; $i < $column_count; $i++) {
        my $prop = $props_to_print->[$i];
-       my $propinfo = $returnprops->{$prop};
-       die "undefined property '$prop'" if !$propinfo;
+       my $propinfo = $returnprops->{$prop} // {};
 
        my $title = $propinfo->{title} // $prop;
        my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
@@ -480,7 +500,7 @@ sub print_text_table {
            $longest = $len if $len > $longest;
            $sortable = 0 if !defined($entry->{$prop});
        }
-       $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
+       $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
        $sort_key //= $prop if $sortable;
 
        $colopts->{$prop} = {
@@ -489,14 +509,15 @@ sub print_text_table {
            cutoff => $cutoff,
        };
 
+       # skip alignment and cutoff on last column
        $formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
     }
 
     printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
 
     if (defined($sort_key)) {
-       if ($returnprops->{$sort_key}->{type} eq 'integer' ||
-           $returnprops->{$sort_key}->{type} eq 'number') {
+       my $type = $returnprops->{$sort_key}->{type} // 'string';
+       if ($type eq 'integer' || $type eq 'number') {
            @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
        } else {
            @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
@@ -642,7 +663,7 @@ sub setup_environment {
 }
 
 my $handle_cmd  = sub {
-    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $preparefunc, $param_cb) = @_;
 
     $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
@@ -672,7 +693,7 @@ my $handle_cmd  = sub {
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
     $abort->("unknown command '$cmd_str'") if !$class;
 
-    my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
+    my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb);
 
     if (defined $outsub) {
        my $result_schema = $class->map_method_by_name($name)->{returns};
@@ -681,7 +702,7 @@ my $handle_cmd  = sub {
 };
 
 my $handle_simple_cmd = sub {
-    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $preparefunc, $param_cb) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
@@ -710,7 +731,7 @@ my $handle_simple_cmd = sub {
 
     &$preparefunc() if $preparefunc;
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
+    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $param_cb);
 
     if (defined $outsub) {
        my $result_schema = $class->map_method_by_name($name)->{returns};
@@ -734,9 +755,7 @@ sub run_cli_handler {
 
     my $preparefunc = $params{prepare};
 
-    my $read_password_func = $class->can('read_password');
-    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
-       $class->can('string_param_file_mapping');
+    my $param_cb = $gen_param_mapping_func->($cli_handler_class);
 
     $exename = &$get_exe_name($class);
 
@@ -746,9 +765,9 @@ sub run_cli_handler {
     $cmddef = ${"${class}::cmddef"};
 
     if (ref($cmddef) eq 'ARRAY') {
-       &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+       $handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb);
     } else {
-       &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+       $handle_cmd->(\@ARGV, $preparefunc, $param_cb);
     }
 
     exit 0;