cli: print_api_result: add/use new encoding option
[pve-common.git] / src / PVE / CLIFormatter.pm
index 80504b2..77f528b 100644 (file)
@@ -2,15 +2,46 @@ package PVE::CLIFormatter;
 
 use strict;
 use warnings;
+use PVE::JSONSchema;
 use JSON;
+use utf8;
+use Encode;
+
+sub println_max {
+    my ($text, $encoding, $max) = @_;
+
+    if ($max) {
+       my @lines = split(/\n/, $text);
+       foreach my $line (@lines) {
+           print encode($encoding, substr($line, 0, $max) . "\n");
+       }
+    } else {
+       print encode($encoding, $text);
+    }
+}
 
 sub data_to_text {
-    my ($data) = @_;
+    my ($data, $propdef) = @_;
 
+    if (defined($propdef)) {
+       if (my $type = $propdef->{type}) {
+           if ($type eq 'boolean') {
+               return $data ? 1 : 0;
+           }
+       }
+       if (!defined($data) && defined($propdef->{default})) {
+           return "($propdef->{default})";
+       }
+       if (defined(my $renderer = $propdef->{renderer})) {
+           my $code = PVE::JSONSchema::get_renderer($renderer);
+           die "internal error: unknown renderer '$renderer'" if !$code;
+           return $code->($data);
+       }
+    }
     return '' if !defined($data);
 
     if (my $class = ref($data)) {
-       return to_json($data, { utf8 => 1, canonical => 1 });
+       return to_json($data, { canonical => 1 });
     } else {
        return "$data";
     }
@@ -20,12 +51,22 @@ sub data_to_text {
 # $data - the data to print (array of objects)
 # $returnprops -json schema property description
 # $props_to_print - ordered list of properties to print
-# $sort_key can be used to sort after a column, if it isn't set we sort
+# $options
+# - sort_key: can be used to sort after a column, if it isn't set we sort
 #   after the leftmost column (with no undef value in $data) this can be
-#   turned off by passing 0 as $sort_key
-# $border - print with/without table header and asciiart border
+#   turned off by passing 0 as sort_key
+# - border: print with/without table header and asciiart border
+# - columns: limit output width (if > 0)
+# - utf8: use utf8 characters for table delimiters
+
 sub print_text_table {
-    my ($data, $returnprops, $props_to_print, $sort_key, $border) = @_;
+    my ($data, $returnprops, $props_to_print, $options) = @_;
+
+    my $sort_key = $options->{sort_key};
+    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) {
@@ -35,7 +76,9 @@ sub print_text_table {
 
     my $colopts = {};
 
-    my $borderstring = '';
+    my $borderstring_m = '';
+    my $borderstring_b = '';
+    my $borderstring_t = '';
     my $formatstring = '';
 
     my $column_count = scalar(@$props_to_print);
@@ -53,7 +96,7 @@ sub print_text_table {
        my $longest = $titlelen;
        my $sortable = $autosort;
        foreach my $entry (@$data) {
-           my $len = length(data_to_text($entry->{$prop})) // 0;
+           my $len = length(data_to_text($entry->{$prop}, $propinfo)) // 0;
            $longest = $len if $len > $longest;
            $sortable = 0 if !defined($entry->{$prop});
        }
@@ -67,12 +110,46 @@ sub print_text_table {
        };
 
        if ($border) {
-           if ($i == ($column_count - 1)) {
-               $formatstring .= "| %-${cutoff}s |\n";
-               $borderstring .= "+-" . ('-' x $cutoff) . "-+\n";
+           if ($i == 0 && ($column_count == 1)) {
+               if ($utf8) {
+                   $formatstring .= "│ %-${cutoff}s │\n";
+                   $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐\n";
+                   $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤\n";
+                   $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘\n";
+               } else {
+                   $formatstring .= "| %-${cutoff}s |\n";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n";
+               }
+           } elsif ($i == 0) {
+               if ($utf8) {
+                   $formatstring .= "│ %-${cutoff}s ";
+                   $borderstring_t .= "┌─" . ('─' x $cutoff) . '─';
+                   $borderstring_m .= "├─" . ('─' x $cutoff) . '─';
+                   $borderstring_b .= "└─" . ('─' x $cutoff) . '─';
+               } else {
+                   $formatstring .= "| %-${cutoff}s ";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+               }
+           } elsif ($i == ($column_count - 1)) {
+               if ($utf8) {
+                   $formatstring .= "│ %-${cutoff}s │\n";
+                   $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐\n";
+                   $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤\n";
+                   $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘\n";
+               } else {
+                   $formatstring .= "| %-${cutoff}s |\n";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n";
+               }
            } else {
-               $formatstring .= "| %-${cutoff}s ";
-               $borderstring .= "+-" . ('-' x $cutoff) . '-';
+               if ($utf8) {
+                   $formatstring .= "│ %-${cutoff}s ";
+                   $borderstring_t .= "┬─" . ('─' x $cutoff) . '─';
+                   $borderstring_m .= "┼─" . ('─' x $cutoff) . '─';
+                   $borderstring_b .= "┴─" . ('─' x $cutoff) . '─';
+               } else {
+                   $formatstring .= "| %-${cutoff}s ";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+               }
            }
        } else {
            # skip alignment and cutoff on last column
@@ -89,17 +166,22 @@ sub print_text_table {
        }
     }
 
-    print $borderstring if $border;
-    printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+    $borderstring_t = $borderstring_m if !length($borderstring_t);
+    $borderstring_b = $borderstring_m if !length($borderstring_b);
+
+    println_max($borderstring_t, $encoding, $columns) if $border;
+    my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+    println_max($text, $encoding, $columns);
 
     foreach my $entry (@$data) {
-       print $borderstring if $border;
-        printf $formatstring, map {
-           substr(data_to_text($entry->{$_}) // $colopts->{$_}->{default},
+       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, $encoding, $columns);
     }
-    print $borderstring if $border;
+    println_max($borderstring_b, $encoding, $columns) if $border;
 }
 
 # prints the result of an API GET call returning an array as a table.
@@ -108,7 +190,7 @@ sub print_text_table {
 # takes all fields of the results property, with a fallback
 # to all fields occuring in items of $data.
 sub print_api_list {
-    my ($data, $result_schema, $props_to_print, $sort_key, $border) = @_;
+    my ($data, $result_schema, $props_to_print, $options) = @_;
 
     die "can only print object lists\n"
        if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
@@ -129,38 +211,45 @@ sub print_api_list {
        die "unable to detect list properties\n" if !scalar(@$props_to_print);
     }
 
-    print_text_table($data, $returnprops, $props_to_print, $sort_key, $border);
+    print_text_table($data, $returnprops, $props_to_print, $options);
 }
 
 sub print_api_result {
-    my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
+    my ($format, $data, $result_schema, $props_to_print, $options) = @_;
+
+    $options //= {};
+    $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);
            my $kvstore = [];
            foreach my $key (@$props_to_print) {
-               push @$kvstore, { key => $key, value => data_to_text($data->{$key}) };
+               push @$kvstore, { key => $key, value => data_to_text($data->{$key}, $result_schema->{properties}->{$key}) };
            }
            my $schema = { type => 'array', items => { type => 'object' }};
-           print_api_list($kvstore, $schema, ['key', 'value'], 0, $format eq 'text');
+           $options->{border} = $format eq 'text';
+           print_api_list($kvstore, $schema, ['key', 'value'], $options);
        } elsif ($type eq 'array') {
            return if !scalar(@$data);
            my $item_type = $result_schema->{items}->{type};
            if ($item_type eq 'object') {
-               print_api_list($data, $result_schema, $props_to_print, $sort_key, $format eq 'text');
+               $options->{border} = $format eq 'text';
+               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