]> git.proxmox.com Git - pve-common.git/blobdiff - src/PVE/CLIFormatter.pm
print_text_table: handle undefined values in comparision
[pve-common.git] / src / PVE / CLIFormatter.pm
index 411da5ddd3cce6989b407aacd3e4cab954710564..4f18fa9e58d4f85d23a6b2637779f01652aa5772 100644 (file)
@@ -2,12 +2,14 @@ package PVE::CLIFormatter;
 
 use strict;
 use warnings;
+
 use I18N::Langinfo;
 use POSIX qw(strftime);
 use CPAN::Meta::YAML; # comes with perl-modules
 
 use PVE::JSONSchema;
 use PVE::PTY;
+
 use JSON;
 use utf8;
 use Encode;
@@ -76,8 +78,8 @@ 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::JSONSchema::register_renderer('bytes', \&render_bytes);
@@ -148,8 +150,7 @@ sub data_to_text {
 # $props_to_print - ordered list of properties to print
 # $options
 # - 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
+#   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)
@@ -172,11 +173,15 @@ sub print_text_table {
 
     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 = {};
@@ -184,6 +189,7 @@ sub print_text_table {
     my $borderstring_m = '';
     my $borderstring_b = '';
     my $borderstring_t = '';
+    my $borderstring_h = '';
     my $formatstring = '';
 
     my $column_count = scalar(@$props_to_print);
@@ -253,41 +259,49 @@ sub print_text_table {
                if ($utf8) {
                    $formatstring .= "│ %$alignstr${cutoff}s │";
                    $borderstring_t .= "┌─" . ('─' x $cutoff) . "─┐";
+                   $borderstring_h .= "╞═" . ('═' x $cutoff) . '═╡';
                    $borderstring_m .= "├─" . ('─' x $cutoff) . "─┤";
                    $borderstring_b .= "└─" . ('─' x $cutoff) . "─┘";
                } else {
                    $formatstring .= "| %$alignstr${cutoff}s |";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
+                   $borderstring_h .= "+=" . ('=' x $cutoff) . '=';
                }
            } elsif ($i == 0) {
                if ($utf8) {
                    $formatstring .= "│ %$alignstr${cutoff}s ";
                    $borderstring_t .= "┌─" . ('─' x $cutoff) . '─';
+                   $borderstring_h .= "╞═" . ('═' x $cutoff) . '═';
                    $borderstring_m .= "├─" . ('─' x $cutoff) . '─';
                    $borderstring_b .= "└─" . ('─' x $cutoff) . '─';
                } else {
                    $formatstring .= "| %$alignstr${cutoff}s ";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+                   $borderstring_h .= "+=" . ('=' x $cutoff) . '=';
                }
            } elsif ($i == ($column_count - 1)) {
                if ($utf8) {
                    $formatstring .= "│ %$alignstr${cutoff}s │";
                    $borderstring_t .= "┬─" . ('─' x $cutoff) . "─┐";
+                   $borderstring_h .= "╪═" . ('═' x $cutoff) . '═╡';
                    $borderstring_m .= "┼─" . ('─' x $cutoff) . "─┤";
                    $borderstring_b .= "┴─" . ('─' x $cutoff) . "─┘";
                } else {
                    $formatstring .= "| %$alignstr${cutoff}s |";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . "-+";
+                   $borderstring_h .= "+=" . ('=' x $cutoff) . "=+";
                }
            } else {
                if ($utf8) {
                    $formatstring .= "│ %$alignstr${cutoff}s ";
                    $borderstring_t .= "┬─" . ('─' x $cutoff) . '─';
+                   $borderstring_h .= "╪═" . ('═' x $cutoff) . '═';
                    $borderstring_m .= "┼─" . ('─' x $cutoff) . '─';
                    $borderstring_b .= "┴─" . ('─' x $cutoff) . '─';
                } else {
                    $formatstring .= "| %$alignstr${cutoff}s ";
                    $borderstring_m .= "+-" . ('-' x $cutoff) . '-';
+                   $borderstring_h .= "+=" . ('=' x $cutoff) . '=';
                }
            }
        } else {
@@ -311,15 +325,22 @@ sub print_text_table {
 
     $writeln->($borderstring_t) if $border;
 
+    my $borderstring_sep;
     if ($header) {
        my $text = sprintf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
        $writeln->($text);
+       $borderstring_sep = $borderstring_h;
+    } else {
+       $borderstring_sep = $borderstring_m;
     }
 
     for (my $i = 0; $i < scalar(@$tabledata); $i++) {
        my $coldata = $tabledata->[$i];
 
-       $writeln->($borderstring_m) if $border && ($i != 0 || $header);
+       if ($border && ($i != 0 || $header)) {
+           $writeln->($borderstring_sep);
+           $borderstring_sep = $borderstring_m;
+       }
 
        for (my $i = 0; $i < $coldata->{height}; $i++) {
 
@@ -356,7 +377,7 @@ 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, $terminal_opts) = @_;
 
@@ -409,8 +430,9 @@ sub print_api_result {
 
     my $format = $options->{'output-format'} // 'text';
 
-    if (!$result_schema) {
+    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 };