X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FJSONSchema.pm;h=936c3cfa7feeea0527ef19e963858374c02db99f;hp=f90d98c590f279a6461493562f2cee9020be71b7;hb=79501b2a58a7cd5d43c0014fbd336ccfd5fbdc03;hpb=2289890bade3f346a540631245d5c52fa1e08392

diff --git a/src/PVE/JSONSchema.pm b/src/PVE/JSONSchema.pm
index f90d98c..936c3cf 100644
--- a/src/PVE/JSONSchema.pm
+++ b/src/PVE/JSONSchema.pm
@@ -84,6 +84,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',
@@ -229,7 +235,9 @@ my $ipv4_mask_hash = {
     '255.255.255.224' => 27,
     '255.255.255.240' => 28,
     '255.255.255.248' => 29,
-    '255.255.255.252' => 30
+    '255.255.255.252' => 30,
+    '255.255.255.254' => 31,
+    '255.255.255.255' => 32,
 };
 
 register_format('ipv4mask', \&pve_verify_ipv4mask);
@@ -504,6 +512,17 @@ sub parse_property_string {
     # 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 = {};
@@ -643,6 +662,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");
@@ -656,7 +678,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;
@@ -715,7 +737,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");
 		}
 	    }
 
@@ -978,6 +1000,11 @@ my $default_schema_noref = {
 	    optional => 1,
 	    description => "This provides a description of the purpose the instance property. The value can be a string or it can be an object with properties corresponding to various different instance languages (with an optional default property indicating the default description).",
 	},
+	verbose_description => {
+	    type => "string",
+	    optional => 1,
+	    description => "This provides a more verbose description.",
+	},
 	format_description => {
 	    type => "string",
 	    optional => 1,
@@ -1169,11 +1196,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.",
@@ -1464,7 +1486,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);
 
@@ -1497,7 +1519,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') {
@@ -1596,7 +1622,7 @@ sub print_property_string {
     my $done = { map { $_ => 1 } @$skip };
 
     my $cond_add_key = sub {
-	my ($key) = @_;
+	my ($key, $isdefault) = @_;
 
 	return if $done->{$key}; # avoid duplicates
 
@@ -1628,11 +1654,15 @@ sub print_property_string {
 	die "internal error" if defined($phash->{alias});
 
 	my $value_str = &$format_value($key, $value, $phash->{format});
-	&$add_option_string("$key=${value_str}");
+	if ($isdefault) {
+	    &$add_option_string($value_str);
+	} else {
+	    &$add_option_string("$key=${value_str}");
+	}
     };
 
     # add default key first
-    &$cond_add_key($default_key) if defined($default_key);
+    &$cond_add_key($default_key, 1) if defined($default_key);
 
     # add required keys first
     foreach my $key (sort keys %$data) {
@@ -1649,36 +1679,40 @@ sub print_property_string {
 }
 
 sub schema_get_type_text {
-    my ($phash) = @_;
+    my ($phash, $style) = @_;
+
+    my $type = $phash->{type} || 'string';
 
     if ($phash->{typetext}) {
 	return $phash->{typetext};
     } 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 ($phash->{type} eq 'integer' || $phash->{type} eq 'number') {
+    } 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 "$phash->{type} ($phash->{minimum} - $phash->{maximum})";
+	    return "<$type> (" . ($phash->{minimum} + 0) . " - " .
+		($phash->{maximum} + 0) . ")";
 	} elsif (defined($phash->{minimum})) {
-	    return "$phash->{type} ($phash->{minimum} - N)";
+	    return "<$type> (" . ($phash->{minimum} + 0) . " - N)";
 	} elsif (defined($phash->{maximum})) {
-	    return "$phash->{type} (-N - $phash->{maximum})";
+	    return "<$type> (-N - " . ($phash->{maximum} + 0) . ")";
 	}
-    } elsif ($phash->{type} eq 'string') {
+    } 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);
 	    }
 	}
     }
 
-    my $type = $phash->{type} || 'string';
-
-    return $type;
+    return "<$type>";
 }
 
 1;