X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=45c0427b2faec2aed843db7c54ba40e665564e85;hp=8cd6dc690ced7f925e3937c71a960fa12b95d94c;hb=b8dc43668bb64a28dd00b14022302ec8d932deff;hpb=5fa768fc8d9e872d6047a070be27180c4771b5f8

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 8cd6dc6..45c0427 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -10,6 +10,29 @@ use PVE::INotify;
 
 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;
@@ -36,10 +59,120 @@ my $expand_command_name = sub {
     return $cmd;
 };
 
-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);
+
+    if (ref($argv) eq 'ARRAY') {
+	my $expanded = {};
+	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});
+	    $def = $def->{$cmd};
+
+	    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);
+	    }
+
+	    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);
+    }
+    return ($cmd, $def);
+}
+
+sub generate_usage_str {
+    my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
+
+    $assert_initialized->();
+    die 'format required' if !$format;
+
+    $sortfunc //= sub { sort keys %{$_[0]} };
+    $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 ($subcmd, $def) = resolve_cmd($cmd);
+
+    my $generate;
+    $generate = sub {
+	my ($indent, $separator, $def, $prefix) = @_;
+
+	my $str = '';
+	if (ref($def) eq 'HASH') {
+	    my $oldclass = undef;
+	    foreach my $cmd (&$sortfunc($def)) {
+
+		if (ref($def->{$cmd}) eq 'ARRAY') {
+		    my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
+
+		    $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);
+		    $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;
+		    }
+		}
+
+	    }
+	} else {
+	    my ($class, $name, $arg_param, $fixed_param) = @$def;
+	    $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);
+	}
+	return $str;
+    };
+
+    my $cmdstr = $exename;
+    $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
+
+    return $generate->($indent, $separator, $def, $cmdstr);
+}
+
 __PACKAGE__->register_method ({
     name => 'help',
     path => 'help',
@@ -48,12 +181,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',
@@ -68,9 +199,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) {
@@ -82,18 +213,14 @@ __PACKAGE__->register_method ({
 	    return undef;
 	}
 
-	$cmd = &$expand_command_name($cmddef, $cmd);
-
-	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} || []};
-
-	raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
-
-	my $pwcallback = $cli_handler_class->can('read_password');
-	my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
+	my $str;
+	if ($verbose) {
+	    $str = generate_usage_str('full', $cmd, '');
+	} else {
+	    $str = generate_usage_str('short', $cmd, ' ' x 7);
+	}
+	$str =~ s/^\s+//;
 
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
-				    $verbose ? 'full' : 'short', $pwcallback,
-				    $stringfilemap);
 	if ($verbose) {
 	    print "$str\n";
 	} else {
@@ -105,43 +232,22 @@ __PACKAGE__->register_method ({
     }});
 
 sub print_simple_asciidoc_synopsis {
-    my ($class, $name, $arg_param, $uri_param) = @_;
-
     $assert_initialized->();
 
-    my $pwcallback = $cli_handler_class->can('read_password');
-    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
-    my $synopsis = "*${name}* `help`\n\n";
-
-    $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
-				   'asciidoc', $pwcallback, $stringfilemap);
+    my $synopsis = "*${exename}* `help`\n\n";
+    $synopsis .= generate_usage_str('asciidoc');
 
     return $synopsis;
 }
 
 sub print_asciidoc_synopsis {
-
     $assert_initialized->();
 
-    my $pwcallback = $cli_handler_class->can('read_password');
-    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
     my $synopsis = "";
 
     $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
 
-    my $oldclass;
-    foreach my $cmd (sort keys %$cmddef) {
-	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
-				    $uri_param, 'asciidoc', $pwcallback,
-				    $stringfilemap);
-	$synopsis .= "\n" if $oldclass && $oldclass ne $class;
-
-	$synopsis .= "$str\n\n";
-	$oldclass = $class;
-    }
+    $synopsis .= generate_usage_str('asciidoc');
 
     $synopsis .= "\n";
 
@@ -149,45 +255,38 @@ sub print_asciidoc_synopsis {
 }
 
 sub print_usage_verbose {
-
     $assert_initialized->();
 
-    my $pwcallback = $cli_handler_class->can('read_password');
-    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
     print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
 
-    foreach my $cmd (sort keys %$cmddef) {
-	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
-				    'full', $pwcallback, $stringfilemap);
-	print "$str\n\n";
-    }
-}
+    my $str = generate_usage_str('full');
 
-sub sorted_commands {   
-    return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef;
+    print "$str\n";
 }
 
 sub print_usage_short {
-    my ($fd, $msg) = @_;
+    my ($fd, $msg, $cmd) = @_;
 
     $assert_initialized->();
 
-    my $pwcallback = $cli_handler_class->can('read_password');
-    my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
     print $fd "ERROR: $msg\n" if $msg;
     print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
 
-    my $oldclass;
-    foreach my $cmd (sorted_commands()) {
-	my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
-	my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback, $stringfilemap);
-	print $fd "\n" if $oldclass && $oldclass ne $class;
-	print $fd "       $str";
-	$oldclass = $class;
-    }
+    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 either from the same class or subcommands
+		return $a cmp $b;
+	    }
+	} keys %$h;
+    });
 }
 
 my $print_bash_completion = sub {
@@ -212,13 +311,17 @@ my $print_bash_completion = sub {
 
     my ($cmd, $def) = ($simple_cmd, $cmddef);
     if (!$simple_cmd) {
-	if (!scalar(@$args)) {
-	    &$print_result(keys %$def);
+	($cmd, $def, $args, my $expaned) = resolve_cmd($args);
+
+	if (ref($def) eq 'HASH') {
+	    &$print_result(@{$get_commands->($def)});
+	    return;
+	}
+	if (my $expanded_cmd = $expaned->{$cur}) {
+	    print "$expanded_cmd\n";
 	    return;
 	}
-	$cmd = $args->[0];
     }
-    $def = $def->{$cmd};
     return if !$def;
 
     my $pos = scalar(@$args) - 1;
@@ -338,7 +441,7 @@ sub generate_asciidoc_synopsis {
     $cmddef = $def;
 
     if (ref($def) eq 'ARRAY') {
-	print_simple_asciidoc_synopsis(@$def);
+	print_simple_asciidoc_synopsis();
     } else {
 	$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
 
@@ -356,10 +459,11 @@ sub setup_environment {
 my $handle_cmd  = sub {
     my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
 
-    $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+    $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
+    my $cmd_str = join(' ', @$args);
+    my ($cmd, $def, $cmd_args) = 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
@@ -372,19 +476,20 @@ 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 '$exename $cmd_str'") 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 $prefix = "$exename $cmd_str";
+    my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $pwcallback, $stringfilemap);
 
     &$outsub($res) if $outsub;
 };
@@ -398,7 +503,7 @@ my $handle_simple_cmd = sub {
     if (scalar(@$args) >= 1) {
 	if ($args->[0] eq 'help') {
 	    my $str = "USAGE: $name help\n";
-	    $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap);
+	    $str .= generate_usage_str('long');
 	    print STDERR "$str\n\n";
 	    return;
 	} elsif ($args->[0] eq 'verifyapi') {