[pve-devel] [PATCH common v4 3/3] add print_api_list, adapt handle_cmd

[Stoiko Ivanov]

print_api_list takes an array of columns to print, the data, and the returns
definitions of the API, and prints the data by using print_text_table.

handle_cmd and handle_simple_cmd call the output sub with the returns definitons.

Signed-off-by: Stoiko Ivanov <s.ivanov at proxmox.com>
---
 src/PVE/CLIHandler.pm | 30 ++++++++++++++++++++++++++++--
 1 file changed, 28 insertions(+), 2 deletions(-)

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index a4f63ee..dc4ad35 100644
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -458,6 +458,26 @@ sub print_entry {
     }
 }
 
+# used to print the result of an API-listing - expects the API to return 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) = @_;
 
@@ -559,7 +579,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 $returninfo = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $returninfo);
+    }
 };
 
 my $handle_simple_cmd = sub {
@@ -594,7 +617,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 $returninfo = $class->map_method_by_name($name)->{returns};
+	$outsub->($res, $returninfo);
+    }
 };
 
 sub run_cli_handler {
-- 
2.11.0