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"
return $cmd if exists $def->{$cmd}; # command is already complete
- my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
+ 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;
$separator //= '';
$indent //= '';
- 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 $param_cb = $gen_param_mapping_func->($cli_handler_class);
my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
- die "no such command '$cmd->[0]'\n" if !defined($def) && ref($cmd) eq 'ARRAY';
+ $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,
- $read_password_func, $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,
- $read_password_func, $param_mapping_func);
+ $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb);
}
return $str;
};
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 $handle_cmd = sub {
- my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
+ my ($args, $preparefunc, $param_cb) = @_;
$cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
}
# checked special commands, if def is still a hash we got an incomplete sub command
- $abort->("incomplete command '$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 $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $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, $read_password_func, $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, $read_password_func, $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 $read_password_func = $class->can('read_password');
- my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
- $class->can('string_param_file_mapping');
+ my $param_cb = $gen_param_mapping_func->($cli_handler_class);
$exename = &$get_exe_name($class);
- initlog($exename);
+ my $logid = $ENV{PVE_LOG_ID} || $exename;
+ initlog($logid);
no strict 'refs';
$cmddef = ${"${class}::cmddef"};
if (ref($cmddef) eq 'ARRAY') {
- &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+ $handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb);
} else {
- &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
+ $handle_cmd->(\@ARGV, $preparefunc, $param_cb);
}
exit 0;