]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/JSONSchema.pm
1 package PVE
:: JSONSchema
;
5 use Storable
; # for dclone
9 use Devel
:: Cycle
- quiet
; # todo: remove?
10 use PVE
:: Tools
qw(split_list $IPV6RE $IPV4RE ) ;
11 use PVE
:: Exception
qw(raise) ;
12 use HTTP
:: Status
qw(:constants) ;
13 use Net
:: IP
qw(:PROC) ;
19 register_standard_option
23 # Note: This class implements something similar to JSON schema, but it is not 100% complete.
24 # see: http://tools.ietf.org/html/draft-zyp-json-schema-02
25 # see: http://json-schema.org/
27 # the code is similar to the javascript parser from http://code.google.com/p/jsonschema/
29 my $standard_options = {};
30 sub register_standard_option
{
31 my ( $name, $schema ) = @_ ;
33 die "standard option ' $name ' already registered \n "
34 if $standard_options ->{ $name };
36 $standard_options ->{ $name } = $schema ;
39 sub get_standard_option
{
40 my ( $name, $base ) = @_ ;
42 my $std = $standard_options ->{ $name };
43 die "no such standard option ' $name ' \n " if ! $std ;
45 my $res = $base || {};
47 foreach my $opt ( keys %$std ) {
48 next if defined ( $res ->{ $opt });
49 $res ->{ $opt } = $std ->{ $opt };
55 register_standard_option
( 'pve-vmid' , {
56 description
=> "The (unique) ID of the VM." ,
57 type
=> 'integer' , format
=> 'pve-vmid' ,
61 register_standard_option
( 'pve-node' , {
62 description
=> "The cluster node name." ,
63 type
=> 'string' , format
=> 'pve-node' ,
66 register_standard_option
( 'pve-node-list' , {
67 description
=> "List of cluster node names." ,
68 type
=> 'string' , format
=> 'pve-node-list' ,
71 register_standard_option
( 'pve-iface' , {
72 description
=> "Network interface name." ,
73 type
=> 'string' , format
=> 'pve-iface' ,
74 minLength
=> 2 , maxLength
=> 20 ,
77 register_standard_option
( 'pve-storage-id' , {
78 description
=> "The storage identifier." ,
79 type
=> 'string' , format
=> 'pve-storage-id' ,
82 register_standard_option
( 'pve-config-digest' , {
83 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.' ,
86 maxLength
=> 40 , # sha1 hex digest lenght is 40
89 register_standard_option
( 'skiplock' , {
90 description
=> "Ignore locks - only root is allowed to use this option." ,
95 register_standard_option
( 'extra-args' , {
96 description
=> "Extra arguments as array" ,
98 items
=> { type
=> 'string' },
102 my $format_list = {};
104 sub register_format
{
105 my ( $format, $code ) = @_ ;
107 die "JSON schema format ' $format ' already registered \n "
108 if $format_list ->{ $format };
110 $format_list ->{ $format } = $code ;
115 return $format_list ->{ $format };
118 # register some common type for pve
120 register_format
( 'string' , sub {}); # allow format => 'string-list'
122 register_format
( 'urlencoded' , \
& pve_verify_urlencoded
);
123 sub pve_verify_urlencoded
{
124 my ( $text, $noerr ) = @_ ;
125 if ( $text !~ /^[-%a-zA-Z0-9_.!~*'()]*$/ ) {
126 return undef if $noerr ;
127 die "invalid urlencoded string: $text\n " ;
132 register_format
( 'pve-configid' , \
& pve_verify_configid
);
133 sub pve_verify_configid
{
134 my ( $id, $noerr ) = @_ ;
136 if ( $id !~ m/^[a-z][a-z0-9_]+$/i ) {
137 return undef if $noerr ;
138 die "invalid configuration ID ' $id ' \n " ;
143 PVE
:: JSONSchema
:: register_format
( 'pve-storage-id' , \
& parse_storage_id
);
144 sub parse_storage_id
{
145 my ( $storeid, $noerr ) = @_ ;
147 if ( $storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i ) {
148 return undef if $noerr ;
149 die "storage ID ' $storeid ' contains illegal characters \n " ;
155 register_format
( 'pve-vmid' , \
& pve_verify_vmid
);
156 sub pve_verify_vmid
{
157 my ( $vmid, $noerr ) = @_ ;
159 if ( $vmid !~ m/^[1-9][0-9]{2,8}$/ ) {
160 return undef if $noerr ;
161 die "value does not look like a valid VM ID \n " ;
166 register_format
( 'pve-node' , \
& pve_verify_node_name
);
167 sub pve_verify_node_name
{
168 my ( $node, $noerr ) = @_ ;
170 if ( $node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)$/ ) {
171 return undef if $noerr ;
172 die "value does not look like a valid node name \n " ;
177 register_format
( 'ipv4' , \
& pve_verify_ipv4
);
178 sub pve_verify_ipv4
{
179 my ( $ipv4, $noerr ) = @_ ;
181 if ( $ipv4 !~ m/^(?:$IPV4RE)$/ ) {
182 return undef if $noerr ;
183 die "value does not look like a valid IPv4 address \n " ;
188 register_format
( 'ipv6' , \
& pve_verify_ipv6
);
189 sub pve_verify_ipv6
{
190 my ( $ipv6, $noerr ) = @_ ;
192 if ( $ipv6 !~ m/^(?:$IPV6RE)$/ ) {
193 return undef if $noerr ;
194 die "value does not look like a valid IPv6 address \n " ;
199 register_format
( 'ip' , \
& pve_verify_ip
);
201 my ( $ip, $noerr ) = @_ ;
203 if ( $ip !~ m/^(?:(?:$IPV4RE)|(?:$IPV6RE))$/ ) {
204 return undef if $noerr ;
205 die "value does not look like a valid IP address \n " ;
210 my $ipv4_mask_hash = {
227 '255.255.128.0' => 17 ,
228 '255.255.192.0' => 18 ,
229 '255.255.224.0' => 19 ,
230 '255.255.240.0' => 20 ,
231 '255.255.248.0' => 21 ,
232 '255.255.252.0' => 22 ,
233 '255.255.254.0' => 23 ,
234 '255.255.255.0' => 24 ,
235 '255.255.255.128' => 25 ,
236 '255.255.255.192' => 26 ,
237 '255.255.255.224' => 27 ,
238 '255.255.255.240' => 28 ,
239 '255.255.255.248' => 29 ,
240 '255.255.255.252' => 30 ,
241 '255.255.255.254' => 31 ,
242 '255.255.255.255' => 32 ,
245 register_format
( 'ipv4mask' , \
& pve_verify_ipv4mask
);
246 sub pve_verify_ipv4mask
{
247 my ( $mask, $noerr ) = @_ ;
249 if (! defined ( $ipv4_mask_hash ->{ $mask })) {
250 return undef if $noerr ;
251 die "value does not look like a valid IP netmask \n " ;
256 register_format
( 'CIDRv6' , \
& pve_verify_cidrv6
);
257 sub pve_verify_cidrv6
{
258 my ( $cidr, $noerr ) = @_ ;
260 if ( $cidr =~ m!^(?:$IPV6RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 120 )) {
264 return undef if $noerr ;
265 die "value does not look like a valid IPv6 CIDR network \n " ;
268 register_format
( 'CIDRv4' , \
& pve_verify_cidrv4
);
269 sub pve_verify_cidrv4
{
270 my ( $cidr, $noerr ) = @_ ;
272 if ( $cidr =~ m!^(?:$IPV4RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 32 )) {
276 return undef if $noerr ;
277 die "value does not look like a valid IPv4 CIDR network \n " ;
280 register_format
( 'CIDR' , \
& pve_verify_cidr
);
281 sub pve_verify_cidr
{
282 my ( $cidr, $noerr ) = @_ ;
284 if (!( pve_verify_cidrv4
( $cidr, 1 ) ||
285 pve_verify_cidrv6
( $cidr, 1 )))
287 return undef if $noerr ;
288 die "value does not look like a valid CIDR network \n " ;
294 register_format
( 'pve-ipv4-config' , \
& pve_verify_ipv4_config
);
295 sub pve_verify_ipv4_config
{
296 my ( $config, $noerr ) = @_ ;
298 return $config if $config =~ /^(?:dhcp|manual)$/ ||
299 pve_verify_cidrv4
( $config, 1 );
300 return undef if $noerr ;
301 die "value does not look like a valid ipv4 network configuration \n " ;
304 register_format
( 'pve-ipv6-config' , \
& pve_verify_ipv6_config
);
305 sub pve_verify_ipv6_config
{
306 my ( $config, $noerr ) = @_ ;
308 return $config if $config =~ /^(?:auto|dhcp|manual)$/ ||
309 pve_verify_cidrv6
( $config, 1 );
310 return undef if $noerr ;
311 die "value does not look like a valid ipv6 network configuration \n " ;
314 register_format
( 'email' , \
& pve_verify_email
);
315 sub pve_verify_email
{
316 my ( $email, $noerr ) = @_ ;
318 # we use same regex as in Utils.js
319 if ( $email !~ /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,63}$/ ) {
320 return undef if $noerr ;
321 die "value does not look like a valid email address \n " ;
326 register_format
( 'dns-name' , \
& pve_verify_dns_name
);
327 sub pve_verify_dns_name
{
328 my ( $name, $noerr ) = @_ ;
330 my $namere = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)" ;
332 if ( $name !~ /^(${namere}\.)*${namere}$/ ) {
333 return undef if $noerr ;
334 die "value does not look like a valid DNS name \n " ;
339 # network interface name
340 register_format
( 'pve-iface' , \
& pve_verify_iface
);
341 sub pve_verify_iface
{
342 my ( $id, $noerr ) = @_ ;
344 if ( $id !~ m/^[a-z][a-z0-9_]{1,20}([:\.]\d+)?$/i ) {
345 return undef if $noerr ;
346 die "invalid network interface name ' $id ' \n " ;
351 # general addresses by name or IP
352 register_format
( 'address' , \
& pve_verify_address
);
353 sub pve_verify_address
{
354 my ( $addr, $noerr ) = @_ ;
356 if (!( pve_verify_ip
( $addr, 1 ) ||
357 pve_verify_dns_name
( $addr, 1 )))
359 return undef if $noerr ;
360 die "value does not look like a valid address: $addr\n " ;
365 register_format
( 'disk-size' , \
& pve_verify_disk_size
);
366 sub pve_verify_disk_size
{
367 my ( $size, $noerr ) = @_ ;
368 if (! defined ( parse_size
( $size ))) {
369 return undef if $noerr ;
370 die "value does not look like a valid disk size: $size\n " ;
375 register_standard_option
( 'spice-proxy' , {
376 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)." ,
377 type
=> 'string' , format
=> 'address' ,
380 register_standard_option
( 'remote-viewer-config' , {
381 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
382 additionalProperties
=> 1 ,
384 type
=> { type
=> 'string' },
385 password
=> { type
=> 'string' },
386 proxy
=> { type
=> 'string' },
387 host
=> { type
=> 'string' },
388 'tls-port' => { type
=> 'integer' },
392 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
393 sub pve_verify_startup_order
{
394 my ( $value, $noerr ) = @_ ;
396 return $value if pve_parse_startup_order
( $value );
398 return undef if $noerr ;
400 die "unable to parse startup options \n " ;
403 sub pve_parse_startup_order
{
406 return undef if ! $value ;
410 foreach my $p ( split ( /,/ , $value )) {
411 next if $p =~ m/^\s*$/ ;
413 if ( $p =~ m/^(order=)?(\d+)$/ ) {
415 } elsif ( $p =~ m/^up=(\d+)$/ ) {
417 } elsif ( $p =~ m/^down=(\d+)$/ ) {
427 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
428 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." ,
430 type
=> 'string' , format
=> 'pve-startup-order' ,
431 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
435 my ( $format, $value, $path ) = @_ ;
437 return parse_property_string
( $format, $value, $path ) if ref ( $format ) eq 'HASH' ;
438 return if $format eq 'regex' ;
440 if ( $format =~ m/^(.*)-a?list$/ ) {
442 my $code = $format_list ->{ $1 };
444 die "undefined format ' $format ' \n " if ! $code ;
446 # Note: we allow empty lists
447 foreach my $v ( split_list
( $value )) {
451 } elsif ( $format =~ m/^(.*)-opt$/ ) {
453 my $code = $format_list ->{ $1 };
455 die "undefined format ' $format ' \n " if ! $code ;
457 return if ! $value ; # allow empty string
463 my $code = $format_list ->{ $format };
465 die "undefined format ' $format ' \n " if ! $code ;
467 return parse_property_string
( $code, $value, $path ) if ref ( $code ) eq 'HASH' ;
475 return undef if $value !~ m/^(\d+(\.\d+)?)([KMGT])?$/ ;
476 my ( $size, $unit ) = ( $1, $3 );
479 $size = $size * 1024 ;
480 } elsif ( $unit eq 'M' ) {
481 $size = $size * 1024 * 1024 ;
482 } elsif ( $unit eq 'G' ) {
483 $size = $size * 1024 * 1024 * 1024 ;
484 } elsif ( $unit eq 'T' ) {
485 $size = $size * 1024 * 1024 * 1024 * 1024 ;
496 my $kb = int ( $size/1024 );
497 return $size if $kb*1024 != $size ;
499 my $mb = int ( $kb/1024 );
500 return "${kb}K" if $mb*1024 != $kb ;
502 my $gb = int ( $mb/1024 );
503 return "${mb}M" if $gb*1024 != $mb ;
505 my $tb = int ( $gb/1024 );
506 return "${gb}G" if $tb*1024 != $gb ;
513 return 1 if $bool =~ m/^(1|on|yes|true)$/i ;
514 return 0 if $bool =~ m/^(0|off|no|false)$/i ;
518 sub parse_property_string
{
519 my ( $format, $data, $path, $additional_properties ) = @_ ;
521 # In property strings we default to not allowing additional properties
522 $additional_properties = 0 if ! defined ( $additional_properties );
524 # Support named formats here, too:
526 if ( my $desc = $format_list ->{ $format }) {
529 die "unknown format: $format\n " ;
531 } elsif ( ref ( $format ) ne 'HASH' ) {
532 die "unexpected format value of type " . ref ( $format ). " \n " ;
538 foreach my $part ( split ( /,/ , $data )) {
539 next if $part =~ /^\s*$/ ;
541 if ( $part =~ /^([^=]+)=(.+)$/ ) {
542 my ( $k, $v ) = ( $1, $2 );
543 die "duplicate key in comma-separated list property: $k\n " if defined ( $res ->{ $k });
544 my $schema = $format ->{ $k };
545 if ( my $alias = $schema ->{ alias
}) {
546 if ( my $key_alias = $schema ->{ keyAlias
}) {
547 die "key alias ' $key_alias ' is already defined \n " if defined ( $res ->{ $key_alias });
548 $res ->{ $key_alias } = $k ;
551 $schema = $format ->{ $k };
554 die "invalid key in comma-separated list property: $k\n " if ! $schema ;
555 if ( $schema ->{ type
} && $schema ->{ type
} eq 'boolean' ) {
556 $v = parse_boolean
( $v ) // $v ;
559 } elsif ( $part !~ /=/ ) {
560 die "duplicate key in comma-separated list property: $default_key\n " if $default_key ;
561 foreach my $key ( keys %$format ) {
562 if ( $format ->{ $key }->{ default_key
}) {
564 if (! $res ->{ $default_key }) {
565 $res ->{ $default_key } = $part ;
568 die "duplicate key in comma-separated list property: $default_key\n " ;
571 die "value without key, but schema does not define a default key \n " if ! $default_key ;
573 die "missing key in comma-separated list property \n " ;
578 check_object
( $path, $format, $res, $additional_properties, $errors );
579 if ( scalar ( %$errors )) {
580 raise
"format error \n " , errors
=> $errors ;
587 my ( $errors, $path, $msg ) = @_ ;
589 $path = '_root' if ! $path ;
591 if ( $errors ->{ $path }) {
592 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
594 $errors ->{ $path } = $msg ;
601 # see 'man perlretut'
602 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
608 return $value =~ m/^[+-]?\d+$/ ;
612 my ( $path, $type, $value, $errors ) = @_ ;
616 if (! defined ( $value )) {
617 return 1 if $type eq 'null' ;
621 if ( my $tt = ref ( $type )) {
622 if ( $tt eq 'ARRAY' ) {
623 foreach my $t ( @$type ) {
625 check_type
( $path, $t, $value, $tmperr );
626 return 1 if ! scalar ( %$tmperr );
628 my $ttext = join ( '|' , @$type );
629 add_error
( $errors, $path, "type check (' $ttext ') failed" );
631 } elsif ( $tt eq 'HASH' ) {
633 check_prop
( $value, $type, $path, $tmperr );
634 return 1 if ! scalar ( %$tmperr );
635 add_error
( $errors, $path, "type check failed" );
638 die "internal error - got reference type ' $tt '" ;
643 return 1 if $type eq 'any' ;
645 if ( $type eq 'null' ) {
646 if ( defined ( $value )) {
647 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
653 my $vt = ref ( $value );
655 if ( $type eq 'array' ) {
656 if (! $vt || $vt ne 'ARRAY' ) {
657 add_error
( $errors, $path, "type check (' $type ') failed" );
661 } elsif ( $type eq 'object' ) {
662 if (! $vt || $vt ne 'HASH' ) {
663 add_error
( $errors, $path, "type check (' $type ') failed" );
667 } elsif ( $type eq 'coderef' ) {
668 if (! $vt || $vt ne 'CODE' ) {
669 add_error
( $errors, $path, "type check (' $type ') failed" );
673 } elsif ( $type eq 'string' && $vt eq 'Regexp' ) {
674 # qr// regexes can be used as strings and make sense for format=regex
678 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
681 if ( $type eq 'string' ) {
682 return 1 ; # nothing to check ?
683 } elsif ( $type eq 'boolean' ) {
684 #if ($value =~ m/^(1|true|yes|on)$/i) {
687 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
688 } elsif ( $value eq '0' ) {
689 return 1 ; # return success (not value)
691 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
694 } elsif ( $type eq 'integer' ) {
695 if (! is_integer
( $value )) {
696 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
700 } elsif ( $type eq 'number' ) {
701 if (! is_number
( $value )) {
702 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
707 return 1 ; # no need to verify unknown types
717 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
719 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
721 my $st = ref ( $schema );
722 if (! $st || $st ne 'HASH' ) {
723 add_error
( $errors, $path, "Invalid schema definition." );
727 my $vt = ref ( $value );
728 if (! $vt || $vt ne 'HASH' ) {
729 add_error
( $errors, $path, "an object is required" );
733 foreach my $k ( keys %$schema ) {
734 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
737 foreach my $k ( keys %$value ) {
739 my $newpath = $path ?
" $path . $k " : $k ;
741 if ( my $subschema = $schema ->{ $k }) {
742 if ( my $requires = $subschema ->{ requires
}) {
743 if ( ref ( $requires )) {
744 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
745 check_prop
( $value, $requires, $path, $errors );
746 } elsif (! defined ( $value ->{ $requires })) {
747 add_error
( $errors, $path ?
" $path . $requires " : $requires,
748 "missing property - ' $newpath ' requires this property" );
752 next ; # value is already checked above
755 if ( defined ( $additional_properties ) && ! $additional_properties ) {
756 add_error
( $errors, $newpath, "property is not defined in schema " .
757 "and the schema does not allow additional properties" );
760 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
761 if ref ( $additional_properties );
765 sub check_object_warn
{
766 my ( $path, $schema, $value, $additional_properties ) = @_ ;
768 check_object
( $path, $schema, $value, $additional_properties, $errors );
769 if ( scalar ( %$errors )) {
770 foreach my $k ( keys %$errors ) {
771 warn "parse error: $k : $errors ->{ $k } \n " ;
779 my ( $value, $schema, $path, $errors ) = @_ ;
781 die "internal error - no schema" if ! $schema ;
782 die "internal error" if ! $errors ;
784 #print "check_prop $path\n" if $value;
786 my $st = ref ( $schema );
787 if (! $st || $st ne 'HASH' ) {
788 add_error
( $errors, $path, "Invalid schema definition." );
792 # if it extends another schema, it must pass that schema as well
793 if ( $schema ->{ extends
}) {
794 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
797 if (! defined ( $value )) {
798 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
799 if (! $schema ->{ optional
} && ! $schema ->{ alias
} && ! $schema ->{ group
}) {
800 add_error
( $errors, $path, "property is missing and it is not optional" );
805 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
807 if ( $schema ->{ disallow
}) {
809 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
810 add_error
( $errors, $path, "disallowed value was matched" );
815 if ( my $vt = ref ( $value )) {
817 if ( $vt eq 'ARRAY' ) {
818 if ( $schema ->{ items
}) {
819 my $it = ref ( $schema ->{ items
});
820 if ( $it && $it eq 'ARRAY' ) {
821 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
822 die "not implemented" ;
825 foreach my $el ( @$value ) {
826 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
832 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
833 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
834 $value, $schema ->{ additionalProperties
}, $errors );
840 if ( my $format = $schema ->{ format
}) {
841 eval { check_format
( $format, $value, $path ); };
843 add_error
( $errors, $path, "invalid format - $@ " );
848 if ( my $pattern = $schema ->{ pattern
}) {
849 if ( $value !~ m/^$pattern$/ ) {
850 add_error
( $errors, $path, "value does not match the regex pattern" );
855 if ( defined ( my $max = $schema ->{ maxLength
})) {
856 if ( length ( $value ) > $max ) {
857 add_error
( $errors, $path, "value may only be $max characters long" );
862 if ( defined ( my $min = $schema ->{ minLength
})) {
863 if ( length ( $value ) < $min ) {
864 add_error
( $errors, $path, "value must be at least $min characters long" );
869 if ( is_number
( $value )) {
870 if ( defined ( my $max = $schema ->{ maximum
})) {
872 add_error
( $errors, $path, "value must have a maximum value of $max " );
877 if ( defined ( my $min = $schema ->{ minimum
})) {
879 add_error
( $errors, $path, "value must have a minimum value of $min " );
885 if ( my $ea = $schema ->{ enum
}) {
888 foreach my $ev ( @$ea ) {
895 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
896 join ( ", " , @$ea ) . "'" );
903 my ( $instance, $schema, $errmsg ) = @_ ;
906 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
908 # todo: cycle detection is only needed for debugging, I guess
909 # we can disable that in the final release
910 # todo: is there a better/faster way to detect cycles?
912 find_cycle
( $instance, sub { $cycles = 1 });
914 add_error
( $errors, undef , "data structure contains recursive cycles" );
916 check_prop
( $instance, $schema, '' , $errors );
919 if ( scalar ( %$errors )) {
920 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
926 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
927 my $default_schema_noref = {
928 description
=> "This is the JSON Schema for JSON Schemas." ,
929 type
=> [ "object" ],
930 additionalProperties
=> 0 ,
933 type
=> [ "string" , "array" ],
934 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
939 enum
=> $schema_valid_types,
941 enum
=> $schema_valid_types,
945 description
=> "This indicates that the instance property in the instance object is not required." ,
951 description
=> "This is a definition for the properties of an object value" ,
957 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
961 additionalProperties
=> {
962 type
=> [ "boolean" , "object" ],
963 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
970 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
975 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
979 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
986 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
992 description
=> "A text representation of the type (used to generate documentation)." ,
997 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." ,
1004 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
1009 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)." ,
1011 verbose_description
=> {
1014 description
=> "This provides a more verbose description." ,
1016 format_description
=> {
1019 description
=> "This provides a shorter (usually just one word) description for a property used to generate descriptions for comma separated list property strings." ,
1024 description
=> "This provides the title of the property" ,
1027 type
=> [ "string" , "object" ],
1029 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
1032 type
=> [ "string" , "object" ],
1034 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" ,
1039 description
=> "Whether this is the default key in a comma separated list property string." ,
1044 description
=> "When a key represents the same property as another it can be an alias to it, causing the parsed datastructure to use the other key to store the current value under." ,
1049 description
=> "Allows to store the current 'key' as value of another property. Only valid if used together with 'alias'." ,
1050 requires
=> 'alias' ,
1055 description
=> "This indicates the default for the instance property."
1059 description
=> "Bash completion function. This function should return a list of possible values." ,
1065 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, then this instance is not valid." ,
1070 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
1073 # this is from hyper schema
1076 description
=> "This defines the link relations of the instance objects" ,
1083 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" ,
1087 description
=> "This is the name of the link relation" ,
1093 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
1103 my $default_schema = Storable
:: dclone
( $default_schema_noref );
1105 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
1106 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
1108 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
1109 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
1111 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
1112 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
1114 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
1115 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
1117 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
1118 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
1120 my $method_schema = {
1122 additionalProperties
=> 0 ,
1125 description
=> "This a description of the method" ,
1130 description
=> "This indicates the name of the function to call." ,
1133 additionalProperties
=> 1 ,
1148 description
=> "The HTTP method name." ,
1149 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
1154 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
1159 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
1162 proxyto_callback
=> {
1164 description
=> "A function which is called to resolve the proxyto attribute. The default implementaion returns the value of the 'proxyto' parameter." ,
1169 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
1171 additionalProperties
=> 0 ,
1174 description
=> "Describe access permissions." ,
1178 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
1180 enum
=> [ 'all' , 'world' ],
1184 description
=> "Array of permission checks (prefix notation)." ,
1191 description
=> "Used internally" ,
1195 description
=> "Used internally" ,
1200 description
=> "path for URL matching (uri template)" ,
1202 fragmentDelimiter
=> {
1204 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." ,
1209 description
=> "JSON Schema for parameters." ,
1214 description
=> "JSON Schema for return value." ,
1219 description
=> "method implementaion (code reference)" ,
1224 description
=> "Delegate call to this class (perl class string)." ,
1227 additionalProperties
=> 0 ,
1233 fragmentDelimiter
=> { optional
=> 1 }
1241 sub validate_schema
{
1244 my $errmsg = "internal error - unable to verify schema \n " ;
1245 validate
( $schema, $default_schema, $errmsg );
1248 sub validate_method_info
{
1251 my $errmsg = "internal error - unable to verify method info \n " ;
1252 validate
( $info, $method_schema, $errmsg );
1254 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1255 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1258 # run a self test on load
1259 # make sure we can verify the default schema
1260 validate_schema
( $default_schema_noref );
1261 validate_schema
( $method_schema );
1263 # and now some utility methods (used by pve api)
1264 sub method_get_child_link
{
1267 return undef if ! $info ;
1269 my $schema = $info ->{ returns
};
1270 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1272 my $links = $schema ->{ links
};
1273 return undef if ! $links ;
1276 foreach my $lnk ( @$links ) {
1277 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1286 # a way to parse command line parameters, using a
1287 # schema to configure Getopt::Long
1289 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1291 if (! $schema || ! $schema ->{ properties
}) {
1292 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1293 if scalar ( @$args ) != 0 ;
1298 if ( $arg_param && ! ref ( $arg_param )) {
1299 my $pd = $schema ->{ properties
}->{ $arg_param };
1300 die "expected list format $pd ->{format}"
1301 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1302 $list_param = $arg_param ;
1306 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1307 my $pd = $schema ->{ properties
}->{ $prop };
1308 next if $list_param && $prop eq $list_param ;
1309 next if defined ( $fixed_param ->{ $prop });
1311 if ( $prop eq 'password' && $pwcallback ) {
1312 # we do not accept plain password on input line, instead
1313 # we turn this into a boolean option and ask for password below
1314 # using $pwcallback() (for security reasons).
1315 push @getopt, " $prop " ;
1316 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1317 push @getopt, " $prop :s" ;
1319 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1320 push @getopt, " $prop =s@" ;
1322 push @getopt, " $prop =s" ;
1327 Getopt
:: Long
:: Configure
( 'prefix_pattern=(--|-)' );
1330 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1331 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1335 $opts ->{ $list_param } = $args ;
1337 } elsif ( ref ( $arg_param )) {
1338 foreach my $arg_name ( @$arg_param ) {
1339 if ( $opts ->{ 'extra-args' }) {
1340 raise
( "internal error: extra-args must be the last argument \n " , code
=> HTTP_BAD_REQUEST
);
1342 if ( $arg_name eq 'extra-args' ) {
1343 $opts ->{ 'extra-args' } = $args ;
1347 raise
( "not enough arguments \n " , code
=> HTTP_BAD_REQUEST
) if ! @$args ;
1348 $opts ->{ $arg_name } = shift @$args ;
1350 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
) if @$args ;
1352 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1353 if scalar ( @$args ) != 0 ;
1357 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1358 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1359 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1360 $opts ->{ password
} = & $pwcallback ();
1365 # decode after Getopt as we are not sure how well it handles unicode
1366 foreach my $p ( keys %$opts ) {
1367 if (! ref ( $opts ->{ $p })) {
1368 $opts ->{ $p } = decode
( 'locale' , $opts ->{ $p });
1369 } elsif ( ref ( $opts ->{ $p }) eq 'ARRAY' ) {
1371 foreach my $v (@{ $opts ->{ $p }}) {
1372 push @$tmp, decode
( 'locale' , $v );
1375 } elsif ( ref ( $opts ->{ $p }) eq 'SCALAR' ) {
1376 $opts ->{ $p } = decode
( 'locale' , $$opts ->{ $p });
1378 raise
( "decoding options failed, unknown reference \n " , code
=> HTTP_BAD_REQUEST
);
1382 foreach my $p ( keys %$opts ) {
1383 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1384 if ( $pd ->{ type
} eq 'boolean' ) {
1385 if ( $opts ->{ $p } eq '' ) {
1387 } elsif ( defined ( my $bool = parse_boolean
( $opts ->{ $p }))) {
1388 $opts ->{ $p } = $bool ;
1390 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1392 } elsif ( $pd ->{ format
}) {
1394 if ( $pd ->{ format
} =~ m/-list/ ) {
1395 # allow --vmid 100 --vmid 101 and --vmid 100,101
1396 # allow --dow mon --dow fri and --dow mon,fri
1397 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }}) if ref ( $opts ->{ $p }) eq 'ARRAY' ;
1398 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1399 # we encode array as \0 separated strings
1400 # Note: CGI.pm also use this encoding
1401 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1402 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1404 # st that split_list knows it is \0 terminated
1405 my $v = $opts ->{ $p }->[ 0 ];
1406 $opts ->{ $p } = " $v\0 " ;
1413 foreach my $p ( keys %$fixed_param ) {
1414 $opts ->{ $p } = $fixed_param ->{ $p };
1420 # A way to parse configuration data by giving a json schema
1422 my ( $schema, $filename, $raw ) = @_ ;
1424 # do fast check (avoid validate_schema($schema))
1425 die "got strange schema" if ! $schema ->{ type
} ||
1426 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1430 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1433 next if $line =~ /^#/ ;
1435 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1438 if ( $schema ->{ properties
}->{ $key } &&
1439 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1441 $value = parse_boolean
( $value ) // $value ;
1443 $cfg ->{ $key } = $value ;
1445 warn "ignore config line: $line\n "
1450 check_prop
( $cfg, $schema, '' , $errors );
1452 foreach my $k ( keys %$errors ) {
1453 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1460 # generate simple key/value file
1462 my ( $schema, $filename, $cfg ) = @_ ;
1464 # do fast check (avoid validate_schema($schema))
1465 die "got strange schema" if ! $schema ->{ type
} ||
1466 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1468 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1472 foreach my $k ( keys %$cfg ) {
1473 $data .= " $k : $cfg ->{ $k } \n " ;
1479 # helpers used to generate our manual pages
1481 my $find_schema_default_key = sub {
1485 my $keyAliasProps = {};
1487 foreach my $key ( keys %$format ) {
1488 my $phash = $format ->{ $key };
1489 if ( $phash ->{ default_key
}) {
1490 die "multiple default keys in schema ( $default_key, $key ) \n "
1491 if defined ( $default_key );
1492 die "default key ' $key ' is an alias - this is not allowed \n "
1493 if defined ( $phash ->{ alias
});
1494 die "default key ' $key ' with keyAlias attribute is not allowed \n "
1495 if $phash ->{ keyAlias
};
1496 $default_key = $key ;
1498 my $key_alias = $phash ->{ keyAlias
};
1499 die "found keyAlias without 'alias definition for ' $key ' \n "
1500 if $key_alias && ! $phash ->{ alias
};
1502 if ( $phash ->{ alias
} && $key_alias ) {
1503 die "inconsistent keyAlias ' $key_alias ' definition"
1504 if defined ( $keyAliasProps ->{ $key_alias }) &&
1505 $keyAliasProps ->{ $key_alias } ne $phash ->{ alias
};
1506 $keyAliasProps ->{ $key_alias } = $phash ->{ alias
};
1510 return wantarray ?
( $default_key, $keyAliasProps ) : $default_key ;
1513 sub generate_typetext
{
1514 my ( $format, $list_enums ) = @_ ;
1516 my ( $default_key, $keyAliasProps ) = & $find_schema_default_key ( $format );
1521 my $add_option_string = sub {
1522 my ( $text, $optional ) = @_ ;
1528 $text = "[ $text ]" if $optional ;
1533 my $format_key_value = sub {
1534 my ( $key, $phash ) = @_ ;
1536 die "internal error" if defined ( $phash ->{ alias
});
1542 if ( my $desc = $phash ->{ format_description
}) {
1543 $typetext .= "< $desc >" ;
1544 } elsif ( my $text = $phash ->{ typetext
}) {
1546 } elsif ( my $enum = $phash ->{ enum
}) {
1547 if ( $list_enums || ( scalar ( @$enum ) <= 3 )) {
1548 $typetext .= '<' . join ( '|' , @$enum ) . '>' ;
1550 $typetext .= '<enum>' ;
1552 } elsif ( $phash ->{ type
} eq 'boolean' ) {
1553 $typetext .= '<1|0>' ;
1554 } elsif ( $phash ->{ type
} eq 'integer' ) {
1555 $typetext .= '<integer>' ;
1556 } elsif ( $phash ->{ type
} eq 'number' ) {
1557 $typetext .= '<number>' ;
1559 die "internal error: neither format_description nor typetext found for option ' $key '" ;
1562 if ( defined ( $default_key ) && ( $default_key eq $key )) {
1563 & $add_option_string ( "[ $keytext =] $typetext " , $phash ->{ optional
});
1565 & $add_option_string ( " $keytext = $typetext " , $phash ->{ optional
});
1571 my $cond_add_key = sub {
1574 return if $done ->{ $key }; # avoid duplicates
1578 my $phash = $format ->{ $key };
1580 return if ! $phash ; # should not happen
1582 return if $phash ->{ alias
};
1584 & $format_key_value ( $key, $phash );
1588 & $cond_add_key ( $default_key ) if defined ( $default_key );
1590 # add required keys first
1591 foreach my $key ( sort keys %$format ) {
1592 my $phash = $format ->{ $key };
1593 & $cond_add_key ( $key ) if $phash && ! $phash ->{ optional
};
1597 foreach my $key ( sort keys %$format ) {
1598 & $cond_add_key ( $key );
1601 foreach my $keyAlias ( sort keys %$keyAliasProps ) {
1602 & $add_option_string ( "< $keyAlias >=< $keyAliasProps ->{ $keyAlias }>" , 1 );
1608 sub print_property_string
{
1609 my ( $data, $format, $skip, $path ) = @_ ;
1611 if ( ref ( $format ) ne 'HASH' ) {
1612 my $schema = get_format
( $format );
1613 die "not a valid format: $format\n " if ! $schema ;
1618 check_object
( $path, $format, $data, undef , $errors );
1619 if ( scalar ( %$errors )) {
1620 raise
"format error" , errors
=> $errors ;
1623 my ( $default_key, $keyAliasProps ) = & $find_schema_default_key ( $format );
1628 my $add_option_string = sub {
1631 $res .= ',' if $add_sep ;
1636 my $format_value = sub {
1637 my ( $key, $value, $format ) = @_ ;
1639 if ( defined ( $format ) && ( $format eq 'disk-size' )) {
1640 return format_size
( $value );
1642 die "illegal value with commas for $key\n " if $value =~ /,/ ;
1647 my $done = { map { $_ => 1 } @$skip };
1649 my $cond_add_key = sub {
1650 my ( $key, $isdefault ) = @_ ;
1652 return if $done ->{ $key }; # avoid duplicates
1656 my $value = $data ->{ $key };
1658 return if ! defined ( $value );
1660 my $phash = $format ->{ $key };
1662 # try to combine values if we have key aliases
1663 if ( my $combine = $keyAliasProps ->{ $key }) {
1664 if ( defined ( my $combine_value = $data ->{ $combine })) {
1665 my $combine_format = $format ->{ $combine }->{ format
};
1666 my $value_str = & $format_value ( $key, $value, $phash ->{ format
});
1667 my $combine_str = & $format_value ( $combine, $combine_value, $combine_format );
1668 & $add_option_string ( "${value_str}=${combine_str}" );
1669 $done ->{ $combine } = 1 ;
1674 if ( $phash && $phash ->{ alias
}) {
1675 $phash = $format ->{ $phash ->{ alias
}};
1678 die "invalid key ' $key ' \n " if ! $phash ;
1679 die "internal error" if defined ( $phash ->{ alias
});
1681 my $value_str = & $format_value ( $key, $value, $phash ->{ format
});
1683 & $add_option_string ( $value_str );
1685 & $add_option_string ( " $key =${value_str}" );
1689 # add default key first
1690 & $cond_add_key ( $default_key, 1 ) if defined ( $default_key );
1692 # add required keys first
1693 foreach my $key ( sort keys %$data ) {
1694 my $phash = $format ->{ $key };
1695 & $cond_add_key ( $key ) if $phash && ! $phash ->{ optional
};
1699 foreach my $key ( sort keys %$data ) {
1700 & $cond_add_key ( $key );
1706 sub schema_get_type_text
{
1707 my ( $phash, $style ) = @_ ;
1709 my $type = $phash ->{ type
} || 'string' ;
1711 if ( $phash ->{ typetext
}) {
1712 return $phash ->{ typetext
};
1713 } elsif ( $phash ->{ format_description
}) {
1714 return "< $phash ->{format_description}>" ;
1715 } elsif ( $phash ->{ enum
}) {
1716 return "<" . join ( ' | ' , sort @{ $phash ->{ enum
}}) . ">" ;
1717 } elsif ( $phash ->{ pattern
}) {
1718 return $phash ->{ pattern
};
1719 } elsif ( $type eq 'integer' || $type eq 'number' ) {
1720 # NOTE: always access values as number (avoid converion to string)
1721 if ( defined ( $phash ->{ minimum
}) && defined ( $phash ->{ maximum
})) {
1722 return "< $type > (" . ( $phash ->{ minimum
} + 0 ) . " - " .
1723 ( $phash ->{ maximum
} + 0 ) . ")" ;
1724 } elsif ( defined ( $phash ->{ minimum
})) {
1725 return "< $type > (" . ( $phash ->{ minimum
} + 0 ) . " - N)" ;
1726 } elsif ( defined ( $phash ->{ maximum
})) {
1727 return "< $type > (-N - " . ( $phash ->{ maximum
} + 0 ) . ")" ;
1729 } elsif ( $type eq 'string' ) {
1730 if ( my $format = $phash ->{ format
}) {
1731 $format = get_format
( $format ) if ref ( $format ) ne 'HASH' ;
1732 if ( ref ( $format ) eq 'HASH' ) {
1734 $list_enums = 1 if $style && $style eq 'config-sub' ;
1735 return generate_typetext
( $format, $list_enums );