cli: print_text_table: another fix for poperties without schema

[pve-common.git] / src / PVE / CLIHandler.pm

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index 078a42df6556a73e87415f226a59468abca5a76d..a0d5b0e4a1ca5bd02ec73c78bb825e52b8d9e0e8 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -442,35 +442,32 @@ sub data_to_text {
 }
 
 # prints a formatted table with a title row.
-# $formatopts is an array of hashes, with the following keys:
-# 'key' - key of $data element to print
-# 'title' - column title, defaults to 'key' - won't get cutoff
-# 'cutoff' - maximal (print) length of this column values, if set
-#            the last column will never be cutoff
-# 'default' - optional default value for the column
-# formatopts element order defines column order (left to right)
-# $sort_key is either a column name, or integer 1 which simply
-# sorts the output according to the leftmost column not containing
-# any undef. if not specified, we do not change order.
+# $data - the data to print (array of objects)
+# $returnprops -json schema property description
+# $props_to_print - ordered list of properties to print
+# $sort_key can be used to sort after a 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
 sub print_text_table {
-    my ($formatopts, $data, $sort_key) = @_;
+    my ($data, $returnprops, $props_to_print, $sort_key) = @_;
 
-    my ($formatstring, @keys, @titles, %cutoffs, %defaults);
-    my $last_col = $formatopts->[$#{$formatopts}];
-
-    my $autosort = 0;
-    if (defined($sort_key) && ($sort_key eq 1)) {
-       $autosort = 1;
+    my $autosort = 1;
+    if (defined($sort_key) && $sort_key eq 0) {
+       $autosort = 0;
        $sort_key = undef;
     }
 
-    foreach my $col ( @$formatopts ) {
-       my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
-       $title //= $key;
+    my $colopts = {};
+    my $formatstring = '';
+
+    my $column_count = scalar(@$props_to_print);
 
-       push @keys, $key;
-       push @titles, $title;
-       $defaults{$key} = $col->{default} // '';
+    for (my $i = 0; $i < $column_count; $i++) {
+       my $prop = $props_to_print->[$i];
+       my $propinfo = $returnprops->{$prop} // {};
+
+       my $title = $propinfo->{title} // $prop;
+       my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
 
        # calculate maximal print width and cutoff
        my $titlelen = length($title);
@@ -478,30 +475,39 @@ sub print_text_table {
        my $longest = $titlelen;
        my $sortable = $autosort;
        foreach my $entry (@$data) {
-           my $len = length(data_to_text($entry->{$key})) // 0;
+           my $len = length(data_to_text($entry->{$prop})) // 0;
            $longest = $len if $len > $longest;
-           $sortable = 0 if !defined($entry->{$key});
+           $sortable = 0 if !defined($entry->{$prop});
        }
+       $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
+       $sort_key //= $prop if $sortable;
 
-       $sort_key //= $key if $sortable;
-       $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
-       $cutoffs{$key} = $cutoff;
+       $colopts->{$prop} = {
+           title => $title,
+           default => $propinfo->{default} // '',
+           cutoff => $cutoff,
+       };
 
-       my $printalign = $cutoff > $titlelen ? '-' : '';
-       if ($col == $last_col) {
-           $formatstring .= "%${printalign}${titlelen}s\n";
-       } else {
-           $formatstring .= "%${printalign}${cutoff}s ";
-       }
+       # skip alignment and cutoff on last column
+       $formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
     }
 
-    printf $formatstring, @titles;
+    printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
 
-    if (defined($sort_key)){
-       @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+    if (defined($sort_key)) {
+       my $type = $returnprops->{$sort_key}->{type} // 'string';
+       if ($type eq 'integer' || $type eq 'number') {
+           @$data = sort { $a->{$sort_key} <=> $b->{$sort_key} } @$data;
+       } else {
+           @$data = sort { $a->{$sort_key} cmp $b->{$sort_key} } @$data;
+       }
     }
+
     foreach my $entry (@$data) {
-        printf $formatstring, map { substr((data_to_text($entry->{$_}) // $defaults{$_}), 0 , $cutoffs{$_}) } @keys;
+        printf $formatstring, map {
+           substr(data_to_text($entry->{$_}) // $colopts->{$_}->{default},
+                  0, $colopts->{$_}->{cutoff});
+       } @$props_to_print;
     }
 }
 
@@ -532,19 +538,7 @@ sub print_api_list {
        die "unable to detect list properties\n" if !scalar(@$props_to_print);
     }
 
-    my $formatopts = [];
-    foreach my $prop ( @$props_to_print ) {
-       my $propinfo = $returnprops->{$prop};
-       my $colopts = {
-           key => $prop,
-           title => $propinfo->{title},
-           default => $propinfo->{default},
-           cutoff => $propinfo->{print_width} // $propinfo->{maxLength},
-       };
-       push @$formatopts, $colopts;
-    }
-
-    print_text_table($formatopts, $data, $sort_key);
+    print_text_table($data, $returnprops, $props_to_print, $sort_key);
 }
 
 sub print_api_result {
@@ -557,14 +551,9 @@ sub print_api_result {
     } elsif ($format eq 'text') {
        my $type = $result_schema->{type};
        if ($type eq 'object') {
-           if (defined($props_to_print)) {
-               foreach my $key (@$props_to_print) {
-                   print $key . ": " .  data_to_text($data->{$key}) . "\n";
-               }
-           } else {
-               foreach my $key (sort keys %$data) {
-                   print $key . ": " .  data_to_text($data->{$key}) . "\n";
-               }
+           $props_to_print = [ sort keys %$data ] if !defined($props_to_print);
+           foreach my $key (@$props_to_print) {
+               print $key . ": " .  data_to_text($data->{$key}) . "\n";
            }
        } elsif ($type eq 'array') {
            return if !scalar(@$data);