cli handler: print correct command prefix for alias in asciidoc output

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

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 802ce87aa0c5d7224255319fcc06db407eca6b03..ad3f44ba06edd7e7d88e3505beabbaaf5034ca93 100644 (file)
--- 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;
@@ -108,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;
@@ -143,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
@@ -191,32 +201,33 @@ sub generate_usage_str {
 
     my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
 
-    my $generate;
-    $generate = sub {
+    my $generate_weak;
+    $generate_weak = sub {
        my ($indent, $separator, $def, $prefix) = @_;
 
        my $str = '';
        if (ref($def) eq 'HASH') {
            my $oldclass = undef;
-           foreach my $cmd (&$sortfunc($def)) {
+           foreach my $cmd ($sortfunc->($def)) {
 
                if (ref($def->{$cmd}) eq 'ARRAY') {
                    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, $formatter_properties);
+                   $str .= $class->usage_str(
+                       $name, "$prefix $cmd", $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
+
                    $oldclass = $class;
 
                } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
 
-                   $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
+                   $str .= "*$prefix $cmd*\n\nAn alias for '$prefix $def->{$cmd}->{alias}'.\n\n";
 
                } else {
                    next if $def->{$cmd}->{alias};
 
-                   my $substr = $generate->($indent, '', $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;
@@ -225,14 +236,16 @@ sub generate_usage_str {
 
            }
        } else {
+           $abort->("unknown command '$cmd->[0]'") if !$def;
            my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def;
-           $abort->("unknown command '$cmd'") if !$class;
 
            $str .= $indent;
            $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);
 }
@@ -338,7 +351,7 @@ sub print_usage_short {
 
     print {$fd} generate_usage_str('short', $cmd, ' ' x 7, $cmd ? '' : "\n", sub {
        my ($h) = @_;
-       return sort {
+       my @sorted_commands = sort {
            if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
                # $a and $b are both real commands order them by their class
                return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
@@ -350,6 +363,7 @@ sub print_usage_short {
                return $a cmp $b;
            }
        } keys %$h;
+       return @sorted_commands;
     });
 }
 
@@ -419,7 +433,7 @@ my $print_bash_completion = sub {
                my $res = $d->{completion}->($cmd, $pname, $cur, $args);
                &$print_result(@$res);
            }
-       } elsif ($d->{type} eq 'boolean') {
+       } elsif ($d->{type} && $d->{type} eq 'boolean') {
            &$print_result('0', '1');
        } elsif ($d->{enum}) {
            &$print_result(@{$d->{enum}});
@@ -507,7 +521,7 @@ function _$exename() {
     cmd=\${words[1]}
     curr=\${words[cwords]}
     prev=\${words[cwords-1]}
-    compadd \$(COMP_CWORD="\$cwords" COMP_LINE="\$line" COMP_POINT="\$point" \\
+    compadd -- \$(COMP_CWORD="\$cwords" COMP_LINE="\$line" COMP_POINT="\$point" \\
        $exename bashcomplete "\$cmd" "\$curr" "\$prev")
 }
 __EOD__
@@ -525,11 +539,12 @@ sub generate_asciidoc_synopsis {
 
     $exename = &$get_exe_name($class);
 
-    no strict 'refs';
-    my $def = ${"${class}::cmddef"};
-    $cmddef = $def;
+    {
+       no strict 'refs'; ## no critic (ProhibitNoStrict)
+       $cmddef = ${"${class}::cmddef"};
+    }
 
-    if (ref($def) eq 'ARRAY') {
+    if (ref($cmddef) eq 'ARRAY') {
        print_simple_asciidoc_synopsis();
     } else {
        $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
@@ -647,8 +662,10 @@ sub run_cli_handler {
     my $logid = $ENV{PVE_LOG_ID} || $exename;
     initlog($logid);
 
-    no strict 'refs';
-    $cmddef = ${"${class}::cmddef"};
+    {
+       no strict 'refs'; ## no critic (ProhibitNoStrict)
+       $cmddef = ${"${class}::cmddef"};
+    }
 
     if (ref($cmddef) eq 'ARRAY') {
        $handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb);