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

diff --git a/src/PVE/RESTHandler.pm b/src/PVE/RESTHandler.pm
index ad0f929..75d5d2e 100644
--- a/src/PVE/RESTHandler.pm
+++ b/src/PVE/RESTHandler.pm
@@ -6,10 +6,10 @@ 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 Storable qw(dclone);
+use Clone qw(clone);
 
 my $method_registry = {};
 my $method_by_name = {};
@@ -17,8 +17,35 @@ my $method_path_lookup = {};
 
 our $AUTOLOAD;  # it's a package global
 
+our $standard_output_options = {
+    'output-format' => PVE::JSONSchema::get_standard_option('pve-output-format'),
+    noheader => {
+	description => "Do not show column headers (for 'text' format).",
+	type => 'boolean',
+	optional => 1,
+	default => 0,
+    },
+    noborder => {
+	description => "Do not draw borders (for 'text' format).",
+	type => 'boolean',
+	optional => 1,
+	default => 0,
+    },
+    quiet => {
+        description => "Suppress printing results.",
+        type => 'boolean',
+        optional => 1,
+    },
+    'human-readable' => {
+        description => "Call output rendering functions to produce human readable text.",
+        type => 'boolean',
+        optional => 1,
+	default => 1,
+    }
+};
+
 sub api_clone_schema {
-    my ($schema) = @_;
+    my ($schema, $no_typetext) = @_;
 
     my $res = {};
     my $ref = ref($schema);
@@ -27,20 +54,30 @@ 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]
 	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 ($idx > 0 && defined($d->{"${name}0"})) {
+		    next; # only handle once for -xx0, but only if -xx0 exists
 		}
 	    }
-	    $res->{$k}->{$p} = ref($pd) ? dclone($pd) : $pd;
+	    my $tmp = ref($pd) ? clone($pd) : $pd;
+	    # NOTE: add typetext property for more complex types, to
+	    # make the web api viewer code simpler
+	    if (!$no_typetext && !(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} = $tmp;
 	}
     }
 
@@ -48,7 +85,7 @@ sub api_clone_schema {
 }
 
 sub api_dump_full {
-    my ($tree, $index, $class, $prefix) = @_;
+    my ($tree, $index, $class, $prefix, $raw_dump) = @_;
 
     $prefix = '' if !$prefix;
 
@@ -60,7 +97,7 @@ sub api_dump_full {
 	$path =~ s/\/+$//;
 
 	if ($info->{subclass}) {
-	    api_dump_full($tree, $index, $info->{subclass}, $path);
+	    api_dump_full($tree, $index, $info->{subclass}, $path, $raw_dump);
 	} else {
 	    next if !$path;
 
@@ -100,12 +137,17 @@ sub api_dump_full {
 			$k eq "path";
 
 		    my $d = $info->{$k};
-		    
-		    if ($k eq 'parameters') {
-			$data->{$k} = api_clone_schema($d);
-		    } else {
 
-			$data->{$k} = ref($d) ? dclone($d) : $d;
+		    if ($raw_dump) {
+			$data->{$k} = $d;
+		    } else {
+			if ($k eq 'parameters') {
+			    $data->{$k} = api_clone_schema($d);
+			} elsif ($k eq 'returns') {
+			    $data->{$k} = api_clone_schema($d, 1);
+			} else {
+			    $data->{$k} = ref($d) ? clone($d) : $d;
+			}
 		    }
 		} 
 		$res->{info}->{$info->{method}} = $data;
@@ -129,13 +171,46 @@ sub api_dump_cleanup_tree {
 
 }
 
+# api_dump_remove_refs: prepare API tree for use with to_json($tree)
+sub api_dump_remove_refs {
+    my ($tree) = @_;
+
+    my $class = ref($tree);
+    return $tree if !$class;
+
+    if ($class eq 'ARRAY') {
+	my $res = [];
+	foreach my $el (@$tree) {
+	    push @$res, api_dump_remove_refs($el);
+	}
+	return $res;
+    } elsif ($class eq 'HASH') {
+	my $res = {};
+	foreach my $k (keys %$tree) {
+	    if (my $itemclass = ref($tree->{$k})) {
+		if ($itemclass eq 'CODE') {
+		    next if $k eq 'completion';
+		}
+		$res->{$k} = api_dump_remove_refs($tree->{$k});
+	    } else {
+		$res->{$k} = $tree->{$k};
+	    }
+	}
+	return $res;
+    } elsif ($class eq 'Regexp') {
+	return "$tree"; # return string representation
+    } else {
+	die "unknown class '$class'\n";
+    }
+}
+
 sub api_dump {
-    my ($class, $prefix) = @_;
+    my ($class, $prefix, $raw_dump) = @_;
 
     my $tree = [];
 
     my $index = {};
-    api_dump_full($tree, $index, $class);
+    api_dump_full($tree, $index, $class, $prefix, $raw_dump);
     api_dump_cleanup_tree($tree);
     return $tree;
 };
@@ -240,31 +315,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 {
@@ -386,41 +436,205 @@ 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); 
+    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', 'config-sub', 'arg' or 'fixed'
+# $mapdef: parameter mapping ({ desc => XXX, func => sub {...} })
+my $get_property_description = sub {
+    my ($name, $style, $phash, $format, $mapdef) = @_;
+
+    my $res = '';
+
+    $format = 'asciidoc' if !defined($format);
+
+    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_text = PVE::JSONSchema::schema_get_type_text($phash, $style);
+
+    if ($mapdef && $phash->{type} eq 'string') {
+	$type_text = $mapdef->{desc};
+    }
+
+    if ($format eq 'asciidoc') {
+
+	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 {
+	    die "unknown style '$style'";
+	}
+
+	$res .= "`$type_text` " if $type_text;
+
+	if (defined(my $dv = $phash->{default})) {
+	    $res .= "('default =' `$dv`)";
+	}
+
+	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;
+	    $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%s\n", $display_name, "$type_text", "$defaulttxt";
+	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;
+};
+
+# 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, $interactive);
+	if (ref($item) eq 'ARRAY') {
+	    ($name, $func, $desc, $interactive) = @$item;
+	} elsif (ref($item) eq 'HASH') {
+	    # just use the hash
+	    $res->{$item->{name}} = $item;
+	    next;
+	} else {
+	    $name = $item;
+	    $func = sub { return PVE::Tools::file_get_contents($_[0]) };
+	}
+	$desc //= '<filepath>';
+	$res->{$name} = { desc => $desc, func => $func, interactive => $interactive };
+    }
+
+    return $res;
+};
+
 # generate usage information for command line tools
 #
-# $name        ... the name of the method
+# $info        ... method info
 # $prefix      ... usually something like "$exename $cmd" ('pvesm add')
 # $arg_param   ... list of parameters we want to get as ordered arguments 
 #                  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
-# $hidepw      ... hide password option (use this if you provide a read passwork callback)
-sub usage_str {
-    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw) = @_;
+#   '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')
+# $param_cb    ... mapping for string parameters to file path parameters
+# $formatter_properties  ... additional property definitions (passed to output formatter)
+sub getopt_usage {
+    my ($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
 
     $format = 'long' if !$format;
 
-    my $info = $self->map_method_by_name($name);
     my $schema = $info->{parameters};
-    my $prop = $schema->{properties};
+    my $name = $info->{name};
+    my $prop = { %{$schema->{properties}} }; # copy
+
+    my $has_output_format_option = $formatter_properties->{'output-format'} ? 1 : 0;
+
+    if ($formatter_properties) {
+	foreach my $key (keys %$formatter_properties) {
+	    if (!$standard_output_options->{$key}) {
+		$prop->{$key} = $formatter_properties->{$key};
+	    }
+	}
+    }
+
+    # also remove $standard_output_options from $prop (pvesh, pveclient)
+    if ($prop->{'output-format'}) {
+	$has_output_format_option = 1;
+	foreach my $key (keys %$prop) {
+	    if ($standard_output_options->{$key}) {
+		delete $prop->{$key};
+	    }
+	}
+    }
 
     my $out = '';
 
@@ -443,47 +657,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);
     }
 
     my $idx_param = {}; # -vlan\d+ -scsi\d+
@@ -493,37 +671,59 @@ 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 $param_map = {};
+
+	if (defined($param_cb)) {
+	    my $mapping = $param_cb->($name);
+	    $param_map = $compute_param_mapping_hash->($mapping);
+	    next if $k eq 'password' && $param_map->{$k} && !$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_prop_descr($k, "-$base");
+
+	$opts .= $get_property_description->($base, 'arg', $prop->{$k}, $format, $param_map->{$k});
 
 	if (!$prop->{$k}->{optional}) {
 	    $args .= " " if $args;
-	    $args .= "-$base <$type>"
+	    $args .= "--$base <$type_text>"
 	}
     } 
 
-    $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 .= " `[OPTIONS]`" if $opts;
+	$out .= " `[FORMAT_OPTIONS]`" if $has_output_format_option;
+	$out .= "\n";
+    } else {
+	$out .= "USAGE: " if $format ne 'short';
+	$out .= "$prefix $args";
+	$out .= " [OPTIONS]" if $opts;
+	$out .= " [FORMAT_OPTIONS]" if $has_output_format_option;
+	$out .= "\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 +733,125 @@ sub usage_str {
     return $out;
 }
 
-sub cli_handler {
-    my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback) = @_;
+sub usage_str {
+    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties) = @_;
 
     my $info = $self->map_method_by_name($name);
 
+    return getopt_usage($info, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
+}
+
+# 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);
+	next if $phash->{alias};
+
+	my $base = $k;
+	if ($k =~ m/^([a-z]+)(\d+)$/) {
+	    my ($name, $idx) = ($1, $2);
+	    next if $idx_param->{$name};
+	    if ($idx == 0 && defined($prop->{"${name}1"})) {
+		$idx_param->{$name} = 1;
+		$base = "${name}[n]";
+	    }
+	}
+
+	$raw .= $get_property_description->($base, $style, $phash, $format);
+
+	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);
+	}
+
+	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_map) = @_;
+
+    while (my ($k, $d) = each %$param_map) {
+	next if $d->{interactive}; # handled by the JSONSchema's get_options code
+	$param->{$k} = $d->{func}->($param->{$k})
+	    if defined($param->{$k});
+    }
+
+    return $param;
+};
+
+sub add_standard_output_properties {
+    my ($propdef, $list) = @_;
+
+    $propdef //= {};
+
+    $list //= [ keys %$standard_output_options ];
+
+    my $res = { %$propdef }; # copy
+
+    foreach my $opt (@$list) {
+	die "no such standard output option '$opt'\n" if !defined($standard_output_options->{$opt});
+	die "detected overwriten standard CLI parameter '$opt'\n" if defined($res->{$opt});
+	$res->{$opt} = $standard_output_options->{$opt};
+    }
+
+    return $res;
+}
+
+sub extract_standard_output_properties {
+    my ($data) = @_;
+
+    my $options = {};
+    foreach my $opt (keys %$standard_output_options) {
+	$options->{$opt} = delete $data->{$opt} if defined($data->{$opt});
+    }
+
+    return $options;
+}
+
+sub cli_handler {
+    my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $param_cb, $formatter_properties) = @_;
+
+    my $info = $self->map_method_by_name($name);
     my $res;
+    my $fmt_param = {};
+
     eval {
-	my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $pwcallback);
+	my $param_map = {};
+	$param_map = $compute_param_mapping_hash->($param_cb->($name)) if $param_cb;
+	my $schema = { %{$info->{parameters}} }; # copy
+	$schema->{properties} = { %{$schema->{properties}}, %$formatter_properties } if $formatter_properties;
+	my $param = PVE::JSONSchema::get_options($schema, $args, $arg_param, $fixed_param, $param_map);
+
+	if ($formatter_properties) {
+	    foreach my $opt (keys %$formatter_properties) {
+		$fmt_param->{$opt} = delete $param->{$opt} if defined($param->{$opt});
+	    }
+	}
+
+	if (defined($param_map)) {
+	    $replace_file_names_with_contents->($param, $param_map);
+	}
+
 	$res = $self->handle($info, $param);
     };
     if (my $err = $@) {
@@ -548,12 +859,12 @@ 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', $param_cb, $formatter_properties);
 
 	die $err;
     }
 
-    return $res;
+    return wantarray ? ($res, $fmt_param) : $res;
 }
 
 # utility methods