cli: data_to_text: never render undefined values

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

diff --git a/src/PVE/CLIFormatter.pm b/src/PVE/CLIFormatter.pm
index 93e2cad6585e2540a0713557e2ef40b3ddaafc21..a6c47952fecf16b8d852c2ac1a6b579c836ec262 100644 (file)
--- a/src/PVE/CLIFormatter.pm
+++ b/src/PVE/CLIFormatter.pm
@@ -2,27 +2,48 @@ package PVE::CLIFormatter;
 
 use strict;
 use warnings;
+use I18N::Langinfo;
+
 use PVE::JSONSchema;
+use PVE::PTY;
 use JSON;
 use utf8;
 use Encode;
 
+sub query_terminal_options {
+    my ($options) = @_;
+
+    $options //= {};
+
+    if (-t STDOUT) {
+       ($options->{columns}) = PVE::PTY::tcgetsize(*STDOUT);
+    }
+
+    $options->{encoding} = I18N::Langinfo::langinfo(I18N::Langinfo::CODESET());
+
+    $options->{utf8} = 1 if $options->{encoding} eq 'UTF-8';
+
+    return $options;
+}
+
 sub println_max {
-    my ($text, $max) = @_;
+    my ($text, $encoding, $max) = @_;
 
     if ($max) {
        my @lines = split(/\n/, $text);
        foreach my $line (@lines) {
-           print encode('UTF-8', substr($line, 0, $max) . "\n");
+           print encode($encoding, substr($line, 0, $max) . "\n");
        }
     } else {
-       print encode('UTF-8', $text);
+       print encode($encoding, $text);
     }
 }
 
 sub data_to_text {
     my ($data, $propdef) = @_;
 
+    return '' if !defined($data);
+
     if (defined($propdef)) {
        if (my $type = $propdef->{type}) {
            if ($type eq 'boolean') {
@@ -38,7 +59,6 @@ sub data_to_text {
            return $code->($data);
        }
     }
-    return '' if !defined($data);
 
     if (my $class = ref($data)) {
        return to_json($data, { canonical => 1 });
@@ -66,6 +86,7 @@ sub print_text_table {
     my $border = $options->{border};
     my $columns = $options->{columns};
     my $utf8 = $options->{utf8};
+    my $encoding = $options->{encoding} // 'UTF-8';
 
     my $autosort = 1;
     if (defined($sort_key) && $sort_key eq 0) {
@@ -168,19 +189,19 @@ sub print_text_table {
     $borderstring_t = $borderstring_m if !length($borderstring_t);
     $borderstring_b = $borderstring_m if !length($borderstring_b);
 
-    println_max($borderstring_t, $columns) if $border;
+    println_max($borderstring_t, $encoding, $columns) if $border;
     my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
-    println_max($text, $columns);
+    println_max($text, $encoding, $columns);
 
     foreach my $entry (@$data) {
-       println_max($borderstring_m, $columns) if $border;
+       println_max($borderstring_m, $encoding, $columns) if $border;
         $text = sprintf $formatstring, map {
            substr(data_to_text($entry->{$_}, $returnprops->{$_}) // $colopts->{$_}->{default},
                   0, $colopts->{$_}->{cutoff});
        } @$props_to_print;
-       println_max($text, $columns);
+       println_max($text, $encoding, $columns);
     }
-    println_max($borderstring_b, $columns) if $border;
+    println_max($borderstring_b, $encoding, $columns) if $border;
 }
 
 # prints the result of an API GET call returning an array as a table.
@@ -216,14 +237,19 @@ sub print_api_list {
 sub print_api_result {
     my ($format, $data, $result_schema, $props_to_print, $options) = @_;
 
-    $options //= {};
-    $options = { %$options }; # copy
+    if (!defined($options)) {
+       $options = query_terminal_options({});
+    } else {
+       $options = { %$options }; # copy
+    }
 
     return if $result_schema->{type} eq 'null';
 
     if ($format eq 'json') {
+       # Note: we always use utf8 encoding for json format
        print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
     } elsif ($format eq 'text' || $format eq 'plain') {
+       my $encoding = $options->{encoding} // 'UTF-8';
        my $type = $result_schema->{type};
        if ($type eq 'object') {
            $props_to_print = [ sort keys %$data ] if !defined($props_to_print);
@@ -242,11 +268,11 @@ sub print_api_result {
                print_api_list($data, $result_schema, $props_to_print, $options);
            } else {
                foreach my $entry (@$data) {
-                   print data_to_text($entry) . "\n";
+                   print encode($encoding, data_to_text($entry) . "\n");
                }
            }
        } else {
-           print "$data\n";
+           print encode($encoding, "$data\n");
        }
     } else {
        die "internal error: unknown output format"; # should not happen