]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/JSONSchema.pm
5beebd80139a1aacbb8ce6dfc34b9bfa50417eb2
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 ;
106 return $format_list ->{ $format };
109 # register some common type for pve
111 register_format
( 'string' , sub {}); # allow format => 'string-list'
113 register_format
( 'pve-configid' , \
& pve_verify_configid
);
114 sub pve_verify_configid
{
115 my ( $id, $noerr ) = @_ ;
117 if ( $id !~ m/^[a-z][a-z0-9_]+$/i ) {
118 return undef if $noerr ;
119 die "invalid configuration ID ' $id ' \n " ;
124 PVE
:: JSONSchema
:: register_format
( 'pve-storage-id' , \
& parse_storage_id
);
125 sub parse_storage_id
{
126 my ( $storeid, $noerr ) = @_ ;
128 if ( $storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i ) {
129 return undef if $noerr ;
130 die "storage ID ' $storeid ' contains illegal characters \n " ;
136 register_format
( 'pve-vmid' , \
& pve_verify_vmid
);
137 sub pve_verify_vmid
{
138 my ( $vmid, $noerr ) = @_ ;
140 if ( $vmid !~ m/^[1-9][0-9]+$/ ) {
141 return undef if $noerr ;
142 die "value does not look like a valid VM ID \n " ;
147 register_format
( 'pve-node' , \
& pve_verify_node_name
);
148 sub pve_verify_node_name
{
149 my ( $node, $noerr ) = @_ ;
151 if ( $node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)$/ ) {
152 return undef if $noerr ;
153 die "value does not look like a valid node name \n " ;
158 register_format
( 'ipv4' , \
& pve_verify_ipv4
);
159 sub pve_verify_ipv4
{
160 my ( $ipv4, $noerr ) = @_ ;
162 if ( $ipv4 !~ m/^(?:$IPV4RE)$/ ) {
163 return undef if $noerr ;
164 die "value does not look like a valid IPv4 address \n " ;
169 register_format
( 'ipv6' , \
& pve_verify_ipv6
);
170 sub pve_verify_ipv6
{
171 my ( $ipv6, $noerr ) = @_ ;
173 if ( $ipv6 !~ m/^(?:$IPV6RE)$/ ) {
174 return undef if $noerr ;
175 die "value does not look like a valid IPv6 address \n " ;
180 register_format
( 'ip' , \
& pve_verify_ip
);
182 my ( $ip, $noerr ) = @_ ;
184 if ( $ip !~ m/^(?:(?:$IPV4RE)|(?:$IPV6RE))$/ ) {
185 return undef if $noerr ;
186 die "value does not look like a valid IP address \n " ;
191 my $ipv4_mask_hash = {
208 '255.255.128.0' => 17 ,
209 '255.255.192.0' => 18 ,
210 '255.255.224.0' => 19 ,
211 '255.255.240.0' => 20 ,
212 '255.255.248.0' => 21 ,
213 '255.255.252.0' => 22 ,
214 '255.255.254.0' => 23 ,
215 '255.255.255.0' => 24 ,
216 '255.255.255.128' => 25 ,
217 '255.255.255.192' => 26 ,
218 '255.255.255.224' => 27 ,
219 '255.255.255.240' => 28 ,
220 '255.255.255.248' => 29 ,
221 '255.255.255.252' => 30
224 register_format
( 'ipv4mask' , \
& pve_verify_ipv4mask
);
225 sub pve_verify_ipv4mask
{
226 my ( $mask, $noerr ) = @_ ;
228 if (! defined ( $ipv4_mask_hash ->{ $mask })) {
229 return undef if $noerr ;
230 die "value does not look like a valid IP netmask \n " ;
235 register_format
( 'CIDRv6' , \
& pve_verify_cidrv6
);
236 sub pve_verify_cidrv6
{
237 my ( $cidr, $noerr ) = @_ ;
239 if ( $cidr =~ m!^(?:$IPV6RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 120 )) {
243 return undef if $noerr ;
244 die "value does not look like a valid IPv6 CIDR network \n " ;
247 register_format
( 'CIDRv4' , \
& pve_verify_cidrv4
);
248 sub pve_verify_cidrv4
{
249 my ( $cidr, $noerr ) = @_ ;
251 if ( $cidr =~ m!^(?:$IPV4RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 < 32 )) {
255 return undef if $noerr ;
256 die "value does not look like a valid IPv4 CIDR network \n " ;
259 register_format
( 'CIDR' , \
& pve_verify_cidr
);
260 sub pve_verify_cidr
{
261 my ( $cidr, $noerr ) = @_ ;
263 if (!( pve_verify_cidrv4
( $cidr, 1 ) ||
264 pve_verify_cidrv6
( $cidr, 1 )))
266 return undef if $noerr ;
267 die "value does not look like a valid CIDR network \n " ;
273 register_format
( 'pve-ipv4-config' , \
& pve_verify_ipv4_config
);
274 sub pve_verify_ipv4_config
{
275 my ( $config, $noerr ) = @_ ;
277 return $config if $config =~ /^(?:dhcp|manual)$/ ||
278 pve_verify_cidrv4
( $config, 1 );
279 return undef if $noerr ;
280 die "value does not look like a valid ipv4 network configuration \n " ;
283 register_format
( 'pve-ipv6-config' , \
& pve_verify_ipv6_config
);
284 sub pve_verify_ipv6_config
{
285 my ( $config, $noerr ) = @_ ;
287 return $config if $config =~ /^(?:auto|dhcp|manual)$/ ||
288 pve_verify_cidrv6
( $config, 1 );
289 return undef if $noerr ;
290 die "value does not look like a valid ipv6 network configuration \n " ;
293 register_format
( 'email' , \
& pve_verify_email
);
294 sub pve_verify_email
{
295 my ( $email, $noerr ) = @_ ;
297 # we use same regex as in Utils.js
298 if ( $email !~ /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,63}$/ ) {
299 return undef if $noerr ;
300 die "value does not look like a valid email address \n " ;
305 register_format
( 'dns-name' , \
& pve_verify_dns_name
);
306 sub pve_verify_dns_name
{
307 my ( $name, $noerr ) = @_ ;
309 my $namere = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)" ;
311 if ( $name !~ /^(${namere}\.)*${namere}$/ ) {
312 return undef if $noerr ;
313 die "value does not look like a valid DNS name \n " ;
318 # network interface name
319 register_format
( 'pve-iface' , \
& pve_verify_iface
);
320 sub pve_verify_iface
{
321 my ( $id, $noerr ) = @_ ;
323 if ( $id !~ m/^[a-z][a-z0-9_]{1,20}([:\.]\d+)?$/i ) {
324 return undef if $noerr ;
325 die "invalid network interface name ' $id ' \n " ;
330 # general addresses by name or IP
331 register_format
( 'address' , \
& pve_verify_address
);
332 sub pve_verify_address
{
333 my ( $addr, $noerr ) = @_ ;
335 if (!( pve_verify_ip
( $addr, 1 ) ||
336 pve_verify_dns_name
( $addr, 1 )))
338 return undef if $noerr ;
339 die "value does not look like a valid address: $addr\n " ;
344 register_standard_option
( 'spice-proxy' , {
345 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)." ,
346 type
=> 'string' , format
=> 'address' ,
349 register_standard_option
( 'remote-viewer-config' , {
350 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
351 additionalProperties
=> 1 ,
353 type
=> { type
=> 'string' },
354 password
=> { type
=> 'string' },
355 proxy
=> { type
=> 'string' },
356 host
=> { type
=> 'string' },
357 'tls-port' => { type
=> 'integer' },
361 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
362 sub pve_verify_startup_order
{
363 my ( $value, $noerr ) = @_ ;
365 return $value if pve_parse_startup_order
( $value );
367 return undef if $noerr ;
369 die "unable to parse startup options \n " ;
372 sub pve_parse_startup_order
{
375 return undef if ! $value ;
379 foreach my $p ( split ( /,/ , $value )) {
380 next if $p =~ m/^\s*$/ ;
382 if ( $p =~ m/^(order=)?(\d+)$/ ) {
384 } elsif ( $p =~ m/^up=(\d+)$/ ) {
386 } elsif ( $p =~ m/^down=(\d+)$/ ) {
396 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
397 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." ,
399 type
=> 'string' , format
=> 'pve-startup-order' ,
400 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
404 my ( $format, $value, $path ) = @_ ;
406 return parse_property_string
( $format, $value, $path ) if ref ( $format ) eq 'HASH' ;
407 return if $format eq 'regex' ;
409 if ( $format =~ m/^(.*)-a?list$/ ) {
411 my $code = $format_list ->{ $1 };
413 die "undefined format ' $format ' \n " if ! $code ;
415 # Note: we allow empty lists
416 foreach my $v ( split_list
( $value )) {
420 } elsif ( $format =~ m/^(.*)-opt$/ ) {
422 my $code = $format_list ->{ $1 };
424 die "undefined format ' $format ' \n " if ! $code ;
426 return if ! $value ; # allow empty string
432 my $code = $format_list ->{ $format };
434 die "undefined format ' $format ' \n " if ! $code ;
436 return parse_property_string
( $code, $value, $path ) if ref ( $code ) eq 'HASH' ;
444 return undef if $value !~ m/^(\d+(\.\d+)?)([KMGT])?$/ ;
445 my ( $size, $unit ) = ( $1, $3 );
448 $size = $size * 1024 ;
449 } elsif ( $unit eq 'M' ) {
450 $size = $size * 1024 * 1024 ;
451 } elsif ( $unit eq 'G' ) {
452 $size = $size * 1024 * 1024 * 1024 ;
453 } elsif ( $unit eq 'T' ) {
454 $size = $size * 1024 * 1024 * 1024 * 1024 ;
465 my $kb = int ( $size/1024 );
466 return $size if $kb*1024 != $size ;
468 my $mb = int ( $kb/1024 );
469 return "${kb}K" if $mb*1024 != $kb ;
471 my $gb = int ( $mb/1024 );
472 return "${mb}M" if $gb*1024 != $mb ;
474 my $tb = int ( $gb/1024 );
475 return "${gb}G" if $tb*1024 != $gb ;
480 sub parse_property_string
{
481 my ( $format, $data, $path ) = @_ ;
486 foreach my $part ( split ( /,/ , $data )) {
487 next if $part =~ /^\s*$/ ;
489 if ( $part =~ /^([^=]+)=(.+)$/ ) {
490 my ( $k, $v ) = ( $1, $2 );
491 die "duplicate key in comma-separated list property: $k " if defined ( $res ->{ $k });
492 my $schema = $format ->{ $k };
493 die "invalid key in comma-separated list property: $k " if ! $schema ;
494 if ( $schema ->{ type
} && $schema ->{ type
} eq 'boolean' ) {
495 $v = 1 if $v =~ m/^(1|on|yes|true)$/i ;
496 $v = 0 if $v =~ m/^(0|off|no|false)$/i ;
499 } elsif ( $part !~ /=/ ) {
500 die "duplicate key in comma-separated list property: $default_key " if $default_key ;
501 foreach my $key ( keys %$format ) {
502 if ( $format ->{ $key }->{ default_key
}) {
504 if (! $res ->{ $default_key }) {
505 $res ->{ $default_key } = $part ;
508 die "duplicate key in comma-separated list property: $default_key " ;
512 die "missing key in comma-separated list property" ;
517 check_object
( $path, $format, $res, undef , $errors );
518 if ( scalar ( %$errors )) {
519 raise
"format error" , errors
=> $errors ;
526 my ( $errors, $path, $msg ) = @_ ;
528 $path = '_root' if ! $path ;
530 if ( $errors ->{ $path }) {
531 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
533 $errors ->{ $path } = $msg ;
540 # see 'man perlretut'
541 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
547 return $value =~ m/^[+-]?\d+$/ ;
551 my ( $path, $type, $value, $errors ) = @_ ;
555 if (! defined ( $value )) {
556 return 1 if $type eq 'null' ;
560 if ( my $tt = ref ( $type )) {
561 if ( $tt eq 'ARRAY' ) {
562 foreach my $t ( @$type ) {
564 check_type
( $path, $t, $value, $tmperr );
565 return 1 if ! scalar ( %$tmperr );
567 my $ttext = join ( '|' , @$type );
568 add_error
( $errors, $path, "type check (' $ttext ') failed" );
570 } elsif ( $tt eq 'HASH' ) {
572 check_prop
( $value, $type, $path, $tmperr );
573 return 1 if ! scalar ( %$tmperr );
574 add_error
( $errors, $path, "type check failed" );
577 die "internal error - got reference type ' $tt '" ;
582 return 1 if $type eq 'any' ;
584 if ( $type eq 'null' ) {
585 if ( defined ( $value )) {
586 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
592 my $vt = ref ( $value );
594 if ( $type eq 'array' ) {
595 if (! $vt || $vt ne 'ARRAY' ) {
596 add_error
( $errors, $path, "type check (' $type ') failed" );
600 } elsif ( $type eq 'object' ) {
601 if (! $vt || $vt ne 'HASH' ) {
602 add_error
( $errors, $path, "type check (' $type ') failed" );
606 } elsif ( $type eq 'coderef' ) {
607 if (! $vt || $vt ne 'CODE' ) {
608 add_error
( $errors, $path, "type check (' $type ') failed" );
614 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
617 if ( $type eq 'string' ) {
618 return 1 ; # nothing to check ?
619 } elsif ( $type eq 'boolean' ) {
620 #if ($value =~ m/^(1|true|yes|on)$/i) {
623 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
624 } elsif ( $value eq '0' ) {
627 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
630 } elsif ( $type eq 'integer' ) {
631 if (! is_integer
( $value )) {
632 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
636 } elsif ( $type eq 'number' ) {
637 if (! is_number
( $value )) {
638 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
643 return 1 ; # no need to verify unknown types
653 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
655 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
657 my $st = ref ( $schema );
658 if (! $st || $st ne 'HASH' ) {
659 add_error
( $errors, $path, "Invalid schema definition." );
663 my $vt = ref ( $value );
664 if (! $vt || $vt ne 'HASH' ) {
665 add_error
( $errors, $path, "an object is required" );
669 foreach my $k ( keys %$schema ) {
670 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
673 foreach my $k ( keys %$value ) {
675 my $newpath = $path ?
" $path . $k " : $k ;
677 if ( my $subschema = $schema ->{ $k }) {
678 if ( my $requires = $subschema ->{ requires
}) {
679 if ( ref ( $requires )) {
680 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
681 check_prop
( $value, $requires, $path, $errors );
682 } elsif (! defined ( $value ->{ $requires })) {
683 add_error
( $errors, $path ?
" $path . $requires " : $requires,
684 "missing property - ' $newpath ' requiers this property" );
688 next ; # value is already checked above
691 if ( defined ( $additional_properties ) && ! $additional_properties ) {
692 add_error
( $errors, $newpath, "property is not defined in schema " .
693 "and the schema does not allow additional properties" );
696 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
697 if ref ( $additional_properties );
701 sub check_object_warn
{
702 my ( $path, $schema, $value, $additional_properties ) = @_ ;
704 check_object
( $path, $schema, $value, $additional_properties, $errors );
705 if ( scalar ( %$errors )) {
706 foreach my $k ( keys %$errors ) {
707 warn "parse error: $k : $errors ->{ $k } \n " ;
715 my ( $value, $schema, $path, $errors ) = @_ ;
717 die "internal error - no schema" if ! $schema ;
718 die "internal error" if ! $errors ;
720 #print "check_prop $path\n" if $value;
722 my $st = ref ( $schema );
723 if (! $st || $st ne 'HASH' ) {
724 add_error
( $errors, $path, "Invalid schema definition." );
728 # if it extends another schema, it must pass that schema as well
729 if ( $schema ->{ extends
}) {
730 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
733 if (! defined ( $value )) {
734 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
735 if (! $schema ->{ optional
}) {
736 add_error
( $errors, $path, "property is missing and it is not optional" );
741 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
743 if ( $schema ->{ disallow
}) {
745 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
746 add_error
( $errors, $path, "disallowed value was matched" );
751 if ( my $vt = ref ( $value )) {
753 if ( $vt eq 'ARRAY' ) {
754 if ( $schema ->{ items
}) {
755 my $it = ref ( $schema ->{ items
});
756 if ( $it && $it eq 'ARRAY' ) {
757 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
758 die "not implemented" ;
761 foreach my $el ( @$value ) {
762 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
768 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
769 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
770 $value, $schema ->{ additionalProperties
}, $errors );
776 if ( my $format = $schema ->{ format
}) {
777 eval { check_format
( $format, $value, $path ); };
779 add_error
( $errors, $path, "invalid format - $@ " );
784 if ( my $pattern = $schema ->{ pattern
}) {
785 if ( $value !~ m/^$pattern$/ ) {
786 add_error
( $errors, $path, "value does not match the regex pattern" );
791 if ( defined ( my $max = $schema ->{ maxLength
})) {
792 if ( length ( $value ) > $max ) {
793 add_error
( $errors, $path, "value may only be $max characters long" );
798 if ( defined ( my $min = $schema ->{ minLength
})) {
799 if ( length ( $value ) < $min ) {
800 add_error
( $errors, $path, "value must be at least $min characters long" );
805 if ( is_number
( $value )) {
806 if ( defined ( my $max = $schema ->{ maximum
})) {
808 add_error
( $errors, $path, "value must have a maximum value of $max " );
813 if ( defined ( my $min = $schema ->{ minimum
})) {
815 add_error
( $errors, $path, "value must have a minimum value of $min " );
821 if ( my $ea = $schema ->{ enum
}) {
824 foreach my $ev ( @$ea ) {
831 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
832 join ( ", " , @$ea ) . "'" );
839 my ( $instance, $schema, $errmsg ) = @_ ;
842 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
844 # todo: cycle detection is only needed for debugging, I guess
845 # we can disable that in the final release
846 # todo: is there a better/faster way to detect cycles?
848 find_cycle
( $instance, sub { $cycles = 1 });
850 add_error
( $errors, undef , "data structure contains recursive cycles" );
852 check_prop
( $instance, $schema, '' , $errors );
855 if ( scalar ( %$errors )) {
856 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
862 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
863 my $default_schema_noref = {
864 description
=> "This is the JSON Schema for JSON Schemas." ,
865 type
=> [ "object" ],
866 additionalProperties
=> 0 ,
869 type
=> [ "string" , "array" ],
870 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
875 enum
=> $schema_valid_types,
877 enum
=> $schema_valid_types,
881 description
=> "This indicates that the instance property in the instance object is not required." ,
887 description
=> "This is a definition for the properties of an object value" ,
893 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
897 additionalProperties
=> {
898 type
=> [ "boolean" , "object" ],
899 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
906 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
911 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
915 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
922 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
928 description
=> "A text representation of the type (used to generate documentation)." ,
933 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." ,
941 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
946 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)." ,
948 format_description
=> {
951 description
=> "This provides a shorter (usually just one word) description for a property used to generate descriptions for comma separated list property strings." ,
956 description
=> "This provides the title of the property" ,
959 type
=> [ "string" , "object" ],
961 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
964 type
=> [ "string" , "object" ],
966 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" ,
971 description
=> "Whether this is the default key in a comma separated list property string." ,
976 description
=> "This indicates the default for the instance property."
980 description
=> "Bash completion function. This function should return a list of possible values." ,
986 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." ,
991 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
994 # this is from hyper schema
997 description
=> "This defines the link relations of the instance objects" ,
1004 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" ,
1008 description
=> "This is the name of the link relation" ,
1014 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
1024 my $default_schema = Storable
:: dclone
( $default_schema_noref );
1026 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
1027 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
1029 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
1030 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
1032 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
1033 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
1035 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
1036 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
1038 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
1039 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
1041 my $method_schema = {
1043 additionalProperties
=> 0 ,
1046 description
=> "This a description of the method" ,
1051 description
=> "This indicates the name of the function to call." ,
1054 additionalProperties
=> 1 ,
1069 description
=> "The HTTP method name." ,
1070 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
1075 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
1080 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
1085 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
1087 additionalProperties
=> 0 ,
1090 description
=> "Describe access permissions." ,
1094 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
1096 enum
=> [ 'all' , 'world' ],
1100 description
=> "Array of permission checks (prefix notation)." ,
1107 description
=> "Used internally" ,
1111 description
=> "Used internally" ,
1116 description
=> "path for URL matching (uri template)" ,
1118 fragmentDelimiter
=> {
1120 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." ,
1125 description
=> "JSON Schema for parameters." ,
1130 description
=> "Used to store page formatter information (set by PVE::RESTHandler->register_page_formatter)." ,
1135 description
=> "JSON Schema for return value." ,
1140 description
=> "method implementaion (code reference)" ,
1145 description
=> "Delegate call to this class (perl class string)." ,
1148 additionalProperties
=> 0 ,
1154 fragmentDelimiter
=> { optional
=> 1 }
1162 sub validate_schema
{
1165 my $errmsg = "internal error - unable to verify schema \n " ;
1166 validate
( $schema, $default_schema, $errmsg );
1169 sub validate_method_info
{
1172 my $errmsg = "internal error - unable to verify method info \n " ;
1173 validate
( $info, $method_schema, $errmsg );
1175 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1176 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1179 # run a self test on load
1180 # make sure we can verify the default schema
1181 validate_schema
( $default_schema_noref );
1182 validate_schema
( $method_schema );
1184 # and now some utility methods (used by pve api)
1185 sub method_get_child_link
{
1188 return undef if ! $info ;
1190 my $schema = $info ->{ returns
};
1191 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1193 my $links = $schema ->{ links
};
1194 return undef if ! $links ;
1197 foreach my $lnk ( @$links ) {
1198 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1207 # a way to parse command line parameters, using a
1208 # schema to configure Getopt::Long
1210 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1212 if (! $schema || ! $schema ->{ properties
}) {
1213 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1214 if scalar ( @$args ) != 0 ;
1219 if ( $arg_param && ! ref ( $arg_param )) {
1220 my $pd = $schema ->{ properties
}->{ $arg_param };
1221 die "expected list format $pd ->{format}"
1222 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1223 $list_param = $arg_param ;
1227 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1228 my $pd = $schema ->{ properties
}->{ $prop };
1229 next if $list_param && $prop eq $list_param ;
1230 next if defined ( $fixed_param ->{ $prop });
1232 if ( $prop eq 'password' && $pwcallback ) {
1233 # we do not accept plain password on input line, instead
1234 # we turn this into a boolean option and ask for password below
1235 # using $pwcallback() (for security reasons).
1236 push @getopt, " $prop " ;
1237 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1238 push @getopt, " $prop :s" ;
1240 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1241 push @getopt, " $prop =s@" ;
1243 push @getopt, " $prop =s" ;
1248 Getopt
:: Long
:: Configure
( 'prefix_pattern=(--|-)' );
1251 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1252 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1256 $opts ->{ $list_param } = $args ;
1258 } elsif ( ref ( $arg_param )) {
1259 foreach my $arg_name ( @$arg_param ) {
1260 if ( $opts ->{ 'extra-args' }) {
1261 raise
( "internal error: extra-args must be the last argument \n " , code
=> HTTP_BAD_REQUEST
);
1263 if ( $arg_name eq 'extra-args' ) {
1264 $opts ->{ 'extra-args' } = $args ;
1268 raise
( "not enough arguments \n " , code
=> HTTP_BAD_REQUEST
) if ! @$args ;
1269 $opts ->{ $arg_name } = shift @$args ;
1271 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
) if @$args ;
1273 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1274 if scalar ( @$args ) != 0 ;
1278 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1279 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1280 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1281 $opts ->{ password
} = & $pwcallback ();
1286 $opts = PVE
:: Tools
:: decode_utf8_parameters
( $opts );
1288 foreach my $p ( keys %$opts ) {
1289 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1290 if ( $pd ->{ type
} eq 'boolean' ) {
1291 if ( $opts ->{ $p } eq '' ) {
1293 } elsif ( $opts ->{ $p } =~ m/^(1|true|yes|on)$/i ) {
1295 } elsif ( $opts ->{ $p } =~ m/^(0|false|no|off)$/i ) {
1298 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1300 } elsif ( $pd ->{ format
}) {
1302 if ( $pd ->{ format
} =~ m/-list/ ) {
1303 # allow --vmid 100 --vmid 101 and --vmid 100,101
1304 # allow --dow mon --dow fri and --dow mon,fri
1305 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }}) if ref ( $opts ->{ $p }) eq 'ARRAY' ;
1306 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1307 # we encode array as \0 separated strings
1308 # Note: CGI.pm also use this encoding
1309 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1310 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1312 # st that split_list knows it is \0 terminated
1313 my $v = $opts ->{ $p }->[ 0 ];
1314 $opts ->{ $p } = " $v\0 " ;
1321 foreach my $p ( keys %$fixed_param ) {
1322 $opts ->{ $p } = $fixed_param ->{ $p };
1328 # A way to parse configuration data by giving a json schema
1330 my ( $schema, $filename, $raw ) = @_ ;
1332 # do fast check (avoid validate_schema($schema))
1333 die "got strange schema" if ! $schema ->{ type
} ||
1334 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1338 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1341 next if $line =~ /^#/ ;
1343 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1346 if ( $schema ->{ properties
}->{ $key } &&
1347 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1349 $value = 1 if $value =~ m/^(1|on|yes|true)$/i ;
1350 $value = 0 if $value =~ m/^(0|off|no|false)$/i ;
1352 $cfg ->{ $key } = $value ;
1354 warn "ignore config line: $line\n "
1359 check_prop
( $cfg, $schema, '' , $errors );
1361 foreach my $k ( keys %$errors ) {
1362 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1369 # generate simple key/value file
1371 my ( $schema, $filename, $cfg ) = @_ ;
1373 # do fast check (avoid validate_schema($schema))
1374 die "got strange schema" if ! $schema ->{ type
} ||
1375 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1377 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1381 foreach my $k ( keys %$cfg ) {
1382 $data .= " $k : $cfg ->{ $k } \n " ;