X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=0b93a4bc224fa5021d2bb29bfe6f391bec89fbb7;hp=c3e70fb21a82e34aef8c70ef951422ea770cfaf1;hb=e97f807c388c10250f442b1f16c5315df2ffc2af;hpb=4c802a572c726b3e7cb001308f38dee8de5b4060

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index c3e70fb..0b93a4b 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -2,18 +2,97 @@ package PVE::CLIHandler;
 
 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);
 
+# $cmddef defines which (sub)commands are available in a specific CLI class.
+# A real command is always an array consisting of its class, name, array of
+# position fixed (required) parameters and hash of predefined parameters when
+# mapping a CLI command t o an API call. Optionally an output method can be
+# passed at the end, e.g., for formatting or transformation purpose.
+#
+# [class, name, fixed_params, API_pre-set params, output_sub ]
+#
+# In case of so called 'simple commands', the $cmddef can be also just an
+# array.
+#
+# Examples:
+# $cmddef = {
+#     command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
+#     do => {
+#         this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
+#             my ($res) = @_;
+#             print "$res\n";
+#         }],
+#         that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
+#     },
+#     dothat => { alias => 'do that' },
+# }
 my $cmddef;
 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"
@@ -29,17 +108,73 @@ 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' && 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 $complete_command_names = sub {
-    return [ sort keys %$cmddef ];
+my $get_commands = sub {
+    my $def = shift // die "no command definition passed!";
+    return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ];
 };
 
+my $complete_command_names = sub { $get_commands->($cmddef) };
+
+# traverses the command definition using the $argv array, resolving one level
+# of aliases.
+# Returns the matching (sub) command and its definition, and argument array for
+# this (sub) command and a hash where we marked which (sub) commands got
+# expanded (e.g. st => status) while traversing
+sub resolve_cmd {
+    my ($argv, $is_alias) = @_;
+
+    my ($def, $cmd) = ($cmddef, $argv);
+    my $cmdstr = $exename;
+
+    if (ref($argv) eq 'ARRAY') {
+	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]);
+	    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_last_arg, $cmdstr);
+	    }
+
+	    if (defined($def->{alias})) {
+		die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
+		# replace aliased (sub)command with the expanded aliased command
+		splice @$argv, $i, 1, split(/ +/, $def->{alias});
+		return resolve_cmd($argv, 1);
+	    }
+	}
+	# 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_last_arg, $cmdstr);
+    }
+    return ($cmd, $def, undef, undef, $cmdstr);
+}
+
 sub generate_usage_str {
     my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
 
@@ -50,11 +185,10 @@ sub generate_usage_str {
     $separator //= '';
     $indent //= '';
 
-    my $can_read_pass = $cli_handler_class->can('read_password');
-    my $can_str_param_fmap = $cli_handler_class->can('string_param_file_mapping');
+    my $param_cb = $gen_param_mapping_func->($cli_handler_class);
 
-    my $def = $cmddef;
-    $def = $def->{$cmd} if $cmd && ref($def) eq 'HASH' && $def->{$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 {
@@ -71,9 +205,21 @@ sub generate_usage_str {
 		    $str .= $separator if $oldclass && $oldclass ne $class;
 		    $str .= $indent;
 		    $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
-		                              $fixed_param, $format,
-		                              $can_read_pass, $can_str_param_fmap);
+		                              $fixed_param, $format, $param_cb);
 		    $oldclass = $class;
+
+		} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
+
+		    $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
+
+		} else {
+		    next if $def->{$cmd}->{alias};
+
+		    my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd");
+		    if ($substr) {
+			$substr .= $separator if $substr !~ /\Q$separator\E{2}/;
+			$str .= $substr;
+		    }
 		}
 
 	    }
@@ -82,13 +228,12 @@ sub generate_usage_str {
 	    $abort->("unknown command '$cmd'") if !$class;
 
 	    $str .= $indent;
-	    $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
-	                              $can_read_pass, $can_str_param_fmap);
+	    $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb);
 	}
 	return $str;
     };
 
-    return $generate->($indent, $separator, $def, $exename);
+    return $generate->($indent, $separator, $def, $cmdstr);
 }
 
 __PACKAGE__->register_method ({
@@ -99,12 +244,10 @@ __PACKAGE__->register_method ({
     parameters => {
 	additionalProperties => 0,
 	properties => {
-	    cmd => {
-		description => "Command name",
-		type => 'string',
-		optional => 1,
+	    'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
+		description => 'Shows help for a specific command',
 		completion => $complete_command_names,
-	    },
+	    }),
 	    verbose => {
 		description => "Verbose output format.",
 		type => 'boolean',
@@ -119,9 +262,9 @@ __PACKAGE__->register_method ({
 
 	$assert_initialized->();
 
-	my $cmd = $param->{cmd};
+	my $cmd = $param->{'extra-args'};
 
-	my $verbose = defined($cmd) && $cmd; 
+	my $verbose = defined($cmd) && $cmd;
 	$verbose = $param->{verbose} if defined($param->{verbose});
 
 	if (!$cmd) {
@@ -185,21 +328,24 @@ sub print_usage_verbose {
 }
 
 sub print_usage_short {
-    my ($fd, $msg) = @_;
+    my ($fd, $msg, $cmd) = @_;
 
     $assert_initialized->();
 
     print $fd "ERROR: $msg\n" if $msg;
     print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
 
-    print {$fd} generate_usage_str('short', undef, ' ' x 7, "\n", sub {
+    print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub {
 	my ($h) = @_;
 	return 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;
+	    } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
+		# real command and subcommand mixed, put sub commands first
+		return ref($h->{$b}) eq 'ARRAY' ? -1 : 1;
 	    } else {
-		# both are from the same class
+		# both are either from the same class or subcommands
 		return $a cmp $b;
 	    }
 	} keys %$h;
@@ -222,19 +368,24 @@ my $print_bash_completion = sub {
     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) {
-	if (!scalar(@$args)) {
-	    &$print_result(keys %$def);
+	($cmd, $def, $args, my $expanded) = resolve_cmd($args);
+
+	if (defined($expanded) && $prev ne $expanded) {
+	    print "$expanded\n";
+	    return;
+	}
+
+	if (ref($def) eq 'HASH') {
+	    &$print_result(@{$get_commands->($def)});
 	    return;
 	}
-	$cmd = $args->[0];
     }
-    $def = $def->{$cmd};
     return if !$def;
 
     my $pos = scalar(@$args) - 1;
@@ -274,7 +425,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);
@@ -370,12 +520,12 @@ sub setup_environment {
 }
 
 my $handle_cmd  = sub {
-    my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+    my ($args, $preparefunc, $param_cb) = @_;
 
-    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+    $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
+    my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
 
-    my $cmd = shift @$args;
     $abort->("no command specified") if !$cmd;
 
     # call verifyapi before setup_environment(), don't execute any real code in
@@ -388,25 +538,28 @@ my $handle_cmd  = sub {
     $cli_handler_class->setup_environment();
 
     if ($cmd eq 'bashcomplete') {
-	&$print_bash_completion(undef, @$args);
+	&$print_bash_completion(undef, @$cmd_args);
 	return;
     }
 
-    &$preparefunc() if $preparefunc;
+    # checked special commands, if def is still a hash we got an incomplete sub command
+    $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
 
-    $cmd = &$expand_command_name($cmddef, $cmd);
+    &$preparefunc() if $preparefunc;
 
-    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
-    $abort->("unknown command '$cmd'") if !$class;
+    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
+    $abort->("unknown command '$cmd_str'") if !$class;
 
-    my $prefix = "$exename $cmd";
-    my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+    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, $stringfilemap) = @_;
+    my ($args, $preparefunc, $param_cb) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
@@ -435,9 +588,12 @@ my $handle_simple_cmd = sub {
 
     &$preparefunc() if $preparefunc;
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+    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 {
@@ -456,8 +612,7 @@ sub run_cli_handler {
 
     my $preparefunc = $params{prepare};
 
-    my $pwcallback = $class->can('read_password');
-    my $stringfilemap = $class->can('string_param_file_mapping');
+    my $param_cb = $gen_param_mapping_func->($cli_handler_class);
 
     $exename = &$get_exe_name($class);
 
@@ -467,9 +622,9 @@ sub run_cli_handler {
     $cmddef = ${"${class}::cmddef"};
 
     if (ref($cmddef) eq 'ARRAY') {
-	&$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+	$handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb);
     } else {
-	&$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+	$handle_cmd->(\@ARGV, $preparefunc, $param_cb);
     }
 
     exit 0;