X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FJSONSchema.pm;h=c09a9f474a5413e7c1caa35bd5b9febdebf7eb91;hp=5b5fe1568a234a3c89832d2dba825c38be243952;hb=b21cf5754615b1af8f0a4f8edaa4ab81ebaf4a86;hpb=e43faad9ff27f4d252d5604439c7aab1ff1c6251

diff --git a/src/PVE/JSONSchema.pm b/src/PVE/JSONSchema.pm
index 5b5fe15..c09a9f4 100644
--- a/src/PVE/JSONSchema.pm
+++ b/src/PVE/JSONSchema.pm
@@ -4,6 +4,8 @@ use strict;
 use warnings;
 use Storable; # for dclone
 use Getopt::Long;
+use Encode::Locale;
+use Encode;
 use Devel::Cycle -quiet; # todo: remove?
 use PVE::Tools qw(split_list $IPV6RE $IPV4RE);
 use PVE::Exception qw(raise);
@@ -84,6 +86,12 @@ register_standard_option('pve-config-digest', {
     maxLength => 40, # sha1 hex digest lenght is 40
 });
 
+register_standard_option('skiplock', {
+    description => "Ignore locks - only root is allowed to use this option.",
+    type => 'boolean',
+    optional => 1,
+});
+
 register_standard_option('extra-args', {
     description => "Extra arguments as array",
     type => 'array',
@@ -91,6 +99,12 @@ register_standard_option('extra-args', {
     optional => 1
 });
 
+register_standard_option('fingerprint-sha256', {
+    description => "Certificate SHA 256 fingerprint.",
+    type => 'string',
+    pattern => '([A-Fa-f0-9]{2}:){31}[A-Fa-f0-9]{2}',
+});
+
 my $format_list = {};
 
 sub register_format {
@@ -500,12 +514,30 @@ sub format_size {
     return "${tb}T";
 };
 
+sub parse_boolean {
+    my ($bool) = @_;
+    return 1 if $bool =~ m/^(1|on|yes|true)$/i;
+    return 0 if $bool =~ m/^(0|off|no|false)$/i;
+    return undef;
+}
+
 sub parse_property_string {
     my ($format, $data, $path, $additional_properties) = @_;
 
     # In property strings we default to not allowing additional properties
     $additional_properties = 0 if !defined($additional_properties);
 
+    # Support named formats here, too:
+    if (!ref($format)) {
+	if (my $desc = $format_list->{$format}) {
+	    $format = $desc;
+	} else {
+	    die "unknown format: $format\n";
+	}
+    } elsif (ref($format) ne 'HASH') {
+	die "unexpected format value of type ".ref($format)."\n";
+    }
+
     my $default_key;
 
     my $res = {};
@@ -527,8 +559,7 @@ sub parse_property_string {
 
 	    die "invalid key in comma-separated list property: $k\n" if !$schema;
 	    if ($schema->{type} && $schema->{type} eq 'boolean') {
-		$v = 1 if $v =~ m/^(1|on|yes|true)$/i;
-		$v = 0 if $v =~ m/^(0|off|no|false)$/i;
+		$v = parse_boolean($v) // $v;
 	    }
 	    $res->{$k} = $v;
 	} elsif ($part !~ /=/) {
@@ -645,6 +676,9 @@ sub check_type {
 		return undef;
 	    }
 	    return 1;
+	} elsif ($type eq 'string' && $vt eq 'Regexp') {
+	    # qr// regexes can be used as strings and make sense for format=regex
+	    return 1;
 	} else {
 	    if ($vt) {
 		add_error($errors, $path, "type check ('$type') failed - got $vt");
@@ -658,7 +692,7 @@ sub check_type {
 			return 1;
 		    #} elsif ($value =~ m/^(0|false|no|off)$/i) {
 		    } elsif ($value eq '0') {
-			return 0;
+			return 1; # return success (not value)
 		    } else {
 			add_error($errors, $path, "type check ('$type') failed - got '$value'");
 			return undef;
@@ -717,7 +751,7 @@ sub check_object {
 		    check_prop($value, $requires, $path, $errors);
 		} elsif (!defined($value->{$requires})) {
 		    add_error($errors, $path ? "$path.$requires" : $requires, 
-			      "missing property - '$newpath' requiers this property");
+			      "missing property - '$newpath' requires this property");
 		}
 	    }
 
@@ -1126,11 +1160,21 @@ my $method_schema = {
 	    description => "Method needs special privileges - only pvedaemon can execute it",            
 	    optional => 1,
         },
+        download => {
+            type => 'boolean',
+	    description => "Method downloads the file content (filename is the return value of the method).",
+	    optional => 1,
+        },
 	proxyto => {
 	    type =>  'string',
 	    description => "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter.",
 	    optional => 1,
 	},
+	proxyto_callback => {
+	    type =>  'coderef',
+	    description => "A function which is called to resolve the proxyto attribute. The default implementaion returns the value of the 'proxyto' parameter.",
+	    optional => 1,
+	},
         permissions => {
 	    type => 'object',
 	    description => "Required access permissions. By default only 'root' is allowed to access this method.",
@@ -1176,11 +1220,6 @@ my $method_schema = {
 	    description => "JSON Schema for parameters.",
 	    optional => 1,
 	},
-        formatter => {
-	    type => 'object',
-	    description => "Used to store page formatter information (set by PVE::RESTHandler->register_page_formatter).",
-	    optional => 1,
-        },
 	returns => {
 	    type => 'object',
 	    description => "JSON Schema for return value.",
@@ -1334,17 +1373,30 @@ sub get_options {
 	}
     }
 
-    $opts = PVE::Tools::decode_utf8_parameters($opts);
+    # decode after Getopt as we are not sure how well it handles unicode
+    foreach my $p (keys %$opts) {
+	if (!ref($opts->{$p})) {
+	    $opts->{$p} = decode('locale', $opts->{$p});
+	} elsif (ref($opts->{$p}) eq 'ARRAY') {
+	    my $tmp = [];
+	    foreach my $v (@{$opts->{$p}}) {
+		push @$tmp, decode('locale', $v);
+	    }
+	    $opts->{$p} = $tmp;
+	} elsif (ref($opts->{$p}) eq 'SCALAR') {
+	    $opts->{$p} = decode('locale', $$opts->{$p});
+	} else {
+	    raise("decoding options failed, unknown reference\n", code => HTTP_BAD_REQUEST);
+	}
+    }
 
     foreach my $p (keys %$opts) {
 	if (my $pd = $schema->{properties}->{$p}) {
 	    if ($pd->{type} eq 'boolean') {
 		if ($opts->{$p} eq '') {
 		    $opts->{$p} = 1;
-		} elsif ($opts->{$p} =~ m/^(1|true|yes|on)$/i) {
-		    $opts->{$p} = 1;
-		} elsif ($opts->{$p} =~ m/^(0|false|no|off)$/i) {
-		    $opts->{$p} = 0;
+		} elsif (defined(my $bool = parse_boolean($opts->{$p}))) {
+		    $opts->{$p} = $bool;
 		} else {
 		    raise("unable to parse boolean option\n", code => HTTP_BAD_REQUEST);
 		}
@@ -1397,8 +1449,7 @@ sub parse_config {
 	    if ($schema->{properties}->{$key} && 
 		$schema->{properties}->{$key}->{type} eq 'boolean') {
 
-		$value = 1 if $value =~ m/^(1|on|yes|true)$/i; 
-	        $value = 0 if $value =~ m/^(0|off|no|false)$/i; 
+		$value = parse_boolean($value) // $value;
 	    }
 	    $cfg->{$key} = $value;
 	} else {
@@ -1471,7 +1522,7 @@ my $find_schema_default_key = sub {
 };
 
 sub generate_typetext {
-    my ($format) = @_;
+    my ($format, $list_enums) = @_;
 
     my ($default_key, $keyAliasProps) = &$find_schema_default_key($format);
 
@@ -1504,7 +1555,11 @@ sub generate_typetext {
 	} elsif (my $text = $phash->{typetext}) {
 	    $typetext .= $text;
 	} elsif (my $enum = $phash->{enum}) {
-	    $typetext .= '<' . join('|', @$enum) . '>';
+	    if ($list_enums || (scalar(@$enum) <= 3)) {
+		$typetext .= '<' . join('|', @$enum) . '>';
+	    } else {
+		$typetext .= '<enum>';
+	    }
 	} elsif ($phash->{type} eq 'boolean') {
 	    $typetext .= '<1|0>';
 	} elsif ($phash->{type} eq 'integer') {
@@ -1660,7 +1715,7 @@ sub print_property_string {
 }
 
 sub schema_get_type_text {
-    my ($phash) = @_;
+    my ($phash, $style) = @_;
 
     my $type = $phash->{type} || 'string';
 
@@ -1669,27 +1724,31 @@ sub schema_get_type_text {
     } elsif ($phash->{format_description}) {
 	return "<$phash->{format_description}>";
     } elsif ($phash->{enum}) {
-	return "(" . join(' | ', sort @{$phash->{enum}}) . ")";
+	return "<" . join(' | ', sort @{$phash->{enum}}) . ">";
     } elsif ($phash->{pattern}) {
 	return $phash->{pattern};
     } elsif ($type eq 'integer' || $type eq 'number') {
+	# NOTE: always access values as number (avoid converion to string)
 	if (defined($phash->{minimum}) && defined($phash->{maximum})) {
-	    return "$type ($phash->{minimum} - $phash->{maximum})";
+	    return "<$type> (" . ($phash->{minimum} + 0) . " - " .
+		($phash->{maximum} + 0) . ")";
 	} elsif (defined($phash->{minimum})) {
-	    return "$type ($phash->{minimum} - N)";
+	    return "<$type> (" . ($phash->{minimum} + 0) . " - N)";
 	} elsif (defined($phash->{maximum})) {
-	    return "$type (-N - $phash->{maximum})";
+	    return "<$type> (-N - " . ($phash->{maximum} + 0) . ")";
 	}
     } elsif ($type eq 'string') {
 	if (my $format = $phash->{format}) {
 	    $format = get_format($format) if ref($format) ne 'HASH';
 	    if (ref($format) eq 'HASH') {
-		return generate_typetext($format);
+		my $list_enums = 0;
+		$list_enums = 1 if $style && $style eq 'config-sub';
+		return generate_typetext($format, $list_enums);
 	    }
 	}
     }
 
-    return $type;
+    return "<$type>";
 }
 
 1;