X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=a0d5b0e4a1ca5bd02ec73c78bb825e52b8d9e0e8;hp=b46d87e6d697c6e33d803ed547e7efb995869495;hb=3c3d1e07c805630a5811f6d5db4f14dc80a52fc0;hpb=340c98629c6a1ae22c6078aa4689da41401a6af8

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index b46d87e..a0d5b0e 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -432,7 +432,7 @@ my $print_bash_completion = sub {
 sub data_to_text {
     my ($data) = @_;
 
-    return undef if !defined($data);
+    return '' if !defined($data);
 
     if (my $class = ref($data)) {
 	return to_json($data, { utf8 => 1, canonical => 1 });
@@ -442,80 +442,107 @@ sub data_to_text {
 }
 
 # 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)
+# $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 ($formatopts, $data) = @_;
+    my ($data, $returnprops, $props_to_print, $sort_key) = @_;
 
-    my ($formatstring, @keys, @titles, %cutoffs, %defaults);
-    my $last_col = $formatopts->[$#{$formatopts}];
+    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);
 
-    foreach my $col ( @$formatopts ) {
-	my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
-	$title //= $key;
+    for (my $i = 0; $i < $column_count; $i++) {
+	my $prop = $props_to_print->[$i];
+	my $propinfo = $returnprops->{$prop} // {};
 
-	push @keys, $key;
-	push @titles, $title;
-	$defaults{$key} = $col->{default} // '';
+	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->{$key})) // 0;
+	    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 ";
+    }
 
-	$cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
-	$cutoffs{$key} = $cutoff;
+    printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
 
-	my $printalign = $cutoff > $titlelen ? '-' : '';
-	if ($col == $last_col) {
-	    $formatstring .= "%${printalign}${titlelen}s\n";
+    if (defined($sort_key)) {
+	my $type = $returnprops->{$sort_key}->{type} // 'string';
+	if ($type eq 'integer' || $type eq 'number') {
+	    @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
 	} else {
-	    $formatstring .= "%${printalign}${cutoff}s ";
+	    @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
 	}
     }
 
-    printf $formatstring, @titles;
-
-    foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) {
-        printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+    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
-# and to have the results key of the API call defined.
+# 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 ($props_to_print, $data, $returninfo) = @_;
+    my ($data, $result_schema, $props_to_print, $sort_key) = @_;
 
-    die "can only print array result" if $returninfo->{type} ne 'array';
+    die "can only print object lists\n"
+	if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
 
-    my $returnprops = $returninfo->{items}->{properties};
+    my $returnprops = $result_schema->{items}->{properties};
 
-    my $formatopts = [];
-    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;
+    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($formatopts, $data);
+    print_text_table($data, $returnprops, $props_to_print, $sort_key);
 }
 
 sub print_api_result {
-    my ($format, $data, $result_schema) = @_;
+    my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
 
     return if $result_schema->{type} eq 'null';
 
@@ -524,15 +551,15 @@ sub print_api_result {
     } elsif ($format eq 'text') {
 	my $type = $result_schema->{type};
 	if ($type eq 'object') {
-	    foreach my $key (sort keys %$data) {
+	    $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') {
-		my $prop_list = [ sort keys %{$result_schema->{items}->{properties}}];
-		print_api_list($prop_list, $data, $result_schema);
+		print_api_list($data, $result_schema, $props_to_print, $sort_key);
 	    } else {
 		foreach my $entry (@$data) {
 		    print data_to_text($entry) . "\n";
@@ -648,8 +675,8 @@ my $handle_cmd  = sub {
     my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
     if (defined $outsub) {
-	my $returninfo = $class->map_method_by_name($name)->{returns};
-	$outsub->($res, $returninfo);
+	my $result_schema = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $result_schema);
     }
 };
 
@@ -686,8 +713,8 @@ my $handle_simple_cmd = sub {
     my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
     if (defined $outsub) {
-	my $returninfo = $class->map_method_by_name($name)->{returns};
-	$outsub->($res, $returninfo);
+	my $result_schema = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $result_schema);
     }
 };