use strict;
use warnings;
+use JSON;
use PVE::SafeSyslog;
use PVE::Exception qw(raise raise_param_exc);
use PVE::RESTHandler;
+use PVE::PTY;
use PVE::INotify;
+use PVE::CLIFormatter;
use base qw(PVE::RESTHandler);
my $exename;
my $cli_handler_class;
+my $standard_mappings = {
+ 'pve-password' => {
+ name => 'password',
+ desc => '<password>',
+ interactive => 1,
+ func => sub {
+ my ($value) = @_;
+ return $value if $value;
+ return PVE::PTY::get_confirmed_password();
+ },
+ },
+};
+sub get_standard_mapping {
+ my ($name, $base) = @_;
+
+ my $std = $standard_mappings->{$name};
+ die "no such standard mapping '$name'\n" if !$std;
+
+ my $res = $base || {};
+
+ foreach my $opt (keys %$std) {
+ next if defined($res->{$opt});
+ $res->{$opt} = $std->{$opt};
+ }
+
+ return $res;
+}
+
+my $gen_param_mapping_func = sub {
+ my ($cli_handler_class) = @_;
+
+ my $param_mapping = $cli_handler_class->can('param_mapping');
+
+ if (!$param_mapping) {
+ my $read_password = $cli_handler_class->can('read_password');
+ my $string_param_mapping = $cli_handler_class->can('string_param_file_mapping');
+
+ return $string_param_mapping if !$read_password;
+
+ $param_mapping = sub {
+ my ($name) = @_;
+
+ my $password_map = get_standard_mapping('pve-password', {
+ func => $read_password
+ });
+ my $map = $string_param_mapping ? $string_param_mapping->($name) : [];
+ return [@$map, $password_map];
+ };
+ }
+
+ return $param_mapping;
+};
+
my $assert_initialized = sub {
my @caller = caller;
die "$caller[0]:$caller[2] - not initialized\n"
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' && exists($_[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 {
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})) {
# 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 {
$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 $param_cb = $gen_param_mapping_func->($cli_handler_class);
- 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 {
$str .= $separator if $oldclass && $oldclass ne $class;
$str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
- $fixed_param, $format,
- $can_read_pass, $param_mapping_func);
+ $fixed_param, $format, $param_cb);
$oldclass = $class;
} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
$abort->("unknown command '$cmd'") if !$class;
$str .= $indent;
- $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
- $can_read_pass, $param_mapping_func);
+ $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb);
}
return $str;
};
- my $cmdstr = $exename;
- $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
-
return $generate->($indent, $separator, $def, $cmdstr);
}
shift @$args; # no need for program name
my $print_result = sub {
foreach my $p (@_) {
- print "$p\n" if $p =~ m/^$cur/;
+ print "$p\n" if $p =~ m/^\Q$cur\E/;
}
};
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;
}
}
};
# positional arguments
- $pos++ if $simple_cmd;
if ($pos < scalar(@$arg_param)) {
my $pname = $arg_param->[$pos];
&$print_parameter_completion($pname);
}
my $handle_cmd = sub {
- my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+ my ($args, $preparefunc, $param_cb) = @_;
$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;
}
# 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'", $args) 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, $param_cb);
- &$outsub($res) if $outsub;
+ if (defined $outsub) {
+ my $result_schema = $class->map_method_by_name($name)->{returns};
+ $outsub->($res, $result_schema);
+ }
};
my $handle_simple_cmd = sub {
- my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+ my ($args, $preparefunc, $param_cb) = @_;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
die "no class specified" if !$class;
&$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, $param_cb);
- &$outsub($res) if $outsub;
+ if (defined $outsub) {
+ my $result_schema = $class->map_method_by_name($name)->{returns};
+ $outsub->($res, $result_schema);
+ }
};
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 $param_cb = $gen_param_mapping_func->($cli_handler_class);
$exename = &$get_exe_name($class);
$cmddef = ${"${class}::cmddef"};
if (ref($cmddef) eq 'ARRAY') {
- &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+ $handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb);
} else {
- &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+ $handle_cmd->(\@ARGV, $preparefunc, $param_cb);
}
exit 0;
projects / pve-common.git / blobdiff