]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/CLIHandler.pm
cli: filter out aliases when trying to expand command
[pve-common.git] / src / PVE / CLIHandler.pm
index 33b7aca04742e9b9846cfb2d7740f7156607a94d..49a459ba26299877c3d2abcd53feb0085c50eb65 100644 (file)
@@ -52,11 +52,14 @@ my $abort = sub {
 my $expand_command_name = sub {
     my ($def, $cmd) = @_;
 
-    if (!$def->{$cmd}) {
-       my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
-       return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
-    }
-    return $cmd;
+    return $cmd if exists $def->{$cmd}; # command is already complete
+
+    my $is_alias = sub { ref($_[0]) eq 'HASH' && $_[0]->{alias} };
+    my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
+
+    return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
+
+    return undef;
 };
 
 my $get_commands = sub {
@@ -75,21 +78,30 @@ sub resolve_cmd {
     my ($argv, $is_alias) = @_;
 
     my ($def, $cmd) = ($cmddef, $argv);
+    my $cmdstr = $exename;
 
     if (ref($argv) eq 'ARRAY') {
-       my $expanded = {};
+       my $expanded_last_arg;
        my $last_arg_id = scalar(@$argv) - 1;
 
        for my $i (0..$last_arg_id) {
            $cmd = $expand_command_name->($def, $argv->[$i]);
-           $expanded->{$argv->[$i]} = $cmd if $cmd ne $argv->[$i];
-           last if !defined($def->{$cmd});
+           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]; 
+           }
+           $cmdstr .= " $cmd";
            $def = $def->{$cmd};
+           last if !defined($def);
 
            if (ref($def) eq 'ARRAY') {
                # could expand to a real command, rest of $argv are its arguments
                my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
-               return ($cmd, $def, $cmd_args, $expanded);
+               return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
            }
 
            if (defined($def->{alias})) {
@@ -102,9 +114,9 @@ sub resolve_cmd {
        # 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
        my $cmd_args = [ @$argv[1..$last_arg_id] ];
-       return ($argv->[0], $def, $cmd_args, $expanded);
+       return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
     }
-    return ($cmd, $def);
+    return ($cmd, $def, undef, undef, $cmdstr);
 }
 
 sub generate_usage_str {
@@ -117,10 +129,12 @@ sub generate_usage_str {
     $separator //= '';
     $indent //= '';
 
-    my $can_read_pass = $cli_handler_class->can('read_password');
-    my $param_mapping_func = $cli_handler_class->can('string_param_file_mapping');
+    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 ($subcmd, $def) = resolve_cmd($cmd);
+    my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
+    $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
 
     my $generate;
     $generate = sub {
@@ -138,7 +152,7 @@ sub generate_usage_str {
                    $str .= $indent;
                    $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
                                              $fixed_param, $format,
-                                             $can_read_pass, $param_mapping_func);
+                                             $read_password_func, $param_mapping_func);
                    $oldclass = $class;
 
                } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
@@ -162,14 +176,11 @@ sub generate_usage_str {
 
            $str .= $indent;
            $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
-                                     $can_read_pass, $param_mapping_func);
+                                     $read_password_func, $param_mapping_func);
        }
        return $str;
     };
 
-    my $cmdstr = $exename;
-    $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
-
     return $generate->($indent, $separator, $def, $cmdstr);
 }
 
@@ -311,14 +322,15 @@ my $print_bash_completion = sub {
 
     my ($cmd, $def) = ($simple_cmd, $cmddef);
     if (!$simple_cmd) {
-       ($cmd, $def, $args, my $expaned) = resolve_cmd($args);
+       ($cmd, $def, $args, my $expanded) = resolve_cmd($args);
 
-       if (ref($def) eq 'HASH') {
-           &$print_result(@{$get_commands->($def)});
+       if (defined($expanded) && $prev ne $expanded) {
+           print "$expanded\n";
            return;
        }
-       if (my $expanded_cmd = $expaned->{$cur}) {
-           print "$expanded_cmd\n";
+
+       if (ref($def) eq 'HASH') {
+           &$print_result(@{$get_commands->($def)});
            return;
        }
     }
@@ -361,7 +373,6 @@ my $print_bash_completion = sub {
     };
 
     # positional arguments
-    $pos++ if $simple_cmd;
     if ($pos < scalar(@$arg_param)) {
        my $pname = $arg_param->[$pos];
        &$print_parameter_completion($pname);
@@ -457,12 +468,11 @@ sub setup_environment {
 }
 
 my $handle_cmd  = sub {
-    my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
-    my $cmd_str = join(' ', @$args);
-    my ($cmd, $def, $cmd_args) = resolve_cmd($args);
+    my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
 
     $abort->("no command specified") if !$cmd;
 
@@ -481,21 +491,20 @@ my $handle_cmd  = sub {
     }
 
     # 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;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
     $abort->("unknown command '$cmd_str'") if !$class;
 
-    my $prefix = "$exename $cmd_str";
-    my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $pwcallback, $param_mapping_func);
+    my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
     &$outsub($res) if $outsub;
 };
 
 my $handle_simple_cmd = sub {
-    my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
@@ -524,7 +533,7 @@ my $handle_simple_cmd = sub {
 
     &$preparefunc() if $preparefunc;
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $param_mapping_func);
+    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
     &$outsub($res) if $outsub;
 };
@@ -545,8 +554,9 @@ sub run_cli_handler {
 
     my $preparefunc = $params{prepare};
 
-    my $pwcallback = $class->can('read_password');
-    my $param_mapping_func = $class->can('string_param_file_mapping');
+    my $read_password_func = $class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+       $class->can('string_param_file_mapping');
 
     $exename = &$get_exe_name($class);
 
@@ -556,9 +566,9 @@ sub run_cli_handler {
     $cmddef = ${"${class}::cmddef"};
 
     if (ref($cmddef) eq 'ARRAY') {
-       &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+       &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     } else {
-       &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+       &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     }
 
     exit 0;