proxmox-mirrors/pve-common
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-common synced 2025-07-17 14:01:32 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

CLIHandler: fix command usage string generation

Browse Source 
track our command string, i.e. everything which cannot be an argument
for a specific command, in resolve_cmd, as we go through the commando
definition there anyway and know if a ARGV element is part of the
command itself or its arguments.

Fixes a problem where a invalid command had all the passed parameter
attached in the resulting USAGE output.

Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
This commit is contained in:
Thomas Lamprecht 2018-03-06 09:08:11 +01:00 committed by Wolfgang Bumiller
parent 7c5eeae56a
commit f932646909
1 changed files with 9 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

21
src/PVE/CLIHandler.pm
View File

@ -75,6 +75,7 @@ sub resolve_cmd {
my ($argv, $is_alias) = @_; my ($argv, $is_alias) = @_;
my ($def, $cmd) = ($cmddef, $argv); my ($def, $cmd) = ($cmddef, $argv);
my $cmdstr = $exename;
if (ref($argv) eq 'ARRAY') { if (ref($argv) eq 'ARRAY') {
my $expanded = {}; my $expanded = {};
@ -82,6 +83,7 @@ sub resolve_cmd {
for my $i (0..$last_arg_id) { for my $i (0..$last_arg_id) {
$cmd = $expand_command_name->($def, $argv->[$i]); $cmd = $expand_command_name->($def, $argv->[$i]);
$cmdstr .= " $cmd";
$expanded->{$argv->[$i]} = $cmd if $cmd ne $argv->[$i]; $expanded->{$argv->[$i]} = $cmd if $cmd ne $argv->[$i];
last if !defined($def->{$cmd}); last if !defined($def->{$cmd});
$def = $def->{$cmd}; $def = $def->{$cmd};
@ -89,7 +91,7 @@ sub resolve_cmd {
if (ref($def) eq 'ARRAY') { if (ref($def) eq 'ARRAY') {
# could expand to a real command, rest of $argv are its arguments # could expand to a real command, rest of $argv are its arguments
my $cmd_args = [ @$argv[$i+1..$last_arg_id] ]; my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
return ($cmd, $def, $cmd_args, $expanded); return ($cmd, $def, $cmd_args, $expanded, $cmdstr);
} }
if (defined($def->{alias})) { if (defined($def->{alias})) {
@ -102,9 +104,9 @@ sub resolve_cmd {
# got either a special command (bashcomplete, verifyapi) or an unknown # got either a special command (bashcomplete, verifyapi) or an unknown
# cmd, just return first entry as cmd and the rest of $argv as cmd_arg # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
my $cmd_args = [ @$argv[1..$last_arg_id] ]; my $cmd_args = [ @$argv[1..$last_arg_id] ];
return ($argv->[0], $def, $cmd_args, $expanded); return ($argv->[0], $def, $cmd_args, $expanded, $cmdstr);
} }
return ($cmd, $def); return ($cmd, $def, undef, undef, $cmdstr);
} }
sub generate_usage_str { sub generate_usage_str {
@ -121,7 +123,7 @@ sub generate_usage_str {
my $param_mapping_func = $cli_handler_class->can('param_mapping') || my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
$cli_handler_class->can('string_param_file_mapping'); $cli_handler_class->can('string_param_file_mapping');
my ($subcmd, $def) = resolve_cmd($cmd); my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
my $generate; my $generate;
$generate = sub { $generate = sub {
@ -168,9 +170,6 @@ sub generate_usage_str {
return $str; return $str;
}; };
my $cmdstr = $exename;
$cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
return $generate->($indent, $separator, $def, $cmdstr); return $generate->($indent, $separator, $def, $cmdstr);
} }
@ -462,8 +461,7 @@ my $handle_cmd = sub {
$cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ]; $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
my $cmd_str = join(' ', @$args); my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
my ($cmd, $def, $cmd_args) = resolve_cmd($args);
$abort->("no command specified") if !$cmd; $abort->("no command specified") if !$cmd;
@ -482,15 +480,14 @@ my $handle_cmd = sub {
} }
# checked special commands, if def is still a hash we got an incomplete sub command # checked special commands, if def is still a hash we got an incomplete sub command
$abort->("incomplete command '$exename $cmd_str'") if ref($def) eq 'HASH'; $abort->("incomplete command '$cmd_str'") if ref($def) eq 'HASH';
&$preparefunc() if $preparefunc; &$preparefunc() if $preparefunc;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []}; my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
$abort->("unknown command '$cmd_str'") if !$class; $abort->("unknown command '$cmd_str'") if !$class;
my $prefix = "$exename $cmd_str"; 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($prefix, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
&$outsub($res) if $outsub; &$outsub($res) if $outsub;
}; };