use strict;
use warnings;
+
use I18N::Langinfo;
-use POSIX qw(strftime);
+use YAML::XS; # supports Dumping JSON::PP::Boolean
+$YAML::XS::Boolean = "JSON::PP";
use PVE::JSONSchema;
use PVE::PTY;
+use PVE::Format;
+
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) = @_;
-
- my $text = '';
- my $rest = $duration_in_seconds;
-
- my $step = sub {
- my ($unit, $unitlength) = @_;
-
- if ((my $v = int($rest/$unitlength)) > 0) {
- $text .= " " if length($text);
- $text .= "${v}${unit}";
- $rest -= $v * $unitlength;
- }
- };
-
- $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);
+PVE::JSONSchema::register_renderer('timestamp', \&PVE::Format::render_timestamp);
+PVE::JSONSchema::register_renderer('timestamp_gmt', \&PVE::Format::render_timestamp_gmt);
+PVE::JSONSchema::register_renderer('duration', \&PVE::Format::render_duration);
+PVE::JSONSchema::register_renderer('fraction_as_percentage', \&PVE::Format::render_fraction_as_percentage);
+PVE::JSONSchema::register_renderer('bytes', \&PVE::Format::render_bytes);
-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 {
+sub render_yaml {
my ($value) = @_;
- my @units = qw(B KiB MiB GiB TiB PiB);
+ my $data = YAML::XS::Dump($value);
+ $data =~ s/^---[\n\s]//; # remove yaml marker
- 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;
+ return $data;
}
-PVE::JSONSchema::register_renderer('bytes', \&render_bytes);
+PVE::JSONSchema::register_renderer('yaml', \&render_yaml);
sub query_terminal_options {
my ($options) = @_;
}
sub data_to_text {
- my ($data, $propdef) = @_;
+ my ($data, $propdef, $options, $terminal_opts) = @_;
return '' if !defined($data);
- if (defined($propdef)) {
+ $terminal_opts //= {};
+
+ my $human_readable = $options->{'human-readable'} // 1;
+
+ if ($human_readable && defined($propdef)) {
if (my $type = $propdef->{type}) {
if ($type eq 'boolean') {
return $data ? 1 : 0;
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, $terminal_opts);
}
}
if (my $class = ref($data)) {
- return to_json($data, { canonical => 1 });
+ # JSON::PP::Boolean requires allow_nonref
+ return to_json($data, { allow_nonref => 1, canonical => 1 });
} else {
return "$data";
}
# $returnprops -json schema property description
# $props_to_print - ordered list of properties to print
# $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
+# - sort_key: can be used to sort after a specific column, if it isn't set we sort
+# after the leftmost column. This can be turned off by passing 0 as sort_key
+# - noborder: print without asciiart border
+# - noheader: print without table header
# - columns: limit output width (if > 0)
# - utf8: use utf8 characters for table delimiters
sub print_text_table {
- my ($data, $returnprops, $props_to_print, $options) = @_;
+ my ($data, $returnprops, $props_to_print, $options, $terminal_opts) = @_;
+
+ $terminal_opts //= query_terminal_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 $show_border = !$options->{noborder};
+ my $show_header = !$options->{noheader};
- if (!defined($sort_key) || $sort_key eq 0) {
- $sort_key = $props_to_print->[0];
- }
+ my $columns = $terminal_opts->{columns};
+ my $utf8 = $terminal_opts->{utf8};
+ my $encoding = $terminal_opts->{encoding} // 'UTF-8';
+
+ $sort_key //= $props_to_print->[0];
- if (defined($sort_key)) {
+ if (defined($sort_key) && $sort_key ne 0) {
my $type = $returnprops->{$sort_key}->{type} // 'string';
+ my $cmpfn;
if ($type eq 'integer' || $type eq 'number') {
- @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
+ $cmpfn = sub { $_[0] <=> $_[1] };
} else {
- @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+ $cmpfn = sub { $_[0] cmp $_[1] };
}
+ @$data = sort {
+ PVE::Tools::safe_compare($a->{$sort_key}, $b->{$sort_key}, $cmpfn)
+ } @$data;
}
my $colopts = {};
- my $borderstring_m = '';
- my $borderstring_b = '';
- my $borderstring_t = '';
+ my $border = { m => '', b => '', t => '', h => '' };
my $formatstring = '';
my $column_count = scalar(@$props_to_print);
my $prop = $props_to_print->[$i];
my $propinfo = $returnprops->{$prop} // {};
- my $text = data_to_text($entry->{$prop}, $propinfo);
+ my $text = data_to_text($entry->{$prop}, $propinfo, $options, $terminal_opts);
my $lines = [ split(/\n/, $text) ];
my $linecount = scalar(@$lines);
$height = $linecount if $linecount > $height;
$width = $len if $len > $width;
}
+ $width = ($width =~ m/^(\d+)$/) ? int($1) : 0; # untaint int
+
$rowdata->{$prop} = {
lines => $lines,
width => $width,
for (my $i = 0; $i < $column_count; $i++) {
my $prop = $props_to_print->[$i];
my $propinfo = $returnprops->{$prop} // {};
+ my $type = $propinfo->{type} // 'string';
+ my $alignstr = ($type eq 'integer' || $type eq 'number') ? '' : '-';
my $title = $propinfo->{title} // $prop;
my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
cutoff => $cutoff,
};
- if ($border) {
+ if ($show_border) {
if ($i == 0 && ($column_count == 1)) {
if ($utf8) {
- $formatstring .= "│ %-${cutoff}s │";
- $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
- $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
- $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
+ $formatstring .= "│ %$alignstr${cutoff}s │";
+ $border->{t} .= "┌─" . ('─' x $cutoff) . "─┐";
+ $border->{h} .= "╞═" . ('═' x $cutoff) . '═╡';
+ $border->{m} .= "├─" . ('─' x $cutoff) . "─┤";
+ $border->{b} .= "└─" . ('─' x $cutoff) . "─┘";
} else {
- $formatstring .= "| %-${cutoff}s |";
- $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
+ $formatstring .= "| %$alignstr${cutoff}s |";
+ $border->{m} .= "+-" . ('-' x $cutoff) . "-+";
+ $border->{h} .= "+=" . ('=' x $cutoff) . '=';
}
} elsif ($i == 0) {
if ($utf8) {
- $formatstring .= "│ %-${cutoff}s ";
- $borderstring_t .= "┌─" . ('─' x $cutoff) . '─';
- $borderstring_m .= "├─" . ('─' x $cutoff) . '─';
- $borderstring_b .= "└─" . ('─' x $cutoff) . '─';
+ $formatstring .= "│ %$alignstr${cutoff}s ";
+ $border->{t} .= "┌─" . ('─' x $cutoff) . '─';
+ $border->{h} .= "╞═" . ('═' x $cutoff) . '═';
+ $border->{m} .= "├─" . ('─' x $cutoff) . '─';
+ $border->{b} .= "└─" . ('─' x $cutoff) . '─';
} else {
- $formatstring .= "| %-${cutoff}s ";
- $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+ $formatstring .= "| %$alignstr${cutoff}s ";
+ $border->{m} .= "+-" . ('-' x $cutoff) . '-';
+ $border->{h} .= "+=" . ('=' x $cutoff) . '=';
}
} elsif ($i == ($column_count - 1)) {
if ($utf8) {
- $formatstring .= "│ %-${cutoff}s │";
- $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
- $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
- $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
+ $formatstring .= "│ %$alignstr${cutoff}s │";
+ $border->{t} .= "┬─" . ('─' x $cutoff) . "─┐";
+ $border->{h} .= "╪═" . ('═' x $cutoff) . '═╡';
+ $border->{m} .= "┼─" . ('─' x $cutoff) . "─┤";
+ $border->{b} .= "┴─" . ('─' x $cutoff) . "─┘";
} else {
- $formatstring .= "| %-${cutoff}s |";
- $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
+ $formatstring .= "| %$alignstr${cutoff}s |";
+ $border->{m} .= "+-" . ('-' x $cutoff) . "-+";
+ $border->{h} .= "+=" . ('=' x $cutoff) . "=+";
}
} else {
if ($utf8) {
- $formatstring .= "│ %-${cutoff}s ";
- $borderstring_t .= "┬─" . ('─' x $cutoff) . '─';
- $borderstring_m .= "┼─" . ('─' x $cutoff) . '─';
- $borderstring_b .= "┴─" . ('─' x $cutoff) . '─';
+ $formatstring .= "│ %$alignstr${cutoff}s ";
+ $border->{t} .= "┬─" . ('─' x $cutoff) . '─';
+ $border->{h} .= "╪═" . ('═' x $cutoff) . '═';
+ $border->{m} .= "┼─" . ('─' x $cutoff) . '─';
+ $border->{b} .= "┴─" . ('─' x $cutoff) . '─';
} else {
- $formatstring .= "| %-${cutoff}s ";
- $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+ $formatstring .= "| %$alignstr${cutoff}s ";
+ $border->{m} .= "+-" . ('-' x $cutoff) . '-';
+ $border->{h} .= "+=" . ('=' x $cutoff) . '=';
}
}
} else {
# skip alignment and cutoff on last column
- $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%-${cutoff}s ";
+ $formatstring .= ($i == ($column_count - 1)) ? "%s" : "%$alignstr${cutoff}s ";
}
}
- $borderstring_t = $borderstring_m if !length($borderstring_t);
- $borderstring_b = $borderstring_m if !length($borderstring_b);
+ $border->{t} = $border->{m} if !length($border->{t});
+ $border->{b} = $border->{m} if !length($border->{b});
my $writeln = sub {
my ($text) = @_;
}
};
- $writeln->($borderstring_t) if $border;
- my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
- $writeln->($text);
+ $writeln->($border->{t}) if $show_border;
- foreach my $coldata (@$tabledata) {
- $writeln->($borderstring_m) if $border;
+ if ($show_header) {
+ my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+ $writeln->($text);
+ $border->{sep} = $border->{h};
+ } else {
+ $border->{sep} = $border->{m};
+ }
- for (my $i = 0; $i < $coldata->{height}; $i++) {
+ for (my $i = 0; $i < scalar(@$tabledata); $i++) {
+ my $coldata = $tabledata->[$i];
- $text = sprintf $formatstring, map {
+ if ($show_border && ($i != 0 || $show_header)) {
+ $writeln->($border->{sep});
+ $border->{sep} = $border->{m};
+ }
+
+ for (my $i = 0; $i < $coldata->{height}; $i++) {
+ my $text = sprintf $formatstring, map {
substr($coldata->{rowdata}->{$_}->{lines}->[$i] // '', 0, $colopts->{$_}->{cutoff});
} @$props_to_print;
}
}
- $writeln->($borderstring_b) if $border;
+ $writeln->($border->{b}) if $show_border;
}
sub extract_properties_to_print {
# takes formatting information from the results property of the call
# if $props_to_print is provided, prints only those columns. otherwise
# takes all fields of the results property, with a fallback
-# to all fields occuring in items of $data.
+# to all fields occurring in items of $data.
sub print_api_list {
- my ($data, $result_schema, $props_to_print, $options) = @_;
+ my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
die "can only print object lists\n"
if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
die "unable to detect list properties\n" if !scalar(@$props_to_print);
- print_text_table($data, $returnprops, $props_to_print, $options);
+ print_text_table($data, $returnprops, $props_to_print, $options, $terminal_opts);
}
-sub print_api_result {
- my ($format, $data, $result_schema, $props_to_print, $options) = @_;
+my $guess_type = sub {
+ my $data = shift;
+
+ return 'null' if !defined($data);
- if (!defined($options)) {
- $options = query_terminal_options({});
+ my $class = ref($data);
+ return 'string' if !$class;
+
+ if ($class eq 'HASH') {
+ return 'object';
+ } elsif ($class eq 'ARRAY') {
+ return 'array';
} else {
- $options = { %$options }; # copy
+ return 'string'; # better than nothing
}
+};
+
+sub print_api_result {
+ my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
- return if $result_schema->{type} eq 'null';
+ return if $options->{quiet};
- if ($format eq 'json') {
+ $terminal_opts //= query_terminal_options({});
+
+ my $format = $options->{'output-format'} // 'text';
+
+ if ($result_schema && defined($result_schema->{type})) {
+ return if $result_schema->{type} eq 'null';
+ return if $result_schema->{optional} && !defined($data);
+ } else {
+ my $type = $guess_type->($data);
+ $result_schema = { type => $type };
+ $result_schema->{items} = { type => $guess_type->($data->[0]) } if $type eq 'array';
+ }
+
+ if ($format eq 'yaml') {
+ print encode('UTF-8', YAML::XS::Dump($data));
+ } elsif ($format eq 'json') {
+ # Note: we always use utf8 encoding for json format
+ print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1 }) . "\n";
+ } elsif ($format eq 'json-pretty') {
# 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') {
+ } elsif ($format eq 'text') {
my $encoding = $options->{encoding} // 'UTF-8';
my $type = $result_schema->{type};
if ($type eq 'object') {
$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}) };
+ next if !defined($data->{$key});
+ push @$kvstore, { key => $key, value => data_to_text($data->{$key}, $result_schema->{properties}->{$key}, $options, $terminal_opts) };
}
my $schema = { type => 'array', items => { type => 'object' }};
- $options->{border} = $format eq 'text';
- print_api_list($kvstore, $schema, ['key', 'value'], $options);
+ print_api_list($kvstore, $schema, ['key', 'value'], $options, $terminal_opts);
} elsif ($type eq 'array') {
- return if !scalar(@$data);
+ if (ref($data) eq 'ARRAY') {
+ return if !scalar(@$data);
+ } elsif (ref($data) eq 'HASH') {
+ return if !scalar($data->%*);
+ die "got hash object, but result schema specified array!\n"
+ }
my $item_type = $result_schema->{items}->{type};
if ($item_type eq 'object') {
- $options->{border} = $format eq 'text';
- print_api_list($data, $result_schema, $props_to_print, $options);
+ print_api_list($data, $result_schema, $props_to_print, $options, $terminal_opts);
} else {
- foreach my $entry (@$data) {
- print encode($encoding, data_to_text($entry) . "\n");
+ my $kvstore = [];
+ foreach my $value (@$data) {
+ push @$kvstore, { value => $value };
}
+ my $schema = { type => 'array', items => { type => 'object', properties => { value => $result_schema->{items} }}};
+ print_api_list($kvstore, $schema, ['value'], { %$options, noheader => 1 }, $terminal_opts);
}
} else {
print encode($encoding, "$data\n");
}
}
+sub print_api_result_plain {
+ my ($data, $result_schema, $props_to_print, $options) = @_;
+
+ # avoid borders and header, ignore terminal width
+ $options = $options ? { %$options } : {}; # copy
+
+ $options->{noheader} //= 1;
+ $options->{noborder} //= 1;
+
+ print_api_result($data, $result_schema, $props_to_print, $options, {});
+}
+
1;
projects / pve-common.git / blobdiff