X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FRESTHandler.pm;h=ca3f99b5b58e8a948cf9976db8ef4e76b94670ba;hp=3da21d7cad18618d9928f390fe2620a3039657cf;hb=2c2a5fd3df9c12f69aa1e8e36f4badd4fde92458;hpb=8fa050cd6271ac9d1627bc5c2319fcf7383d6177

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index 3da21d7..ca3f99b 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -36,8 +36,8 @@ sub api_clone_schema {
 	    if ($p =~ m/^([a-z]+)(\d+)$/) {
 		if ($2 == 0) {
 		    $p = "$1\[n\]";
-		} else {
-		    next;
+		} elsif (defined($d->{$1.'0'})) {
+		    next; # only handle once for -xx0, but only if -xx0 exists
 		}
 	    }
 	    $res->{$k}->{$p} = ref($pd) ? clone($pd) : $pd;
@@ -404,12 +404,13 @@ sub handle {
 }
 
 # format option, display type and description
-# $k: option name
-# $display_name: for example "-$k" of "<$k>", pass undef to use "$k:"
+# $name: option name
+# $display_name: for example "-$name" of "<$name>", pass undef to use "$name:"
 # $phash: json schema property hash
-# $format: 'asciidoc' or 'pod'
+# $format: 'asciidoc', 'short', 'long' or 'full'
+# $style: 'config', 'arg' or 'fixed'
 my $get_property_description = sub {
-    my ($k, $display_name, $phash, $format, $hidepw) = @_;
+    my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
 
     my $res = '';
 
@@ -421,16 +422,29 @@ my $get_property_description = sub {
 
     my $type = PVE::PodParser::schema_get_type_text($phash);
 
-    if ($hidepw && $k eq 'password') {
+    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 (defined($display_name)) {
-	    $res .= "`$display_name` ";
+	if ($style eq 'config') {
+	    $res .= "`$name`: ";
+	} elsif ($style eq 'arg') {
+	    $res .= "`-$name` ";
+	} elsif ($style eq 'fixed') {
+	    $res .= "`<$name>` ";
 	} else {
-	    $res .= "`$k:` ";
+	    die "unknown style '$style'";
 	}
 
 	$res .= "`$type` " if $type;
@@ -439,7 +453,12 @@ my $get_property_description = sub {
 	    $res .= "(default=`$dv`)";
 	}
 	$res .= "::\n\n";
-	$res .= Text::Wrap::wrap('', '', ($descr)) . "\n";
+
+	my $wdescr = Text::Wrap::wrap('', '', ($descr));
+	chomp $wdescr;
+	$wdescr =~ s/^$/+/mg;
+
+	$res .= $wdescr . "\n";
 
 	if (my $req = $phash->{requires}) {
 	    my $tmp .= ref($req) ? join(', ', @$req) : $req;
@@ -447,14 +466,23 @@ my $get_property_description = sub {
 	}
 	$res .= "\n";
 
-    } elsif ($format eq 'pod') {
+    } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') {
 
 	my $defaulttxt = '';
 	if (defined(my $dv = $phash->{default})) {
 	    $defaulttxt = "   (default=$dv)";
 	}
 
-	$display_name = "$k:" if !defined($display_name);
+	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 = "             ";
@@ -484,13 +512,14 @@ 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
 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;
 
@@ -523,7 +552,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, "<$k>", $prop->{$k}, $format, 0);
+	$argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -545,7 +574,9 @@ sub usage_str {
 	    $base = "${name}[n]";
 	}
 
-	$opts .= &$get_property_description($k, "-$base", $prop->{$k}, $format, $hidepw);
+	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;
@@ -584,10 +615,12 @@ sub usage_str {
 
 # generate docs from JSON schema properties
 sub dump_properties {
-    my ($prop, $format, $filterFn) = @_;
+    my ($prop, $format, $style, $filterFn) = @_;
 
     my $raw = '';
 
+    $style //= 'config';
+    
     my $idx_param = {}; # -vlan\d+ -scsi\d+
 
     foreach my $k (sort keys %$prop) {
@@ -605,19 +638,35 @@ sub dump_properties {
 	    $base = "${name}[n]";
 	}
 
-	$raw .= &$get_property_description($k, undef, $phash, $format, 0);
+	$raw .= &$get_property_description($base, $style, $phash, $format, 0);
     }
+
     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 = $@) {
@@ -625,7 +674,7 @@ sub cli_handler {
 
 	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;
     }