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 $borderstring_h = '';
190 my $formatstring = '';
192 my $column_count = scalar(@$props_to_print);
196 foreach my $entry (@$data) {
201 for (my $i = 0; $i < $column_count; $i++) {
202 my $prop = $props_to_print->[$i];
203 my $propinfo = $returnprops->{$prop} // {};
205 my $text = data_to_text
($entry->{$prop}, $propinfo, $options, $terminal_opts);
206 my $lines = [ split(/\n/, $text) ];
207 my $linecount = scalar(@$lines);
208 $height = $linecount if $linecount > $height;
211 foreach my $line (@$lines) {
212 my $len = length($line);
213 $width = $len if $len > $width;
216 $width = ($width =~ m/^(\d+)$/) ?
int($1) : 0; # untaint int
218 $rowdata->{$prop} = {
230 for (my $i = 0; $i < $column_count; $i++) {
231 my $prop = $props_to_print->[$i];
232 my $propinfo = $returnprops->{$prop} // {};
233 my $type = $propinfo->{type
} // 'string';
234 my $alignstr = ($type eq 'integer' || $type eq 'number') ?
'' : '-';
236 my $title = $propinfo->{title
} // $prop;
237 my $cutoff = $propinfo->{print_width
} // $propinfo->{maxLength
};
239 # calculate maximal print width and cutoff
240 my $titlelen = length($title);
242 my $longest = $titlelen;
243 foreach my $coldata (@$tabledata) {
244 my $rowdata = $coldata->{rowdata
}->{$prop};
245 $longest = $rowdata->{width
} if $rowdata->{width
} > $longest;
247 $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
249 $colopts->{$prop} = {
255 if ($i == 0 && ($column_count == 1)) {
257 $formatstring .= "│ %$alignstr${cutoff}s │";
258 $borderstring_t .= "┌─" . ('─' x
$cutoff) . "─┐";
259 $borderstring_h .= "╞═" . ('═' x
$cutoff) . '═╡';
260 $borderstring_m .= "├─" . ('─' x
$cutoff) . "─┤";
261 $borderstring_b .= "└─" . ('─' x
$cutoff) . "─┘";
263 $formatstring .= "| %$alignstr${cutoff}s |";
264 $borderstring_m .= "+-" . ('-' x
$cutoff) . "-+";
265 $borderstring_h .= "+=" . ('=' x
$cutoff) . '=';
269 $formatstring .= "│ %$alignstr${cutoff}s ";
270 $borderstring_t .= "┌─" . ('─' x
$cutoff) . '─';
271 $borderstring_h .= "╞═" . ('═' x
$cutoff) . '═';
272 $borderstring_m .= "├─" . ('─' x
$cutoff) . '─';
273 $borderstring_b .= "└─" . ('─' x
$cutoff) . '─';
275 $formatstring .= "| %$alignstr${cutoff}s ";
276 $borderstring_m .= "+-" . ('-' x
$cutoff) . '-';
277 $borderstring_h .= "+=" . ('=' x
$cutoff) . '=';
279 } elsif ($i == ($column_count - 1)) {
281 $formatstring .= "│ %$alignstr${cutoff}s │";
282 $borderstring_t .= "┬─" . ('─' x
$cutoff) . "─┐";
283 $borderstring_h .= "╪═" . ('═' x
$cutoff) . '═╡';
284 $borderstring_m .= "┼─" . ('─' x
$cutoff) . "─┤";
285 $borderstring_b .= "┴─" . ('─' x
$cutoff) . "─┘";
287 $formatstring .= "| %$alignstr${cutoff}s |";
288 $borderstring_m .= "+-" . ('-' x
$cutoff) . "-+";
289 $borderstring_h .= "+=" . ('=' x
$cutoff) . "=+";
293 $formatstring .= "│ %$alignstr${cutoff}s ";
294 $borderstring_t .= "┬─" . ('─' x
$cutoff) . '─';
295 $borderstring_h .= "╪═" . ('═' x
$cutoff) . '═';
296 $borderstring_m .= "┼─" . ('─' x
$cutoff) . '─';
297 $borderstring_b .= "┴─" . ('─' x
$cutoff) . '─';
299 $formatstring .= "| %$alignstr${cutoff}s ";
300 $borderstring_m .= "+-" . ('-' x
$cutoff) . '-';
301 $borderstring_h .= "+=" . ('=' x
$cutoff) . '=';
305 # skip alignment and cutoff on last column
306 $formatstring .= ($i == ($column_count - 1)) ?
"%s" : "%$alignstr${cutoff}s ";
310 $borderstring_t = $borderstring_m if !length($borderstring_t);
311 $borderstring_b = $borderstring_m if !length($borderstring_b);
317 print encode
($encoding, substr($text, 0, $columns) . "\n");
319 print encode
($encoding, $text) . "\n";
323 $writeln->($borderstring_t) if $border;
325 my $borderstring_sep;
327 my $text = sprintf $formatstring, map { $colopts->{$_}->{title
} } @$props_to_print;
329 $borderstring_sep = $borderstring_h;
331 $borderstring_sep = $borderstring_m;
334 for (my $i = 0; $i < scalar(@$tabledata); $i++) {
335 my $coldata = $tabledata->[$i];
337 if ($border && ($i != 0 || $header)) {
338 $writeln->($borderstring_sep);
339 $borderstring_sep = $borderstring_m;
342 for (my $i = 0; $i < $coldata->{height
}; $i++) {
344 my $text = sprintf $formatstring, map {
345 substr($coldata->{rowdata
}->{$_}->{lines
}->[$i] // '', 0, $colopts->{$_}->{cutoff
});
352 $writeln->($borderstring_b) if $border;
355 sub extract_properties_to_print
{
361 foreach my $key (keys %$propdef) {
362 my $prop = $propdef->{$key};
363 if ($prop->{optional
}) {
364 push @$optional, $key;
366 push @$required, $key;
370 return [ sort(@$required), sort(@$optional) ];
373 # prints the result of an API GET call returning an array as a table.
374 # takes formatting information from the results property of the call
375 # if $props_to_print is provided, prints only those columns. otherwise
376 # takes all fields of the results property, with a fallback
377 # to all fields occurring in items of $data.
379 my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
381 die "can only print object lists\n"
382 if !($result_schema->{type
} eq 'array' && $result_schema->{items
}->{type
} eq 'object');
384 my $returnprops = $result_schema->{items
}->{properties
};
386 $props_to_print = extract_properties_to_print
($returnprops)
387 if !defined($props_to_print);
389 if (!scalar(@$props_to_print)) {
391 foreach my $obj (@$data) {
392 foreach my $key (keys %$obj) {
393 $all_props->{$key} = 1;
396 $props_to_print = [ sort keys %{$all_props} ];
399 die "unable to detect list properties\n" if !scalar(@$props_to_print);
401 print_text_table
($data, $returnprops, $props_to_print, $options, $terminal_opts);
404 my $guess_type = sub {
407 return 'null' if !defined($data);
409 my $class = ref($data);
410 return 'string' if !$class;
412 if ($class eq 'HASH') {
414 } elsif ($class eq 'ARRAY') {
417 return 'string'; # better than nothing
421 sub print_api_result
{
422 my ($data, $result_schema, $props_to_print, $options, $terminal_opts) = @_;
424 return if $options->{quiet
};
426 $terminal_opts //= query_terminal_options
({});
428 my $format = $options->{'output-format'} // 'text';
430 if ($result_schema && defined($result_schema->{type
})) {
431 return if $result_schema->{type
} eq 'null';
432 return if $result_schema->{optional
} && !defined($data);
434 my $type = $guess_type->($data);
435 $result_schema = { type
=> $type };
436 $result_schema->{items
} = { type
=> $guess_type->($data->[0]) } if $type eq 'array';
439 if ($format eq 'yaml') {
440 print encode
('UTF-8', CPAN
::Meta
::YAML
::Dump
($data));
441 } elsif ($format eq 'json') {
442 # Note: we always use utf8 encoding for json format
443 print to_json
($data, {utf8
=> 1, allow_nonref
=> 1, canonical
=> 1 }) . "\n";
444 } elsif ($format eq 'json-pretty') {
445 # Note: we always use utf8 encoding for json format
446 print to_json
($data, {utf8
=> 1, allow_nonref
=> 1, canonical
=> 1, pretty
=> 1 });
447 } elsif ($format eq 'text') {
448 my $encoding = $options->{encoding
} // 'UTF-8';
449 my $type = $result_schema->{type
};
450 if ($type eq 'object') {
451 $props_to_print = extract_properties_to_print
($result_schema->{properties
})
452 if !defined($props_to_print);
453 $props_to_print = [ sort keys %$data ] if !scalar(@$props_to_print);
455 foreach my $key (@$props_to_print) {
456 next if !defined($data->{$key});
457 push @$kvstore, { key
=> $key, value
=> data_to_text
($data->{$key}, $result_schema->{properties
}->{$key}, $options, $terminal_opts) };
459 my $schema = { type
=> 'array', items
=> { type
=> 'object' }};
460 print_api_list
($kvstore, $schema, ['key', 'value'], $options, $terminal_opts);
461 } elsif ($type eq 'array') {
462 return if !scalar(@$data);
463 my $item_type = $result_schema->{items
}->{type
};
464 if ($item_type eq 'object') {
465 print_api_list
($data, $result_schema, $props_to_print, $options, $terminal_opts);
468 foreach my $value (@$data) {
469 push @$kvstore, { value
=> $value };
471 my $schema = { type
=> 'array', items
=> { type
=> 'object', properties
=> { value
=> $result_schema->{items
} }}};
472 print_api_list
($kvstore, $schema, ['value'], { %$options, noheader
=> 1 }, $terminal_opts);
475 print encode
($encoding, "$data\n");
478 die "internal error: unknown output format"; # should not happen
482 sub print_api_result_plain
{
483 my ($data, $result_schema, $props_to_print, $options) = @_;
485 # avoid borders and header, ignore terminal width
486 $options = $options ?
{ %$options } : {}; # copy
488 $options->{noheader
} //= 1;
489 $options->{noborder
} //= 1;
491 print_api_result
($data, $result_schema, $props_to_print, $options, {});