X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=1b95d9a1fd499346fb36ef8555b16bebc0908dba;hp=33b7aca04742e9b9846cfb2d7740f7156607a94d;hb=acd6f38373a6d337cc2c8453861b8f15ac57a534;hpb=94e0f9540fc556bac3eccaab599e3aeea55d8044

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 33b7aca..1b95d9a 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -52,11 +52,14 @@ 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 $get_commands = sub {
@@ -75,21 +78,30 @@ sub resolve_cmd {
     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})) {
@@ -102,9 +114,9 @@ sub resolve_cmd {
 	# 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 {
@@ -117,10 +129,12 @@ 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 $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 ($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 {
@@ -138,7 +152,7 @@ sub generate_usage_str {
 		    $str .= $indent;
 		    $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
 		                              $fixed_param, $format,
-		                              $can_read_pass, $param_mapping_func);
+		                              $read_password_func, $param_mapping_func);
 		    $oldclass = $class;
 
 		} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
@@ -162,14 +176,11 @@ sub generate_usage_str {
 
 	    $str .= $indent;
 	    $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
-	                              $can_read_pass, $param_mapping_func);
+	                              $read_password_func, $param_mapping_func);
 	}
 	return $str;
     };
 
-    my $cmdstr = $exename;
-    $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
-
     return $generate->($indent, $separator, $def, $cmdstr);
 }
 
@@ -305,20 +316,21 @@ 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) {
-	($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;
 	}
     }
@@ -361,7 +373,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);
@@ -388,6 +399,86 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
+# prints a formatted table with a title row.
+# $formatopts is an array of hashes, with the following keys:
+# 'key' - key of $data element to print
+# 'title' - column title, defaults to 'key' - won't get cutoff
+# 'cutoff' - maximal (print) length of this column values, if set
+#            the last column will never be cutoff
+# 'default' - optional default value for the column
+# formatopts element order defines column order (left to right)
+sub print_text_table {
+    my ($formatopts, $data) = @_;
+    my ($formatstring, @keys, @titles, %cutoffs, %defaults, $last_col);
+
+    $last_col = $formatopts->[$#{$formatopts}];
+    foreach my $col ( @$formatopts ) {
+	my ($key, $title, $cutoff, $default) = @$col{ qw(key title cutoff default)};
+	$title //= $key;
+
+	push @keys, $key;
+	push @titles, $title;
+	$defaults{$key} = $default;
+
+	#calculate maximal print width and cutoff
+	my $titlelen = length($title);
+
+	my $longest = $titlelen;
+	foreach my $entry (@$data) {
+	    my $len = length($entry->{$key}) // 0;
+	    $longest = $len if $len > $longest;
+	}
+
+	$cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
+	$cutoffs{$key} = $cutoff;
+
+	my $printalign = $cutoff > $titlelen ? '-' : '';
+	if ($col == $last_col) {
+	    $formatstring .= "%${printalign}${titlelen}s\n";
+	} else {
+	    $formatstring .= "%${printalign}${cutoff}s ";
+	}
+    }
+
+    printf $formatstring, @titles;
+
+    foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data){
+        printf $formatstring, map { substr(($entry->{$_} // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+    }
+}
+
+sub print_entry {
+    my $entry = shift;
+    #TODO: handle objects/hashes as well
+    foreach my $item (sort keys %$entry) {
+	if (ref($entry->{$item}) eq 'ARRAY'){
+	    printf "%s: [ %s ]\n", $item, join(", ", @{$entry->{$item}});
+	} else {
+	    printf "%s: %s\n", $item, $entry->{$item};
+	}
+    }
+}
+
+# prints the result of an API GET call returning an array
+# and to have the results key of the API call defined.
+sub print_api_list {
+    my ($props_to_print, $data, $returninfo) = @_;
+    my $formatopts;
+    my $returnprops = $returninfo->{items}->{properties};
+    foreach my $prop ( @$props_to_print ) {
+	my $propinfo = $returnprops->{$prop};
+	my $colopts = {
+	    key => $prop,
+	    title => $propinfo->{title},
+	    default => $propinfo->{default},
+	    cutoff => $propinfo->{print_width} // $propinfo->{maxLength},
+	};
+	push @$formatopts, $colopts;
+    }
+
+    print_text_table($formatopts, $data);
+}
+
 sub verify_api {
     my ($class) = @_;
 
@@ -457,12 +548,11 @@ sub setup_environment {
 }
 
 my $handle_cmd  = sub {
-    my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     $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;
 
@@ -481,21 +571,23 @@ my $handle_cmd  = sub {
     }
 
     # 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, $read_password_func, $param_mapping_func);
 
-    &$outsub($res) if $outsub;
+    if (defined $outsub) {
+	my $returninfo = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $returninfo);
+    }
 };
 
 my $handle_simple_cmd = sub {
-    my ($args, $pwcallback, $preparefunc, $param_mapping_func) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
@@ -524,9 +616,12 @@ my $handle_simple_cmd = sub {
 
     &$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, $read_password_func, $param_mapping_func);
 
-    &$outsub($res) if $outsub;
+    if (defined $outsub) {
+	my $returninfo = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $returninfo);
+    }
 };
 
 sub run_cli_handler {
@@ -545,8 +640,9 @@ 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 $read_password_func = $class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+	$class->can('string_param_file_mapping');
 
     $exename = &$get_exe_name($class);
 
@@ -556,9 +652,9 @@ sub run_cli_handler {
     $cmddef = ${"${class}::cmddef"};
 
     if (ref($cmddef) eq 'ARRAY') {
-	&$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+	&$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     } else {
-	&$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $param_mapping_func);
+	&$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     }
 
     exit 0;