rename $pwcallback to $read_password_func
[pve-common.git] / src / PVE / RESTHandler.pm
index ca3f99b..0a64158 100644 (file)
@@ -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\]";
-               } elsif (defined($d->{$1.'0'})) {
+               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
                }
            }
-           $res->{$k}->{$p} = ref($pd) ? clone($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 (!(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;
        }
     }
 
@@ -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 {
@@ -408,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 = '';
 
@@ -418,43 +404,50 @@ 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 && $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') {
 
        if ($style eq 'config') {
            $res .= "`$name`: ";
+       } 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') {
+           $res .= ";;\n\n";
+       } else {
+           $res .= "::\n\n";
        }
-       $res .= "::\n\n";
 
-       my $wdescr = Text::Wrap::wrap('', '', ($descr));
+       my $wdescr = $descr;
        chomp $wdescr;
        $wdescr =~ s/^$/+/mg;
 
@@ -484,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));
@@ -504,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
@@ -517,9 +541,9 @@ my $get_property_description = sub {
 #   '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
+# $param_mapping_func ... mapping for string parameters to file path parameters
 sub usage_str {
-    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $stringfilemap) = @_;
+    my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $param_mapping_func) = @_;
 
     $format = 'long' if !$format;
 
@@ -562,25 +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]";
+           }
        }
 
-       my $mapping = defined($stringfilemap) ? &$stringfilemap($name) : undef;
+       my $param_mapping_hash = $compute_param_mapping_hash->(&$param_mapping_func($name))
+           if $param_mapping_func;
+
        $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>"
        }
     } 
 
@@ -627,46 +655,63 @@ sub dump_properties {
        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);
+       }
+
+       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, $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;
 };
 
 sub cli_handler {
-    my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $pwcallback, $stringfilemap) = @_;
+    my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $read_password_func, $param_mapping_func) = @_;
 
     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);
+       my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $read_password_func);
+
+       if (defined($param_mapping_func)) {
+           my $param_mapping_hash = $compute_param_mapping_hash->(&$param_mapping_func($name));
+           &$replace_file_names_with_contents($param, $param_mapping_hash);
+       }
+
        $res = $self->handle($info, $param);
     };
     if (my $err = $@) {
@@ -674,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, $stringfilemap);
+       $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $read_password_func, $param_mapping_func);
 
        die $err;
     }