X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=9955d77e06395c85dd219dac7d9f322bc1824992;hp=71457070168ebaf809d1c7850c1c0ca9667d5bd1;hb=87e31b23589e2747b819d7ac5f1fc45f6754b9c1;hpb=0adee98536b55a5a391e74844423e704fdb98f96 diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index 7145707..9955d77 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,10 +2,13 @@ package PVE::CLIHandler; use strict; use warnings; + use JSON; +use Scalar::Util qw(weaken); use PVE::SafeSyslog; use PVE::Exception qw(raise raise_param_exc); +use PVE::JSONSchema; use PVE::RESTHandler; use PVE::PTY; use PVE::INotify; @@ -17,7 +20,9 @@ use base qw(PVE::RESTHandler); # A real command is always an array consisting of its class, name, array of # position fixed (required) parameters and hash of predefined parameters when # mapping a CLI command t o an API call. Optionally an output method can be -# passed at the end, e.g., for formatting or transformation purpose. +# passed at the end, e.g., for formatting or transformation purpose, and +# a schema of additional properties/arguments which are added to +# the method schema and gets passed to the formatter. # # [class, name, fixed_params, API_pre-set params, output_sub ] # @@ -106,13 +111,15 @@ my $abort = sub { }; my $expand_command_name = sub { - my ($def, $cmd) = @_; + my ($def, $cmd, $enforce_exact) = @_; return $cmd if exists $def->{$cmd}; # command is already complete my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias}) }; my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def; + return @expanded if !$enforce_exact; + return $expanded[0] if scalar(@expanded) == 1; # enforce exact match return undef; @@ -141,18 +148,23 @@ sub resolve_cmd { my $last_arg_id = scalar(@$argv) - 1; for my $i (0..$last_arg_id) { - $cmd = $expand_command_name->($def, $argv->[$i]); + $cmd = $expand_command_name->($def, $argv->[$i], 1); if (defined($cmd)) { # If the argument was expanded (or was already complete) and it # is the final argument, tell our caller about it: $expanded_last_arg = $cmd if $i == $last_arg_id; } else { # Otherwise continue with the unexpanded version of it. - $cmd = $argv->[$i]; + $cmd = $argv->[$i]; } $cmdstr .= " $cmd"; + if (!defined($def->{$cmd})) { + # $cmd still could be a valid prefix for bash_completion + # in that case keep $def as it is, else set it to undef + $def = undef if !$expand_command_name->($def, $cmd); + last; + } $def = $def->{$cmd}; - last if !defined($def); if (ref($def) eq 'ARRAY') { # could expand to a real command, rest of $argv are its arguments @@ -188,10 +200,9 @@ sub generate_usage_str { 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'; - my $generate; - $generate = sub { + my $generate_weak; + $generate_weak = sub { my ($indent, $separator, $def, $prefix) = @_; my $str = ''; @@ -200,12 +211,12 @@ sub generate_usage_str { foreach my $cmd (&$sortfunc($def)) { if (ref($def->{$cmd}) eq 'ARRAY') { - my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}}; + my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}}; $str .= $separator if $oldclass && $oldclass ne $class; $str .= $indent; $str .= $class->usage_str($name, "$prefix $cmd", $arg_param, - $fixed_param, $format, $param_cb); + $fixed_param, $format, $param_cb, $formatter_properties); $oldclass = $class; } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) { @@ -215,7 +226,7 @@ sub generate_usage_str { } else { next if $def->{$cmd}->{alias}; - my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd"); + my $substr = $generate_weak->($indent, '', $def->{$cmd}, "$prefix $cmd"); if ($substr) { $substr .= $separator if $substr !~ /\Q$separator\E{2}/; $str .= $substr; @@ -224,14 +235,16 @@ sub generate_usage_str { } } else { - my ($class, $name, $arg_param, $fixed_param) = @$def; - $abort->("unknown command '$cmd'") if !$class; + $abort->("unknown command '$cmd->[0]'") if !$def; + my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def; $str .= $indent; - $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb); + $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties); } return $str; }; + my $generate = $generate_weak; + weaken($generate_weak); return $generate->($indent, $separator, $def, $cmdstr); } @@ -333,9 +346,9 @@ sub print_usage_short { $assert_initialized->(); print $fd "ERROR: $msg\n" if $msg; - print $fd "USAGE: $exename [ARGS] [OPTIONS]\n"; + print $fd "USAGE: $exename [ARGS] [OPTIONS]\n\n"; - print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub { + print {$fd} generate_usage_str('short', $cmd, ' ' x 7, $cmd ? '' : "\n", sub { my ($h) = @_; return sort { if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') { @@ -395,7 +408,7 @@ my $print_bash_completion = sub { my $skip_param = {}; - my ($class, $name, $arg_param, $uri_param) = @$def; + my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def; $arg_param //= []; $uri_param //= {}; @@ -406,7 +419,8 @@ my $print_bash_completion = sub { my $info = $class->map_method_by_name($name); - my $prop = $info->{parameters}->{properties}; + my $prop = { %{$info->{parameters}->{properties}} }; # copy + $prop = { %$prop, %$formatter_properties } if $formatter_properties; my $print_parameter_completion = sub { my ($pname) = @_; @@ -487,6 +501,30 @@ complete -o default -C '$exename bashcomplete' $exename __EOD__ } +sub generate_zsh_completions { + my ($class) = @_; + + # generate zsh completion config + + $exename = &$get_exe_name($class); + + print <<__EOD__; +#compdef _$exename $exename + +function _$exename() { + local cwords line point cmd curr prev + cwords=\${#words[@]} + line=\$words + point=\${#line} + cmd=\${words[1]} + curr=\${words[cwords]} + prev=\${words[cwords-1]} + compadd -- \$(COMP_CWORD="\$cwords" COMP_LINE="\$line" COMP_POINT="\$point" \\ + $exename bashcomplete "\$cmd" "\$curr" "\$prev") +} +__EOD__ +} + sub generate_asciidoc_synopsys { my ($class) = @_; $class->generate_asciidoc_synopsis(); @@ -547,23 +585,22 @@ my $handle_cmd = sub { &$preparefunc() if $preparefunc; - my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []}; + my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []}; $abort->("unknown command '$cmd_str'") if !$class; - my $options = PVE::CLIFormatter::query_terminal_options({}); - - my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $options); + my ($res, $formatter_params) = $class->cli_handler( + $cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties); if (defined $outsub) { my $result_schema = $class->map_method_by_name($name)->{returns}; - $outsub->($res, $result_schema, $options); + $outsub->($res, $result_schema, $formatter_params); } }; my $handle_simple_cmd = sub { my ($args, $preparefunc, $param_cb) = @_; - my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef}; + my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef}; die "no class specified" if !$class; if (scalar(@$args) >= 1) { @@ -590,13 +627,12 @@ my $handle_simple_cmd = sub { &$preparefunc() if $preparefunc; - my $options = PVE::CLIFormatter::query_terminal_options({}); - - my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $options); + my ($res, $formatter_params) = $class->cli_handler( + $name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties); if (defined $outsub) { my $result_schema = $class->map_method_by_name($name)->{returns}; - $outsub->($res, $result_schema, $options); + $outsub->($res, $result_schema, $formatter_params); } };