use PVE::SafeSyslog;
use PVE::Exception qw(raise raise_param_exc);
use PVE::JSONSchema;
-use PVE::PodParser;
use HTTP::Status qw(:constants :is status_message);
use Text::Wrap;
use Clone qw(clone);
foreach my $p (keys %$d) {
my $pd = $d->{$p};
if ($p =~ m/^([a-z]+)(\d+)$/) {
- if ($2 == 0) {
- $p = "$1\[n\]";
- } else {
- next;
+ my ($name, $idx) = ($1, $2);
+ if ($idx == 0 && defined($d->{"${name}1"})) {
+ $p = "${name}[n]";
+ } elsif (defined($d->{"${name}0"})) {
+ next; # only handle once for -xx0, but only if -xx0 exists
+ }
+ }
+ my $tmp = ref($pd) ? clone($pd) : $pd;
+ # NOTE: add typetext property for more complex types, to
+ # make the web api viewer code simpler
+ if (!(defined($tmp->{enum}) || defined($tmp->{pattern}))) {
+ my $typetext = PVE::JSONSchema::schema_get_type_text($tmp);
+ if ($tmp->{type} && ($tmp->{type} ne $typetext)) {
+ $tmp->{typetext} = $typetext;
}
}
- $res->{$k}->{$p} = ref($pd) ? clone($pd) : $pd;
+ $res->{$k}->{$p} = $tmp;
}
}
return $result;
}
+# format option, display type and description
+# $name: option name
+# $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
+# $phash: json schema property hash
+# $format: 'asciidoc', 'short', 'long' or 'full'
+# $style: 'config', 'config-sub', 'arg' or 'fixed'
+my $get_property_description = sub {
+ my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
+
+ my $res = '';
+
+ $format = 'asciidoc' if !defined($format);
+
+ my $descr = $phash->{description} || "no description available";
+
+ if ($phash->{verbose_description} &&
+ ($style eq 'config' || $style eq 'config-sub')) {
+ $descr = $phash->{verbose_description};
+ }
+
+ chomp $descr;
+
+ my $type = PVE::JSONSchema::schema_get_type_text($phash, $style);
+
+ if ($hidepw && $name eq 'password') {
+ $type = '';
+ }
+
+ if ($fileparams && $type eq 'string') {
+ foreach my $elem (@$fileparams) {
+ if ($name eq $elem) {
+ $type = '<filepath>';
+ last;
+ }
+ }
+ }
+
+ if ($format eq 'asciidoc') {
+
+ if ($style eq 'config') {
+ $res .= "`$name`: ";
+ } elsif ($style eq 'config-sub') {
+ $res .= "`$name`=";
+ } elsif ($style eq 'arg') {
+ $res .= "`-$name` ";
+ } elsif ($style eq 'fixed') {
+ $res .= "`<$name>`: ";
+ } else {
+ die "unknown style '$style'";
+ }
+
+ $res .= "`$type` " if $type;
+
+ if (defined(my $dv = $phash->{default})) {
+ $res .= "('default =' `$dv`)";
+ }
+
+ if ($style eq 'config-sub') {
+ $res .= ";;\n\n";
+ } else {
+ $res .= "::\n\n";
+ }
+
+ my $wdescr = $descr;
+ chomp $wdescr;
+ $wdescr =~ s/^$/+/mg;
+
+ $res .= $wdescr . "\n";
+
+ if (my $req = $phash->{requires}) {
+ my $tmp .= ref($req) ? join(', ', @$req) : $req;
+ $res .= "+\nNOTE: Requires option(s): `$tmp`\n";
+ }
+ $res .= "\n";
+
+ } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') {
+
+ my $defaulttxt = '';
+ if (defined(my $dv = $phash->{default})) {
+ $defaulttxt = " (default=$dv)";
+ }
+
+ my $display_name;
+ if ($style eq 'config') {
+ $display_name = "$name:";
+ } elsif ($style eq 'arg') {
+ $display_name = "-$name";
+ } elsif ($style eq 'fixed') {
+ $display_name = "<$name>";
+ } else {
+ die "unknown style '$style'";
+ }
+
+ my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type";
+ my $indend = " ";
+
+ $res .= Text::Wrap::wrap('', $indend, ($tmp));
+ $res .= "\n",
+ $res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
+
+ if (my $req = $phash->{requires}) {
+ my $tmp = "Requires option(s): ";
+ $tmp .= ref($req) ? join(', ', @$req) : $req;
+ $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
+ }
+
+ } else {
+ die "unknown format '$format'";
+ }
+
+ return $res;
+};
+
# generate usage information for command line tools
#
# $name ... the name of the method
# on the command line (or single parameter name for lists)
# $fixed_param ... do not generate and info about those parameters
# $format:
-# 'long' ... default (list all options)
-# 'short' ... command line only (one line)
-# 'full' ... also include description
+# 'long' ... default (text, list all options)
+# '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)
+# $stringfilemap ... mapping for string parameters to file path parameters
sub usage_str {
- my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw) = @_;
+ my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $stringfilemap) = @_;
$format = 'long' if !$format;
}
}
- my $get_prop_descr = sub {
- my ($k, $display_name) = @_;
-
- my $phash = $prop->{$k};
-
- my $res = '';
-
- my $descr = $phash->{description} || "no description available";
- chomp $descr;
-
- my $type = PVE::PodParser::schema_get_type_text($phash);
-
- if ($hidepw && $k eq 'password') {
- $type = '';
- }
-
- if ($format eq 'asciidoc') {
- $res .= "[horizontal]\n";
- $res .= "`$display_name`:: `$type` ";
- if (defined(my $dv = $phash->{default})) {
- $res .= "(default=`$dv`)";
- }
- $res .= "\n+\n";
- $res .= Text::Wrap::wrap('', '', ($descr)) . "\n";
-
- if (my $req = $phash->{requires}) {
- #if (my $req = 'test') {
- my $tmp .= ref($req) ? join(', ', @$req) : $req;
- $res .= "+\nNOTE: Requires option(s): `$tmp`\n";
- }
- $res .= "\n";
- } else {
- my $defaulttxt = '';
- if (defined(my $dv = $phash->{default})) {
- $defaulttxt = " (default=$dv)";
- }
- my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type";
- my $indend = " ";
-
- $res .= Text::Wrap::wrap('', $indend, ($tmp));
- $res .= "\n",
- $res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
-
- if (my $req = $phash->{requires}) {
- my $tmp = "Requires option(s): ";
- $tmp .= ref($req) ? join(', ', @$req) : $req;
- $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
- }
- }
-
- return $res;
- };
-
my $argdescr = '';
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_prop_descr($k, "<$k>");
+ $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
}
my $idx_param = {}; # -vlan\d+ -scsi\d+
my $base = $k;
if ($k =~ m/^([a-z]+)(\d+)$/) {
- my $name = $1;
+ my ($name, $idx) = ($1, $2);
next if $idx_param->{$name};
- $idx_param->{$name} = 1;
- $base = "${name}[n]";
+ if ($idx == 0 && defined($prop->{"${name}1"})) {
+ $idx_param->{$name} = 1;
+ $base = "${name}[n]";
+ }
}
- $opts .= &$get_prop_descr($k, "-$base");
+ my $mapping = defined($stringfilemap) ? &$stringfilemap($name) : undef;
+ $opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
+ $hidepw, $mapping);
if (!$prop->{$k}->{optional}) {
$args .= " " if $args;
return $out;
}
+# generate docs from JSON schema properties
+sub dump_properties {
+ my ($prop, $format, $style, $filterFn) = @_;
+
+ my $raw = '';
+
+ $style //= 'config';
+
+ my $idx_param = {}; # -vlan\d+ -scsi\d+
+
+ foreach my $k (sort keys %$prop) {
+ my $phash = $prop->{$k};
+
+ next if defined($filterFn) && &$filterFn($k, $phash);
+ next if $phash->{alias};
+
+ my $base = $k;
+ if ($k =~ m/^([a-z]+)(\d+)$/) {
+ my ($name, $idx) = ($1, $2);
+ next if $idx_param->{$name};
+ if ($idx == 0 && defined($prop->{"${name}1"})) {
+ $idx_param->{$name} = 1;
+ $base = "${name}[n]";
+ }
+ }
+
+ $raw .= &$get_property_description($base, $style, $phash, $format, 0);
+
+ next if $style ne 'config';
+
+ my $prop_fmt = $phash->{format};
+ next if !$prop_fmt;
+
+ if (ref($prop_fmt) ne 'HASH') {
+ $prop_fmt = PVE::JSONSchema::get_format($prop_fmt);
+ }
+
+ next if !(ref($prop_fmt) && (ref($prop_fmt) eq 'HASH'));
+
+ $raw .= dump_properties($prop_fmt, $format, 'config-sub')
+
+ }
+
+ return $raw;
+}
+
+my $replace_file_names_with_contents = sub {
+ my ($param, $mapping) = @_;
+
+ if ($mapping) {
+ foreach my $elem ( @$mapping ) {
+ $param->{$elem} = PVE::Tools::file_get_contents($param->{$elem})
+ if defined($param->{$elem});
+ }
+ }
+
+ return $param;
+};
+
sub cli_handler {
- my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback) = @_;
+ my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback, $stringfilemap) = @_;
my $info = $self->map_method_by_name($name);
my $res;
eval {
my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $pwcallback);
+ &$replace_file_names_with_contents($param, &$stringfilemap($name))
+ if defined($stringfilemap);
$res = $self->handle($info, $param);
};
if (my $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', $pwcallback);
+ $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $pwcallback, $stringfilemap);
die $err;
}
projects / pve-common.git / blobdiff