print api res: always allow result to be undef if optional

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

diff --git a/src/PVE/CLIFormatter.pm b/src/PVE/CLIFormatter.pm
index d964b51cda6343d3a75454651fba6a04eea198fe..84dbed1e6e2af6fbaf63c2e7d3631247f94bd664 100644 (file)
--- a/src/PVE/CLIFormatter.pm
+++ b/src/PVE/CLIFormatter.pm
@@ -2,12 +2,14 @@ package PVE::CLIFormatter;
 
 use strict;
 use warnings;
+
 use I18N::Langinfo;
 use POSIX qw(strftime);
 use CPAN::Meta::YAML; # comes with perl-modules
 
 use PVE::JSONSchema;
 use PVE::PTY;
+
 use JSON;
 use utf8;
 use Encode;
@@ -76,8 +78,8 @@ sub render_bytes {
         $max_unit = int(log($value)/log(1024));
         $value /= 1024**($max_unit);
     }
-
-    return sprintf "%.2f $units[$max_unit]", $value;
+    my $unit = $units[$max_unit];
+    return sprintf "%.2f $unit", $value;
 }
 
 PVE::JSONSchema::register_renderer('bytes', \&render_bytes);
@@ -135,7 +137,8 @@ sub data_to_text {
     }
 
     if (my $class = ref($data)) {
-       return to_json($data, { canonical => 1 });
+       # JSON::PP::Boolean requires allow_nonref
+       return to_json($data, { allow_nonref => 1, canonical => 1 });
     } else {
        return "$data";
     }
@@ -355,7 +358,7 @@ sub extract_properties_to_print {
 # 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.
+# to all fields occurring in items of $data.
 sub print_api_list {
     my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
 
@@ -382,6 +385,23 @@ sub print_api_list {
     print_text_table($data, $returnprops, $props_to_print, $options, $terminal_opts);
 }
 
+my $guess_type = sub {
+    my $data = shift;
+
+    return 'null' if !defined($data);
+
+    my $class = ref($data);
+    return 'string' if !$class;
+
+    if ($class eq 'HASH') {
+       return 'object';
+    } elsif ($class eq 'ARRAY') {
+       return 'array';
+    } else {
+       return 'string'; # better than nothing
+    }
+};
+
 sub print_api_result {
     my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
 
@@ -391,7 +411,14 @@ sub print_api_result {
 
     my $format = $options->{'output-format'} // 'text';
 
-    return if $result_schema->{type} eq 'null';
+    if ($result_schema && defined($result_schema->{type})) {
+       return if $result_schema->{type} eq 'null';
+       return if $result_schema->{optional} && !defined($data);
+    } else {
+       my $type = $guess_type->($data);
+       $result_schema = { type => $type };
+       $result_schema->{items} = { type => $guess_type->($data->[0]) } if $type eq 'array';
+    }
 
     if ($format eq 'yaml') {
        print encode('UTF-8', CPAN::Meta::YAML::Dump($data));
@@ -436,4 +463,16 @@ sub print_api_result {
     }
 }
 
+sub print_api_result_plain {
+    my ($data, $result_schema, $props_to_print, $options) = @_;
+
+    # avoid borders and header, ignore terminal width
+    $options = $options ? { %$options } : {}; # copy
+
+    $options->{noheader} //= 1;
+    $options->{noborder} //= 1;
+
+    print_api_result($data, $result_schema, $props_to_print, $options, {});
+}
+
 1;