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

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index ad0f929..ca3f99b 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -9,7 +9,7 @@ use PVE::JSONSchema;
 use PVE::PodParser;
 use HTTP::Status qw(:constants :is status_message);
 use Text::Wrap;
-use Storable qw(dclone);
+use Clone qw(clone);
 
 my $method_registry = {};
 my $method_by_name = {};
@@ -27,7 +27,7 @@ sub api_clone_schema {
     foreach my $k (keys %$schema) {
 	my $d = $schema->{$k};
 	if ($k ne 'properties') {
-	    $res->{$k} = ref($d) ? dclone($d) : $d;
+	    $res->{$k} = ref($d) ? clone($d) : $d;
 	    next;
 	}
 	# convert indexed parameters like -net\d+ to -net[n]
@@ -36,11 +36,11 @@ 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) ? dclone($pd) : $pd;
+	    $res->{$k}->{$p} = ref($pd) ? clone($pd) : $pd;
 	}
     }
 
@@ -105,7 +105,7 @@ sub api_dump_full {
 			$data->{$k} = api_clone_schema($d);
 		    } else {
 
-			$data->{$k} = ref($d) ? dclone($d) : $d;
+			$data->{$k} = ref($d) ? clone($d) : $d;
 		    }
 		} 
 		$res->{info}->{$info->{method}} = $data;
@@ -386,21 +386,124 @@ sub handle {
 	# warn "validate ". Dumper($param}) . "\n" . Dumper($schema);
 	PVE::JSONSchema::validate($param, $schema);
 	# untaint data (already validated)
+	my $extra = delete $param->{'extra-args'};
 	while (my ($key, $val) = each %$param) {
 	    ($param->{$key}) = $val =~ /^(.*)$/s;
 	}
+	$param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra;
     }
 
     my $result = &$func($param); 
 
     # todo: this is only to be safe - disable?
     if (my $schema = $info->{returns}) {
-	PVE::JSONSchema::validate($result, $schema, "Result verification vailed\n");
+	PVE::JSONSchema::validate($result, $schema, "Result verification failed\n");
     }
 
     return $result;
 }
 
+# format option, display type and description
+# $name: option name
+# $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'
+my $get_property_description = sub {
+    my ($name, $style, $phash, $format, $hidepw, $fileparams) = @_;
+
+    my $res = '';
+
+    $format = 'asciidoc' if !defined($format);
+
+    my $descr = $phash->{description} || "no description available";
+
+    chomp $descr;
+
+    my $type = PVE::PodParser::schema_get_type_text($phash);
+
+    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 ($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;
+
+	if (defined(my $dv = $phash->{default})) {
+	    $res .= "(default=`$dv`)";
+	}
+	$res .= "::\n\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;
+	    $res .= "+\nNOTE: Requires option(s): `$tmp`\n";
+	}
+	$res .= "\n";
+
+    } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') {
+
+	my $defaulttxt = '';
+	if (defined(my $dv = $phash->{default})) {
+	    $defaulttxt = "   (default=$dv)";
+	}
+
+	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 = "             ";
+
+	$res .= Text::Wrap::wrap('', $indend, ($tmp));
+	$res .= "\n",
+	$res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
+
+	if (my $req = $phash->{requires}) {
+	    my $tmp = "Requires option(s): ";
+	    $tmp .= ref($req) ? join(', ', @$req) : $req;
+	    $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
+	}
+
+    } else {
+	die "unknown format '$format'";
+    }
+
+    return $res;
+};
+
 # generate usage information for command line tools
 #
 # $name        ... the name of the method
@@ -409,12 +512,14 @@ sub handle {
 #                  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;
 
@@ -443,47 +548,11 @@ sub usage_str {
 	}
     }
 
-    my $get_prop_descr = sub {
-	my ($k, $display_name) = @_;
- 
-	my $phash = $prop->{$k};
-
-	my $res = '';
-	
-	my $descr = $phash->{description} || "no description available";
-	chomp $descr;
-
-	my $type = PVE::PodParser::schema_get_type_text($phash);
-
-	if ($hidepw && $k eq 'password') {
-	    $type = '';
-	}
-	
-	my $defaulttxt = '';
-	if (defined(my $dv = $phash->{default})) {
-	    $defaulttxt = "   (default=$dv)";
-	}
-	my $tmp = sprintf "  %-10s %s$defaulttxt\n", $display_name, "$type";
-	my $indend = "             ";
-
-	$res .= Text::Wrap::wrap('', $indend, ($tmp));
-	$res .= "\n",
-	$res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n";
-
-	if (my $req = $phash->{requires}) {
-	    my $tmp = "Requires option(s): ";
-	    $tmp .= ref($req) ? join(', ', @$req) : $req;
-	    $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n";
-	}
-
-	return $res;
-    };
-
     my $argdescr = '';
     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_prop_descr($k, "<$k>");
+	$argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -505,7 +574,9 @@ sub usage_str {
 	    $base = "${name}[n]";
 	}
 
-	$opts .= &$get_prop_descr($k, "-$base");
+	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;
@@ -513,17 +584,26 @@ sub usage_str {
 	}
     } 
 
-    $out .= "USAGE: " if $format ne 'short';
-
-    $out .= "$prefix $args";
-
-    $out .= $opts ? " [OPTIONS]\n" : "\n";
+    if ($format eq 'asciidoc') {
+	$out .= "*${prefix}*";
+	$out .= " `$args`" if $args;
+	$out .= $opts ? " `[OPTIONS]`\n" : "\n";
+    } else {
+	$out .= "USAGE: " if $format ne 'short';
+	$out .= "$prefix $args";
+	$out .= $opts ? " [OPTIONS]\n" : "\n";
+    }
 
     return $out if $format eq 'short';
 
-    if ($info->{description} && $format eq 'full') {
-	my $desc = Text::Wrap::wrap('  ', '  ', ($info->{description}));
-	$out .= "\n$desc\n\n";
+    if ($info->{description}) {
+	if ($format eq 'asciidoc') {
+	    my $desc = Text::Wrap::wrap('', '', ($info->{description}));
+	    $out .= "\n$desc\n\n";
+	} elsif ($format eq 'full') {
+	    my $desc = Text::Wrap::wrap('  ', '  ', ($info->{description}));
+	    $out .= "\n$desc\n\n";
+	}
     }
 
     $out .= $argdescr if $argdescr;
@@ -533,14 +613,60 @@ sub usage_str {
     return $out;
 }
 
+# generate docs from JSON schema properties
+sub dump_properties {
+    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';
+
+	my $base = $k;
+	if ($k =~ m/^([a-z]+)(\d+)$/) {
+	    my $name = $1;
+	    next if $idx_param->{$name};
+	    $idx_param->{$name} = 1;
+	    $base = "${name}[n]";
+	}
+
+	$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 = $@) {
@@ -548,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;
     }