PVE::CLIHandler - new helper print_api_result

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

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index dc4ad35c68e4df243b80d408e338dfc11c6e0b87..b46d87e6d697c6e33d803ed547e7efb995869495 100644 (file)
--- 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"
@@ -399,32 +429,46 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
+sub data_to_text {
+    my ($data) = @_;
+
+    return undef 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.
 # $formatopts is an array of hashes, with the following keys:
-# 'key' - the key in the data-objects to use for this column
-# 'title' - the title to print above the column, defaults to 'key' - always gets printed in full
-# 'cutoff' - the maximal length of the data, overlong values will be truncated
-# 'default' - an optional default value for the column
-# the last column always gets printed in full
+# '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}];
+    my ($formatstring, @keys, @titles, %cutoffs, %defaults);
+    my $last_col = $formatopts->[$#{$formatopts}];
+
     foreach my $col ( @$formatopts ) {
-       my ($key, $title, $cutoff, $default) = @$col{ qw(key title cutoff default)};
+       my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
        $title //= $key;
 
        push @keys, $key;
        push @titles, $title;
-       $defaults{$key} = $default;
+       $defaults{$key} = $col->{default} // '';
 
-       #calculate maximal print width and cutoff
+       # calculate maximal print width and cutoff
        my $titlelen = length($title);
 
        my $longest = $titlelen;
        foreach my $entry (@$data) {
-           my $len = length($entry->{$key}) // 0;
+           my $len = length(data_to_text($entry->{$key})) // 0;
            $longest = $len if $len > $longest;
        }
 
@@ -441,29 +485,21 @@ sub print_text_table {
 
     printf $formatstring, @titles;
 
-    foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data){
-        printf $formatstring, map { substr(($entry->{$_} // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+    foreach my $entry (sort { $a->{$keys[0]} cmp $b->{$keys[0]} } @$data) {
+        printf $formatstring, map { substr((data_to_text($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};
-       }
-    }
-}
-
-# used to print the result of an API-listing - expects the API to return an array
+# 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;
+
+    die "can only print array result" if $returninfo->{type} ne 'array';
+
     my $returnprops = $returninfo->{items}->{properties};
+
+    my $formatopts = [];
     foreach my $prop ( @$props_to_print ) {
        my $propinfo = $returnprops->{$prop};
        my $colopts = {
@@ -478,6 +514,38 @@ sub print_api_list {
     print_text_table($formatopts, $data);
 }
 
+sub print_api_result {
+    my ($format, $data, $result_schema) = @_;
+
+    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') {
+           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') {
+               my $prop_list = [ sort keys %{$result_schema->{items}->{properties}}];
+               print_api_list($prop_list, $data, $result_schema);
+           } 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) = @_;