]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/JSONSchema.pm
1 package PVE
:: JSONSchema
;
5 use Storable
; # for dclone
7 use Devel
:: Cycle
- quiet
; # todo: remove?
8 use PVE
:: Tools
qw(split_list $IPV6RE $IPV4RE ) ;
9 use PVE
:: Exception
qw(raise) ;
10 use HTTP
:: Status
qw(:constants) ;
11 use Net
:: IP
qw(:PROC) ;
16 register_standard_option
20 # Note: This class implements something similar to JSON schema, but it is not 100% complete.
21 # see: http://tools.ietf.org/html/draft-zyp-json-schema-02
22 # see: http://json-schema.org/
24 # the code is similar to the javascript parser from http://code.google.com/p/jsonschema/
26 my $standard_options = {};
27 sub register_standard_option
{
28 my ( $name, $schema ) = @_ ;
30 die "standard option ' $name ' already registered \n "
31 if $standard_options ->{ $name };
33 $standard_options ->{ $name } = $schema ;
36 sub get_standard_option
{
37 my ( $name, $base ) = @_ ;
39 my $std = $standard_options ->{ $name };
40 die "no such standard option ' $name ' \n " if ! $std ;
42 my $res = $base || {};
44 foreach my $opt ( keys %$std ) {
45 next if defined ( $res ->{ $opt });
46 $res ->{ $opt } = $std ->{ $opt };
52 register_standard_option
( 'pve-vmid' , {
53 description
=> "The (unique) ID of the VM." ,
54 type
=> 'integer' , format
=> 'pve-vmid' ,
58 register_standard_option
( 'pve-node' , {
59 description
=> "The cluster node name." ,
60 type
=> 'string' , format
=> 'pve-node' ,
63 register_standard_option
( 'pve-node-list' , {
64 description
=> "List of cluster node names." ,
65 type
=> 'string' , format
=> 'pve-node-list' ,
68 register_standard_option
( 'pve-iface' , {
69 description
=> "Network interface name." ,
70 type
=> 'string' , format
=> 'pve-iface' ,
71 minLength
=> 2 , maxLength
=> 20 ,
74 PVE
:: JSONSchema
:: register_standard_option
( 'pve-storage-id' , {
75 description
=> "The storage identifier." ,
76 type
=> 'string' , format
=> 'pve-storage-id' ,
79 PVE
:: JSONSchema
:: register_standard_option
( 'pve-config-digest' , {
80 description
=> 'Prevent changes if current configuration file has different SHA1 digest. This can be used to prevent concurrent modifications.' ,
83 maxLength
=> 40 , # sha1 hex digest lenght is 40
86 PVE
:: JSONSchema
:: register_standard_option
( 'extra-args' , {
87 description
=> "Extra arguments as array" ,
89 items
=> { type
=> 'string' },
96 my ( $format, $code ) = @_ ;
98 die "JSON schema format ' $format ' already registered \n "
99 if $format_list ->{ $format };
101 $format_list ->{ $format } = $code ;
104 # register some common type for pve
106 register_format
( 'string' , sub {}); # allow format => 'string-list'
108 register_format
( 'pve-configid' , \
& pve_verify_configid
);
109 sub pve_verify_configid
{
110 my ( $id, $noerr ) = @_ ;
112 if ( $id !~ m/^[a-z][a-z0-9_]+$/i ) {
113 return undef if $noerr ;
114 die "invalid configuration ID ' $id ' \n " ;
119 PVE
:: JSONSchema
:: register_format
( 'pve-storage-id' , \
& parse_storage_id
);
120 sub parse_storage_id
{
121 my ( $storeid, $noerr ) = @_ ;
123 if ( $storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i ) {
124 return undef if $noerr ;
125 die "storage ID ' $storeid ' contains illegal characters \n " ;
131 register_format
( 'pve-vmid' , \
& pve_verify_vmid
);
132 sub pve_verify_vmid
{
133 my ( $vmid, $noerr ) = @_ ;
135 if ( $vmid !~ m/^[1-9][0-9]+$/ ) {
136 return undef if $noerr ;
137 die "value does not look like a valid VM ID \n " ;
142 register_format
( 'pve-node' , \
& pve_verify_node_name
);
143 sub pve_verify_node_name
{
144 my ( $node, $noerr ) = @_ ;
146 if ( $node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)$/ ) {
147 return undef if $noerr ;
148 die "value does not look like a valid node name \n " ;
153 register_format
( 'ipv4' , \
& pve_verify_ipv4
);
154 sub pve_verify_ipv4
{
155 my ( $ipv4, $noerr ) = @_ ;
157 if ( $ipv4 !~ m/^(?:$IPV4RE)$/ ) {
158 return undef if $noerr ;
159 die "value does not look like a valid IPv4 address \n " ;
164 register_format
( 'ipv6' , \
& pve_verify_ipv6
);
165 sub pve_verify_ipv6
{
166 my ( $ipv6, $noerr ) = @_ ;
168 if ( $ipv6 !~ m/^(?:$IPV6RE)$/ ) {
169 return undef if $noerr ;
170 die "value does not look like a valid IPv6 address \n " ;
175 register_format
( 'ip' , \
& pve_verify_ip
);
177 my ( $ip, $noerr ) = @_ ;
179 if ( $ip !~ m/^(?:(?:$IPV4RE)|(?:$IPV6RE))$/ ) {
180 return undef if $noerr ;
181 die "value does not look like a valid IP address \n " ;
186 my $ipv4_mask_hash = {
203 '255.255.128.0' => 17 ,
204 '255.255.192.0' => 18 ,
205 '255.255.224.0' => 19 ,
206 '255.255.240.0' => 20 ,
207 '255.255.248.0' => 21 ,
208 '255.255.252.0' => 22 ,
209 '255.255.254.0' => 23 ,
210 '255.255.255.0' => 24 ,
211 '255.255.255.128' => 25 ,
212 '255.255.255.192' => 26 ,
213 '255.255.255.224' => 27 ,
214 '255.255.255.240' => 28 ,
215 '255.255.255.248' => 29 ,
216 '255.255.255.252' => 30
219 register_format
( 'ipv4mask' , \
& pve_verify_ipv4mask
);
220 sub pve_verify_ipv4mask
{
221 my ( $mask, $noerr ) = @_ ;
223 if (! defined ( $ipv4_mask_hash ->{ $mask })) {
224 return undef if $noerr ;
225 die "value does not look like a valid IP netmask \n " ;
230 register_format
( 'CIDRv6' , \
& pve_verify_cidrv6
);
231 sub pve_verify_cidrv6
{
232 my ( $cidr, $noerr ) = @_ ;
234 if ( $cidr =~ m!^(?:$IPV6RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 120 )) {
238 return undef if $noerr ;
239 die "value does not look like a valid IPv6 CIDR network \n " ;
242 register_format
( 'CIDRv4' , \
& pve_verify_cidrv4
);
243 sub pve_verify_cidrv4
{
244 my ( $cidr, $noerr ) = @_ ;
246 if ( $cidr =~ m!^(?:$IPV4RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 < 32 )) {
250 return undef if $noerr ;
251 die "value does not look like a valid IPv4 CIDR network \n " ;
254 register_format
( 'CIDR' , \
& pve_verify_cidr
);
255 sub pve_verify_cidr
{
256 my ( $cidr, $noerr ) = @_ ;
258 if (!( pve_verify_cidrv4
( $cidr, 1 ) ||
259 pve_verify_cidrv6
( $cidr, 1 )))
261 return undef if $noerr ;
262 die "value does not look like a valid CIDR network \n " ;
268 register_format
( 'pve-ipv4-config' , \
& pve_verify_ipv4_config
);
269 sub pve_verify_ipv4_config
{
270 my ( $config, $noerr ) = @_ ;
272 return $config if $config =~ /^(?:dhcp|manual)$/ ||
273 pve_verify_cidrv4
( $config, 1 );
274 return undef if $noerr ;
275 die "value does not look like a valid ipv4 network configuration \n " ;
278 register_format
( 'pve-ipv6-config' , \
& pve_verify_ipv6_config
);
279 sub pve_verify_ipv6_config
{
280 my ( $config, $noerr ) = @_ ;
282 return $config if $config =~ /^(?:auto|dhcp|manual)$/ ||
283 pve_verify_cidrv6
( $config, 1 );
284 return undef if $noerr ;
285 die "value does not look like a valid ipv6 network configuration \n " ;
288 register_format
( 'email' , \
& pve_verify_email
);
289 sub pve_verify_email
{
290 my ( $email, $noerr ) = @_ ;
292 # we use same regex as in Utils.js
293 if ( $email !~ /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,63}$/ ) {
294 return undef if $noerr ;
295 die "value does not look like a valid email address \n " ;
300 register_format
( 'dns-name' , \
& pve_verify_dns_name
);
301 sub pve_verify_dns_name
{
302 my ( $name, $noerr ) = @_ ;
304 my $namere = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)" ;
306 if ( $name !~ /^(${namere}\.)*${namere}$/ ) {
307 return undef if $noerr ;
308 die "value does not look like a valid DNS name \n " ;
313 # network interface name
314 register_format
( 'pve-iface' , \
& pve_verify_iface
);
315 sub pve_verify_iface
{
316 my ( $id, $noerr ) = @_ ;
318 if ( $id !~ m/^[a-z][a-z0-9_]{1,20}([:\.]\d+)?$/i ) {
319 return undef if $noerr ;
320 die "invalid network interface name ' $id ' \n " ;
325 # general addresses by name or IP
326 register_format
( 'address' , \
& pve_verify_address
);
327 sub pve_verify_address
{
328 my ( $addr, $noerr ) = @_ ;
330 if (!( pve_verify_ip
( $addr, 1 ) ||
331 pve_verify_dns_name
( $addr, 1 )))
333 return undef if $noerr ;
334 die "value does not look like a valid address: $addr\n " ;
339 register_standard_option
( 'spice-proxy' , {
340 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)." ,
341 type
=> 'string' , format
=> 'address' ,
344 register_standard_option
( 'remote-viewer-config' , {
345 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
346 additionalProperties
=> 1 ,
348 type
=> { type
=> 'string' },
349 password
=> { type
=> 'string' },
350 proxy
=> { type
=> 'string' },
351 host
=> { type
=> 'string' },
352 'tls-port' => { type
=> 'integer' },
356 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
357 sub pve_verify_startup_order
{
358 my ( $value, $noerr ) = @_ ;
360 return $value if pve_parse_startup_order
( $value );
362 return undef if $noerr ;
364 die "unable to parse startup options \n " ;
367 sub pve_parse_startup_order
{
370 return undef if ! $value ;
374 foreach my $p ( split ( /,/ , $value )) {
375 next if $p =~ m/^\s*$/ ;
377 if ( $p =~ m/^(order=)?(\d+)$/ ) {
379 } elsif ( $p =~ m/^up=(\d+)$/ ) {
381 } elsif ( $p =~ m/^down=(\d+)$/ ) {
391 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
392 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." ,
394 type
=> 'string' , format
=> 'pve-startup-order' ,
395 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
399 my ( $format, $value, $path ) = @_ ;
401 return parse_property_string
( $format, $value, $path ) if ref ( $format ) eq 'HASH' ;
402 return if $format eq 'regex' ;
404 if ( $format =~ m/^(.*)-a?list$/ ) {
406 my $code = $format_list ->{ $1 };
408 die "undefined format ' $format ' \n " if ! $code ;
410 # Note: we allow empty lists
411 foreach my $v ( split_list
( $value )) {
415 } elsif ( $format =~ m/^(.*)-opt$/ ) {
417 my $code = $format_list ->{ $1 };
419 die "undefined format ' $format ' \n " if ! $code ;
421 return if ! $value ; # allow empty string
427 my $code = $format_list ->{ $format };
429 die "undefined format ' $format ' \n " if ! $code ;
431 return parse_property_string
( $code, $value, $path ) if ref ( $code ) eq 'HASH' ;
436 sub parse_property_string
{
437 my ( $format, $data, $path ) = @_ ;
442 foreach my $part ( split ( /,/ , $data )) {
443 next if $part =~ /^\s*$/ ;
445 if ( $part =~ /^([^=]+)=(.+)$/ ) {
446 my ( $k, $v ) = ( $1, $2 );
447 die "duplicate key in comma-separated list property: $k " if defined ( $res ->{ $k });
448 my $schema = $format ->{ $k };
449 die "invalid key in comma-separated list property: $k " if ! $schema ;
450 if ( $schema ->{ type
} && $schema ->{ type
} eq 'boolean' ) {
451 $v = 1 if $v =~ m/^(1|on|yes|true)$/i ;
452 $v = 0 if $v =~ m/^(0|off|no|false)$/i ;
455 } elsif ( $part !~ /=/ ) {
456 die "duplicate key in comma-separated list property: $default_key " if $default_key ;
457 foreach my $key ( keys %$format ) {
458 if ( $format ->{ $key }->{ default_key
}) {
460 if (! $res ->{ $default_key }) {
461 $res ->{ $default_key } = $part ;
464 die "duplicate key in comma-separated list property: $default_key " ;
468 die "missing key in comma-separated list property" ;
473 check_object
( $path, $format, $res, undef , $errors );
474 if ( scalar ( %$errors )) {
475 raise
"format error" , errors
=> $errors ;
482 my ( $errors, $path, $msg ) = @_ ;
484 $path = '_root' if ! $path ;
486 if ( $errors ->{ $path }) {
487 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
489 $errors ->{ $path } = $msg ;
496 # see 'man perlretut'
497 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
503 return $value =~ m/^[+-]?\d+$/ ;
507 my ( $path, $type, $value, $errors ) = @_ ;
511 if (! defined ( $value )) {
512 return 1 if $type eq 'null' ;
516 if ( my $tt = ref ( $type )) {
517 if ( $tt eq 'ARRAY' ) {
518 foreach my $t ( @$type ) {
520 check_type
( $path, $t, $value, $tmperr );
521 return 1 if ! scalar ( %$tmperr );
523 my $ttext = join ( '|' , @$type );
524 add_error
( $errors, $path, "type check (' $ttext ') failed" );
526 } elsif ( $tt eq 'HASH' ) {
528 check_prop
( $value, $type, $path, $tmperr );
529 return 1 if ! scalar ( %$tmperr );
530 add_error
( $errors, $path, "type check failed" );
533 die "internal error - got reference type ' $tt '" ;
538 return 1 if $type eq 'any' ;
540 if ( $type eq 'null' ) {
541 if ( defined ( $value )) {
542 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
548 my $vt = ref ( $value );
550 if ( $type eq 'array' ) {
551 if (! $vt || $vt ne 'ARRAY' ) {
552 add_error
( $errors, $path, "type check (' $type ') failed" );
556 } elsif ( $type eq 'object' ) {
557 if (! $vt || $vt ne 'HASH' ) {
558 add_error
( $errors, $path, "type check (' $type ') failed" );
562 } elsif ( $type eq 'coderef' ) {
563 if (! $vt || $vt ne 'CODE' ) {
564 add_error
( $errors, $path, "type check (' $type ') failed" );
570 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
573 if ( $type eq 'string' ) {
574 return 1 ; # nothing to check ?
575 } elsif ( $type eq 'boolean' ) {
576 #if ($value =~ m/^(1|true|yes|on)$/i) {
579 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
580 } elsif ( $value eq '0' ) {
583 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
586 } elsif ( $type eq 'integer' ) {
587 if (! is_integer
( $value )) {
588 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
592 } elsif ( $type eq 'number' ) {
593 if (! is_number
( $value )) {
594 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
599 return 1 ; # no need to verify unknown types
609 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
611 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
613 my $st = ref ( $schema );
614 if (! $st || $st ne 'HASH' ) {
615 add_error
( $errors, $path, "Invalid schema definition." );
619 my $vt = ref ( $value );
620 if (! $vt || $vt ne 'HASH' ) {
621 add_error
( $errors, $path, "an object is required" );
625 foreach my $k ( keys %$schema ) {
626 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
629 foreach my $k ( keys %$value ) {
631 my $newpath = $path ?
" $path . $k " : $k ;
633 if ( my $subschema = $schema ->{ $k }) {
634 if ( my $requires = $subschema ->{ requires
}) {
635 if ( ref ( $requires )) {
636 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
637 check_prop
( $value, $requires, $path, $errors );
638 } elsif (! defined ( $value ->{ $requires })) {
639 add_error
( $errors, $path ?
" $path . $requires " : $requires,
640 "missing property - ' $newpath ' requiers this property" );
644 next ; # value is already checked above
647 if ( defined ( $additional_properties ) && ! $additional_properties ) {
648 add_error
( $errors, $newpath, "property is not defined in schema " .
649 "and the schema does not allow additional properties" );
652 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
653 if ref ( $additional_properties );
657 sub check_object_warn
{
658 my ( $path, $schema, $value, $additional_properties ) = @_ ;
660 check_object
( $path, $schema, $value, $additional_properties, $errors );
661 if ( scalar ( %$errors )) {
662 foreach my $k ( keys %$errors ) {
663 warn "parse error: $k : $errors ->{ $k } \n " ;
671 my ( $value, $schema, $path, $errors ) = @_ ;
673 die "internal error - no schema" if ! $schema ;
674 die "internal error" if ! $errors ;
676 #print "check_prop $path\n" if $value;
678 my $st = ref ( $schema );
679 if (! $st || $st ne 'HASH' ) {
680 add_error
( $errors, $path, "Invalid schema definition." );
684 # if it extends another schema, it must pass that schema as well
685 if ( $schema ->{ extends
}) {
686 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
689 if (! defined ( $value )) {
690 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
691 if (! $schema ->{ optional
}) {
692 add_error
( $errors, $path, "property is missing and it is not optional" );
697 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
699 if ( $schema ->{ disallow
}) {
701 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
702 add_error
( $errors, $path, "disallowed value was matched" );
707 if ( my $vt = ref ( $value )) {
709 if ( $vt eq 'ARRAY' ) {
710 if ( $schema ->{ items
}) {
711 my $it = ref ( $schema ->{ items
});
712 if ( $it && $it eq 'ARRAY' ) {
713 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
714 die "not implemented" ;
717 foreach my $el ( @$value ) {
718 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
724 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
725 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
726 $value, $schema ->{ additionalProperties
}, $errors );
732 if ( my $format = $schema ->{ format
}) {
733 eval { check_format
( $format, $value, $path ); };
735 add_error
( $errors, $path, "invalid format - $@ " );
740 if ( my $pattern = $schema ->{ pattern
}) {
741 if ( $value !~ m/^$pattern$/ ) {
742 add_error
( $errors, $path, "value does not match the regex pattern" );
747 if ( defined ( my $max = $schema ->{ maxLength
})) {
748 if ( length ( $value ) > $max ) {
749 add_error
( $errors, $path, "value may only be $max characters long" );
754 if ( defined ( my $min = $schema ->{ minLength
})) {
755 if ( length ( $value ) < $min ) {
756 add_error
( $errors, $path, "value must be at least $min characters long" );
761 if ( is_number
( $value )) {
762 if ( defined ( my $max = $schema ->{ maximum
})) {
764 add_error
( $errors, $path, "value must have a maximum value of $max " );
769 if ( defined ( my $min = $schema ->{ minimum
})) {
771 add_error
( $errors, $path, "value must have a minimum value of $min " );
777 if ( my $ea = $schema ->{ enum
}) {
780 foreach my $ev ( @$ea ) {
787 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
788 join ( ", " , @$ea ) . "'" );
795 my ( $instance, $schema, $errmsg ) = @_ ;
798 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
800 # todo: cycle detection is only needed for debugging, I guess
801 # we can disable that in the final release
802 # todo: is there a better/faster way to detect cycles?
804 find_cycle
( $instance, sub { $cycles = 1 });
806 add_error
( $errors, undef , "data structure contains recursive cycles" );
808 check_prop
( $instance, $schema, '' , $errors );
811 if ( scalar ( %$errors )) {
812 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
818 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
819 my $default_schema_noref = {
820 description
=> "This is the JSON Schema for JSON Schemas." ,
821 type
=> [ "object" ],
822 additionalProperties
=> 0 ,
825 type
=> [ "string" , "array" ],
826 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
831 enum
=> $schema_valid_types,
833 enum
=> $schema_valid_types,
837 description
=> "This indicates that the instance property in the instance object is not required." ,
843 description
=> "This is a definition for the properties of an object value" ,
849 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
853 additionalProperties
=> {
854 type
=> [ "boolean" , "object" ],
855 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
862 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
867 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
871 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
878 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
884 description
=> "A text representation of the type (used to generate documentation)." ,
889 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." ,
897 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
902 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)." ,
904 format_description
=> {
907 description
=> "This provides a shorter (usually just one word) description for a property used to generate descriptions for comma separated list property strings." ,
912 description
=> "This provides the title of the property" ,
915 type
=> [ "string" , "object" ],
917 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
920 type
=> [ "string" , "object" ],
922 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" ,
927 description
=> "Whether this is the default key in a comma separated list property string." ,
932 description
=> "This indicates the default for the instance property."
936 description
=> "Bash completion function. This function should return a list of possible values." ,
942 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." ,
947 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
950 # this is from hyper schema
953 description
=> "This defines the link relations of the instance objects" ,
960 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" ,
964 description
=> "This is the name of the link relation" ,
970 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
980 my $default_schema = Storable
:: dclone
( $default_schema_noref );
982 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
983 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
985 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
986 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
988 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
989 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
991 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
992 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
994 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
995 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
997 my $method_schema = {
999 additionalProperties
=> 0 ,
1002 description
=> "This a description of the method" ,
1007 description
=> "This indicates the name of the function to call." ,
1010 additionalProperties
=> 1 ,
1025 description
=> "The HTTP method name." ,
1026 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
1031 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
1036 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
1041 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
1043 additionalProperties
=> 0 ,
1046 description
=> "Describe access permissions." ,
1050 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
1052 enum
=> [ 'all' , 'world' ],
1056 description
=> "Array of permission checks (prefix notation)." ,
1063 description
=> "Used internally" ,
1067 description
=> "Used internally" ,
1072 description
=> "path for URL matching (uri template)" ,
1074 fragmentDelimiter
=> {
1076 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." ,
1081 description
=> "JSON Schema for parameters." ,
1086 description
=> "Used to store page formatter information (set by PVE::RESTHandler->register_page_formatter)." ,
1091 description
=> "JSON Schema for return value." ,
1096 description
=> "method implementaion (code reference)" ,
1101 description
=> "Delegate call to this class (perl class string)." ,
1104 additionalProperties
=> 0 ,
1110 fragmentDelimiter
=> { optional
=> 1 }
1118 sub validate_schema
{
1121 my $errmsg = "internal error - unable to verify schema \n " ;
1122 validate
( $schema, $default_schema, $errmsg );
1125 sub validate_method_info
{
1128 my $errmsg = "internal error - unable to verify method info \n " ;
1129 validate
( $info, $method_schema, $errmsg );
1131 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1132 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1135 # run a self test on load
1136 # make sure we can verify the default schema
1137 validate_schema
( $default_schema_noref );
1138 validate_schema
( $method_schema );
1140 # and now some utility methods (used by pve api)
1141 sub method_get_child_link
{
1144 return undef if ! $info ;
1146 my $schema = $info ->{ returns
};
1147 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1149 my $links = $schema ->{ links
};
1150 return undef if ! $links ;
1153 foreach my $lnk ( @$links ) {
1154 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1163 # a way to parse command line parameters, using a
1164 # schema to configure Getopt::Long
1166 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1168 if (! $schema || ! $schema ->{ properties
}) {
1169 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1170 if scalar ( @$args ) != 0 ;
1175 if ( $arg_param && ! ref ( $arg_param )) {
1176 my $pd = $schema ->{ properties
}->{ $arg_param };
1177 die "expected list format $pd ->{format}"
1178 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1179 $list_param = $arg_param ;
1183 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1184 my $pd = $schema ->{ properties
}->{ $prop };
1185 next if $list_param && $prop eq $list_param ;
1186 next if defined ( $fixed_param ->{ $prop });
1188 if ( $prop eq 'password' && $pwcallback ) {
1189 # we do not accept plain password on input line, instead
1190 # we turn this into a boolean option and ask for password below
1191 # using $pwcallback() (for security reasons).
1192 push @getopt, " $prop " ;
1193 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1194 push @getopt, " $prop :s" ;
1196 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1197 push @getopt, " $prop =s@" ;
1199 push @getopt, " $prop =s" ;
1204 Getopt
:: Long
:: Configure
( 'prefix_pattern=(--|-)' );
1207 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1208 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1212 $opts ->{ $list_param } = $args ;
1214 } elsif ( ref ( $arg_param )) {
1215 foreach my $arg_name ( @$arg_param ) {
1216 if ( $opts ->{ 'extra-args' }) {
1217 raise
( "internal error: extra-args must be the last argument \n " , code
=> HTTP_BAD_REQUEST
);
1219 if ( $arg_name eq 'extra-args' ) {
1220 $opts ->{ 'extra-args' } = $args ;
1224 raise
( "not enough arguments \n " , code
=> HTTP_BAD_REQUEST
) if ! @$args ;
1225 $opts ->{ $arg_name } = shift @$args ;
1227 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
) if @$args ;
1229 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1230 if scalar ( @$args ) != 0 ;
1234 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1235 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1236 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1237 $opts ->{ password
} = & $pwcallback ();
1242 $opts = PVE
:: Tools
:: decode_utf8_parameters
( $opts );
1244 foreach my $p ( keys %$opts ) {
1245 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1246 if ( $pd ->{ type
} eq 'boolean' ) {
1247 if ( $opts ->{ $p } eq '' ) {
1249 } elsif ( $opts ->{ $p } =~ m/^(1|true|yes|on)$/i ) {
1251 } elsif ( $opts ->{ $p } =~ m/^(0|false|no|off)$/i ) {
1254 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1256 } elsif ( $pd ->{ format
}) {
1258 if ( $pd ->{ format
} =~ m/-list/ ) {
1259 # allow --vmid 100 --vmid 101 and --vmid 100,101
1260 # allow --dow mon --dow fri and --dow mon,fri
1261 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }}) if ref ( $opts ->{ $p }) eq 'ARRAY' ;
1262 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1263 # we encode array as \0 separated strings
1264 # Note: CGI.pm also use this encoding
1265 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1266 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1268 # st that split_list knows it is \0 terminated
1269 my $v = $opts ->{ $p }->[ 0 ];
1270 $opts ->{ $p } = " $v\0 " ;
1277 foreach my $p ( keys %$fixed_param ) {
1278 $opts ->{ $p } = $fixed_param ->{ $p };
1284 # A way to parse configuration data by giving a json schema
1286 my ( $schema, $filename, $raw ) = @_ ;
1288 # do fast check (avoid validate_schema($schema))
1289 die "got strange schema" if ! $schema ->{ type
} ||
1290 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1294 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1297 next if $line =~ /^#/ ;
1299 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1302 if ( $schema ->{ properties
}->{ $key } &&
1303 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1305 $value = 1 if $value =~ m/^(1|on|yes|true)$/i ;
1306 $value = 0 if $value =~ m/^(0|off|no|false)$/i ;
1308 $cfg ->{ $key } = $value ;
1310 warn "ignore config line: $line\n "
1315 check_prop
( $cfg, $schema, '' , $errors );
1317 foreach my $k ( keys %$errors ) {
1318 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1325 # generate simple key/value file
1327 my ( $schema, $filename, $cfg ) = @_ ;
1329 # do fast check (avoid validate_schema($schema))
1330 die "got strange schema" if ! $schema ->{ type
} ||
1331 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1333 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1337 foreach my $k ( keys %$cfg ) {
1338 $data .= " $k : $cfg ->{ $k } \n " ;
1344 sub generate_typetext
{
1347 my ( @optional, @required );
1348 foreach my $key ( sort keys %$schema ) {
1349 next if ! $schema ->{ $key }->{ format_description
} &&
1350 ! $schema ->{ $key }->{ typetext
};
1351 if ( $schema ->{ $key }->{ optional
}) {
1352 push @optional, $key ;
1354 push @required, $key ;
1357 my ( $pre, $post ) = ( '' , '' );
1360 if ( my $desc = $schema ->{ $key }->{ format_description
}) {
1361 $typetext .= " $pre$key =< $desc > $post " ;
1362 } elsif ( my $text = $schema ->{ $key }->{ typetext
}) {
1363 $typetext .= " $pre$text$post " ;
1365 die "internal error: neither format_description nor typetext found" ;
1368 foreach my $key ( @required ) {
1372 $pre = $pre ?
' [,' : '[' ;
1374 foreach my $key ( @optional ) {