]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/CLIFormatter.pm
cli: print_text_table: restore autoformat behavior
[pve-common.git] / src / PVE / CLIFormatter.pm
index 93e2cad6585e2540a0713557e2ef40b3ddaafc21..b50464d6c1a2e69cd2c3a4c0f6f8d2860f7bfaa8 100644 (file)
@@ -2,27 +2,35 @@ package PVE::CLIFormatter;
 
 use strict;
 use warnings;
+use I18N::Langinfo;
+
 use PVE::JSONSchema;
+use PVE::PTY;
 use JSON;
 use utf8;
 use Encode;
 
-sub println_max {
-    my ($text, $max) = @_;
+sub query_terminal_options {
+    my ($options) = @_;
 
-    if ($max) {
-       my @lines = split(/\n/, $text);
-       foreach my $line (@lines) {
-           print encode('UTF-8', substr($line, 0, $max) . "\n");
-       }
-    } else {
-       print encode('UTF-8', $text);
+    $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 data_to_text {
     my ($data, $propdef) = @_;
 
+    return '' if !defined($data);
+
     if (defined($propdef)) {
        if (my $type = $propdef->{type}) {
            if ($type eq 'boolean') {
@@ -38,7 +46,6 @@ sub data_to_text {
            return $code->($data);
        }
     }
-    return '' if !defined($data);
 
     if (my $class = ref($data)) {
        return to_json($data, { canonical => 1 });
@@ -66,11 +73,19 @@ 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) {
-       $autosort = 0;
-       $sort_key = undef;
+    if (!defined($sort_key) || $sort_key eq 0) {
+       $sort_key = $props_to_print->[0];
+    }
+
+    if (defined($sort_key)) {
+       my $type = $returnprops->{$sort_key}->{type} // 'string';
+       if ($type eq 'integer' || $type eq 'number') {
+           @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
+       } else {
+           @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+       }
     }
 
     my $colopts = {};
@@ -82,6 +97,40 @@ sub print_text_table {
 
     my $column_count = scalar(@$props_to_print);
 
+    my $tabledata = [];
+
+    foreach my $entry (@$data) {
+
+       my $height = 1;
+       my $rowdata = {};
+
+       for (my $i = 0; $i < $column_count; $i++) {
+           my $prop = $props_to_print->[$i];
+           my $propinfo = $returnprops->{$prop} // {};
+
+           my $text = data_to_text($entry->{$prop}, $propinfo);
+           my $lines = [ split(/\n/, $text) ];
+           my $linecount = scalar(@$lines);
+           $height = $linecount if $linecount > $height;
+
+           my $width = 0;
+           foreach my $line (@$lines) {
+               my $len = length($line);
+               $width = $len if $len > $width;
+           }
+
+           $rowdata->{$prop} = {
+               lines => $lines,
+               width => $width,
+           };
+       }
+
+       push @$tabledata, {
+           height => $height,
+           rowdata => $rowdata,
+       };
+    }
+
     for (my $i = 0; $i < $column_count; $i++) {
        my $prop = $props_to_print->[$i];
        my $propinfo = $returnprops->{$prop} // {};
@@ -93,31 +142,27 @@ sub print_text_table {
        my $titlelen = length($title);
 
        my $longest = $titlelen;
-       my $sortable = $autosort;
-       foreach my $entry (@$data) {
-           my $len = length(data_to_text($entry->{$prop}, $propinfo)) // 0;
-           $longest = $len if $len > $longest;
-           $sortable = 0 if !defined($entry->{$prop});
+       foreach my $coldata (@$tabledata) {
+           my $rowdata = $coldata->{rowdata}->{$prop};
+           $longest = $rowdata->{width} if $rowdata->{width} > $longest;
        }
        $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
-       $sort_key //= $prop if $sortable;
 
        $colopts->{$prop} = {
            title => $title,
-           default => $propinfo->{default} // '',
            cutoff => $cutoff,
        };
 
        if ($border) {
            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";
+                   $formatstring .= "│ %-${cutoff}s │";
+                   $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
+                   $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
+                   $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
                } else {
-                   $formatstring .= "| %-${cutoff}s |\n";
-                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n";
+                   $formatstring .= "| %-${cutoff}s |";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
                }
            } elsif ($i == 0) {
                if ($utf8) {
@@ -131,13 +176,13 @@ sub print_text_table {
                }
            } 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";
+                   $formatstring .= "│ %-${cutoff}s │";
+                   $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
+                   $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
+                   $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
                } else {
-                   $formatstring .= "| %-${cutoff}s |\n";
-                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n";
+                   $formatstring .= "| %-${cutoff}s |";
+                   $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
                }
            } else {
                if ($utf8) {
@@ -152,35 +197,41 @@ sub print_text_table {
            }
        } else {
            # skip alignment and cutoff on last column
-           $formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
-       }
-    }
-
-    if (defined($sort_key)) {
-       my $type = $returnprops->{$sort_key}->{type} // 'string';
-       if ($type eq 'integer' || $type eq 'number') {
-           @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
-       } else {
-           @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+           $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%-${cutoff}s ";
        }
     }
 
     $borderstring_t = $borderstring_m if !length($borderstring_t);
     $borderstring_b = $borderstring_m if !length($borderstring_b);
 
-    println_max($borderstring_t, $columns) if $border;
+    my $writeln = sub {
+       my ($text) = @_;
+
+       if ($columns) {
+           print encode($encoding, substr($text, 0, $columns) . "\n");
+       } else {
+           print encode($encoding, $text) . "\n";
+       }
+    };
+
+    $writeln->($borderstring_t) if $border;
     my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
-    println_max($text, $columns);
+    $writeln->($text);
 
-    foreach my $entry (@$data) {
-       println_max($borderstring_m, $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);
+    foreach my $coldata (@$tabledata) {
+       $writeln->($borderstring_m) if $border;
+
+       for (my $i = 0; $i < $coldata->{height}; $i++) {
+
+           $text = sprintf $formatstring, map {
+               substr($coldata->{rowdata}->{$_}->{lines}->[$i] // '', 0, $colopts->{$_}->{cutoff});
+           } @$props_to_print;
+
+           $writeln->($text);
+       }
     }
-    println_max($borderstring_b, $columns) if $border;
+
+    $writeln->($borderstring_b) if $border;
 }
 
 # prints the result of an API GET call returning an array as a table.
@@ -216,14 +267,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 +298,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