PVE::CLIHandler::print_text_table - cleanup, directly use json schema data

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

diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm
index dfdc41c158a352360618b8fb173a904735430a88..3013cc213dd2069365a67391c1b2a5f3b9a2c5cc 100644 (file)
--- a/src/PVE/CLIHandler.pm
+++ b/src/PVE/CLIHandler.pm
@@ -442,58 +442,72 @@ 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)
-# sorts the output according to the leftmost column not containing any undef
+# $data - the data to print (array of objects)
+# $returnprops -json schema property description
+# $props_to_print - ordered list of properties to print
+# $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.
 sub print_text_table {
-    my ($formatopts, $data) = @_;
+    my ($data, $returnprops, $props_to_print, $sort_key) = @_;
 
-    my ($formatstring, @keys, @titles, %cutoffs, %defaults, $sort_key);
-    my $last_col = $formatopts->[$#{$formatopts}];
+    my $autosort = 0;
+    if (defined($sort_key) && ($sort_key eq 1)) {
+       $autosort = 1;
+       $sort_key = undef;
+    }
+
+    my $colopts = {};
+    my $formatstring = '';
 
-    foreach my $col ( @$formatopts ) {
-       my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
-       $title //= $key;
+    my $column_count = scalar(@$props_to_print);
+
+    for (my $i = 0; $i < $column_count; $i++) {
+       my $prop = $props_to_print->[$i];
+       my $propinfo = $returnprops->{$prop};
+       die "undefined property '$prop'" if !$propinfo;
 
-       push @keys, $key;
-       push @titles, $title;
-       $defaults{$key} = $col->{default} // '';
+       my $title = $propinfo->{title} // $prop;
+       my $cutoff = $propinfo->{print_width} // $propinfo->{maxLength};
 
        # calculate maximal print width and cutoff
        my $titlelen = length($title);
 
        my $longest = $titlelen;
-       my $sortable = 1;
+       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});
        }
-
-       $sort_key //= $key if $sortable;
        $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
-       $cutoffs{$key} = $cutoff;
+       $sort_key //= $prop if $sortable;
 
-       my $printalign = $cutoff > $titlelen ? '-' : '';
-       if ($col == $last_col) {
-           $formatstring .= "%${printalign}${titlelen}s\n";
-       } else {
-           $formatstring .= "%${printalign}${cutoff}s ";
-       }
+       $colopts->{$prop} = {
+           title => $title,
+           default => $propinfo->{default} // '',
+           cutoff => $cutoff,
+       };
+
+       $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)) {
+       if ($returnprops->{$sort_key}->{type} eq 'integer' ||
+           $returnprops->{$sort_key}->{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;
     }
 }
 
@@ -503,7 +517,7 @@ sub print_text_table {
 # 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) = @_;
+    my ($data, $result_schema, $props_to_print, $sort_key) = @_;
 
     die "can only print object lists\n"
        if !($result_schema->{type} eq 'array' && $result_schema->{items}->{type} eq 'object');
@@ -524,23 +538,11 @@ 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);
+    print_text_table($data, $returnprops, $props_to_print, $sort_key);
 }
 
 sub print_api_result {
-    my ($format, $data, $result_schema, $props_to_print) = @_;
+    my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
 
     return if $result_schema->{type} eq 'null';
 
@@ -562,7 +564,7 @@ sub print_api_result {
            return if !scalar(@$data);
            my $item_type = $result_schema->{items}->{type};
            if ($item_type eq 'object') {
-               print_api_list($data, $result_schema, $props_to_print);
+               print_api_list($data, $result_schema, $props_to_print, $sort_key);
            } else {
                foreach my $entry (@$data) {
                    print data_to_text($entry) . "\n";