}
sub handle {
- my ($self, $info, $param) = @_;
+ my ($self, $info, $param, $output_options) = @_;
my $func = $info->{code};
$param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra;
}
- my $result = &$func($param);
+ $output_options //= {};
+ my $result = &$func($param, $output_options);
# todo: this is only to be safe - disable?
if (my $schema = $info->{returns}) {
# $style: 'config', 'config-sub', 'arg' or 'fixed'
# $mapdef: parameter mapping ({ desc => XXX, func => sub {...} })
my $get_property_description = sub {
- my ($name, $style, $phash, $format, $hidepw, $mapdef) = @_;
+ my ($name, $style, $phash, $format, $mapdef) = @_;
my $res = '';
my $type_text = PVE::JSONSchema::schema_get_type_text($phash, $style);
- if ($hidepw && $name eq 'password') {
- $type_text = '';
- }
-
if ($mapdef && $phash->{type} eq 'string') {
$type_text = $mapdef->{desc};
}
# generate usage information for command line tools
#
-# $name ... the name of the method
+# $info ... method info
# $prefix ... usually something like "$exename $cmd" ('pvesm add')
# $arg_param ... list of parameters we want to get as ordered arguments
# on the command line (or single parameter name for lists)
# 'short' ... command line only (text, one line)
# 'full' ... text, include description
# 'asciidoc' ... generate asciidoc for man pages (like 'full')
-# $hidepw ... hide password option (use this if you provide a read passwork callback)
-# $param_mapping_func ... mapping for string parameters to file path parameters
-sub usage_str {
- my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $param_mapping_func) = @_;
+# $param_cb ... mapping for string parameters to file path parameters
+sub getopt_usage {
+ my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
$format = 'long' if !$format;
- my $info = $self->map_method_by_name($name);
my $schema = $info->{parameters};
+ my $name = $info->{name};
my $prop = $schema->{properties};
my $out = '';
foreach my $k (@$arg_param) {
next if defined($fixed_param->{$k}); # just to be sure
next if !$prop->{$k}; # just to be sure
- $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
+ $argdescr .= $get_property_description->($k, 'fixed', $prop->{$k}, $format);
}
my $idx_param = {}; # -vlan\d+ -scsi\d+
my $type_text = $prop->{$k}->{type} || 'string';
- next if $hidepw && ($k eq 'password') && !$prop->{$k}->{optional};
+ my $param_map = {};
+
+ if (defined($param_cb)) {
+ my $mapping = $param_cb->($name);
+ $param_map = $compute_param_mapping_hash->($mapping);
+ next if $k eq 'password' && $param_map->{$k} && !$prop->{$k}->{optional};
+ }
my $base = $k;
if ($k =~ m/^([a-z]+)(\d+)$/) {
}
}
- my $param_mapping_hash = $compute_param_mapping_hash->(&$param_mapping_func($name))
- if $param_mapping_func;
- $opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
- $hidepw, $param_mapping_hash->{$k});
+ $opts .= $get_property_description->($base, 'arg', $prop->{$k}, $format, $param_map->{$k});
if (!$prop->{$k}->{optional}) {
$args .= " " if $args;
return $out;
}
+sub usage_str {
+ my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb) = @_;
+
+ my $info = $self->map_method_by_name($name);
+
+ return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb);
+}
+
# generate docs from JSON schema properties
sub dump_properties {
my ($prop, $format, $style, $filterFn) = @_;
}
}
- $raw .= &$get_property_description($base, $style, $phash, $format, 0);
+ $raw .= $get_property_description->($base, $style, $phash, $format);
next if $style ne 'config';
}
my $replace_file_names_with_contents = sub {
- my ($param, $param_mapping_hash) = @_;
+ my ($param, $param_map) = @_;
- while (my ($k, $d) = each %$param_mapping_hash) {
+ while (my ($k, $d) = each %$param_map) {
next if $d->{interactive}; # handled by the JSONSchema's get_options code
$param->{$k} = $d->{func}->($param->{$k})
if defined($param->{$k});
return $param;
};
+our $standard_output_options = {
+ format => PVE::JSONSchema::get_standard_option('pve-output-format'),
+ noheader => {
+ description => "Do not show column headers (for 'text' format).",
+ type => 'boolean',
+ optional => 1,
+ default => 1,
+ },
+ noborder => {
+ description => "Do not draw borders (for 'text' format).",
+ type => 'boolean',
+ optional => 1,
+ default => 1,
+ },
+ quiet => {
+ description => "Suppress printing results.",
+ type => 'boolean',
+ optional => 1,
+ },
+ 'human-readable' => {
+ description => "Call output rendering functions to produce human readable text.",
+ type => 'boolean',
+ optional => 1,
+ default => 1,
+ }
+};
+
+sub add_standard_output_parameters {
+ my ($org_schema) = @_;
+
+ my $schema = { %$org_schema };
+ $schema->{properties} = { %{$schema->{properties}}, %$standard_output_options };
+
+ return $schema;
+};
+
sub cli_handler {
- my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $read_password_func, $param_mapping_func) = @_;
+ my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb, $options) = @_;
my $info = $self->map_method_by_name($name);
+ $options //= {};
+
+ my $add_stdopts = $options->{'std-output-opts'};
my $res;
eval {
- my $param_mapping_hash = $compute_param_mapping_hash->($param_mapping_func->($name)) if $param_mapping_func;
- my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $read_password_func, $param_mapping_hash);
+ my $param_map = {};
+ $param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb;
+ my $schema = $add_stdopts ? add_standard_output_parameters($info->{parameters}) : $info->{properties} ;
+ my $param = PVE::JSONSchema::get_options($schema, $args, $arg_param, $fixed_param, $param_map);
+
+ if ($add_stdopts) {
+ foreach my $opt (keys %$standard_output_options) {
+ $options->{$opt} = delete $param->{$opt} if defined($param->{$opt});
+ }
+ }
- if (defined($param_mapping_hash)) {
- &$replace_file_names_with_contents($param, $param_mapping_hash);
+ if (defined($param_map)) {
+ $replace_file_names_with_contents->($param, $param_map);
}
- $res = $self->handle($info, $param);
+ $res = $self->handle($info, $param, $options);
};
if (my $err = $@) {
my $ec = ref($err);
die $err if !$ec || $ec ne "PVE::Exception" || !$err->is_param_exc();
- $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $read_password_func, $param_mapping_func);
+ $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $param_cb);
die $err;
}