X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=0b93a4bc224fa5021d2bb29bfe6f391bec89fbb7;hp=2fa7933ee00574baaf860cb87fcc0f34974d7e38;hb=f53ad23ac974cf6677e1eb3faa44a2f61b8e1040;hpb=85b9def289c52e768cc6aea99687f75211952646 diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index 2fa7933..0b93a4b 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,11 +2,14 @@ package PVE::CLIHandler; use strict; use warnings; +use JSON; use PVE::SafeSyslog; use PVE::Exception qw(raise raise_param_exc); use PVE::RESTHandler; +use PVE::PTY; use PVE::INotify; +use PVE::CLIFormatter; use base qw(PVE::RESTHandler); @@ -37,6 +40,59 @@ my $cmddef; my $exename; my $cli_handler_class; +my $standard_mappings = { + 'pve-password' => { + name => 'password', + desc => '', + interactive => 1, + func => sub { + my ($value) = @_; + return $value if $value; + return PVE::PTY::get_confirmed_password(); + }, + }, +}; +sub get_standard_mapping { + my ($name, $base) = @_; + + my $std = $standard_mappings->{$name}; + die "no such standard mapping '$name'\n" if !$std; + + my $res = $base || {}; + + foreach my $opt (keys %$std) { + next if defined($res->{$opt}); + $res->{$opt} = $std->{$opt}; + } + + 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" @@ -129,9 +185,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'; @@ -151,8 +205,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')) { @@ -175,8 +228,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; }; @@ -399,90 +451,6 @@ my $print_bash_completion = sub { &$print_result(@option_list); }; -# prints a formatted table with a title row. -# $formatopts is an array of hashes, with the following keys: -# 'key' - key of $data element to print -# 'title' - column title, defaults to 'key' - won't get cutoff -# 'cutoff' - maximal (print) length of this column values, if set -# the last column will never be cutoff -# 'default' - optional default value for the column -# formatopts element order defines column order (left to right) -sub print_text_table { - my ($formatopts, $data) = @_; - - my ($formatstring, @keys, @titles, %cutoffs, %defaults); - my $last_col = $formatopts->[$#{$formatopts}]; - - foreach my $col ( @$formatopts ) { - my ($key, $title, $cutoff, $default) = @$col{qw(key title cutoff default)}; - $title //= $key; - - push @keys, $key; - push @titles, $title; - $defaults{$key} = $default; - - # calculate maximal print width and cutoff - my $titlelen = length($title); - - my $longest = $titlelen; - foreach my $entry (@$data) { - my $len = length($entry->{$key}) // 0; - $longest = $len if $len > $longest; - } - - $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest; - $cutoffs{$key} = $cutoff; - - my $printalign = $cutoff > $titlelen ? '-' : ''; - if ($col == $last_col) { - $formatstring .= "%${printalign}${titlelen}s\n"; - } else { - $formatstring .= "%${printalign}${cutoff}s "; - } - } - - printf $formatstring, @titles; - - foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) { - printf $formatstring, map { substr(($entry->{$_} // $defaults{$_}), 0 , $cutoffs{$_}) } @keys; - } -} - -sub print_entry { - my $entry = shift; - - #TODO: handle objects/hashes as well - foreach my $item (sort keys %$entry) { - if (ref($entry->{$item}) eq 'ARRAY') { - printf "%s: [ %s ]\n", $item, join(", ", @{$entry->{$item}}); - } else { - printf "%s: %s\n", $item, $entry->{$item}; - } - } -} - -# prints the result of an API GET call returning an array -# and to have the results key of the API call defined. -sub print_api_list { - my ($props_to_print, $data, $returninfo) = @_; - - my $returnprops = $returninfo->{items}->{properties}; - - my $formatopts = []; - foreach my $prop ( @$props_to_print ) { - my $propinfo = $returnprops->{$prop}; - my $colopts = { - key => $prop, - title => $propinfo->{title}, - default => $propinfo->{default}, - cutoff => $propinfo->{print_width} // $propinfo->{maxLength}, - }; - push @$formatopts, $colopts; - } - - print_text_table($formatopts, $data); -} - sub verify_api { my ($class) = @_; @@ -552,7 +520,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'] ]; @@ -582,16 +550,16 @@ 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 $returninfo = $class->map_method_by_name($name)->{returns}; - $outsub->($res, $returninfo); + my $result_schema = $class->map_method_by_name($name)->{returns}; + $outsub->($res, $result_schema); } }; 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; @@ -620,11 +588,11 @@ 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 $returninfo = $class->map_method_by_name($name)->{returns}; - $outsub->($res, $returninfo); + my $result_schema = $class->map_method_by_name($name)->{returns}; + $outsub->($res, $result_schema); } }; @@ -644,9 +612,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); @@ -656,9 +622,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;