use strict;
use warnings;
+use I18N::Langinfo;
+use POSIX qw(strftime);
+
use PVE::JSONSchema;
+use PVE::PTY;
use JSON;
+use utf8;
+use Encode;
+
+sub render_timestamp {
+ my ($epoch) = @_;
+
+ # ISO 8601 date format
+ return strftime("%F %H:%M:%S", localtime($epoch));
+}
+
+PVE::JSONSchema::register_renderer('timestamp', \&render_timestamp);
+
+sub render_duration {
+ my ($duration_in_seconds) = @_;
-sub println_max {
- my ($text, $max) = @_;
+ my $text = '';
+ my $rest = $duration_in_seconds;
- if ($max) {
- my @lines = split(/\n/, $text);
- foreach my $line (@lines) {
- print substr($line, 0, $max) . "\n";
+ my $step = sub {
+ my ($unit, $unitlength) = @_;
+
+ if ((my $v = int($rest/$unitlength)) > 0) {
+ $text .= " " if length($text);
+ $text .= "${v}${unit}";
+ $rest -= $v * $unitlength;
}
- } else {
- print $text;
+ };
+
+ $step->('w', 7*24*3600);
+ $step->('d', 24*3600);
+ $step->('h', 3600);
+ $step->('m', 60);
+ $step->('s', 1);
+
+ return $text;
+}
+
+PVE::JSONSchema::register_renderer('duration', \&render_duration);
+
+sub render_fraction_as_percentage {
+ my ($fraction) = @_;
+
+ return sprintf("%.2f%%", $fraction*100);
+}
+
+PVE::JSONSchema::register_renderer(
+ 'fraction_as_percentage', \&render_fraction_as_percentage);
+
+sub render_bytes {
+ my ($value) = @_;
+
+ my @units = qw(B KiB MiB GiB TiB PiB);
+
+ my $max_unit = 0;
+ if ($value > 1023) {
+ $max_unit = int(log($value)/log(1024));
+ $value /= 1024**($max_unit);
+ }
+
+ return sprintf "%.2f $units[$max_unit]", $value;
+}
+
+PVE::JSONSchema::register_renderer('bytes', \&render_bytes);
+
+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 data_to_text {
- my ($data, $propdef) = @_;
+ my ($data, $propdef, $options) = @_;
+
+ return '' if !defined($data);
if (defined($propdef)) {
if (my $type = $propdef->{type}) {
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 $code->($data, $options);
}
}
- return '' if !defined($data);
if (my $class = ref($data)) {
return to_json($data, { canonical => 1 });
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 = {};
- my $borderstring = '';
+ my $borderstring_m = '';
+ my $borderstring_b = '';
+ my $borderstring_t = '';
my $formatstring = '';
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, $options);
+ 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} // {};
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 == ($column_count - 1)) {
- $formatstring .= "| %-${cutoff}s |\n";
- $borderstring .= "+-" . ('-' x $cutoff) . "-+\n";
+ if ($i == 0 && ($column_count == 1)) {
+ 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 == 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 │";
+ $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
+ $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
+ $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
+ } else {
+ $formatstring .= "| %-${cutoff}s |";
+ $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
+ }
} 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
- $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;
+ $borderstring_t = $borderstring_m if !length($borderstring_t);
+ $borderstring_b = $borderstring_m if !length($borderstring_b);
+
+ my $writeln = sub {
+ my ($text) = @_;
+
+ if ($columns) {
+ print encode($encoding, substr($text, 0, $columns) . "\n");
} else {
- @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+ print encode($encoding, $text) . "\n";
}
- }
+ };
- println_max($borderstring, $columns) if $border;
+ $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, $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, $columns) if $border;
+
+ $writeln->($borderstring_b) if $border;
+}
+
+sub extract_properties_to_print {
+ my ($propdef) = @_;
+
+ my $required = [];
+ my $optional = [];
+
+ foreach my $key (keys %$propdef) {
+ my $prop = $propdef->{$key};
+ if ($prop->{optional}) {
+ push @$optional, $key;
+ } else {
+ push @$required, $key;
+ }
+ }
+
+ return [ sort(@$required), sort(@$optional) ];
}
# prints the result of an API GET call returning an array as a table.
my $returnprops = $result_schema->{items}->{properties};
- if (!defined($props_to_print)) {
- $props_to_print = [ sort keys %$returnprops ];
- if (!scalar(@$props_to_print)) {
- my $all_props = {};
- foreach my $obj (@{$data}) {
- foreach my $key (keys %{$obj}) {
- $all_props->{ $key } = 1;
- }
+ $props_to_print = extract_properties_to_print($returnprops)
+ if !defined($props_to_print);
+
+ if (!scalar(@$props_to_print)) {
+ my $all_props = {};
+ foreach my $obj (@$data) {
+ foreach my $key (keys %$obj) {
+ $all_props->{$key} = 1;
}
- $props_to_print = [ sort keys %{$all_props} ];
}
- die "unable to detect list properties\n" if !scalar(@$props_to_print);
+ $props_to_print = [ sort keys %{$all_props} ];
}
+ die "unable to detect list properties\n" if !scalar(@$props_to_print);
+
print_text_table($data, $returnprops, $props_to_print, $options);
}
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);
+ $props_to_print = extract_properties_to_print($result_schema->{properties})
+ if !defined($props_to_print);
+ $props_to_print = [ sort keys %$data ] if !scalar(@$props_to_print);
my $kvstore = [];
foreach my $key (@$props_to_print) {
- push @$kvstore, { key => $key, value => data_to_text($data->{$key}, $result_schema->{properties}->{$key}) };
+ push @$kvstore, { key => $key, value => data_to_text($data->{$key}, $result_schema->{properties}->{$key}, $options) };
}
my $schema = { type => 'array', items => { type => 'object' }};
$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, $result_schema->{items}, $options) . "\n");
}
}
} else {
- print "$data\n";
+ print encode($encoding, "$data\n");
}
} else {
die "internal error: unknown output format"; # should not happen
projects / pve-common.git / blobdiff