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

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index 3da21d7..bd3f8ae 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -6,7 +6,7 @@ use warnings;
 use PVE::SafeSyslog;
 use PVE::Exception qw(raise raise_param_exc);
 use PVE::JSONSchema;
-use PVE::PodParser;
+use PVE::Tools;
 use HTTP::Status qw(:constants :is status_message);
 use Text::Wrap;
 use Clone qw(clone);
@@ -34,13 +34,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 +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 {
@@ -404,12 +389,14 @@ 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', 'config-sub', 'arg' or 'fixed'
+# $mapdef: parameter mapping ({ desc => XXX, func => sub {...} })
 my $get_property_description = sub {
-    my ($k, $display_name, $phash, $format, $hidepw) = @_;
+    my ($name, $style, $phash, $format, $hidepw, $mapdef) = @_;
 
     my $res = '';
 
@@ -417,29 +404,54 @@ 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_text = PVE::JSONSchema::schema_get_type_text($phash, $style);
 
-    if ($hidepw && $k eq 'password') {
-	$type = '';
+    if ($hidepw && $name eq 'password') {
+	$type_text = '';
+    }
+
+    if ($mapdef && $phash->{type} eq 'string') {
+	$type_text = $mapdef->{desc};
     }
 
     if ($format eq 'asciidoc') {
 
-	if (defined($display_name)) {
-	    $res .= "`$display_name` ";
+	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 {
-	    $res .= "`$k:` ";
+	    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`)";
 	}
-	$res .= "::\n\n";
-	$res .= Text::Wrap::wrap('', '', ($descr)) . "\n";
+
+	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;
@@ -447,16 +459,25 @@ 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 $tmp = sprintf "  %-10s %s$defaulttxt\n", $display_name, "$type_text";
 	my $indend = "             ";
 
 	$res .= Text::Wrap::wrap('', $indend, ($tmp));
@@ -476,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
@@ -484,13 +536,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 +576,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+
@@ -533,23 +586,29 @@ 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};
 
 	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($k, "-$base", $prop->{$k}, $format, $hidepw);
+	my $param_mapping_hash = $compute_param_mapping_hash->(&$stringfilemap($name))
+	    if $stringfilemap;
+
+	$opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format,
+					    $hidepw, $param_mapping_hash->{$k});
 
 	if (!$prop->{$k}->{optional}) {
 	    $args .= " " if $args;
-	    $args .= "-$base <$type>"
+	    $args .= "--$base <$type_text>"
 	}
     } 
 
@@ -584,40 +643,75 @@ 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) {
 	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);
 	}
 
-	$raw .= &$get_property_description($k, undef, $phash, $format, 0);
+	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, $param_mapping_hash) = @_;
+
+    while (my ($k, $d) = each %$param_mapping_hash) {
+	$param->{$k} = $d->{func}->($param->{$k})
+	    if defined($param->{$k});
+    }
+
+    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);
+
+	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 = $@) {
@@ -625,7 +719,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;
     }