X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FRESTHandler.pm;h=60e915ba840d0df75688e7193f8ecca54fb8a723;hp=cd1aa35ed58a85802c2148f59a57b52d5fdfe768;hb=305068a7e5d4f2326a45446e85decb615fa365ea;hpb=a736ac996c33bce0e43241791cf31c13459c57ee

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index cd1aa35..60e915b 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -408,8 +408,9 @@ sub handle {
 # $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'
 my $get_property_description = sub {
-    my ($name, $display_name, $phash, $format, $hidepw) = @_;
+    my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
 
     my $res = '';
 
@@ -425,12 +426,25 @@ my $get_property_description = sub {
 	$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` ";
-	} else {
+	if ($style eq 'config') {
 	    $res .= "`$name`: ";
+	} elsif ($style eq 'arg') {
+	    $res .= "`-$name` ";
+	} elsif ($style eq 'fixed') {
+	    $res .= "`<$name>` ";
+	} else {
+	    die "unknown style '$style'";
 	}
 
 	$res .= "`$type` " if $type;
@@ -459,7 +473,16 @@ my $get_property_description = sub {
 	    $defaulttxt = "   (default=$dv)";
 	}
 
-	$display_name = "$name:" 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 = "             ";
@@ -494,8 +517,9 @@ my $get_property_description = sub {
 #   'full'     ... also 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;
 
@@ -528,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}, 'text', 0);
+	$argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -550,7 +574,9 @@ sub usage_str {
 	    $base = "${name}[n]";
 	}
 
-	$opts .= &$get_property_description($base, "-$base", $prop->{$k}, 'text', $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;
@@ -589,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) {
@@ -610,19 +638,34 @@ sub dump_properties {
 	    $base = "${name}[n]";
 	}
 
-	$raw .= &$get_property_description($base, 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 = $@) {
@@ -630,7 +673,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;
     }