]>
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 ;
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_format
( 'disk-size' , \
& pve_verify_disk_size
);
345 sub pve_verify_disk_size
{
346 my ( $size, $noerr ) = @_ ;
347 if (! defined ( parse_size
( $size ))) {
348 return undef if $noerr ;
349 die "value does not look like a valid disk size: $size\n " ;
354 register_standard_option
( 'spice-proxy' , {
355 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)." ,
356 type
=> 'string' , format
=> 'address' ,
359 register_standard_option
( 'remote-viewer-config' , {
360 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
361 additionalProperties
=> 1 ,
363 type
=> { type
=> 'string' },
364 password
=> { type
=> 'string' },
365 proxy
=> { type
=> 'string' },
366 host
=> { type
=> 'string' },
367 'tls-port' => { type
=> 'integer' },
371 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
372 sub pve_verify_startup_order
{
373 my ( $value, $noerr ) = @_ ;
375 return $value if pve_parse_startup_order
( $value );
377 return undef if $noerr ;
379 die "unable to parse startup options \n " ;
382 sub pve_parse_startup_order
{
385 return undef if ! $value ;
389 foreach my $p ( split ( /,/ , $value )) {
390 next if $p =~ m/^\s*$/ ;
392 if ( $p =~ m/^(order=)?(\d+)$/ ) {
394 } elsif ( $p =~ m/^up=(\d+)$/ ) {
396 } elsif ( $p =~ m/^down=(\d+)$/ ) {
406 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
407 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." ,
409 type
=> 'string' , format
=> 'pve-startup-order' ,
410 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
414 my ( $format, $value, $path ) = @_ ;
416 return parse_property_string
( $format, $value, $path ) if ref ( $format ) eq 'HASH' ;
417 return if $format eq 'regex' ;
419 if ( $format =~ m/^(.*)-a?list$/ ) {
421 my $code = $format_list ->{ $1 };
423 die "undefined format ' $format ' \n " if ! $code ;
425 # Note: we allow empty lists
426 foreach my $v ( split_list
( $value )) {
430 } elsif ( $format =~ m/^(.*)-opt$/ ) {
432 my $code = $format_list ->{ $1 };
434 die "undefined format ' $format ' \n " if ! $code ;
436 return if ! $value ; # allow empty string
442 my $code = $format_list ->{ $format };
444 die "undefined format ' $format ' \n " if ! $code ;
446 return parse_property_string
( $code, $value, $path ) if ref ( $code ) eq 'HASH' ;
454 return undef if $value !~ m/^(\d+(\.\d+)?)([KMGT])?$/ ;
455 my ( $size, $unit ) = ( $1, $3 );
458 $size = $size * 1024 ;
459 } elsif ( $unit eq 'M' ) {
460 $size = $size * 1024 * 1024 ;
461 } elsif ( $unit eq 'G' ) {
462 $size = $size * 1024 * 1024 * 1024 ;
463 } elsif ( $unit eq 'T' ) {
464 $size = $size * 1024 * 1024 * 1024 * 1024 ;
475 my $kb = int ( $size/1024 );
476 return $size if $kb*1024 != $size ;
478 my $mb = int ( $kb/1024 );
479 return "${kb}K" if $mb*1024 != $kb ;
481 my $gb = int ( $mb/1024 );
482 return "${mb}M" if $gb*1024 != $mb ;
484 my $tb = int ( $gb/1024 );
485 return "${gb}G" if $tb*1024 != $gb ;
490 sub parse_property_string
{
491 my ( $format, $data, $path ) = @_ ;
496 foreach my $part ( split ( /,/ , $data )) {
497 next if $part =~ /^\s*$/ ;
499 if ( $part =~ /^([^=]+)=(.+)$/ ) {
500 my ( $k, $v ) = ( $1, $2 );
501 die "duplicate key in comma-separated list property: $k\n " if defined ( $res ->{ $k });
502 my $schema = $format ->{ $k };
503 die "invalid key in comma-separated list property: $k\n " if ! $schema ;
504 if ( $schema ->{ type
} && $schema ->{ type
} eq 'boolean' ) {
505 $v = 1 if $v =~ m/^(1|on|yes|true)$/i ;
506 $v = 0 if $v =~ m/^(0|off|no|false)$/i ;
509 } elsif ( $part !~ /=/ ) {
510 die "duplicate key in comma-separated list property: $default_key\n " if $default_key ;
511 foreach my $key ( keys %$format ) {
512 if ( $format ->{ $key }->{ default_key
}) {
514 if (! $res ->{ $default_key }) {
515 $res ->{ $default_key } = $part ;
518 die "duplicate key in comma-separated list property: $default_key\n " ;
522 die "missing key in comma-separated list property \n " ;
527 check_object
( $path, $format, $res, undef , $errors );
528 if ( scalar ( %$errors )) {
529 raise
"format error \n " , errors
=> $errors ;
535 sub print_property_string
{
536 my ( $data, $format, $skip, $path ) = @_ ;
538 if ( ref ( $format ) ne 'HASH' ) {
539 my $schema = $format_list ->{ $format };
540 die "not a valid format: $format " if ! $schema ;
545 check_object
( $path, $format, $data, undef , $errors );
546 if ( scalar ( %$errors )) {
547 raise
"format error" , errors
=> $errors ;
551 my %skipped = map { $_ => 1 } @$skip ;
553 my %required ; # this is a set, all present keys are required regardless of value
554 foreach my $key ( keys %$format ) {
556 if (! $format ->{ $key }->{ optional
} && ! $skipped { $key }) {
561 if ( $format ->{ $key }->{ default_key
}) {
563 warn "multiple default keys in schema ( $default_key, $key )" ;
573 $text = " $data ->{ $default_key }" ;
580 foreach my $key ( sort keys %$data ) {
581 die "invalid key: $key " if ! $allowed { $key };
582 delete $required { $key };
583 next if $skipped { $key };
585 my $typeformat = $format ->{ $key }->{ format
};
586 my $value = $data ->{ $key };
589 if ( $typeformat && $typeformat eq 'disk-size' ) {
590 $text .= " $key =" . format_size
( $value );
592 $text .= " $key = $value " ;
596 if ( my $missing = join ( ',' , keys %required )) {
597 die "missing properties: $missing " ;
604 my ( $errors, $path, $msg ) = @_ ;
606 $path = '_root' if ! $path ;
608 if ( $errors ->{ $path }) {
609 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
611 $errors ->{ $path } = $msg ;
618 # see 'man perlretut'
619 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
625 return $value =~ m/^[+-]?\d+$/ ;
629 my ( $path, $type, $value, $errors ) = @_ ;
633 if (! defined ( $value )) {
634 return 1 if $type eq 'null' ;
638 if ( my $tt = ref ( $type )) {
639 if ( $tt eq 'ARRAY' ) {
640 foreach my $t ( @$type ) {
642 check_type
( $path, $t, $value, $tmperr );
643 return 1 if ! scalar ( %$tmperr );
645 my $ttext = join ( '|' , @$type );
646 add_error
( $errors, $path, "type check (' $ttext ') failed" );
648 } elsif ( $tt eq 'HASH' ) {
650 check_prop
( $value, $type, $path, $tmperr );
651 return 1 if ! scalar ( %$tmperr );
652 add_error
( $errors, $path, "type check failed" );
655 die "internal error - got reference type ' $tt '" ;
660 return 1 if $type eq 'any' ;
662 if ( $type eq 'null' ) {
663 if ( defined ( $value )) {
664 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
670 my $vt = ref ( $value );
672 if ( $type eq 'array' ) {
673 if (! $vt || $vt ne 'ARRAY' ) {
674 add_error
( $errors, $path, "type check (' $type ') failed" );
678 } elsif ( $type eq 'object' ) {
679 if (! $vt || $vt ne 'HASH' ) {
680 add_error
( $errors, $path, "type check (' $type ') failed" );
684 } elsif ( $type eq 'coderef' ) {
685 if (! $vt || $vt ne 'CODE' ) {
686 add_error
( $errors, $path, "type check (' $type ') failed" );
692 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
695 if ( $type eq 'string' ) {
696 return 1 ; # nothing to check ?
697 } elsif ( $type eq 'boolean' ) {
698 #if ($value =~ m/^(1|true|yes|on)$/i) {
701 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
702 } elsif ( $value eq '0' ) {
705 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
708 } elsif ( $type eq 'integer' ) {
709 if (! is_integer
( $value )) {
710 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
714 } elsif ( $type eq 'number' ) {
715 if (! is_number
( $value )) {
716 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
721 return 1 ; # no need to verify unknown types
731 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
733 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
735 my $st = ref ( $schema );
736 if (! $st || $st ne 'HASH' ) {
737 add_error
( $errors, $path, "Invalid schema definition." );
741 my $vt = ref ( $value );
742 if (! $vt || $vt ne 'HASH' ) {
743 add_error
( $errors, $path, "an object is required" );
747 foreach my $k ( keys %$schema ) {
748 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
751 foreach my $k ( keys %$value ) {
753 my $newpath = $path ?
" $path . $k " : $k ;
755 if ( my $subschema = $schema ->{ $k }) {
756 if ( my $requires = $subschema ->{ requires
}) {
757 if ( ref ( $requires )) {
758 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
759 check_prop
( $value, $requires, $path, $errors );
760 } elsif (! defined ( $value ->{ $requires })) {
761 add_error
( $errors, $path ?
" $path . $requires " : $requires,
762 "missing property - ' $newpath ' requiers this property" );
766 next ; # value is already checked above
769 if ( defined ( $additional_properties ) && ! $additional_properties ) {
770 add_error
( $errors, $newpath, "property is not defined in schema " .
771 "and the schema does not allow additional properties" );
774 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
775 if ref ( $additional_properties );
779 sub check_object_warn
{
780 my ( $path, $schema, $value, $additional_properties ) = @_ ;
782 check_object
( $path, $schema, $value, $additional_properties, $errors );
783 if ( scalar ( %$errors )) {
784 foreach my $k ( keys %$errors ) {
785 warn "parse error: $k : $errors ->{ $k } \n " ;
793 my ( $value, $schema, $path, $errors ) = @_ ;
795 die "internal error - no schema" if ! $schema ;
796 die "internal error" if ! $errors ;
798 #print "check_prop $path\n" if $value;
800 my $st = ref ( $schema );
801 if (! $st || $st ne 'HASH' ) {
802 add_error
( $errors, $path, "Invalid schema definition." );
806 # if it extends another schema, it must pass that schema as well
807 if ( $schema ->{ extends
}) {
808 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
811 if (! defined ( $value )) {
812 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
813 if (! $schema ->{ optional
}) {
814 add_error
( $errors, $path, "property is missing and it is not optional" );
819 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
821 if ( $schema ->{ disallow
}) {
823 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
824 add_error
( $errors, $path, "disallowed value was matched" );
829 if ( my $vt = ref ( $value )) {
831 if ( $vt eq 'ARRAY' ) {
832 if ( $schema ->{ items
}) {
833 my $it = ref ( $schema ->{ items
});
834 if ( $it && $it eq 'ARRAY' ) {
835 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
836 die "not implemented" ;
839 foreach my $el ( @$value ) {
840 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
846 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
847 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
848 $value, $schema ->{ additionalProperties
}, $errors );
854 if ( my $format = $schema ->{ format
}) {
855 eval { check_format
( $format, $value, $path ); };
857 add_error
( $errors, $path, "invalid format - $@ " );
862 if ( my $pattern = $schema ->{ pattern
}) {
863 if ( $value !~ m/^$pattern$/ ) {
864 add_error
( $errors, $path, "value does not match the regex pattern" );
869 if ( defined ( my $max = $schema ->{ maxLength
})) {
870 if ( length ( $value ) > $max ) {
871 add_error
( $errors, $path, "value may only be $max characters long" );
876 if ( defined ( my $min = $schema ->{ minLength
})) {
877 if ( length ( $value ) < $min ) {
878 add_error
( $errors, $path, "value must be at least $min characters long" );
883 if ( is_number
( $value )) {
884 if ( defined ( my $max = $schema ->{ maximum
})) {
886 add_error
( $errors, $path, "value must have a maximum value of $max " );
891 if ( defined ( my $min = $schema ->{ minimum
})) {
893 add_error
( $errors, $path, "value must have a minimum value of $min " );
899 if ( my $ea = $schema ->{ enum
}) {
902 foreach my $ev ( @$ea ) {
909 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
910 join ( ", " , @$ea ) . "'" );
917 my ( $instance, $schema, $errmsg ) = @_ ;
920 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
922 # todo: cycle detection is only needed for debugging, I guess
923 # we can disable that in the final release
924 # todo: is there a better/faster way to detect cycles?
926 find_cycle
( $instance, sub { $cycles = 1 });
928 add_error
( $errors, undef , "data structure contains recursive cycles" );
930 check_prop
( $instance, $schema, '' , $errors );
933 if ( scalar ( %$errors )) {
934 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
940 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
941 my $default_schema_noref = {
942 description
=> "This is the JSON Schema for JSON Schemas." ,
943 type
=> [ "object" ],
944 additionalProperties
=> 0 ,
947 type
=> [ "string" , "array" ],
948 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
953 enum
=> $schema_valid_types,
955 enum
=> $schema_valid_types,
959 description
=> "This indicates that the instance property in the instance object is not required." ,
965 description
=> "This is a definition for the properties of an object value" ,
971 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
975 additionalProperties
=> {
976 type
=> [ "boolean" , "object" ],
977 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
984 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
989 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
993 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
1000 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
1006 description
=> "A text representation of the type (used to generate documentation)." ,
1011 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." ,
1019 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
1024 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)." ,
1026 format_description
=> {
1029 description
=> "This provides a shorter (usually just one word) description for a property used to generate descriptions for comma separated list property strings." ,
1034 description
=> "This provides the title of the property" ,
1037 type
=> [ "string" , "object" ],
1039 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
1042 type
=> [ "string" , "object" ],
1044 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" ,
1049 description
=> "Whether this is the default key in a comma separated list property string." ,
1054 description
=> "This indicates the default for the instance property."
1058 description
=> "Bash completion function. This function should return a list of possible values." ,
1064 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." ,
1069 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
1072 # this is from hyper schema
1075 description
=> "This defines the link relations of the instance objects" ,
1082 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" ,
1086 description
=> "This is the name of the link relation" ,
1092 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
1102 my $default_schema = Storable
:: dclone
( $default_schema_noref );
1104 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
1105 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
1107 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
1108 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
1110 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
1111 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
1113 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
1114 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
1116 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
1117 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
1119 my $method_schema = {
1121 additionalProperties
=> 0 ,
1124 description
=> "This a description of the method" ,
1129 description
=> "This indicates the name of the function to call." ,
1132 additionalProperties
=> 1 ,
1147 description
=> "The HTTP method name." ,
1148 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
1153 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
1158 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
1163 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
1165 additionalProperties
=> 0 ,
1168 description
=> "Describe access permissions." ,
1172 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
1174 enum
=> [ 'all' , 'world' ],
1178 description
=> "Array of permission checks (prefix notation)." ,
1185 description
=> "Used internally" ,
1189 description
=> "Used internally" ,
1194 description
=> "path for URL matching (uri template)" ,
1196 fragmentDelimiter
=> {
1198 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." ,
1203 description
=> "JSON Schema for parameters." ,
1208 description
=> "Used to store page formatter information (set by PVE::RESTHandler->register_page_formatter)." ,
1213 description
=> "JSON Schema for return value." ,
1218 description
=> "method implementaion (code reference)" ,
1223 description
=> "Delegate call to this class (perl class string)." ,
1226 additionalProperties
=> 0 ,
1232 fragmentDelimiter
=> { optional
=> 1 }
1240 sub validate_schema
{
1243 my $errmsg = "internal error - unable to verify schema \n " ;
1244 validate
( $schema, $default_schema, $errmsg );
1247 sub validate_method_info
{
1250 my $errmsg = "internal error - unable to verify method info \n " ;
1251 validate
( $info, $method_schema, $errmsg );
1253 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1254 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1257 # run a self test on load
1258 # make sure we can verify the default schema
1259 validate_schema
( $default_schema_noref );
1260 validate_schema
( $method_schema );
1262 # and now some utility methods (used by pve api)
1263 sub method_get_child_link
{
1266 return undef if ! $info ;
1268 my $schema = $info ->{ returns
};
1269 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1271 my $links = $schema ->{ links
};
1272 return undef if ! $links ;
1275 foreach my $lnk ( @$links ) {
1276 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1285 # a way to parse command line parameters, using a
1286 # schema to configure Getopt::Long
1288 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1290 if (! $schema || ! $schema ->{ properties
}) {
1291 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1292 if scalar ( @$args ) != 0 ;
1297 if ( $arg_param && ! ref ( $arg_param )) {
1298 my $pd = $schema ->{ properties
}->{ $arg_param };
1299 die "expected list format $pd ->{format}"
1300 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1301 $list_param = $arg_param ;
1305 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1306 my $pd = $schema ->{ properties
}->{ $prop };
1307 next if $list_param && $prop eq $list_param ;
1308 next if defined ( $fixed_param ->{ $prop });
1310 if ( $prop eq 'password' && $pwcallback ) {
1311 # we do not accept plain password on input line, instead
1312 # we turn this into a boolean option and ask for password below
1313 # using $pwcallback() (for security reasons).
1314 push @getopt, " $prop " ;
1315 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1316 push @getopt, " $prop :s" ;
1318 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1319 push @getopt, " $prop =s@" ;
1321 push @getopt, " $prop =s" ;
1326 Getopt
:: Long
:: Configure
( 'prefix_pattern=(--|-)' );
1329 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1330 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1334 $opts ->{ $list_param } = $args ;
1336 } elsif ( ref ( $arg_param )) {
1337 foreach my $arg_name ( @$arg_param ) {
1338 if ( $opts ->{ 'extra-args' }) {
1339 raise
( "internal error: extra-args must be the last argument \n " , code
=> HTTP_BAD_REQUEST
);
1341 if ( $arg_name eq 'extra-args' ) {
1342 $opts ->{ 'extra-args' } = $args ;
1346 raise
( "not enough arguments \n " , code
=> HTTP_BAD_REQUEST
) if ! @$args ;
1347 $opts ->{ $arg_name } = shift @$args ;
1349 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
) if @$args ;
1351 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1352 if scalar ( @$args ) != 0 ;
1356 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1357 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1358 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1359 $opts ->{ password
} = & $pwcallback ();
1364 $opts = PVE
:: Tools
:: decode_utf8_parameters
( $opts );
1366 foreach my $p ( keys %$opts ) {
1367 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1368 if ( $pd ->{ type
} eq 'boolean' ) {
1369 if ( $opts ->{ $p } eq '' ) {
1371 } elsif ( $opts ->{ $p } =~ m/^(1|true|yes|on)$/i ) {
1373 } elsif ( $opts ->{ $p } =~ m/^(0|false|no|off)$/i ) {
1376 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1378 } elsif ( $pd ->{ format
}) {
1380 if ( $pd ->{ format
} =~ m/-list/ ) {
1381 # allow --vmid 100 --vmid 101 and --vmid 100,101
1382 # allow --dow mon --dow fri and --dow mon,fri
1383 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }}) if ref ( $opts ->{ $p }) eq 'ARRAY' ;
1384 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1385 # we encode array as \0 separated strings
1386 # Note: CGI.pm also use this encoding
1387 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1388 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1390 # st that split_list knows it is \0 terminated
1391 my $v = $opts ->{ $p }->[ 0 ];
1392 $opts ->{ $p } = " $v\0 " ;
1399 foreach my $p ( keys %$fixed_param ) {
1400 $opts ->{ $p } = $fixed_param ->{ $p };
1406 # A way to parse configuration data by giving a json schema
1408 my ( $schema, $filename, $raw ) = @_ ;
1410 # do fast check (avoid validate_schema($schema))
1411 die "got strange schema" if ! $schema ->{ type
} ||
1412 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1416 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1419 next if $line =~ /^#/ ;
1421 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1424 if ( $schema ->{ properties
}->{ $key } &&
1425 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1427 $value = 1 if $value =~ m/^(1|on|yes|true)$/i ;
1428 $value = 0 if $value =~ m/^(0|off|no|false)$/i ;
1430 $cfg ->{ $key } = $value ;
1432 warn "ignore config line: $line\n "
1437 check_prop
( $cfg, $schema, '' , $errors );
1439 foreach my $k ( keys %$errors ) {
1440 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1447 # generate simple key/value file
1449 my ( $schema, $filename, $cfg ) = @_ ;
1451 # do fast check (avoid validate_schema($schema))
1452 die "got strange schema" if ! $schema ->{ type
} ||
1453 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1455 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1459 foreach my $k ( keys %$cfg ) {
1460 $data .= " $k : $cfg ->{ $k } \n " ;