proxmox-mirrors/pve-client
1
0
Fork 0
mirror of https://git.proxmox.com/git/pve-client synced 2025-10-05 02:51:37 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update files from pve-common

Browse Source
This commit is contained in:
Dietmar Maurer 2018-07-24 09:31:55 +02:00
parent 2154d1f375
commit 5aa25367b7
3 changed files with 68 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
PVE/APIClient/CLIFormatter.pm
View File

@ -374,7 +374,7 @@ sub print_api_result {
$options = { %$options }; # copy $options = { %$options }; # copy
} }
my $format = $options->{format} // 'text'; my $format = $options->{'output-format'} // 'text';
return if $result_schema->{type} eq 'null'; return if $result_schema->{type} eq 'null';

35
PVE/APIClient/CLIHandler.pm
View File

@ -17,7 +17,9 @@ use base qw(PVE::APIClient::RESTHandler);
# A real command is always an array consisting of its class, name, array of # A real command is always an array consisting of its class, name, array of
# position fixed (required) parameters and hash of predefined parameters when # 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 # 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. # passed at the end, e.g., for formatting or transformation purpose, and
# a schema of additional properties/arguments which are added to
# the method schema and gets passed to the formatter.
# #
# [class, name, fixed_params, API_pre-set params, output_sub ] # [class, name, fixed_params, API_pre-set params, output_sub ]
# #
@ -200,12 +202,12 @@ sub generate_usage_str {
foreach my $cmd (&$sortfunc($def)) { foreach my $cmd (&$sortfunc($def)) {
if (ref($def->{$cmd}) eq 'ARRAY') { if (ref($def->{$cmd}) eq 'ARRAY') {
my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}}; my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}};
$str .= $separator if $oldclass && $oldclass ne $class; $str .= $separator if $oldclass && $oldclass ne $class;
$str .= $indent; $str .= $indent;
$str .= $class->usage_str($name, "$prefix $cmd", $arg_param, $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
$fixed_param, $format, $param_cb); $fixed_param, $format, $param_cb, $formatter_properties);
$oldclass = $class; $oldclass = $class;
} elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) { } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) {
@ -224,11 +226,11 @@ sub generate_usage_str {
} }
} else { } else {
my ($class, $name, $arg_param, $fixed_param) = @$def; my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def;
$abort->("unknown command '$cmd'") if !$class; $abort->("unknown command '$cmd'") if !$class;
$str .= $indent; $str .= $indent;
$str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb); $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
} }
return $str; return $str;
}; };
@ -395,7 +397,7 @@ my $print_bash_completion = sub {
my $skip_param = {}; my $skip_param = {};
my ($class, $name, $arg_param, $uri_param) = @$def; my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def;
$arg_param //= []; $arg_param //= [];
$uri_param //= {}; $uri_param //= {};
@ -406,7 +408,8 @@ my $print_bash_completion = sub {
my $info = $class->map_method_by_name($name); my $info = $class->map_method_by_name($name);
my $prop = $info->{parameters}->{properties}; my $prop = { %{$info->{parameters}->{properties}} }; # copy
$prop = { %$prop, %$formatter_properties } if $formatter_properties;
my $print_parameter_completion = sub { my $print_parameter_completion = sub {
my ($pname) = @_; my ($pname) = @_;
@ -547,23 +550,22 @@ my $handle_cmd = sub {
&$preparefunc() if $preparefunc; &$preparefunc() if $preparefunc;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []}; my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []};
$abort->("unknown command '$cmd_str'") if !$class; $abort->("unknown command '$cmd_str'") if !$class;
my $options = PVE::APIClient::CLIFormatter::query_terminal_options({}); my ($res, $formatter_params) = $class->cli_handler(
$cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties);
my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $options);
if (defined $outsub) { if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns}; my $result_schema = $class->map_method_by_name($name)->{returns};
$outsub->($res, $result_schema, $options); $outsub->($res, $result_schema, $formatter_params);
} }
}; };
my $handle_simple_cmd = sub { my $handle_simple_cmd = sub {
my ($args, $preparefunc, $param_cb) = @_; my ($args, $preparefunc, $param_cb) = @_;
my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef}; my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef};
die "no class specified" if !$class; die "no class specified" if !$class;
if (scalar(@$args) >= 1) { if (scalar(@$args) >= 1) {
@ -590,13 +592,12 @@ my $handle_simple_cmd = sub {
&$preparefunc() if $preparefunc; &$preparefunc() if $preparefunc;
my $options = PVE::APIClient::CLIFormatter::query_terminal_options({}); my ($res, $formatter_params) = $class->cli_handler(
$name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties);
my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $options);
if (defined $outsub) { if (defined $outsub) {
my $result_schema = $class->map_method_by_name($name)->{returns}; my $result_schema = $class->map_method_by_name($name)->{returns};
$outsub->($res, $result_schema, $options); $outsub->($res, $result_schema, $formatter_params);
} }
}; };

74
PVE/APIClient/RESTHandler.pm
View File

@ -37,7 +37,7 @@ sub api_clone_schema {
my ($name, $idx) = ($1, $2); my ($name, $idx) = ($1, $2);
if ($idx == 0 && defined($d->{"${name}1"})) { if ($idx == 0 && defined($d->{"${name}1"})) {
$p = "${name}[n]"; $p = "${name}[n]";
} elsif (defined($d->{"${name}0"})) { } elsif ($idx > 0 && defined($d->{"${name}0"})) {
next; # only handle once for -xx0, but only if -xx0 exists next; # only handle once for -xx0, but only if -xx0 exists
} }
} }
@ -394,7 +394,7 @@ sub find_handler {
} }
sub handle { sub handle {
my ($self, $info, $param, $output_options) = @_; my ($self, $info, $param) = @_;
my $func = $info->{code}; my $func = $info->{code};
@ -414,8 +414,7 @@ sub handle {
$param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra; $param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra;
} }
$output_options //= {}; my $result = &$func($param);
my $result = &$func($param, $output_options);
# todo: this is only to be safe - disable? # todo: this is only to be safe - disable?
if (my $schema = $info->{returns}) { if (my $schema = $info->{returns}) {
@ -577,15 +576,17 @@ my $compute_param_mapping_hash = sub {
# 'short' ... command line only (text, one line) # 'short' ... command line only (text, one line)
# 'full' ... text, include description # 'full' ... text, include description
# 'asciidoc' ... generate asciidoc for man pages (like 'full') # 'asciidoc' ... generate asciidoc for man pages (like 'full')
# $param_cb ... mapping for string parameters to file path parameters # $param_cb ... mapping for string parameters to file path parameters
# $formatter_properties ... additional property definitions (passed to output formatter)
sub getopt_usage { sub getopt_usage {
my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_; my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
$format = 'long' if !$format; $format = 'long' if !$format;
my $schema = $info->{parameters}; my $schema = $info->{parameters};
my $name = $info->{name}; my $name = $info->{name};
my $prop = $schema->{properties}; my $prop = { %{$schema->{properties}} }; # copy
$prop = { %$prop, %$formatter_properties } if $formatter_properties;
my $out = ''; my $out = '';
@ -681,11 +682,11 @@ sub getopt_usage {
} }
sub usage_str { sub usage_str {
my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_; my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
my $info = $self->map_method_by_name($name); my $info = $self->map_method_by_name($name);
return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb); return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
} }
# generate docs from JSON schema properties # generate docs from JSON schema properties
@ -747,7 +748,7 @@ my $replace_file_names_with_contents = sub {
}; };
our $standard_output_options = { our $standard_output_options = {
format => PVE::APIClient::JSONSchema::get_standard_option('pve-output-format'), 'output-format' => PVE::APIClient::JSONSchema::get_standard_option('pve-output-format'),
noheader => { noheader => {
description => "Do not show column headers (for 'text' format).", description => "Do not show column headers (for 'text' format).",
type => 'boolean', type => 'boolean',
@ -773,49 +774,72 @@ our $standard_output_options = {
} }
}; };
sub add_standard_output_parameters { sub add_standard_output_properties {
my ($org_schema) = @_; my ($propdef, $list) = @_;
my $schema = { %$org_schema }; $propdef //= {};
$schema->{properties} = { %{$schema->{properties}}, %$standard_output_options };
return $schema; $list //= [ keys %$standard_output_options ];
};
my $res = { %$propdef }; # copy
foreach my $opt (@$list) {
die "no such standard output option '$opt'\n" if !defined($standard_output_options->{$opt});
die "detected overwriten standard CLI parameter '$opt'\n" if defined($res->{$opt});
$res->{$opt} = $standard_output_options->{$opt};
}
return $res;
}
sub extract_standard_output_properties {
my ($data) = @_;
my $options = {};
foreach my $opt (keys %$standard_output_options) {
$options->{$opt} = delete $data->{$opt} if defined($data->{$opt});
}
return $options;
}
sub cli_handler { sub cli_handler {
my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb, $options) = @_; my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb, $formatter_properties) = @_;
my $info = $self->map_method_by_name($name); my $info = $self->map_method_by_name($name);
$options //= {};
my $res; my $res;
my $fmt_param = {};
eval { eval {
my $param_map = {}; my $param_map = {};
$param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb; $param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb;
my $schema = add_standard_output_parameters($info->{parameters}); my $schema = { %{$info->{parameters}} }; # copy
$schema->{properties} = { %{$schema->{properties}}, %$formatter_properties } if $formatter_properties;
my $param = PVE::APIClient::JSONSchema::get_options($schema, $args, $arg_param, $fixed_param, $param_map); my $param = PVE::APIClient::JSONSchema::get_options($schema, $args, $arg_param, $fixed_param, $param_map);
foreach my $opt (keys %$standard_output_options) { if ($formatter_properties) {
$options->{$opt} = delete $param->{$opt} if defined($param->{$opt}); foreach my $opt (keys %$formatter_properties) {
$fmt_param->{$opt} = delete $param->{$opt} if defined($param->{$opt});
}
} }
if (defined($param_map)) { if (defined($param_map)) {
$replace_file_names_with_contents->($param, $param_map); $replace_file_names_with_contents->($param, $param_map);
} }
$res = $self->handle($info, $param, $options); $res = $self->handle($info, $param);
}; };
if (my $err = $@) { if (my $err = $@) {
my $ec = ref($err); my $ec = ref($err);
die $err if !$ec || $ec ne "PVE::APIClient::Exception" || !$err->is_param_exc(); die $err if !$ec || $ec ne "PVE::APIClient::Exception" || !$err->is_param_exc();
$err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $param_cb); $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $param_cb, $formatter_properties);
die $err; die $err;
} }
return $res; return wantarray ? ($res, $fmt_param) : $res;
} }
# utility methods # utility methods