fix #2696: avoid 'undefined value' warning in 'pvesh help unknown'

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

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 2107108699a4a00b8106e37f38a19b202c058a00..9955d77e06395c85dd219dac7d9f322bc1824992 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
@@ -190,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 = '';
@@ -217,7 +226,7 @@ sub generate_usage_str {
                } 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;
@@ -226,14 +235,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);
 }
@@ -490,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();