]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/JSONSchema.pm
1 package PVE
:: JSONSchema
;
5 use Storable
; # for dclone
7 use Devel
:: Cycle
- quiet
; # todo: remove?
8 use PVE
:: Tools
qw(split_list $IPV6RE $IPV4RE ) ;
9 use PVE
:: Exception
qw(raise) ;
10 use HTTP
:: Status
qw(:constants) ;
11 use Net
:: IP
qw(:PROC) ;
16 register_standard_option
20 # Note: This class implements something similar to JSON schema, but it is not 100% complete.
21 # see: http://tools.ietf.org/html/draft-zyp-json-schema-02
22 # see: http://json-schema.org/
24 # the code is similar to the javascript parser from http://code.google.com/p/jsonschema/
26 my $standard_options = {};
27 sub register_standard_option
{
28 my ( $name, $schema ) = @_ ;
30 die "standard option ' $name ' already registered \n "
31 if $standard_options ->{ $name };
33 $standard_options ->{ $name } = $schema ;
36 sub get_standard_option
{
37 my ( $name, $base ) = @_ ;
39 my $std = $standard_options ->{ $name };
40 die "no such standard option ' $name ' \n " if ! $std ;
42 my $res = $base || {};
44 foreach my $opt ( keys %$std ) {
45 next if defined ( $res ->{ $opt });
46 $res ->{ $opt } = $std ->{ $opt };
52 register_standard_option
( 'pve-vmid' , {
53 description
=> "The (unique) ID of the VM." ,
54 type
=> 'integer' , format
=> 'pve-vmid' ,
58 register_standard_option
( 'pve-node' , {
59 description
=> "The cluster node name." ,
60 type
=> 'string' , format
=> 'pve-node' ,
63 register_standard_option
( 'pve-node-list' , {
64 description
=> "List of cluster node names." ,
65 type
=> 'string' , format
=> 'pve-node-list' ,
68 register_standard_option
( 'pve-iface' , {
69 description
=> "Network interface name." ,
70 type
=> 'string' , format
=> 'pve-iface' ,
71 minLength
=> 2 , maxLength
=> 20 ,
74 PVE
:: JSONSchema
:: register_standard_option
( 'pve-storage-id' , {
75 description
=> "The storage identifier." ,
76 type
=> 'string' , format
=> 'pve-storage-id' ,
79 PVE
:: JSONSchema
:: register_standard_option
( 'pve-config-digest' , {
80 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.' ,
83 maxLength
=> 40 , # sha1 hex digest lenght is 40
86 PVE
:: JSONSchema
:: register_standard_option
( 'extra-args' , {
87 description
=> "Extra arguments as array" ,
89 items
=> { type
=> 'string' },
96 my ( $format, $code ) = @_ ;
98 die "JSON schema format ' $format ' already registered \n "
99 if $format_list ->{ $format };
101 $format_list ->{ $format } = $code ;
104 # register some common type for pve
106 register_format
( 'string' , sub {}); # allow format => 'string-list'
108 register_format
( 'pve-configid' , \
& pve_verify_configid
);
109 sub pve_verify_configid
{
110 my ( $id, $noerr ) = @_ ;
112 if ( $id !~ m/^[a-z][a-z0-9_]+$/i ) {
113 return undef if $noerr ;
114 die "invalid configuration ID ' $id ' \n " ;
119 PVE
:: JSONSchema
:: register_format
( 'pve-storage-id' , \
& parse_storage_id
);
120 sub parse_storage_id
{
121 my ( $storeid, $noerr ) = @_ ;
123 if ( $storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i ) {
124 return undef if $noerr ;
125 die "storage ID ' $storeid ' contains illegal characters \n " ;
131 register_format
( 'pve-vmid' , \
& pve_verify_vmid
);
132 sub pve_verify_vmid
{
133 my ( $vmid, $noerr ) = @_ ;
135 if ( $vmid !~ m/^[1-9][0-9]+$/ ) {
136 return undef if $noerr ;
137 die "value does not look like a valid VM ID \n " ;
142 register_format
( 'pve-node' , \
& pve_verify_node_name
);
143 sub pve_verify_node_name
{
144 my ( $node, $noerr ) = @_ ;
146 if ( $node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)$/ ) {
147 return undef if $noerr ;
148 die "value does not look like a valid node name \n " ;
153 register_format
( 'ipv4' , \
& pve_verify_ipv4
);
154 sub pve_verify_ipv4
{
155 my ( $ipv4, $noerr ) = @_ ;
157 if ( $ipv4 !~ m/^(?:$IPV4RE)$/ ) {
158 return undef if $noerr ;
159 die "value does not look like a valid IPv4 address \n " ;
164 register_format
( 'ipv6' , \
& pve_verify_ipv6
);
165 sub pve_verify_ipv6
{
166 my ( $ipv6, $noerr ) = @_ ;
168 if ( $ipv6 !~ m/^(?:$IPV6RE)$/ ) {
169 return undef if $noerr ;
170 die "value does not look like a valid IPv6 address \n " ;
175 register_format
( 'ip' , \
& pve_verify_ip
);
177 my ( $ip, $noerr ) = @_ ;
179 if ( $ip !~ m/^(?:(?:$IPV4RE)|(?:$IPV6RE))$/ ) {
180 return undef if $noerr ;
181 die "value does not look like a valid IP address \n " ;
186 my $ipv4_mask_hash = {
203 '255.255.128.0' => 17 ,
204 '255.255.192.0' => 18 ,
205 '255.255.224.0' => 19 ,
206 '255.255.240.0' => 20 ,
207 '255.255.248.0' => 21 ,
208 '255.255.252.0' => 22 ,
209 '255.255.254.0' => 23 ,
210 '255.255.255.0' => 24 ,
211 '255.255.255.128' => 25 ,
212 '255.255.255.192' => 26 ,
213 '255.255.255.224' => 27 ,
214 '255.255.255.240' => 28 ,
215 '255.255.255.248' => 29 ,
216 '255.255.255.252' => 30
219 register_format
( 'ipv4mask' , \
& pve_verify_ipv4mask
);
220 sub pve_verify_ipv4mask
{
221 my ( $mask, $noerr ) = @_ ;
223 if (! defined ( $ipv4_mask_hash ->{ $mask })) {
224 return undef if $noerr ;
225 die "value does not look like a valid IP netmask \n " ;
230 register_format
( 'CIDR' , \
& pve_verify_cidr
);
231 sub pve_verify_cidr
{
232 my ( $cidr, $noerr ) = @_ ;
234 if ( $cidr =~ m!^(?:$IPV4RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 < 32 )) {
236 } elsif ( $cidr =~ m!^(?:$IPV6RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 120 )) {
240 return undef if $noerr ;
241 die "value does not look like a valid CIDR network \n " ;
244 register_format
( 'email' , \
& pve_verify_email
);
245 sub pve_verify_email
{
246 my ( $email, $noerr ) = @_ ;
248 # we use same regex as in Utils.js
249 if ( $email !~ /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,63}$/ ) {
250 return undef if $noerr ;
251 die "value does not look like a valid email address \n " ;
256 register_format
( 'dns-name' , \
& pve_verify_dns_name
);
257 sub pve_verify_dns_name
{
258 my ( $name, $noerr ) = @_ ;
260 my $namere = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)" ;
262 if ( $name !~ /^(${namere}\.)*${namere}$/ ) {
263 return undef if $noerr ;
264 die "value does not look like a valid DNS name \n " ;
269 # network interface name
270 register_format
( 'pve-iface' , \
& pve_verify_iface
);
271 sub pve_verify_iface
{
272 my ( $id, $noerr ) = @_ ;
274 if ( $id !~ m/^[a-z][a-z0-9_]{1,20}([:\.]\d+)?$/i ) {
275 return undef if $noerr ;
276 die "invalid network interface name ' $id ' \n " ;
281 # general addresses by name or IP
282 register_format
( 'address' , \
& pve_verify_address
);
283 sub pve_verify_address
{
284 my ( $addr, $noerr ) = @_ ;
286 if (!( pve_verify_ip
( $addr, 1 ) ||
287 pve_verify_dns_name
( $addr, 1 )))
289 return undef if $noerr ;
290 die "value does not look like a valid address: $addr\n " ;
295 register_standard_option
( 'spice-proxy' , {
296 description
=> "SPICE proxy server. This can be used by the client to specify the proxy server. All nodes in a cluster runs 'spiceproxy', so it is up to the client to choose one. By default, we return the node where the VM is currently running. As resonable setting is to use same node you use to connect to the API (This is window.location.hostname for the JS GUI)." ,
297 type
=> 'string' , format
=> 'address' ,
300 register_standard_option
( 'remote-viewer-config' , {
301 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
302 additionalProperties
=> 1 ,
304 type
=> { type
=> 'string' },
305 password
=> { type
=> 'string' },
306 proxy
=> { type
=> 'string' },
307 host
=> { type
=> 'string' },
308 'tls-port' => { type
=> 'integer' },
312 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
313 sub pve_verify_startup_order
{
314 my ( $value, $noerr ) = @_ ;
316 return $value if pve_parse_startup_order
( $value );
318 return undef if $noerr ;
320 die "unable to parse startup options \n " ;
323 sub pve_parse_startup_order
{
326 return undef if ! $value ;
330 foreach my $p ( split ( /,/ , $value )) {
331 next if $p =~ m/^\s*$/ ;
333 if ( $p =~ m/^(order=)?(\d+)$/ ) {
335 } elsif ( $p =~ m/^up=(\d+)$/ ) {
337 } elsif ( $p =~ m/^down=(\d+)$/ ) {
347 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
348 description
=> "Startup and shutdown behavior. Order is a non-negative number defining the general startup order. Shutdown in done with reverse ordering. Additionally you can set the 'up' or 'down' delay in seconds, which specifies a delay to wait before the next VM is started or stopped." ,
350 type
=> 'string' , format
=> 'pve-startup-order' ,
351 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
355 my ( $format, $value ) = @_ ;
357 return if $format eq 'regex' ;
359 if ( $format =~ m/^(.*)-a?list$/ ) {
361 my $code = $format_list ->{ $1 };
363 die "undefined format ' $format ' \n " if ! $code ;
365 # Note: we allow empty lists
366 foreach my $v ( split_list
( $value )) {
370 } elsif ( $format =~ m/^(.*)-opt$/ ) {
372 my $code = $format_list ->{ $1 };
374 die "undefined format ' $format ' \n " if ! $code ;
376 return if ! $value ; # allow empty string
382 my $code = $format_list ->{ $format };
384 die "undefined format ' $format ' \n " if ! $code ;
391 my ( $errors, $path, $msg ) = @_ ;
393 $path = '_root' if ! $path ;
395 if ( $errors ->{ $path }) {
396 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
398 $errors ->{ $path } = $msg ;
405 # see 'man perlretut'
406 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
412 return $value =~ m/^[+-]?\d+$/ ;
416 my ( $path, $type, $value, $errors ) = @_ ;
420 if (! defined ( $value )) {
421 return 1 if $type eq 'null' ;
425 if ( my $tt = ref ( $type )) {
426 if ( $tt eq 'ARRAY' ) {
427 foreach my $t ( @$type ) {
429 check_type
( $path, $t, $value, $tmperr );
430 return 1 if ! scalar ( %$tmperr );
432 my $ttext = join ( '|' , @$type );
433 add_error
( $errors, $path, "type check (' $ttext ') failed" );
435 } elsif ( $tt eq 'HASH' ) {
437 check_prop
( $value, $type, $path, $tmperr );
438 return 1 if ! scalar ( %$tmperr );
439 add_error
( $errors, $path, "type check failed" );
442 die "internal error - got reference type ' $tt '" ;
447 return 1 if $type eq 'any' ;
449 if ( $type eq 'null' ) {
450 if ( defined ( $value )) {
451 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
457 my $vt = ref ( $value );
459 if ( $type eq 'array' ) {
460 if (! $vt || $vt ne 'ARRAY' ) {
461 add_error
( $errors, $path, "type check (' $type ') failed" );
465 } elsif ( $type eq 'object' ) {
466 if (! $vt || $vt ne 'HASH' ) {
467 add_error
( $errors, $path, "type check (' $type ') failed" );
471 } elsif ( $type eq 'coderef' ) {
472 if (! $vt || $vt ne 'CODE' ) {
473 add_error
( $errors, $path, "type check (' $type ') failed" );
479 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
482 if ( $type eq 'string' ) {
483 return 1 ; # nothing to check ?
484 } elsif ( $type eq 'boolean' ) {
485 #if ($value =~ m/^(1|true|yes|on)$/i) {
488 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
489 } elsif ( $value eq '0' ) {
492 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
495 } elsif ( $type eq 'integer' ) {
496 if (! is_integer
( $value )) {
497 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
501 } elsif ( $type eq 'number' ) {
502 if (! is_number
( $value )) {
503 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
508 return 1 ; # no need to verify unknown types
518 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
520 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
522 my $st = ref ( $schema );
523 if (! $st || $st ne 'HASH' ) {
524 add_error
( $errors, $path, "Invalid schema definition." );
528 my $vt = ref ( $value );
529 if (! $vt || $vt ne 'HASH' ) {
530 add_error
( $errors, $path, "an object is required" );
534 foreach my $k ( keys %$schema ) {
535 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
538 foreach my $k ( keys %$value ) {
540 my $newpath = $path ?
" $path . $k " : $k ;
542 if ( my $subschema = $schema ->{ $k }) {
543 if ( my $requires = $subschema ->{ requires
}) {
544 if ( ref ( $requires )) {
545 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
546 check_prop
( $value, $requires, $path, $errors );
547 } elsif (! defined ( $value ->{ $requires })) {
548 add_error
( $errors, $path ?
" $path . $requires " : $requires,
549 "missing property - ' $newpath ' requiers this property" );
553 next ; # value is already checked above
556 if ( defined ( $additional_properties ) && ! $additional_properties ) {
557 add_error
( $errors, $newpath, "property is not defined in schema " .
558 "and the schema does not allow additional properties" );
561 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
562 if ref ( $additional_properties );
567 my ( $value, $schema, $path, $errors ) = @_ ;
569 die "internal error - no schema" if ! $schema ;
570 die "internal error" if ! $errors ;
572 #print "check_prop $path\n" if $value;
574 my $st = ref ( $schema );
575 if (! $st || $st ne 'HASH' ) {
576 add_error
( $errors, $path, "Invalid schema definition." );
580 # if it extends another schema, it must pass that schema as well
581 if ( $schema ->{ extends
}) {
582 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
585 if (! defined ( $value )) {
586 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
587 if (! $schema ->{ optional
}) {
588 add_error
( $errors, $path, "property is missing and it is not optional" );
593 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
595 if ( $schema ->{ disallow
}) {
597 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
598 add_error
( $errors, $path, "disallowed value was matched" );
603 if ( my $vt = ref ( $value )) {
605 if ( $vt eq 'ARRAY' ) {
606 if ( $schema ->{ items
}) {
607 my $it = ref ( $schema ->{ items
});
608 if ( $it && $it eq 'ARRAY' ) {
609 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
610 die "not implemented" ;
613 foreach my $el ( @$value ) {
614 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
620 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
621 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
622 $value, $schema ->{ additionalProperties
}, $errors );
628 if ( my $format = $schema ->{ format
}) {
629 eval { check_format
( $format, $value ); };
631 add_error
( $errors, $path, "invalid format - $@ " );
636 if ( my $pattern = $schema ->{ pattern
}) {
637 if ( $value !~ m/^$pattern$/ ) {
638 add_error
( $errors, $path, "value does not match the regex pattern" );
643 if ( defined ( my $max = $schema ->{ maxLength
})) {
644 if ( length ( $value ) > $max ) {
645 add_error
( $errors, $path, "value may only be $max characters long" );
650 if ( defined ( my $min = $schema ->{ minLength
})) {
651 if ( length ( $value ) < $min ) {
652 add_error
( $errors, $path, "value must be at least $min characters long" );
657 if ( is_number
( $value )) {
658 if ( defined ( my $max = $schema ->{ maximum
})) {
660 add_error
( $errors, $path, "value must have a maximum value of $max " );
665 if ( defined ( my $min = $schema ->{ minimum
})) {
667 add_error
( $errors, $path, "value must have a minimum value of $min " );
673 if ( my $ea = $schema ->{ enum
}) {
676 foreach my $ev ( @$ea ) {
683 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
684 join ( ", " , @$ea ) . "'" );
691 my ( $instance, $schema, $errmsg ) = @_ ;
694 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
696 # todo: cycle detection is only needed for debugging, I guess
697 # we can disable that in the final release
698 # todo: is there a better/faster way to detect cycles?
700 find_cycle
( $instance, sub { $cycles = 1 });
702 add_error
( $errors, undef , "data structure contains recursive cycles" );
704 check_prop
( $instance, $schema, '' , $errors );
707 if ( scalar ( %$errors )) {
708 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
714 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
715 my $default_schema_noref = {
716 description
=> "This is the JSON Schema for JSON Schemas." ,
717 type
=> [ "object" ],
718 additionalProperties
=> 0 ,
721 type
=> [ "string" , "array" ],
722 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
727 enum
=> $schema_valid_types,
729 enum
=> $schema_valid_types,
733 description
=> "This indicates that the instance property in the instance object is not required." ,
739 description
=> "This is a definition for the properties of an object value" ,
745 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
749 additionalProperties
=> {
750 type
=> [ "boolean" , "object" ],
751 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
758 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
763 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
767 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
774 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
780 description
=> "A text representation of the type (used to generate documentation)." ,
785 description
=> "When the instance value is a string, this provides a regular expression that a instance string value should match in order to be valid." ,
793 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
798 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)." ,
803 description
=> "This provides the title of the property" ,
806 type
=> [ "string" , "object" ],
808 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
813 description
=> "This indicates what format the data is among some predefined formats which may include: \n\n date - a string following the ISO format \n address \n schema - a schema definition object \n person \n page \n html - a string representing HTML" ,
818 description
=> "This indicates the default for the instance property."
822 description
=> "Bash completion function. This function should return a list of possible values." ,
828 description
=> "This attribute may take the same values as the \" type \" attribute, however if the instance matches the type or if this value is an array and the instance matches any type or schema in the array, than this instance is not valid." ,
833 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
836 # this is from hyper schema
839 description
=> "This defines the link relations of the instance objects" ,
846 description
=> "This defines the target URL for the relation and can be parameterized using {propertyName} notation. It should be resolved as a URI-reference relative to the URI that was used to retrieve the instance document" ,
850 description
=> "This is the name of the link relation" ,
856 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
866 my $default_schema = Storable
:: dclone
( $default_schema_noref );
868 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
869 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
871 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
872 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
874 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
875 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
877 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
878 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
880 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
881 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
883 my $method_schema = {
885 additionalProperties
=> 0 ,
888 description
=> "This a description of the method" ,
893 description
=> "This indicates the name of the function to call." ,
896 additionalProperties
=> 1 ,
911 description
=> "The HTTP method name." ,
912 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
917 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
922 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
927 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
929 additionalProperties
=> 0 ,
932 description
=> "Describe access permissions." ,
936 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
938 enum
=> [ 'all' , 'world' ],
942 description
=> "Array of permission checks (prefix notation)." ,
949 description
=> "Used internally" ,
953 description
=> "Used internally" ,
958 description
=> "path for URL matching (uri template)" ,
960 fragmentDelimiter
=> {
962 description
=> "A ways to override the default fragment delimiter '/'. This onyl works on a whole sub-class. You can set this to the empty string to match the whole rest of the URI." ,
967 description
=> "JSON Schema for parameters." ,
972 description
=> "Used to store page formatter information (set by PVE::RESTHandler->register_page_formatter)." ,
977 description
=> "JSON Schema for return value." ,
982 description
=> "method implementaion (code reference)" ,
987 description
=> "Delegate call to this class (perl class string)." ,
990 additionalProperties
=> 0 ,
996 fragmentDelimiter
=> { optional
=> 1 }
1004 sub validate_schema
{
1007 my $errmsg = "internal error - unable to verify schema \n " ;
1008 validate
( $schema, $default_schema, $errmsg );
1011 sub validate_method_info
{
1014 my $errmsg = "internal error - unable to verify method info \n " ;
1015 validate
( $info, $method_schema, $errmsg );
1017 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1018 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1021 # run a self test on load
1022 # make sure we can verify the default schema
1023 validate_schema
( $default_schema_noref );
1024 validate_schema
( $method_schema );
1026 # and now some utility methods (used by pve api)
1027 sub method_get_child_link
{
1030 return undef if ! $info ;
1032 my $schema = $info ->{ returns
};
1033 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1035 my $links = $schema ->{ links
};
1036 return undef if ! $links ;
1039 foreach my $lnk ( @$links ) {
1040 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1049 # a way to parse command line parameters, using a
1050 # schema to configure Getopt::Long
1052 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1054 if (! $schema || ! $schema ->{ properties
}) {
1055 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1056 if scalar ( @$args ) != 0 ;
1061 if ( $arg_param && ! ref ( $arg_param )) {
1062 my $pd = $schema ->{ properties
}->{ $arg_param };
1063 die "expected list format $pd ->{format}"
1064 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1065 $list_param = $arg_param ;
1069 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1070 my $pd = $schema ->{ properties
}->{ $prop };
1071 next if $list_param && $prop eq $list_param ;
1072 next if defined ( $fixed_param ->{ $prop });
1074 if ( $prop eq 'password' && $pwcallback ) {
1075 # we do not accept plain password on input line, instead
1076 # we turn this into a boolean option and ask for password below
1077 # using $pwcallback() (for security reasons).
1078 push @getopt, " $prop " ;
1079 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1080 push @getopt, " $prop :s" ;
1082 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1083 push @getopt, " $prop =s@" ;
1085 push @getopt, " $prop =s" ;
1090 Getopt
:: Long
:: Configure
( 'prefix_pattern=(--|-)' );
1093 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1094 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1098 $opts ->{ $list_param } = $args ;
1100 } elsif ( ref ( $arg_param )) {
1101 foreach my $arg_name ( @$arg_param ) {
1102 if ( $opts ->{ 'extra-args' }) {
1103 raise
( "internal error: extra-args must be the last argument \n " , code
=> HTTP_BAD_REQUEST
);
1105 if ( $arg_name eq 'extra-args' ) {
1106 $opts ->{ 'extra-args' } = $args ;
1110 raise
( "not enough arguments \n " , code
=> HTTP_BAD_REQUEST
) if ! @$args ;
1111 $opts ->{ $arg_name } = shift @$args ;
1113 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
) if @$args ;
1115 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1116 if scalar ( @$args ) != 0 ;
1120 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1121 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1122 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1123 $opts ->{ password
} = & $pwcallback ();
1128 $opts = PVE
:: Tools
:: decode_utf8_parameters
( $opts );
1130 foreach my $p ( keys %$opts ) {
1131 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1132 if ( $pd ->{ type
} eq 'boolean' ) {
1133 if ( $opts ->{ $p } eq '' ) {
1135 } elsif ( $opts ->{ $p } =~ m/^(1|true|yes|on)$/i ) {
1137 } elsif ( $opts ->{ $p } =~ m/^(0|false|no|off)$/i ) {
1140 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1142 } elsif ( $pd ->{ format
}) {
1144 if ( $pd ->{ format
} =~ m/-list/ ) {
1145 # allow --vmid 100 --vmid 101 and --vmid 100,101
1146 # allow --dow mon --dow fri and --dow mon,fri
1147 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }}) if ref ( $opts ->{ $p }) eq 'ARRAY' ;
1148 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1149 # we encode array as \0 separated strings
1150 # Note: CGI.pm also use this encoding
1151 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1152 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1154 # st that split_list knows it is \0 terminated
1155 my $v = $opts ->{ $p }->[ 0 ];
1156 $opts ->{ $p } = " $v\0 " ;
1163 foreach my $p ( keys %$fixed_param ) {
1164 $opts ->{ $p } = $fixed_param ->{ $p };
1170 # A way to parse configuration data by giving a json schema
1172 my ( $schema, $filename, $raw ) = @_ ;
1174 # do fast check (avoid validate_schema($schema))
1175 die "got strange schema" if ! $schema ->{ type
} ||
1176 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1180 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1183 next if $line =~ /^#/ ;
1185 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1188 if ( $schema ->{ properties
}->{ $key } &&
1189 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1191 $value = 1 if $value =~ m/^(1|on|yes|true)$/i ;
1192 $value = 0 if $value =~ m/^(0|off|no|false)$/i ;
1194 $cfg ->{ $key } = $value ;
1196 warn "ignore config line: $line\n "
1201 check_prop
( $cfg, $schema, '' , $errors );
1203 foreach my $k ( keys %$errors ) {
1204 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1211 # generate simple key/value file
1213 my ( $schema, $filename, $cfg ) = @_ ;
1215 # do fast check (avoid validate_schema($schema))
1216 die "got strange schema" if ! $schema ->{ type
} ||
1217 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1219 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1223 foreach my $k ( keys %$cfg ) {
1224 $data .= " $k : $cfg ->{ $k } \n " ;