X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FRESTHandler.pm;h=961b2532c085fee7972d149d34aa21e34658d270;hp=ad76b01e410c85587692b4b232b98a4a237a1180;hb=0c0304c0d9a9a753b5d93a6c7b2239059a26d945;hpb=4845032a4636260385b59b55aabdb05c700fea2f

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index ad76b01..961b253 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -6,7 +6,6 @@ use warnings;
 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);
@@ -34,13 +33,23 @@ sub api_clone_schema {
 	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;
 	}
     }
 
@@ -240,31 +249,6 @@ sub register_method {
     push @{$method_registry->{$self}}, $info;
 }
 
-sub register_page_formatter {
-    my ($self, %config) = @_;
-
-    my $format = $config{format} ||
-	die "missing format";
-
-    my $path = $config{path} ||
-	die "missing path";
-
-    my $method = $config{method} ||
-	die "missing method";
-	
-    my $code = $config{code} ||
-	die "missing formatter code";
-    
-    my $uri_param = {};
-    my ($handler, $info) = $self->find_handler($method, $path, $uri_param);
-    die "unabe to find handler for '$method: $path'" if !($handler && $info);
-
-    die "duplicate formatter for '$method: $path'" 
-	if $info->{formatter} && $info->{formatter}->{$format};
-
-    $info->{formatter}->{$format} = $code;
-}
-
 sub DESTROY {}; # avoid problems with autoload
 
 sub AUTOLOAD {
@@ -407,8 +391,8 @@ sub handle {
 # $name: option name
 # $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
 # $phash: json schema property hash
-# $format: 'asciidoc', 'pod' or 'text'
-# $style: 'config', 'arg' or 'fixed'
+# $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) = @_;
 
@@ -418,9 +402,14 @@ my $get_property_description = sub {
 
     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::PodParser::schema_get_type_text($phash);
+    my $type = PVE::JSONSchema::schema_get_type_text($phash, $style);
 
     if ($hidepw && $name eq 'password') {
 	$type = '';
@@ -429,7 +418,7 @@ my $get_property_description = sub {
     if ($fileparams && $type eq 'string') {
 	foreach my $elem (@$fileparams) {
 	    if ($name eq $elem) {
-		$type = 'filepath';
+		$type = '<filepath>';
 		last;
 	    }
 	}
@@ -439,10 +428,12 @@ my $get_property_description = sub {
 
 	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>` ";
+	    $res .= "`<$name>`: ";
 	} else {
 	    die "unknown style '$style'";
 	}
@@ -450,11 +441,16 @@ my $get_property_description = sub {
 	$res .= "`$type` " if $type;
 
 	if (defined(my $dv = $phash->{default})) {
-	    $res .= "(default=`$dv`)";
+	    $res .= "('default =' `$dv`)";
 	}
-	$res .= "::\n\n";
 
-	my $wdescr = Text::Wrap::wrap('', '', ($descr));
+	if ($style eq 'config-sub') {
+	    $res .= ";;\n\n";
+	} else {
+	    $res .= "::\n\n";
+	}
+
+	my $wdescr = $descr;
 	chomp $wdescr;
 	$wdescr =~ s/^$/+/mg;
 
@@ -466,7 +462,7 @@ my $get_property_description = sub {
 	}
 	$res .= "\n";
 
-    } elsif ($format eq 'pod' || $format eq 'text') {
+    } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') {
 
 	my $defaulttxt = '';
 	if (defined(my $dv = $phash->{default})) {
@@ -512,9 +508,9 @@ my $get_property_description = sub {
 #                  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
@@ -552,7 +548,7 @@ sub usage_str {
     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}, 'text', 0);
+	$argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -568,14 +564,17 @@ sub usage_str {
 
 	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_property_description($base, 'arg', $prop->{$k}, 'text',
-					    $hidepw, &$stringfilemap($name));
+	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;
@@ -626,19 +625,35 @@ sub dump_properties {
 	my $phash = $prop->{$k};
 
 	next if defined($filterFn) && &$filterFn($k, $phash);
-
-	my $type = $phash->{type} || 'string';
+	next if $phash->{alias};
 
 	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]";
+	    }
 	}
 
 	$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;
 }