cli: print_text_table: followup code cleanup
[pve-common.git] / src / PVE / CLIHandler.pm
index caa7ca6..b939a22 100644 (file)
@@ -2,10 +2,12 @@ package PVE::CLIHandler;
 
 use strict;
 use warnings;
+use JSON;
 
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::RESTHandler;
+use PVE::PTY;
 use PVE::INotify;
 
 use base qw(PVE::RESTHandler);
@@ -37,6 +39,34 @@ my $cmddef;
 my $exename;
 my $cli_handler_class;
 
+my $standard_mappings = {
+    'pve-password' => {
+       name => 'password',
+       desc => '<password>',
+       interactive => 1,
+       func => sub {
+           my ($value) = @_;
+           return $value if $value;
+           return PVE::PTY::get_confirmed_password();
+       },
+    },
+};
+sub get_standard_mapping {
+    my ($name, $base) = @_;
+
+    my $std = $standard_mappings->{$name};
+    die "no such standard mapping '$name'\n" if !$std;
+
+    my $res = $base || {};
+
+    foreach my $opt (keys %$std) {
+       next if defined($res->{$opt});
+       $res->{$opt} = $std->{$opt};
+    }
+
+    return $res;
+}
+
 my $assert_initialized = sub {
     my @caller = caller;
     die "$caller[0]:$caller[2] - not initialized\n"
@@ -52,11 +82,14 @@ my $abort = sub {
 my $expand_command_name = sub {
     my ($def, $cmd) = @_;
 
-    if (!$def->{$cmd}) {
-       my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
-       return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
-    }
-    return $cmd;
+    return $cmd if exists $def->{$cmd}; # command is already complete
+
+    my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias}) };
+    my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
+
+    return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
+
+    return undef;
 };
 
 my $get_commands = sub {
@@ -75,21 +108,30 @@ sub resolve_cmd {
     my ($argv, $is_alias) = @_;
 
     my ($def, $cmd) = ($cmddef, $argv);
+    my $cmdstr = $exename;
 
     if (ref($argv) eq 'ARRAY') {
-       my $expanded = {};
+       my $expanded_last_arg;
        my $last_arg_id = scalar(@$argv) - 1;
 
        for my $i (0..$last_arg_id) {
            $cmd = $expand_command_name->($def, $argv->[$i]);
-           $expanded->{$argv->[$i]} = $cmd if $cmd ne $argv->[$i];
-           last if !defined($def->{$cmd});
+           if (defined($cmd)) {
+               # If the argument was expanded (or was already complete) and it
+               # is the final argument, tell our caller about it:
+               $expanded_last_arg = $cmd if $i == $last_arg_id;
+           } else {
+               # Otherwise continue with the unexpanded version of it.
+               $cmd = $argv->[$i]; 
+           }
+           $cmdstr .= " $cmd";
            $def = $def->{$cmd};
+           last if !defined($def);
 
            if (ref($def) eq 'ARRAY') {
                # could expand to a real command, rest of $argv are its arguments
                my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
-               return ($cmd, $def, $cmd_args, $expanded);
+               return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
            }
 
            if (defined($def->{alias})) {
@@ -102,9 +144,9 @@ sub resolve_cmd {
        # got either a special command (bashcomplete, verifyapi) or an unknown
        # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
        my $cmd_args = [ @$argv[1..$last_arg_id] ];
-       return ($argv->[0], $def, $cmd_args, $expanded);
+       return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
     }
-    return ($cmd, $def);
+    return ($cmd, $def, undef, undef, $cmdstr);
 }
 
 sub generate_usage_str {
@@ -117,10 +159,12 @@ sub generate_usage_str {
     $separator //= '';
     $indent //= '';
 
-    my $can_read_pass = $cli_handler_class->can('read_password');
-    my $can_str_param_fmap = $cli_handler_class->can('string_param_file_mapping');
+    my $read_password_func = $cli_handler_class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+       $cli_handler_class->can('string_param_file_mapping');
 
-    my ($subcmd, $def) = resolve_cmd($cmd);
+    my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd);
+    $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
 
     my $generate;
     $generate = sub {
@@ -138,7 +182,7 @@ sub generate_usage_str {
                    $str .= $indent;
                    $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
                                              $fixed_param, $format,
-                                             $can_read_pass, $can_str_param_fmap);
+                                             $read_password_func, $param_mapping_func);
                    $oldclass = $class;
 
                } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
@@ -162,14 +206,11 @@ sub generate_usage_str {
 
            $str .= $indent;
            $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
-                                     $can_read_pass, $can_str_param_fmap);
+                                     $read_password_func, $param_mapping_func);
        }
        return $str;
     };
 
-    my $cmdstr = $exename;
-    $cmdstr .= ' ' . join(' ', @$cmd) if defined($cmd);
-
     return $generate->($indent, $separator, $def, $cmdstr);
 }
 
@@ -305,20 +346,21 @@ my $print_bash_completion = sub {
     shift @$args; # no need for program name
     my $print_result = sub {
        foreach my $p (@_) {
-           print "$p\n" if $p =~ m/^$cur/;
+           print "$p\n" if $p =~ m/^\Q$cur\E/;
        }
     };
 
     my ($cmd, $def) = ($simple_cmd, $cmddef);
     if (!$simple_cmd) {
-       ($cmd, $def, $args, my $expaned) = resolve_cmd($args);
+       ($cmd, $def, $args, my $expanded) = resolve_cmd($args);
 
-       if (ref($def) eq 'HASH') {
-           &$print_result(@{$get_commands->($def)});
+       if (defined($expanded) && $prev ne $expanded) {
+           print "$expanded\n";
            return;
        }
-       if (my $expanded_cmd = $expaned->{$cur}) {
-           print "$expanded_cmd\n";
+
+       if (ref($def) eq 'HASH') {
+           &$print_result(@{$get_commands->($def)});
            return;
        }
     }
@@ -361,7 +403,6 @@ my $print_bash_completion = sub {
     };
 
     # positional arguments
-    $pos++ if $simple_cmd;
     if ($pos < scalar(@$arg_param)) {
        my $pname = $arg_param->[$pos];
        &$print_parameter_completion($pname);
@@ -388,6 +429,151 @@ my $print_bash_completion = sub {
     &$print_result(@option_list);
 };
 
+sub data_to_text {
+    my ($data) = @_;
+
+    return '' if !defined($data);
+
+    if (my $class = ref($data)) {
+       return to_json($data, { utf8 => 1, canonical => 1 });
+    } else {
+       return "$data";
+    }
+}
+
+# prints a formatted table with a title row.
+# $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 ($data, $returnprops, $props_to_print, $sort_key) = @_;
+
+    my $autosort = 1;
+    if (defined($sort_key) && $sort_key eq 0) {
+       $autosort = 0;
+       $sort_key = undef;
+    }
+
+    my $colopts = {};
+    my $formatstring = '';
+
+    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;
+
+       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 = $autosort;
+       foreach my $entry (@$data) {
+           my $len = length(data_to_text($entry->{$prop})) // 0;
+           $longest = $len if $len > $longest;
+           $sortable = 0 if !defined($entry->{$prop});
+       }
+       $cutoff = $longest if !defined($cutoff) || $cutoff > $longest;
+       $sort_key //= $prop if $sortable;
+
+       $colopts->{$prop} = {
+           title => $title,
+           default => $propinfo->{default} // '',
+           cutoff => $cutoff,
+       };
+
+       # skip alignment and cutoff on last column
+       $formatstring .= ($i == ($column_count - 1)) ? "%s\n" : "%-${cutoff}s ";
+    }
+
+    printf $formatstring, map { $colopts->{$_}->{title} } @$props_to_print;
+
+    if (defined($sort_key)) {
+       my $type = $returnprops->{$sort_key}->{type};
+       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->{$_}) // $colopts->{$_}->{default},
+                  0, $colopts->{$_}->{cutoff});
+       } @$props_to_print;
+    }
+}
+
+# prints the result of an API GET call returning an array as a table.
+# 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.
+sub print_api_list {
+    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');
+
+    my $returnprops = $result_schema->{items}->{properties};
+
+    if (!defined($props_to_print)) {
+       $props_to_print = [ sort keys %$returnprops ];
+       if (!scalar(@$props_to_print)) {
+           my $all_props = {};
+           foreach my $obj (@{$data}) {
+               foreach my $key (keys %{$obj}) {
+                   $all_props->{ $key } = 1;
+               }
+           }
+           $props_to_print = [ sort keys %{$all_props} ];
+       }
+       die "unable to detect list properties\n" if !scalar(@$props_to_print);
+    }
+
+    print_text_table($data, $returnprops, $props_to_print, $sort_key);
+}
+
+sub print_api_result {
+    my ($format, $data, $result_schema, $props_to_print, $sort_key) = @_;
+
+    return if $result_schema->{type} eq 'null';
+
+    if ($format eq 'json') {
+       print to_json($data, {utf8 => 1, allow_nonref => 1, canonical => 1, pretty => 1 });
+    } elsif ($format eq 'text') {
+       my $type = $result_schema->{type};
+       if ($type eq 'object') {
+           $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);
+           my $item_type = $result_schema->{items}->{type};
+           if ($item_type eq 'object') {
+               print_api_list($data, $result_schema, $props_to_print, $sort_key);
+           } else {
+               foreach my $entry (@$data) {
+                   print data_to_text($entry) . "\n";
+               }
+           }
+       } else {
+           print "$data\n";
+       }
+    } else {
+       die "internal error: unknown output format"; # should not happen
+    }
+}
+
 sub verify_api {
     my ($class) = @_;
 
@@ -457,12 +643,11 @@ sub setup_environment {
 }
 
 my $handle_cmd  = sub {
-    my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
 
-    my $cmd_str = join(' ', @$args);
-    my ($cmd, $def, $cmd_args) = resolve_cmd($args);
+    my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
 
     $abort->("no command specified") if !$cmd;
 
@@ -481,21 +666,23 @@ my $handle_cmd  = sub {
     }
 
     # checked special commands, if def is still a hash we got an incomplete sub command
-    $abort->("incomplete command '$exename $cmd_str'") if ref($def) eq 'HASH';
+    $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
 
     &$preparefunc() if $preparefunc;
 
-    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
+    my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
     $abort->("unknown command '$cmd_str'") if !$class;
 
-    my $prefix = "$exename $cmd_str";
-    my $res = $class->cli_handler($prefix, $name, $cmd_args, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+    my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
-    &$outsub($res) if $outsub;
+    if (defined $outsub) {
+       my $result_schema = $class->map_method_by_name($name)->{returns};
+       $outsub->($res, $result_schema);
+    }
 };
 
 my $handle_simple_cmd = sub {
-    my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+    my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
 
     my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
     die "no class specified" if !$class;
@@ -524,9 +711,12 @@ my $handle_simple_cmd = sub {
 
     &$preparefunc() if $preparefunc;
 
-    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
+    my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
 
-    &$outsub($res) if $outsub;
+    if (defined $outsub) {
+       my $result_schema = $class->map_method_by_name($name)->{returns};
+       $outsub->($res, $result_schema);
+    }
 };
 
 sub run_cli_handler {
@@ -545,8 +735,9 @@ sub run_cli_handler {
 
     my $preparefunc = $params{prepare};
 
-    my $pwcallback = $class->can('read_password');
-    my $stringfilemap = $class->can('string_param_file_mapping');
+    my $read_password_func = $class->can('read_password');
+    my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
+       $class->can('string_param_file_mapping');
 
     $exename = &$get_exe_name($class);
 
@@ -556,9 +747,9 @@ sub run_cli_handler {
     $cmddef = ${"${class}::cmddef"};
 
     if (ref($cmddef) eq 'ARRAY') {
-       &$handle_simple_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+       &$handle_simple_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     } else {
-       &$handle_cmd(\@ARGV, $pwcallback, $preparefunc, $stringfilemap);
+       &$handle_cmd(\@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
     }
 
     exit 0;