proxmox-mirrors/pve-common
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-common synced 2025-07-16 20:33:20 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

cli: print_text_table: support multiline data

Browse Source 
Signed-off-by: Dietmar Maurer <dietmar@proxmox.com>
This commit is contained in:
Dietmar Maurer 2018-06-29 13:15:26 +02:00 committed by Thomas Lamprecht
parent 3cd6f2f350
commit 41d554d9cd
1 changed files with 86 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

140
src/PVE/CLIFormatter.pm
View File

@ -26,19 +26,6 @@ sub query_terminal_options {
return $options; return $options;
} }
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 { sub data_to_text {
my ($data, $propdef) = @_; my ($data, $propdef) = @_;
@ -91,7 +78,16 @@ sub print_text_table {
my $autosort = 1; my $autosort = 1;
if (defined($sort_key) && $sort_key eq 0) { if (defined($sort_key) && $sort_key eq 0) {
$autosort = 0; $autosort = 0;
$sort_key = undef; $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 = {}; my $colopts = {};
@ -103,6 +99,40 @@ sub print_text_table {
my $column_count = scalar(@$props_to_print); 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++) { for (my $i = 0; $i < $column_count; $i++) {
my $prop = $props_to_print->[$i]; my $prop = $props_to_print->[$i];
my $propinfo = $returnprops->{$prop} // {}; my $propinfo = $returnprops->{$prop} // {};
@ -114,31 +144,27 @@ sub print_text_table {
my $titlelen = length($title); my $titlelen = length($title);
my $longest = $titlelen; my $longest = $titlelen;
my $sortable = $autosort; foreach my $coldata (@$tabledata) {
foreach my $entry (@$data) { my $rowdata = $coldata->{rowdata}->{$prop};
my $len = length(data_to_text($entry->{$prop}, $propinfo)) // 0; $longest = $rowdata->{width} if $rowdata->{width} > $longest;
$longest = $len if $len > $longest;
$sortable = 0 if !defined($entry->{$prop});
} }
$cutoff = $longest if !defined($cutoff) || $cutoff > $longest; $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
$sort_key //= $prop if $sortable;
$colopts->{$prop} = { $colopts->{$prop} = {
title => $title, title => $title,
default => $propinfo->{default} // '',
cutoff => $cutoff, cutoff => $cutoff,
}; };
if ($border) { if ($border) {
if ($i == 0 && ($column_count == 1)) { if ($i == 0 && ($column_count == 1)) {
if ($utf8) { if ($utf8) {
$formatstring .= "│ %-${cutoff}s │\n"; $formatstring .= "│ %-${cutoff}s │";
$borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐\n"; $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
$borderstring_m .= "├─" . ('─' x $cutoff) . "─┤\n"; $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
$borderstring_b .= "└─" . ('─' x $cutoff) . "─┘\n"; $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
} else { } else {
$formatstring .= "| %-${cutoff}s |\n"; $formatstring .= "| %-${cutoff}s |";
$borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n"; $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
} }
} elsif ($i == 0) { } elsif ($i == 0) {
if ($utf8) { if ($utf8) {
@ -152,13 +178,13 @@ sub print_text_table {
} }
} elsif ($i == ($column_count - 1)) { } elsif ($i == ($column_count - 1)) {
if ($utf8) { if ($utf8) {
$formatstring .= "│ %-${cutoff}s │\n"; $formatstring .= "│ %-${cutoff}s │";
$borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐\n"; $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
$borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤\n"; $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
$borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘\n"; $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
} else { } else {
$formatstring .= "| %-${cutoff}s |\n"; $formatstring .= "| %-${cutoff}s |";
$borderstring_m .= "+-" . ('-' x $cutoff) . "-+\n"; $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
} }
} else { } else {
if ($utf8) { if ($utf8) {
@ -173,35 +199,41 @@ sub print_text_table {
} }
} else { } else {
# skip alignment and cutoff on last column # skip alignment and cutoff on last column
$formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s "; $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%-${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;
} }
} }
$borderstring_t = $borderstring_m if !length($borderstring_t); $borderstring_t = $borderstring_m if !length($borderstring_t);
$borderstring_b = $borderstring_m if !length($borderstring_b); $borderstring_b = $borderstring_m if !length($borderstring_b);
println_max($borderstring_t, $encoding, $columns) if $border; my $writeln = sub {
my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print; my ($text) = @_;
println_max($text, $encoding, $columns);
foreach my $entry (@$data) { if ($columns) {
println_max($borderstring_m, $encoding, $columns) if $border; print encode($encoding, substr($text, 0, $columns) . "\n");
$text = sprintf $formatstring, map { } else {
substr(data_to_text($entry->{$_}, $returnprops->{$_}) // $colopts->{$_}->{default}, print encode($encoding, $text) . "\n";
0, $colopts->{$_}->{cutoff}); }
} @$props_to_print; };
println_max($text, $encoding, $columns);
$writeln->($borderstring_t) if $border;
my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
$writeln->($text);
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, $encoding, $columns) if $border;
$writeln->($borderstring_b) if $border;
} }
# prints the result of an API GET call returning an array as a table. # prints the result of an API GET call returning an array as a table.