X-Git-Url: https://git.proxmox.com/?p=pve-client.git;a=blobdiff_plain;f=PVE%2FAPIClient%2FCLIFormatter.pm;h=1e77e73a4c0adf1d3eb6b7af52c3eee40d1a70c9;hp=57e0c8912ed04a005afd9b7d3ffadbe434e40ed9;hb=74ad9c37644bcf79d0687e8a36ff37ec29c10206;hpb=d012b98c9b47085b2ee52499f4dd0872ecffe486

diff --git a/PVE/APIClient/CLIFormatter.pm b/PVE/APIClient/CLIFormatter.pm
index 57e0c89..1e77e73 100644
--- a/PVE/APIClient/CLIFormatter.pm
+++ b/PVE/APIClient/CLIFormatter.pm
@@ -3,6 +3,8 @@ package PVE::APIClient::CLIFormatter;
 use strict;
 use warnings;
 use I18N::Langinfo;
+use POSIX qw(strftime);
+use CPAN::Meta::YAML; # comes with perl-modules
 
 use PVE::APIClient::JSONSchema;
 use PVE::APIClient::PTY;
@@ -10,6 +12,24 @@ use JSON;
 use utf8;
 use Encode;
 
+sub render_timestamp {
+    my ($epoch) = @_;
+
+    # ISO 8601 date format
+    return strftime("%F %H:%M:%S", localtime($epoch));
+}
+
+PVE::APIClient::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::APIClient::JSONSchema::register_renderer('timestamp_gmt', \&render_timestamp_gmt);
+
 sub render_duration {
     my ($duration_in_seconds) = @_;
 
@@ -56,12 +76,23 @@ sub render_bytes {
         $max_unit = int(log($value)/log(1024));
         $value /= 1024**($max_unit);
     }
-
-    return sprintf "%.2f $units[$max_unit]", $value;
+    my $unit = $units[$max_unit];
+    return sprintf "%.2f $unit", $value;
 }
 
 PVE::APIClient::JSONSchema::register_renderer('bytes', \&render_bytes);
 
+sub render_yaml {
+    my ($value) = @_;
+
+    my $data = CPAN::Meta::YAML::Dump($value);
+    $data =~ s/^---[\n\s]//; # remove yaml marker
+
+    return $data;
+}
+
+PVE::APIClient::JSONSchema::register_renderer('yaml', \&render_yaml);
+
 sub query_terminal_options {
     my ($options) = @_;
 
@@ -79,11 +110,15 @@ sub query_terminal_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;
@@ -95,12 +130,13 @@ sub data_to_text {
 	if (defined(my $renderer = $propdef->{renderer})) {
 	    my $code = PVE::APIClient::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";
     }
@@ -111,27 +147,30 @@ sub data_to_text {
 # $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
+# - sort_key: can be used to sort after a specific 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
+# - 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 $border = !$options->{noborder};
+    my $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';
 
-    if (defined($sort_key)) {
+    $sort_key //= $props_to_print->[0];
+
+    if (defined($sort_key) && $sort_key ne 0) {
 	my $type = $returnprops->{$sort_key}->{type} // 'string';
 	if ($type eq 'integer' || $type eq 'number') {
 	    @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
@@ -160,7 +199,7 @@ sub print_text_table {
 	    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;
@@ -171,6 +210,8 @@ sub print_text_table {
 		$width = $len if $len > $width;
 	    }
 
+	    $width = ($width =~ m/^(\d+)$/) ? int($1) : 0; # untaint int
+
 	    $rowdata->{$prop} = {
 		lines => $lines,
 		width => $width,
@@ -186,6 +227,8 @@ sub print_text_table {
     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};
@@ -208,48 +251,48 @@ sub print_text_table {
 	if ($border) {
 	    if ($i == 0 && ($column_count == 1)) {
 		if ($utf8) {
-		    $formatstring .= "│ %-${cutoff}s │";
+		    $formatstring .= "│ %$alignstr${cutoff}s │";
 		    $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
 		    $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
 		    $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
 		} else {
-		    $formatstring .= "| %-${cutoff}s |";
+		    $formatstring .= "| %$alignstr${cutoff}s |";
 		    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
 		}
 	    } elsif ($i == 0) {
 		if ($utf8) {
-		    $formatstring .= "│ %-${cutoff}s ";
+		    $formatstring .= "│ %$alignstr${cutoff}s ";
 		    $borderstring_t .= "┌─" . ('─' x $cutoff) . '─';
 		    $borderstring_m .= "├─" . ('─' x $cutoff) . '─';
 		    $borderstring_b .= "└─" . ('─' x $cutoff) . '─';
 		} else {
-		    $formatstring .= "| %-${cutoff}s ";
+		    $formatstring .= "| %$alignstr${cutoff}s ";
 		    $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
 		}
 	    } elsif ($i == ($column_count - 1)) {
 		if ($utf8) {
-		    $formatstring .= "│ %-${cutoff}s │";
+		    $formatstring .= "│ %$alignstr${cutoff}s │";
 		    $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
 		    $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
 		    $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
 		} else {
-		    $formatstring .= "| %-${cutoff}s |";
+		    $formatstring .= "| %$alignstr${cutoff}s |";
 		    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
 		}
 	    } else {
 		if ($utf8) {
-		    $formatstring .= "│ %-${cutoff}s ";
+		    $formatstring .= "│ %$alignstr${cutoff}s ";
 		    $borderstring_t .= "┬─" . ('─' x $cutoff) . '─';
 		    $borderstring_m .= "┼─" . ('─' x $cutoff) . '─';
 		    $borderstring_b .= "┴─" . ('─' x $cutoff) . '─';
 		} else {
-		    $formatstring .= "| %-${cutoff}s ";
+		    $formatstring .= "| %$alignstr${cutoff}s ";
 		    $borderstring_m .= "+-" . ('-' 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 ";
 	}
     }
 
@@ -267,15 +310,20 @@ sub print_text_table {
     };
 
     $writeln->($borderstring_t) if $border;
-    my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
-    $writeln->($text);
 
-    foreach my $coldata (@$tabledata) {
-	$writeln->($borderstring_m) if $border;
+    if ($header) {
+	my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+	$writeln->($text);
+    }
+
+    for (my $i = 0; $i < scalar(@$tabledata); $i++) {
+	my $coldata = $tabledata->[$i];
+
+	$writeln->($borderstring_m) if $border && ($i != 0 || $header);
 
 	for (my $i = 0; $i < $coldata->{height}; $i++) {
 
-	    $text = sprintf $formatstring, map {
+	    my $text = sprintf $formatstring, map {
 		substr($coldata->{rowdata}->{$_}->{lines}->[$i] // '', 0, $colopts->{$_}->{cutoff});
 	    } @$props_to_print;
 
@@ -310,7 +358,7 @@ sub extract_properties_to_print {
 # takes all fields of the results property, with a fallback
 # to all fields occuring 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');
@@ -332,24 +380,52 @@ sub print_api_list {
 
     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 $options->{quiet};
+
+    $terminal_opts //= query_terminal_options({});
 
-    return if $result_schema->{type} eq 'null';
+    my $format = $options->{'output-format'} // 'text';
 
-    if ($format eq 'json') {
+    if ($result_schema && defined($result_schema->{type})) {
+	return if $result_schema->{type} eq 'null';
+    } 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', CPAN::Meta::YAML::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') {
@@ -358,21 +434,23 @@ sub print_api_result {
 	    $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);
 	    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");
@@ -382,4 +460,16 @@ sub print_api_result {
     }
 }
 
+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;