use strict;
use warnings;
use I18N::Langinfo;
+use POSIX qw(strftime);
use PVE::JSONSchema;
use PVE::PTY;
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_timestamp_gmt {
+ my ($epoch) = @_;
+
+ # ISO 8601 date format, standard Greenwich time zone
+ return strftime("%F %H:%M:%S", gmtime($epoch));
+}
+
+PVE::JSONSchema::register_renderer('timestamp_gmt', \&render_timestamp_gmt);
+
sub render_duration {
my ($duration_in_seconds) = @_;
}
sub data_to_text {
- my ($data, $propdef) = @_;
+ my ($data, $propdef, $options) = @_;
return '' if !defined($data);
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);
}
}
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);
my $lines = [ split(/\n/, $text) ];
my $linecount = scalar(@$lines);
$height = $linecount if $linecount > $height;
$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.
# takes formatting information from the results property of the call
# if $props_to_print is provided, prints only those columns. otherwise
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);
}
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($kvstore, $schema, ['key', 'value'], $options);
} elsif ($type eq 'array') {
return if !scalar(@$data);
+ $options->{border} = $format eq 'text';
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);
} 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);
}
} else {
print encode($encoding, "$data\n");