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 61b313b082cea524386a22a6ea13553a0e2f6987..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";
     }
@@ -209,6 +212,8 @@ sub print_text_table {
                $width = $len if $len > $width;
            }
 
+           $width = ($width =~ m/^(\d+)$/) ? int($1) : 0; # untaint int
+
            $rowdata->{$prop} = {
                lines => $lines,
                width => $width,
@@ -224,6 +229,8 @@ sub print_text_table {
     for (my $i = 0; $i < $column_count; $i++) {
        my $prop = $props_to_print->[$i];
        my $propinfo = $returnprops->{$prop} // {};
+       my $type = $propinfo->{type} // 'string';
+       my $alignstr = ($type eq 'integer' || $type eq 'number') ? '' : '-';
 
        my $title = $propinfo->{title} // $prop;
        my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
@@ -246,48 +253,48 @@ sub print_text_table {
        if ($border) {
            if ($i == 0 && ($column_count == 1)) {
                if ($utf8) {
-                   $formatstring .= "│ %-${cutoff}s │";
+                   $formatstring .= "│ %$alignstr${cutoff}s │";
                    $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
                    $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
                    $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
                } else {
-                   $formatstring .= "| %-${cutoff}s |";
+                   $formatstring .= "| %$alignstr${cutoff}s |";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
                }
            } elsif ($i == 0) {
                if ($utf8) {
-                   $formatstring .= "│ %-${cutoff}s ";
+                   $formatstring .= "│ %$alignstr${cutoff}s ";
                    $borderstring_t .= "┌─" . ('─' x $cutoff) . '─';
                    $borderstring_m .= "├─" . ('─' x $cutoff) . '─';
                    $borderstring_b .= "└─" . ('─' x $cutoff) . '─';
                } else {
-                   $formatstring .= "| %-${cutoff}s ";
+                   $formatstring .= "| %$alignstr${cutoff}s ";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
                }
            } elsif ($i == ($column_count - 1)) {
                if ($utf8) {
-                   $formatstring .= "│ %-${cutoff}s │";
+                   $formatstring .= "│ %$alignstr${cutoff}s │";
                    $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
                    $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
                    $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
                } else {
-                   $formatstring .= "| %-${cutoff}s |";
+                   $formatstring .= "| %$alignstr${cutoff}s |";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
                }
            } else {
                if ($utf8) {
-                   $formatstring .= "│ %-${cutoff}s ";
+                   $formatstring .= "│ %$alignstr${cutoff}s ";
                    $borderstring_t .= "┬─" . ('─' x $cutoff) . '─';
                    $borderstring_m .= "┼─" . ('─' x $cutoff) . '─';
                    $borderstring_b .= "┴─" . ('─' x $cutoff) . '─';
                } else {
-                   $formatstring .= "| %-${cutoff}s ";
+                   $formatstring .= "| %$alignstr${cutoff}s ";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
                }
            }
        } else {
            # skip alignment and cutoff on last column
-           $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%-${cutoff}s ";
+           $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%$alignstr${cutoff}s ";
        }
     }
 
@@ -351,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) = @_;
 
@@ -378,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) = @_;
 
@@ -387,9 +411,18 @@ 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 'json') {
+    if ($format eq 'yaml') {
+       print encode('UTF-8', CPAN::Meta::YAML::Dump($data));
+    } elsif ($format eq 'json') {
        # Note: we always use utf8 encoding for json format
        print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1 }) . "\n";
     } elsif ($format eq 'json-pretty') {
@@ -430,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;