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);
+# $cmddef defines which (sub)commands are available in a specific CLI class.
+# A real command is always an array consisting of its class, name, array of
+# position fixed (required) parameters and hash of predefined parameters when
+# mapping a CLI command t o an API call. Optionally an output method can be
+# passed at the end, e.g., for formatting or transformation purpose.
+#
+# [class, name, fixed_params, API_pre-set params, output_sub ]
+#
+# In case of so called 'simple commands', the $cmddef can be also just an
+# array.
+#
+# Examples:
+# $cmddef = {
+# command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
+# do => {
+# this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
+# my ($res) = @_;
+# print "$res\n";
+# }],
+# that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
+# },
+# dothat => { alias => 'do that' },
+# }
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"
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 $complete_command_names = sub {
- return [ sort keys %$cmddef ];
+my $get_commands = sub {
+ my $def = shift // die "no command definition passed!";
+ return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ];
};
+my $complete_command_names = sub { $get_commands->($cmddef) };
+
+# traverses the command definition using the $argv array, resolving one level
+# of aliases.
+# Returns the matching (sub) command and its definition, and argument array for
+# this (sub) command and a hash where we marked which (sub) commands got
+# expanded (e.g. st => status) while traversing
+sub resolve_cmd {
+ my ($argv, $is_alias) = @_;
+
+ my ($def, $cmd) = ($cmddef, $argv);
+ my $cmdstr = $exename;
+
+ if (ref($argv) eq 'ARRAY') {
+ 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]);
+ 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_last_arg, $cmdstr);
+ }
+
+ if (defined($def->{alias})) {
+ die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
+ # replace aliased (sub)command with the expanded aliased command
+ splice @$argv, $i, 1, split(/ +/, $def->{alias});
+ return resolve_cmd($argv, 1);
+ }
+ }
+ # 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_last_arg, $cmdstr);
+ }
+ return ($cmd, $def, undef, undef, $cmdstr);
+}
+
+sub generate_usage_str {
+ my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
+
+ $assert_initialized->();
+ die 'format required' if !$format;
+
+ $sortfunc //= sub { sort keys %{$_[0]} };
+ $separator //= '';
+ $indent //= '';
+
+ 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, undef, undef, $cmdstr) = resolve_cmd($cmd);
+ $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
+
+ my $generate;
+ $generate = sub {
+ my ($indent, $separator, $def, $prefix) = @_;
+
+ my $str = '';
+ if (ref($def) eq 'HASH') {
+ my $oldclass = undef;
+ foreach my $cmd (&$sortfunc($def)) {
+
+ if (ref($def->{$cmd}) eq 'ARRAY') {
+ my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
+
+ $str .= $separator if $oldclass && $oldclass ne $class;
+ $str .= $indent;
+ $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
+ $fixed_param, $format,
+ $read_password_func, $param_mapping_func);
+ $oldclass = $class;
+
+ } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
+
+ $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
+
+ } else {
+ next if $def->{$cmd}->{alias};
+
+ my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd");
+ if ($substr) {
+ $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
+ $str .= $substr;
+ }
+ }
+
+ }
+ } else {
+ my ($class, $name, $arg_param, $fixed_param) = @$def;
+ $abort->("unknown command '$cmd'") if !$class;
+
+ $str .= $indent;
+ $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
+ $read_password_func, $param_mapping_func);
+ }
+ return $str;
+ };
+
+ return $generate->($indent, $separator, $def, $cmdstr);
+}
+
__PACKAGE__->register_method ({
name => 'help',
path => 'help',
parameters => {
additionalProperties => 0,
properties => {
- cmd => {
- description => "Command name",
- type => 'string',
- optional => 1,
+ 'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', {
+ description => 'Shows help for a specific command',
completion => $complete_command_names,
- },
+ }),
verbose => {
description => "Verbose output format.",
type => 'boolean',
$assert_initialized->();
- my $cmd = $param->{cmd};
+ my $cmd = $param->{'extra-args'};
- my $verbose = defined($cmd) && $cmd;
+ my $verbose = defined($cmd) && $cmd;
$verbose = $param->{verbose} if defined($param->{verbose});
if (!$cmd) {
return undef;
}
- $cmd = &$expand_command_name($cmddef, $cmd);
-
- my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} || []};
-
- raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class;
-
- my $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
+ my $str;
+ if ($verbose) {
+ $str = generate_usage_str('full', $cmd, '');
+ } else {
+ $str = generate_usage_str('short', $cmd, ' ' x 7);
+ }
+ $str =~ s/^\s+//;
- my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
- $verbose ? 'full' : 'short', $pwcallback,
- $stringfilemap);
if ($verbose) {
print "$str\n";
} else {
}});
sub print_simple_asciidoc_synopsis {
- my ($class, $name, $arg_param, $uri_param) = @_;
-
$assert_initialized->();
- my $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
- my $synopsis = "*${name}* `help`\n\n";
-
- $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
- 'asciidoc', $pwcallback, $stringfilemap);
+ my $synopsis = "*${exename}* `help`\n\n";
+ $synopsis .= generate_usage_str('asciidoc');
return $synopsis;
}
sub print_asciidoc_synopsis {
-
$assert_initialized->();
- my $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
my $synopsis = "";
$synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
- my $oldclass;
- foreach my $cmd (sort keys %$cmddef) {
- my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
- my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
- $uri_param, 'asciidoc', $pwcallback,
- $stringfilemap);
- $synopsis .= "\n" if $oldclass && $oldclass ne $class;
-
- $synopsis .= "$str\n\n";
- $oldclass = $class;
- }
+ $synopsis .= generate_usage_str('asciidoc');
$synopsis .= "\n";
}
sub print_usage_verbose {
-
$assert_initialized->();
- my $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
- foreach my $cmd (sort keys %$cmddef) {
- my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
- my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
- 'full', $pwcallback, $stringfilemap);
- print "$str\n\n";
- }
-}
+ my $str = generate_usage_str('full');
-sub sorted_commands {
- return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef;
+ print "$str\n";
}
sub print_usage_short {
- my ($fd, $msg) = @_;
+ my ($fd, $msg, $cmd) = @_;
$assert_initialized->();
- my $pwcallback = $cli_handler_class->can('read_password');
- my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
-
print $fd "ERROR: $msg\n" if $msg;
print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
- my $oldclass;
- foreach my $cmd (sorted_commands()) {
- my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
- my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback, $stringfilemap);
- print $fd "\n" if $oldclass && $oldclass ne $class;
- print $fd " $str";
- $oldclass = $class;
- }
+ print {$fd} generate_usage_str('short', $cmd, ' ' x 7, "\n", sub {
+ my ($h) = @_;
+ return sort {
+ if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
+ # $a and $b are both real commands order them by their class
+ return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
+ } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
+ # real command and subcommand mixed, put sub commands first
+ return ref($h->{$b}) eq 'ARRAY' ? -1 : 1;
+ } else {
+ # both are either from the same class or subcommands
+ return $a cmp $b;
+ }
+ } keys %$h;
+ });
}
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) {
- if (!scalar(@$args)) {
- &$print_result(keys %$def);
+ ($cmd, $def, $args, my $expanded) = resolve_cmd($args);
+
+ if (defined($expanded) && $prev ne $expanded) {
+ print "$expanded\n";
+ return;
+ }
+
+ if (ref($def) eq 'HASH') {
+ &$print_result(@{$get_commands->($def)});
return;
}
- $cmd = $args->[0];
}
- $def = $def->{$cmd};
return if !$def;
my $pos = scalar(@$args) - 1;
};
# positional arguments
- $pos++ if $simple_cmd;
if ($pos < scalar(@$arg_param)) {
my $pname = $arg_param->[$pos];
&$print_parameter_completion($pname);
&$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.
+# $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.
+sub print_text_table {
+ my ($formatopts, $data, $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;
+ $sort_key = undef;
+ }
+
+ foreach my $col ( @$formatopts ) {
+ my ($key, $title, $cutoff) = @$col{qw(key title cutoff)};
+ $title //= $key;
+
+ push @keys, $key;
+ push @titles, $title;
+ $defaults{$key} = $col->{default} // '';
+
+ # 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->{$key})) // 0;
+ $longest = $len if $len > $longest;
+ $sortable = 0 if !defined($entry->{$key});
+ }
+
+ $sort_key //= $key if $sortable;
+ $cutoff = (defined($cutoff) && $cutoff < $longest) ? $cutoff : $longest;
+ $cutoffs{$key} = $cutoff;
+
+ my $printalign = $cutoff > $titlelen ? '-' : '';
+ if ($col == $last_col) {
+ $formatstring .= "%${printalign}${titlelen}s\n";
+ } else {
+ $formatstring .= "%${printalign}${cutoff}s ";
+ }
+ }
+
+ printf $formatstring, @titles;
+
+ if (defined($sort_key)){
+ @$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;
+ }
+}
+
+# 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);
+ }
+
+ 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);
+}
+
+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') {
+ 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";
+ }
+ }
+ } 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) = @_;
$cmddef = $def;
if (ref($def) eq 'ARRAY') {
- print_simple_asciidoc_synopsis(@$def);
+ print_simple_asciidoc_synopsis();
} else {
$cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
}
my $handle_cmd = sub {
- my ($args, $pwcallback, $preparefunc, $stringfilemap) = @_;
+ my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
- $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ];
+ $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ];
+ my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args);
- my $cmd = shift @$args;
$abort->("no command specified") if !$cmd;
# call verifyapi before setup_environment(), don't execute any real code in
$cli_handler_class->setup_environment();
if ($cmd eq 'bashcomplete') {
- &$print_bash_completion(undef, @$args);
+ &$print_bash_completion(undef, @$cmd_args);
return;
}
- &$preparefunc() if $preparefunc;
+ # checked special commands, if def is still a hash we got an incomplete sub command
+ $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
- $cmd = &$expand_command_name($cmddef, $cmd);
+ &$preparefunc() if $preparefunc;
- my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
- $abort->("unknown command '$cmd'") if !$class;
+ my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
+ $abort->("unknown command '$cmd_str'") if !$class;
- my $prefix = "$exename $cmd";
- my $res = $class->cli_handler($prefix, $name, \@ARGV, $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;
if (scalar(@$args) >= 1) {
if ($args->[0] eq 'help') {
my $str = "USAGE: $name help\n";
- $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap);
+ $str .= generate_usage_str('long');
print STDERR "$str\n\n";
return;
} elsif ($args->[0] eq 'verifyapi') {
&$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 {
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);
$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;
projects / pve-common.git / blobdiff