X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FRESTHandler.pm;h=bd3f8ae1624b093f200aa5e4e30f45d0968469d1;hp=5e46dc3fb85097bb5c24193055a2aecf6aedf219;hb=dfc6cff8e33769a95b513b1696e6e627eaf55d94;hpb=b54ad320a5165dddc28272279d34183a6533928c

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index 5e46dc3..bd3f8ae 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -6,6 +6,7 @@ use warnings;
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::JSONSchema;
+use PVE::Tools;
 use HTTP::Status qw(:constants :is status_message);
 use Text::Wrap;
 use Clone qw(clone);
@@ -249,31 +250,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 {
@@ -417,9 +393,10 @@ sub handle {
 # $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', 'arg' or 'fixed'
+# $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, $fileparams) = @_;
+    my ($name, $style, $phash, $format, $hidepw, $mapdef) = @_;
 
     my $res = '';
 
@@ -434,19 +411,14 @@ my $get_property_description = sub {
 
     chomp $descr;
 
-    my $type = PVE::JSONSchema::schema_get_type_text($phash);
+    my $type_text = PVE::JSONSchema::schema_get_type_text($phash, $style);
 
     if ($hidepw && $name eq 'password') {
-	$type = '';
+	$type_text = '';
     }
 
-    if ($fileparams && $type eq 'string') {
-	foreach my $elem (@$fileparams) {
-	    if ($name eq $elem) {
-		$type = 'filepath';
-		last;
-	    }
-	}
+    if ($mapdef && $phash->{type} eq 'string') {
+	$type_text = $mapdef->{desc};
     }
 
     if ($format eq 'asciidoc') {
@@ -456,17 +428,17 @@ my $get_property_description = sub {
 	} elsif ($style eq 'config-sub') {
 	    $res .= "`$name`=";
 	} elsif ($style eq 'arg') {
-	    $res .= "`-$name` ";
+	    $res .= "`--$name` ";
 	} elsif ($style eq 'fixed') {
-	    $res .= "`<$name>` ";
+	    $res .= "`<$name>`: ";
 	} else {
 	    die "unknown style '$style'";
 	}
 
-	$res .= "`$type` " if $type;
+	$res .= "`$type_text` " if $type_text;
 
 	if (defined(my $dv = $phash->{default})) {
-	    $res .= "(default=`$dv`)";
+	    $res .= "('default =' `$dv`)";
 	}
 
 	if ($style eq 'config-sub') {
@@ -505,7 +477,7 @@ my $get_property_description = sub {
 	    die "unknown style '$style'";
 	}
 
-	my $tmp = sprintf "  %-10s %s$defaulttxt\n", $display_name, "$type";
+	my $tmp = sprintf "  %-10s %s$defaulttxt\n", $display_name, "$type_text";
 	my $indend = "             ";
 
 	$res .= Text::Wrap::wrap('', $indend, ($tmp));
@@ -525,6 +497,37 @@ my $get_property_description = sub {
     return $res;
 };
 
+# translate parameter mapping definition
+# $mapping_array is a array which can contain:
+#   strings ... in that case we assume it is a parameter name, and
+#      we want to load that parameter from a file
+#   [ param_name, func, desc] ... allows you to specify a arbitrary
+#      mapping func for any param
+#
+# Returns: a hash indexed by parameter_name,
+# i.e.  { param_name => { func => .., desc => ... } }
+my $compute_param_mapping_hash = sub {
+    my ($mapping_array) = @_;
+
+    my $res = {};
+
+    return $res if !defined($mapping_array);
+
+    foreach my $item (@$mapping_array) {
+	my ($name, $func, $desc);
+	if (ref($item) eq 'ARRAY') {
+	    ($name, $func, $desc) = @$item;
+	} else {
+	    $name = $item;
+	    $func = sub { return PVE::Tools::file_get_contents($_[0]) };
+	}
+	$desc //= '<filepath>';
+	$res->{$name} = { desc => $desc, func => $func };
+    }
+
+    return $res;
+};
+
 # generate usage information for command line tools
 #
 # $name        ... the name of the method
@@ -583,7 +586,7 @@ sub usage_str {
 	next if $arg_hash->{$k};
 	next if defined($fixed_param->{$k});
 
-	my $type = $prop->{$k}->{type} || 'string';
+	my $type_text = $prop->{$k}->{type} || 'string';
 
 	next if $hidepw && ($k eq 'password') && !$prop->{$k}->{optional};
 
@@ -597,13 +600,15 @@ sub usage_str {
 	    }
 	}
 
-	my $mapping = defined($stringfilemap) ? &$stringfilemap($name) : undef;
+	my $param_mapping_hash = $compute_param_mapping_hash->(&$stringfilemap($name))
+	    if $stringfilemap;
+
 	$opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
-					    $hidepw, $mapping);
+					    $hidepw, $param_mapping_hash->{$k});
 
 	if (!$prop->{$k}->{optional}) {
 	    $args .= " " if $args;
-	    $args .= "-$base <$type>"
+	    $args .= "--$base <$type_text>"
 	}
     } 
 
@@ -683,13 +688,11 @@ sub dump_properties {
 }
 
 my $replace_file_names_with_contents = sub {
-    my ($param, $mapping) = @_;
+    my ($param, $param_mapping_hash) = @_;
 
-    if ($mapping) {
-	foreach my $elem ( @$mapping ) {
-	    $param->{$elem} = PVE::Tools::file_get_contents($param->{$elem})
-		if defined($param->{$elem});
-	}
+    while (my ($k, $d) = each %$param_mapping_hash) {
+	$param->{$k} = $d->{func}->($param->{$k})
+	    if defined($param->{$k});
     }
 
     return $param;
@@ -703,8 +706,12 @@ sub cli_handler {
     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);
+
+	if (defined($stringfilemap)) {
+	    my $param_mapping_hash = $compute_param_mapping_hash->(&$stringfilemap($name));
+	    &$replace_file_names_with_contents($param, $param_mapping_hash);
+	}
+
 	$res = $self->handle($info, $param);
     };
     if (my $err = $@) {