PVE::CLIHandler::print_api_result - add $props_to_print parameter

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index b04326f4ba2cf322b520761c3580485e240b53d4..9933df704e34c0b9a616a5160716efd0bad6fe5a 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -497,8 +497,11 @@ sub print_text_table {
     }
 }
 
-# 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 ($data, $result_schema, $props_to_print) = @_;
 
@@ -510,7 +513,13 @@ sub print_api_list {
     if (!defined($props_to_print)) {
        $props_to_print = [ sort keys %$returnprops ];
        if (!scalar(@$props_to_print)) {
-           $props_to_print = [ sort keys %{$data->[0]} ];
+           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);
     }
@@ -531,7 +540,7 @@ sub print_api_list {
 }
 
 sub print_api_result {
-    my ($format, $data, $result_schema) = @_;
+    my ($format, $data, $result_schema, $props_to_print) = @_;
 
     return if $result_schema->{type} eq 'null';
 
@@ -540,14 +549,20 @@ sub print_api_result {
     } elsif ($format eq 'text') {
        my $type = $result_schema->{type};
        if ($type eq 'object') {
-           foreach my $key (sort keys %$data) {
-               print $key . ": " .  data_to_text($data->{$key}) . "\n";
+           if (defined($props_to_print)) {
+               foreach my $key (@$props_to_print) {
+                   print $key . ": " .  data_to_text($data->{$key}) . "\n";
+               }
+           } else {
+               foreach my $key (sort keys %$data) {
+                   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);
+               print_api_list($data, $result_schema, $props_to_print);
            } else {
                foreach my $entry (@$data) {
                    print data_to_text($entry) . "\n";