1 package PVE
::CLIFormatter
;
7 use POSIX
qw(strftime);
8 use CPAN
::Meta
::YAML
; # comes with perl-modules
17 sub render_timestamp
{
20 # ISO 8601 date format
21 return strftime
("%F %H:%M:%S", localtime($epoch));
24 PVE
::JSONSchema
::register_renderer
('timestamp', \
&render_timestamp
);
26 sub render_timestamp_gmt
{
29 # ISO 8601 date format, standard Greenwich time zone
30 return strftime
("%F %H:%M:%S", gmtime($epoch));
33 PVE
::JSONSchema
::register_renderer
('timestamp_gmt', \
&render_timestamp_gmt
);
36 my ($duration_in_seconds) = @_;
39 my $rest = $duration_in_seconds;
42 my ($unit, $unitlength) = @_;
44 if ((my $v = int($rest/$unitlength)) > 0) {
45 $text .= " " if length($text);
46 $text .= "${v}${unit}";
47 $rest -= $v * $unitlength;
51 $step->('w', 7*24*3600);
52 $step->('d', 24*3600);
60 PVE
::JSONSchema
::register_renderer
('duration', \
&render_duration
);
62 sub render_fraction_as_percentage
{
65 return sprintf("%.2f%%", $fraction*100);
68 PVE
::JSONSchema
::register_renderer
(
69 'fraction_as_percentage', \
&render_fraction_as_percentage
);
74 my @units = qw(B KiB MiB GiB TiB PiB);
78 $max_unit = int(log($value)/log(1024));
79 $value /= 1024**($max_unit);
81 my $unit = $units[$max_unit];
82 return sprintf "%.2f $unit", $value;
85 PVE
::JSONSchema
::register_renderer
('bytes', \
&render_bytes
);
90 my $data = CPAN
::Meta
::YAML
::Dump
($value);
91 $data =~ s/^---[\n\s]//; # remove yaml marker
96 PVE
::JSONSchema
::register_renderer
('yaml', \
&render_yaml
);
98 sub query_terminal_options
{
104 ($options->{columns
}) = PVE
::PTY
::tcgetsize
(*STDOUT
);
107 $options->{encoding
} = I18N
::Langinfo
::langinfo
(I18N
::Langinfo
::CODESET
());
109 $options->{utf8
} = 1 if $options->{encoding
} eq 'UTF-8';
115 my ($data, $propdef, $options, $terminal_opts) = @_;
117 return '' if !defined($data);
119 $terminal_opts //= {};
121 my $human_readable = $options->{'human-readable'} // 1;
123 if ($human_readable && defined($propdef)) {
124 if (my $type = $propdef->{type
}) {
125 if ($type eq 'boolean') {
126 return $data ?
1 : 0;
129 if (!defined($data) && defined($propdef->{default})) {
130 return "($propdef->{default})";
132 if (defined(my $renderer = $propdef->{renderer
})) {
133 my $code = PVE
::JSONSchema
::get_renderer
($renderer);
134 die "internal error: unknown renderer '$renderer'" if !$code;
135 return $code->($data, $options, $terminal_opts);
139 if (my $class = ref($data)) {
140 # JSON::PP::Boolean requires allow_nonref
141 return to_json
($data, { allow_nonref
=> 1, canonical
=> 1 });
147 # prints a formatted table with a title row.
148 # $data - the data to print (array of objects)
149 # $returnprops -json schema property description
150 # $props_to_print - ordered list of properties to print
152 # - sort_key: can be used to sort after a specific column, if it isn't set we sort
153 # after the leftmost column (with no undef value in $data) this can be
154 # turned off by passing 0 as sort_key
155 # - noborder: print without asciiart border
156 # - noheader: print without table header
157 # - columns: limit output width (if > 0)
158 # - utf8: use utf8 characters for table delimiters
160 sub print_text_table
{
161 my ($data, $returnprops, $props_to_print, $options, $terminal_opts) = @_;
163 $terminal_opts //= query_terminal_options
({});
165 my $sort_key = $options->{sort_key
};
166 my $border = !$options->{noborder
};
167 my $header = !$options->{noheader
};
169 my $columns = $terminal_opts->{columns
};
170 my $utf8 = $terminal_opts->{utf8
};
171 my $encoding = $terminal_opts->{encoding
} // 'UTF-8';
173 $sort_key //= $props_to_print->[0];
175 if (defined($sort_key) && $sort_key ne 0) {
176 my $type = $returnprops->{$sort_key}->{type
} // 'string';
177 if ($type eq 'integer' || $type eq 'number') {
178 @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
180 @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
186 my $borderstring_m = '';
187 my $borderstring_b = '';
188 my $borderstring_t = '';
189 my $formatstring = '';
191 my $column_count = scalar(@$props_to_print);
195 foreach my $entry (@$data) {
200 for (my $i = 0; $i < $column_count; $i++) {
201 my $prop = $props_to_print->[$i];
202 my $propinfo = $returnprops->{$prop} // {};
204 my $text = data_to_text
($entry->{$prop}, $propinfo, $options, $terminal_opts);
205 my $lines = [ split(/\n/, $text) ];
206 my $linecount = scalar(@$lines);
207 $height = $linecount if $linecount > $height;
210 foreach my $line (@$lines) {
211 my $len = length($line);
212 $width = $len if $len > $width;
215 $width = ($width =~ m/^(\d+)$/) ?
int($1) : 0; # untaint int
217 $rowdata->{$prop} = {
229 for (my $i = 0; $i < $column_count; $i++) {
230 my $prop = $props_to_print->[$i];
231 my $propinfo = $returnprops->{$prop} // {};
232 my $type = $propinfo->{type
} // 'string';
233 my $alignstr = ($type eq 'integer' || $type eq 'number') ?
'' : '-';
235 my $title = $propinfo->{title
} // $prop;
236 my $cutoff = $propinfo->{print_width
} // $propinfo->{maxLength
};
238 # calculate maximal print width and cutoff
239 my $titlelen = length($title);
241 my $longest = $titlelen;
242 foreach my $coldata (@$tabledata) {
243 my $rowdata = $coldata->{rowdata
}->{$prop};
244 $longest = $rowdata->{width
} if $rowdata->{width
} > $longest;
246 $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
248 $colopts->{$prop} = {
254 if ($i == 0 && ($column_count == 1)) {
256 $formatstring .= "│ %$alignstr${cutoff}s │";
257 $borderstring_t .= "┌─" . ('─' x
$cutoff) . "─┐";
258 $borderstring_m .= "├─" . ('─' x
$cutoff) . "─┤";
259 $borderstring_b .= "└─" . ('─' x
$cutoff) . "─┘";
261 $formatstring .= "| %$alignstr${cutoff}s |";
262 $borderstring_m .= "+-" . ('-' x
$cutoff) . "-+";
266 $formatstring .= "│ %$alignstr${cutoff}s ";
267 $borderstring_t .= "┌─" . ('─' x
$cutoff) . '─';
268 $borderstring_m .= "├─" . ('─' x
$cutoff) . '─';
269 $borderstring_b .= "└─" . ('─' x
$cutoff) . '─';
271 $formatstring .= "| %$alignstr${cutoff}s ";
272 $borderstring_m .= "+-" . ('-' x
$cutoff) . '-';
274 } elsif ($i == ($column_count - 1)) {
276 $formatstring .= "│ %$alignstr${cutoff}s │";
277 $borderstring_t .= "┬─" . ('─' x
$cutoff) . "─┐";
278 $borderstring_m .= "┼─" . ('─' x
$cutoff) . "─┤";
279 $borderstring_b .= "┴─" . ('─' x
$cutoff) . "─┘";
281 $formatstring .= "| %$alignstr${cutoff}s |";
282 $borderstring_m .= "+-" . ('-' x
$cutoff) . "-+";
286 $formatstring .= "│ %$alignstr${cutoff}s ";
287 $borderstring_t .= "┬─" . ('─' x
$cutoff) . '─';
288 $borderstring_m .= "┼─" . ('─' x
$cutoff) . '─';
289 $borderstring_b .= "┴─" . ('─' x
$cutoff) . '─';
291 $formatstring .= "| %$alignstr${cutoff}s ";
292 $borderstring_m .= "+-" . ('-' x
$cutoff) . '-';
296 # skip alignment and cutoff on last column
297 $formatstring .= ($i == ($column_count - 1)) ?
"%s" : "%$alignstr${cutoff}s ";
301 $borderstring_t = $borderstring_m if !length($borderstring_t);
302 $borderstring_b = $borderstring_m if !length($borderstring_b);
308 print encode
($encoding, substr($text, 0, $columns) . "\n");
310 print encode
($encoding, $text) . "\n";
314 $writeln->($borderstring_t) if $border;
317 my $text = sprintf $formatstring, map { $colopts->{$_}->{title
} } @$props_to_print;
321 for (my $i = 0; $i < scalar(@$tabledata); $i++) {
322 my $coldata = $tabledata->[$i];
324 $writeln->($borderstring_m) if $border && ($i != 0 || $header);
326 for (my $i = 0; $i < $coldata->{height
}; $i++) {
328 my $text = sprintf $formatstring, map {
329 substr($coldata->{rowdata
}->{$_}->{lines
}->[$i] // '', 0, $colopts->{$_}->{cutoff
});
336 $writeln->($borderstring_b) if $border;
339 sub extract_properties_to_print
{
345 foreach my $key (keys %$propdef) {
346 my $prop = $propdef->{$key};
347 if ($prop->{optional
}) {
348 push @$optional, $key;
350 push @$required, $key;
354 return [ sort(@$required), sort(@$optional) ];
357 # prints the result of an API GET call returning an array as a table.
358 # takes formatting information from the results property of the call
359 # if $props_to_print is provided, prints only those columns. otherwise
360 # takes all fields of the results property, with a fallback
361 # to all fields occurring in items of $data.
363 my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
365 die "can only print object lists\n"
366 if !($result_schema->{type
} eq 'array' && $result_schema->{items
}->{type
} eq 'object');
368 my $returnprops = $result_schema->{items
}->{properties
};
370 $props_to_print = extract_properties_to_print
($returnprops)
371 if !defined($props_to_print);
373 if (!scalar(@$props_to_print)) {
375 foreach my $obj (@$data) {
376 foreach my $key (keys %$obj) {
377 $all_props->{$key} = 1;
380 $props_to_print = [ sort keys %{$all_props} ];
383 die "unable to detect list properties\n" if !scalar(@$props_to_print);
385 print_text_table
($data, $returnprops, $props_to_print, $options, $terminal_opts);
388 my $guess_type = sub {
391 return 'null' if !defined($data);
393 my $class = ref($data);
394 return 'string' if !$class;
396 if ($class eq 'HASH') {
398 } elsif ($class eq 'ARRAY') {
401 return 'string'; # better than nothing
405 sub print_api_result
{
406 my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
408 return if $options->{quiet
};
410 $terminal_opts //= query_terminal_options
({});
412 my $format = $options->{'output-format'} // 'text';
414 if ($result_schema && defined($result_schema->{type
})) {
415 return if $result_schema->{type
} eq 'null';
417 my $type = $guess_type->($data);
418 $result_schema = { type
=> $type };
419 $result_schema->{items
} = { type
=> $guess_type->($data->[0]) } if $type eq 'array';
422 if ($format eq 'yaml') {
423 print encode
('UTF-8', CPAN
::Meta
::YAML
::Dump
($data));
424 } elsif ($format eq 'json') {
425 # Note: we always use utf8 encoding for json format
426 print to_json
($data, {utf8
=> 1, allow_nonref
=> 1, canonical
=> 1 }) . "\n";
427 } elsif ($format eq 'json-pretty') {
428 # Note: we always use utf8 encoding for json format
429 print to_json
($data, {utf8
=> 1, allow_nonref
=> 1, canonical
=> 1, pretty
=> 1 });
430 } elsif ($format eq 'text') {
431 my $encoding = $options->{encoding
} // 'UTF-8';
432 my $type = $result_schema->{type
};
433 if ($type eq 'object') {
434 $props_to_print = extract_properties_to_print
($result_schema->{properties
})
435 if !defined($props_to_print);
436 $props_to_print = [ sort keys %$data ] if !scalar(@$props_to_print);
438 foreach my $key (@$props_to_print) {
439 next if !defined($data->{$key});
440 push @$kvstore, { key
=> $key, value
=> data_to_text
($data->{$key}, $result_schema->{properties
}->{$key}, $options, $terminal_opts) };
442 my $schema = { type
=> 'array', items
=> { type
=> 'object' }};
443 print_api_list
($kvstore, $schema, ['key', 'value'], $options, $terminal_opts);
444 } elsif ($type eq 'array') {
445 return if !scalar(@$data);
446 my $item_type = $result_schema->{items
}->{type
};
447 if ($item_type eq 'object') {
448 print_api_list
($data, $result_schema, $props_to_print, $options, $terminal_opts);
451 foreach my $value (@$data) {
452 push @$kvstore, { value
=> $value };
454 my $schema = { type
=> 'array', items
=> { type
=> 'object', properties
=> { value
=> $result_schema->{items
} }}};
455 print_api_list
($kvstore, $schema, ['value'], { %$options, noheader
=> 1 }, $terminal_opts);
458 print encode
($encoding, "$data\n");
461 die "internal error: unknown output format"; # should not happen
465 sub print_api_result_plain
{
466 my ($data, $result_schema, $props_to_print, $options) = @_;
468 # avoid borders and header, ignore terminal width
469 $options = $options ?
{ %$options } : {}; # copy
471 $options->{noheader
} //= 1;
472 $options->{noborder
} //= 1;
474 print_api_result
($data, $result_schema, $props_to_print, $options, {});