X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=0502c4867987c119cef1046796e5941c12ae07a4;hp=9bbc15627bff5a385d4198fc80b77e643b3b81d4;hb=ffe4449cd573756d532f384775bb2f34e2f6a740;hpb=24ccf353c76bcb346bf86761358b638e3105e298

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 9bbc156..0502c48 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -2,10 +2,12 @@ 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 base qw(PVE::RESTHandler);
@@ -37,6 +39,34 @@ 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 $assert_initialized = sub {
     my @caller = caller;
     die "$caller[0]:$caller[2] - not initialized\n"
@@ -54,7 +84,9 @@ my $expand_command_name = sub {
 
     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;
@@ -314,7 +346,7 @@ 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/;
 	}
     };
 
@@ -397,6 +429,151 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
+sub data_to_text {
+    my ($data) = @_;
+
+    return '' if !defined($data);
+
+    if (my $class = ref($data)) {
+	return to_json($data, { utf8 => 1, canonical => 1 });
+    } else {
+	return "$data";
+    }
+}
+
+# prints a formatted table with a title row.
+# $data - the data to print (array of objects)
+# $returnprops -json schema property description
+# $props_to_print - ordered list of properties to print
+# $sort_key can be used to sort after a column, if it isn't set we sort
+#   after the leftmost column (with no undef value in $data) this can be
+#   turned off by passing 0 as $sort_key
+sub print_text_table {
+    my ($data, $returnprops, $props_to_print, $sort_key) = @_;
+
+    my $autosort = 1;
+    if (defined($sort_key) && $sort_key eq 0) {
+	$autosort = 0;
+	$sort_key = undef;
+    }
+
+    my $colopts = {};
+    my $formatstring = '';
+
+    my $column_count = scalar(@$props_to_print);
+
+    for (my $i = 0; $i < $column_count; $i++) {
+	my $prop = $props_to_print->[$i];
+	my $propinfo = $returnprops->{$prop} // {};
+	die "undefined property '$prop'" if !$propinfo;
+
+	my $title = $propinfo->{title} // $prop;
+	my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
+
+	# calculate maximal print width and cutoff
+	my $titlelen = length($title);
+
+	my $longest = $titlelen;
+	my $sortable = $autosort;
+	foreach my $entry (@$data) {
+	    my $len = length(data_to_text($entry->{$prop})) // 0;
+	    $longest = $len if $len > $longest;
+	    $sortable = 0 if !defined($entry->{$prop});
+	}
+	$cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
+	$sort_key //= $prop if $sortable;
+
+	$colopts->{$prop} = {
+	    title => $title,
+	    default => $propinfo->{default} // '',
+	    cutoff => $cutoff,
+	};
+
+	# skip alignment and cutoff on last column
+	$formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
+    }
+
+    printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+
+    if (defined($sort_key)) {
+	my $type = $returnprops->{$sort_key}->{type};
+	if ($type eq 'integer' || $type eq 'number') {
+	    @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
+	} else {
+	    @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+	}
+    }
+
+    foreach my $entry (@$data) {
+        printf $formatstring, map {
+	    substr(data_to_text($entry->{$_}) // $colopts->{$_}->{default},
+		   0, $colopts->{$_}->{cutoff});
+	} @$props_to_print;
+    }
+}
+
+# prints the result of an API GET call returning an array as a table.
+# takes formatting information from the results property of the call
+# if $props_to_print is provided, prints only those columns. otherwise
+# takes all fields of the results property, with a fallback
+# to all fields occuring in items of $data.
+sub print_api_list {
+    my ($data, $result_schema, $props_to_print, $sort_key) = @_;
+
+    die "can only print object lists\n"
+	if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
+
+    my $returnprops = $result_schema->{items}->{properties};
+
+    if (!defined($props_to_print)) {
+	$props_to_print = [ sort keys %$returnprops ];
+	if (!scalar(@$props_to_print)) {
+	    my $all_props = {};
+	    foreach my $obj (@{$data}) {
+		foreach my $key (keys %{$obj}) {
+		    $all_props->{ $key } = 1;
+		}
+	    }
+	    $props_to_print = [ sort keys %{$all_props} ];
+	}
+	die "unable to detect list properties\n" if !scalar(@$props_to_print);
+    }
+
+    print_text_table($data, $returnprops, $props_to_print, $sort_key);
+}
+
+sub print_api_result {
+    my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
+
+    return if $result_schema->{type} eq 'null';
+
+    if ($format eq 'json') {
+	print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
+    } elsif ($format eq 'text') {
+	my $type = $result_schema->{type};
+	if ($type eq 'object') {
+	    $props_to_print = [ sort keys %$data ] if !defined($props_to_print);
+	    foreach my $key (@$props_to_print) {
+		print $key . ": " .  data_to_text($data->{$key}) . "\n";
+	    }
+	} elsif ($type eq 'array') {
+	    return if !scalar(@$data);
+	    my $item_type = $result_schema->{items}->{type};
+	    if ($item_type eq 'object') {
+		print_api_list($data, $result_schema, $props_to_print, $sort_key);
+	    } else {
+		foreach my $entry (@$data) {
+		    print data_to_text($entry) . "\n";
+		}
+	    }
+	} else {
+	    print "$data\n";
+	}
+    } else {
+	die "internal error: unknown output format"; # should not happen
+    }
+}
+
 sub verify_api {
     my ($class) = @_;
 
@@ -489,7 +666,7 @@ my $handle_cmd  = sub {
     }
 
     # 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;
 
@@ -498,7 +675,10 @@ my $handle_cmd  = sub {
 
     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 $result_schema = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $result_schema);
+    }
 };
 
 my $handle_simple_cmd = sub {
@@ -533,7 +713,10 @@ my $handle_simple_cmd = sub {
 
     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 $result_schema = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $result_schema);
+    }
 };
 
 sub run_cli_handler {