]>
git.proxmox.com Git - pve-common.git/blob - src/PVE/JSONSchema.pm
2837cf56378a766d5f5dbe93f8431eabfd1291a9
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
89 my ( $format, $code ) = @_ ;
91 die "JSON schema format ' $format ' already registered \n "
92 if $format_list ->{ $format };
94 $format_list ->{ $format } = $code ;
97 # register some common type for pve
99 register_format
( 'string' , sub {}); # allow format => 'string-list'
101 register_format
( 'pve-configid' , \
& pve_verify_configid
);
102 sub pve_verify_configid
{
103 my ( $id, $noerr ) = @_ ;
105 if ( $id !~ m/^[a-z][a-z0-9_]+$/i ) {
106 return undef if $noerr ;
107 die "invalid configuration ID ' $id ' \n " ;
112 PVE
:: JSONSchema
:: register_format
( 'pve-storage-id' , \
& parse_storage_id
);
113 sub parse_storage_id
{
114 my ( $storeid, $noerr ) = @_ ;
116 if ( $storeid !~ m/^[a-z][a-z0-9\-\_\.]*[a-z0-9]$/i ) {
117 return undef if $noerr ;
118 die "storage ID ' $storeid ' contains illegal characters \n " ;
124 register_format
( 'pve-vmid' , \
& pve_verify_vmid
);
125 sub pve_verify_vmid
{
126 my ( $vmid, $noerr ) = @_ ;
128 if ( $vmid !~ m/^[1-9][0-9]+$/ ) {
129 return undef if $noerr ;
130 die "value does not look like a valid VM ID \n " ;
135 register_format
( 'pve-node' , \
& pve_verify_node_name
);
136 sub pve_verify_node_name
{
137 my ( $node, $noerr ) = @_ ;
139 if ( $node !~ m/^([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)$/ ) {
140 return undef if $noerr ;
141 die "value does not look like a valid node name \n " ;
146 register_format
( 'ipv4' , \
& pve_verify_ipv4
);
147 sub pve_verify_ipv4
{
148 my ( $ipv4, $noerr ) = @_ ;
150 if ( $ipv4 !~ m/^(?:$IPV4RE)$/ ) {
151 return undef if $noerr ;
152 die "value does not look like a valid IPv4 address \n " ;
157 register_format
( 'ipv6' , \
& pve_verify_ipv6
);
158 sub pve_verify_ipv6
{
159 my ( $ipv6, $noerr ) = @_ ;
161 if ( $ipv6 !~ m/^(?:$IPV6RE)$/ ) {
162 return undef if $noerr ;
163 die "value does not look like a valid IPv6 address \n " ;
168 register_format
( 'ip' , \
& pve_verify_ip
);
170 my ( $ip, $noerr ) = @_ ;
172 if ( $ip !~ m/^(?:(?:$IPV4RE)|(?:$IPV6RE))$/ ) {
173 return undef if $noerr ;
174 die "value does not look like a valid IP address \n " ;
179 my $ipv4_mask_hash = {
196 '255.255.128.0' => 17 ,
197 '255.255.192.0' => 18 ,
198 '255.255.224.0' => 19 ,
199 '255.255.240.0' => 20 ,
200 '255.255.248.0' => 21 ,
201 '255.255.252.0' => 22 ,
202 '255.255.254.0' => 23 ,
203 '255.255.255.0' => 24 ,
204 '255.255.255.128' => 25 ,
205 '255.255.255.192' => 26 ,
206 '255.255.255.224' => 27 ,
207 '255.255.255.240' => 28 ,
208 '255.255.255.248' => 29 ,
209 '255.255.255.252' => 30
212 register_format
( 'ipv4mask' , \
& pve_verify_ipv4mask
);
213 sub pve_verify_ipv4mask
{
214 my ( $mask, $noerr ) = @_ ;
216 if (! defined ( $ipv4_mask_hash ->{ $mask })) {
217 return undef if $noerr ;
218 die "value does not look like a valid IP netmask \n " ;
223 register_format
( 'CIDR' , \
& pve_verify_cidr
);
224 sub pve_verify_cidr
{
225 my ( $cidr, $noerr ) = @_ ;
227 if ( $cidr =~ m!^(?:$IPV4RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 < 32 )) {
229 } elsif ( $cidr =~ m!^(?:$IPV6RE)(?:/(\d+))$! && ( $1 > 7 ) && ( $1 <= 120 )) {
233 return undef if $noerr ;
234 die "value does not look like a valid CIDR network \n " ;
237 register_format
( 'email' , \
& pve_verify_email
);
238 sub pve_verify_email
{
239 my ( $email, $noerr ) = @_ ;
241 # we use same regex as extjs Ext.form.VTypes.email
242 if ( $email !~ /^(\w+)([\-+.][\w]+)*@(\w[\-\w]*\.){1,5}([A-Za-z]){2,6}$/ ) {
243 return undef if $noerr ;
244 die "value does not look like a valid email address \n " ;
249 register_format
( 'dns-name' , \
& pve_verify_dns_name
);
250 sub pve_verify_dns_name
{
251 my ( $name, $noerr ) = @_ ;
253 my $namere = "([a-zA-Z0-9]([a-zA-Z0-9\-]*[a-zA-Z0-9])?)" ;
255 if ( $name !~ /^(${namere}\.)*${namere}$/ ) {
256 return undef if $noerr ;
257 die "value does not look like a valid DNS name \n " ;
262 # network interface name
263 register_format
( 'pve-iface' , \
& pve_verify_iface
);
264 sub pve_verify_iface
{
265 my ( $id, $noerr ) = @_ ;
267 if ( $id !~ m/^[a-z][a-z0-9_]{1,20}([:\.]\d+)?$/i ) {
268 return undef if $noerr ;
269 die "invalid network interface name ' $id ' \n " ;
274 # general addresses by name or IP
275 register_format
( 'address' , \
& pve_verify_address
);
276 sub pve_verify_address
{
277 my ( $addr, $noerr ) = @_ ;
279 if (!( pve_verify_ip
( $addr, 1 ) ||
280 pve_verify_dns_name
( $addr, 1 )))
282 return undef if $noerr ;
283 die "value does not look like a valid address: $addr\n " ;
288 register_standard_option
( 'spice-proxy' , {
289 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)." ,
290 type
=> 'string' , format
=> 'address' ,
293 register_standard_option
( 'remote-viewer-config' , {
294 description
=> "Returned values can be directly passed to the 'remote-viewer' application." ,
295 additionalProperties
=> 1 ,
297 type
=> { type
=> 'string' },
298 password
=> { type
=> 'string' },
299 proxy
=> { type
=> 'string' },
300 host
=> { type
=> 'string' },
301 'tls-port' => { type
=> 'integer' },
305 register_format
( 'pve-startup-order' , \
& pve_verify_startup_order
);
306 sub pve_verify_startup_order
{
307 my ( $value, $noerr ) = @_ ;
309 return $value if pve_parse_startup_order
( $value );
311 return undef if $noerr ;
313 die "unable to parse startup options \n " ;
316 sub pve_parse_startup_order
{
319 return undef if ! $value ;
323 foreach my $p ( split ( /,/ , $value )) {
324 next if $p =~ m/^\s*$/ ;
326 if ( $p =~ m/^(order=)?(\d+)$/ ) {
328 } elsif ( $p =~ m/^up=(\d+)$/ ) {
330 } elsif ( $p =~ m/^down=(\d+)$/ ) {
340 PVE
:: JSONSchema
:: register_standard_option
( 'pve-startup-order' , {
341 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." ,
343 type
=> 'string' , format
=> 'pve-startup-order' ,
344 typetext
=> '[[order=]\d+] [,up=\d+] [,down=\d+] ' ,
348 my ( $format, $value ) = @_ ;
350 return if $format eq 'regex' ;
352 if ( $format =~ m/^(.*)-a?list$/ ) {
354 my $code = $format_list ->{ $1 };
356 die "undefined format ' $format ' \n " if ! $code ;
358 # Note: we allow empty lists
359 foreach my $v ( split_list
( $value )) {
363 } elsif ( $format =~ m/^(.*)-opt$/ ) {
365 my $code = $format_list ->{ $1 };
367 die "undefined format ' $format ' \n " if ! $code ;
369 return if ! $value ; # allow empty string
375 my $code = $format_list ->{ $format };
377 die "undefined format ' $format ' \n " if ! $code ;
384 my ( $errors, $path, $msg ) = @_ ;
386 $path = '_root' if ! $path ;
388 if ( $errors ->{ $path }) {
389 $errors ->{ $path } = join ( ' \n ' , $errors ->{ $path }, $msg );
391 $errors ->{ $path } = $msg ;
398 # see 'man perlretut'
399 return $value =~ /^[+-]?(\d+\.\d+|\d+\.|\.\d+|\d+)([eE][+-]?\d+)?$/ ;
405 return $value =~ m/^[+-]?\d+$/ ;
409 my ( $path, $type, $value, $errors ) = @_ ;
413 if (! defined ( $value )) {
414 return 1 if $type eq 'null' ;
418 if ( my $tt = ref ( $type )) {
419 if ( $tt eq 'ARRAY' ) {
420 foreach my $t ( @$type ) {
422 check_type
( $path, $t, $value, $tmperr );
423 return 1 if ! scalar ( %$tmperr );
425 my $ttext = join ( '|' , @$type );
426 add_error
( $errors, $path, "type check (' $ttext ') failed" );
428 } elsif ( $tt eq 'HASH' ) {
430 check_prop
( $value, $type, $path, $tmperr );
431 return 1 if ! scalar ( %$tmperr );
432 add_error
( $errors, $path, "type check failed" );
435 die "internal error - got reference type ' $tt '" ;
440 return 1 if $type eq 'any' ;
442 if ( $type eq 'null' ) {
443 if ( defined ( $value )) {
444 add_error
( $errors, $path, "type check (' $type ') failed - value is not null" );
450 my $vt = ref ( $value );
452 if ( $type eq 'array' ) {
453 if (! $vt || $vt ne 'ARRAY' ) {
454 add_error
( $errors, $path, "type check (' $type ') failed" );
458 } elsif ( $type eq 'object' ) {
459 if (! $vt || $vt ne 'HASH' ) {
460 add_error
( $errors, $path, "type check (' $type ') failed" );
464 } elsif ( $type eq 'coderef' ) {
465 if (! $vt || $vt ne 'CODE' ) {
466 add_error
( $errors, $path, "type check (' $type ') failed" );
472 add_error
( $errors, $path, "type check (' $type ') failed - got $vt " );
475 if ( $type eq 'string' ) {
476 return 1 ; # nothing to check ?
477 } elsif ( $type eq 'boolean' ) {
478 #if ($value =~ m/^(1|true|yes|on)$/i) {
481 #} elsif ($value =~ m/^(0|false|no|off)$/i) {
482 } elsif ( $value eq '0' ) {
485 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
488 } elsif ( $type eq 'integer' ) {
489 if (! is_integer
( $value )) {
490 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
494 } elsif ( $type eq 'number' ) {
495 if (! is_number
( $value )) {
496 add_error
( $errors, $path, "type check (' $type ') failed - got ' $value '" );
501 return 1 ; # no need to verify unknown types
511 my ( $path, $schema, $value, $additional_properties, $errors ) = @_ ;
513 # print "Check Object " . Dumper($value) . "\nSchema: " . Dumper($schema);
515 my $st = ref ( $schema );
516 if (! $st || $st ne 'HASH' ) {
517 add_error
( $errors, $path, "Invalid schema definition." );
521 my $vt = ref ( $value );
522 if (! $vt || $vt ne 'HASH' ) {
523 add_error
( $errors, $path, "an object is required" );
527 foreach my $k ( keys %$schema ) {
528 check_prop
( $value ->{ $k }, $schema ->{ $k }, $path ?
" $path . $k " : $k, $errors );
531 foreach my $k ( keys %$value ) {
533 my $newpath = $path ?
" $path . $k " : $k ;
535 if ( my $subschema = $schema ->{ $k }) {
536 if ( my $requires = $subschema ->{ requires
}) {
537 if ( ref ( $requires )) {
538 #print "TEST: " . Dumper($value) . "\n", Dumper($requires) ;
539 check_prop
( $value, $requires, $path, $errors );
540 } elsif (! defined ( $value ->{ $requires })) {
541 add_error
( $errors, $path ?
" $path . $requires " : $requires,
542 "missing property - ' $newpath ' requiers this property" );
546 next ; # value is already checked above
549 if ( defined ( $additional_properties ) && ! $additional_properties ) {
550 add_error
( $errors, $newpath, "property is not defined in schema " .
551 "and the schema does not allow additional properties" );
554 check_prop
( $value ->{ $k }, $additional_properties, $newpath, $errors )
555 if ref ( $additional_properties );
560 my ( $value, $schema, $path, $errors ) = @_ ;
562 die "internal error - no schema" if ! $schema ;
563 die "internal error" if ! $errors ;
565 #print "check_prop $path\n" if $value;
567 my $st = ref ( $schema );
568 if (! $st || $st ne 'HASH' ) {
569 add_error
( $errors, $path, "Invalid schema definition." );
573 # if it extends another schema, it must pass that schema as well
574 if ( $schema ->{ extends
}) {
575 check_prop
( $value, $schema ->{ extends
}, $path, $errors );
578 if (! defined ( $value )) {
579 return if $schema ->{ type
} && $schema ->{ type
} eq 'null' ;
580 if (! $schema ->{ optional
}) {
581 add_error
( $errors, $path, "property is missing and it is not optional" );
586 return if ! check_type
( $path, $schema ->{ type
}, $value, $errors );
588 if ( $schema ->{ disallow
}) {
590 if ( check_type
( $path, $schema ->{ disallow
}, $value, $tmperr )) {
591 add_error
( $errors, $path, "disallowed value was matched" );
596 if ( my $vt = ref ( $value )) {
598 if ( $vt eq 'ARRAY' ) {
599 if ( $schema ->{ items
}) {
600 my $it = ref ( $schema ->{ items
});
601 if ( $it && $it eq 'ARRAY' ) {
602 #die "implement me $path: $vt " . Dumper($schema) ."\n". Dumper($value);
603 die "not implemented" ;
606 foreach my $el ( @$value ) {
607 check_prop
( $el, $schema ->{ items
}, "${path}[ $ind ]" , $errors );
613 } elsif ( $schema ->{ properties
} || $schema ->{ additionalProperties
}) {
614 check_object
( $path, defined ( $schema ->{ properties
}) ?
$schema ->{ properties
} : {},
615 $value, $schema ->{ additionalProperties
}, $errors );
621 if ( my $format = $schema ->{ format
}) {
622 eval { check_format
( $format, $value ); };
624 add_error
( $errors, $path, "invalid format - $@ " );
629 if ( my $pattern = $schema ->{ pattern
}) {
630 if ( $value !~ m/^$pattern$/ ) {
631 add_error
( $errors, $path, "value does not match the regex pattern" );
636 if ( defined ( my $max = $schema ->{ maxLength
})) {
637 if ( length ( $value ) > $max ) {
638 add_error
( $errors, $path, "value may only be $max characters long" );
643 if ( defined ( my $min = $schema ->{ minLength
})) {
644 if ( length ( $value ) < $min ) {
645 add_error
( $errors, $path, "value must be at least $min characters long" );
650 if ( is_number
( $value )) {
651 if ( defined ( my $max = $schema ->{ maximum
})) {
653 add_error
( $errors, $path, "value must have a maximum value of $max " );
658 if ( defined ( my $min = $schema ->{ minimum
})) {
660 add_error
( $errors, $path, "value must have a minimum value of $min " );
666 if ( my $ea = $schema ->{ enum
}) {
669 foreach my $ev ( @$ea ) {
676 add_error
( $errors, $path, "value ' $value ' does not have a value in the enumeration '" .
677 join ( ", " , @$ea ) . "'" );
684 my ( $instance, $schema, $errmsg ) = @_ ;
687 $errmsg = "Parameter verification failed. \n " if ! $errmsg ;
689 # todo: cycle detection is only needed for debugging, I guess
690 # we can disable that in the final release
691 # todo: is there a better/faster way to detect cycles?
693 find_cycle
( $instance, sub { $cycles = 1 });
695 add_error
( $errors, undef , "data structure contains recursive cycles" );
697 check_prop
( $instance, $schema, '' , $errors );
700 if ( scalar ( %$errors )) {
701 raise
$errmsg, code
=> HTTP_BAD_REQUEST
, errors
=> $errors ;
707 my $schema_valid_types = [ "string" , "object" , "coderef" , "array" , "boolean" , "number" , "integer" , "null" , "any" ];
708 my $default_schema_noref = {
709 description
=> "This is the JSON Schema for JSON Schemas." ,
710 type
=> [ "object" ],
711 additionalProperties
=> 0 ,
714 type
=> [ "string" , "array" ],
715 description
=> "This is a type definition value. This can be a simple type, or a union type" ,
720 enum
=> $schema_valid_types,
722 enum
=> $schema_valid_types,
726 description
=> "This indicates that the instance property in the instance object is not required." ,
732 description
=> "This is a definition for the properties of an object value" ,
738 description
=> "When the value is an array, this indicates the schema to use to validate each item in an array" ,
742 additionalProperties
=> {
743 type
=> [ "boolean" , "object" ],
744 description
=> "This provides a default property definition for all properties that are not explicitly defined in an object type definition." ,
751 description
=> "This indicates the minimum value for the instance property when the type of the instance value is a number." ,
756 description
=> "This indicates the maximum value for the instance property when the type of the instance value is a number." ,
760 description
=> "When the instance value is a string, this indicates minimum length of the string" ,
767 description
=> "When the instance value is a string, this indicates maximum length of the string." ,
773 description
=> "A text representation of the type (used to generate documentation)." ,
778 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." ,
786 description
=> "This provides an enumeration of possible values that are valid for the instance property." ,
791 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)." ,
796 description
=> "This provides the title of the property" ,
799 type
=> [ "string" , "object" ],
801 description
=> "indicates a required property or a schema that must be validated if this property is present" ,
806 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" ,
811 description
=> "This indicates the default for the instance property."
816 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." ,
821 description
=> "This indicates the schema extends the given schema. All instances of this schema must be valid to by the extended schema also." ,
824 # this is from hyper schema
827 description
=> "This defines the link relations of the instance objects" ,
834 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" ,
838 description
=> "This is the name of the link relation" ,
844 description
=> "For submission links, this defines the method that should be used to access the target resource" ,
854 my $default_schema = Storable
:: dclone
( $default_schema_noref );
856 $default_schema ->{ properties
}->{ properties
}->{ additionalProperties
} = $default_schema ;
857 $default_schema ->{ properties
}->{ additionalProperties
}->{ properties
} = $default_schema ->{ properties
};
859 $default_schema ->{ properties
}->{ items
}->{ properties
} = $default_schema ->{ properties
};
860 $default_schema ->{ properties
}->{ items
}->{ additionalProperties
} = 0 ;
862 $default_schema ->{ properties
}->{ disallow
}->{ properties
} = $default_schema ->{ properties
};
863 $default_schema ->{ properties
}->{ disallow
}->{ additionalProperties
} = 0 ;
865 $default_schema ->{ properties
}->{ requires
}->{ properties
} = $default_schema ->{ properties
};
866 $default_schema ->{ properties
}->{ requires
}->{ additionalProperties
} = 0 ;
868 $default_schema ->{ properties
}->{ extends
}->{ properties
} = $default_schema ->{ properties
};
869 $default_schema ->{ properties
}->{ extends
}->{ additionalProperties
} = 0 ;
871 my $method_schema = {
873 additionalProperties
=> 0 ,
876 description
=> "This a description of the method" ,
881 description
=> "This indicates the name of the function to call." ,
884 additionalProperties
=> 1 ,
899 description
=> "The HTTP method name." ,
900 enum
=> [ 'GET' , 'POST' , 'PUT' , 'DELETE' ],
905 description
=> "Method needs special privileges - only pvedaemon can execute it" ,
910 description
=> "A parameter name. If specified, all calls to this method are proxied to the host contained in that parameter." ,
915 description
=> "Required access permissions. By default only 'root' is allowed to access this method." ,
917 additionalProperties
=> 0 ,
920 description
=> "Describe access permissions." ,
924 description
=> "A simply way to allow access for 'all' authenticated users. Value 'world' is used to allow access without credentials." ,
926 enum
=> [ 'all' , 'world' ],
930 description
=> "Array of permission checks (prefix notation)." ,
937 description
=> "Used internally" ,
941 description
=> "Used internally" ,
946 description
=> "path for URL matching (uri template)" ,
948 fragmentDelimiter
=> {
950 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." ,
955 description
=> "JSON Schema for parameters." ,
960 description
=> "JSON Schema for return value." ,
965 description
=> "method implementaion (code reference)" ,
970 description
=> "Delegate call to this class (perl class string)." ,
973 additionalProperties
=> 0 ,
979 fragmentDelimiter
=> { optional
=> 1 }
987 sub validate_schema
{
990 my $errmsg = "internal error - unable to verify schema \n " ;
991 validate
( $schema, $default_schema, $errmsg );
994 sub validate_method_info
{
997 my $errmsg = "internal error - unable to verify method info \n " ;
998 validate
( $info, $method_schema, $errmsg );
1000 validate_schema
( $info ->{ parameters
}) if $info ->{ parameters
};
1001 validate_schema
( $info ->{ returns
}) if $info ->{ returns
};
1004 # run a self test on load
1005 # make sure we can verify the default schema
1006 validate_schema
( $default_schema_noref );
1007 validate_schema
( $method_schema );
1009 # and now some utility methods (used by pve api)
1010 sub method_get_child_link
{
1013 return undef if ! $info ;
1015 my $schema = $info ->{ returns
};
1016 return undef if ! $schema || ! $schema ->{ type
} || $schema ->{ type
} ne 'array' ;
1018 my $links = $schema ->{ links
};
1019 return undef if ! $links ;
1022 foreach my $lnk ( @$links ) {
1023 if ( $lnk ->{ href
} && $lnk ->{ rel
} && ( $lnk ->{ rel
} eq 'child' )) {
1032 # a way to parse command line parameters, using a
1033 # schema to configure Getopt::Long
1035 my ( $schema, $args, $arg_param, $fixed_param, $pwcallback ) = @_ ;
1037 if (! $schema || ! $schema ->{ properties
}) {
1038 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1039 if scalar ( @$args ) != 0 ;
1044 if ( $arg_param && ! ref ( $arg_param )) {
1045 my $pd = $schema ->{ properties
}->{ $arg_param };
1046 die "expected list format $pd ->{format}"
1047 if !( $pd && $pd ->{ format
} && $pd ->{ format
} =~ m/-list/ );
1048 $list_param = $arg_param ;
1052 foreach my $prop ( keys %{ $schema ->{ properties
}}) {
1053 my $pd = $schema ->{ properties
}->{ $prop };
1054 next if $list_param && $prop eq $list_param ;
1055 next if defined ( $fixed_param ->{ $prop });
1057 if ( $prop eq 'password' && $pwcallback ) {
1058 # we do not accept plain password on input line, instead
1059 # we turn this into a boolean option and ask for password below
1060 # using $pwcallback() (for security reasons).
1061 push @getopt, " $prop " ;
1062 } elsif ( $pd ->{ type
} eq 'boolean' ) {
1063 push @getopt, " $prop :s" ;
1065 if ( $pd ->{ format
} && $pd ->{ format
} =~ m/-a?list/ ) {
1066 push @getopt, " $prop =s@" ;
1068 push @getopt, " $prop =s" ;
1074 raise
( "unable to parse option \n " , code
=> HTTP_BAD_REQUEST
)
1075 if ! Getopt
:: Long
:: GetOptionsFromArray
( $args, $opts, @getopt );
1077 if ( my $acount = scalar ( @$args )) {
1079 $opts ->{ $list_param } = $args ;
1081 } elsif ( ref ( $arg_param )) {
1082 raise
( "wrong number of arguments \n " , code
=> HTTP_BAD_REQUEST
)
1083 if scalar ( @$arg_param ) != $acount ;
1084 foreach my $p ( @$arg_param ) {
1085 $opts ->{ $p } = shift @$args ;
1088 raise
( "too many arguments \n " , code
=> HTTP_BAD_REQUEST
)
1089 if scalar ( @$args ) != 0 ;
1093 if ( my $pd = $schema ->{ properties
}->{ password
}) {
1094 if ( $pd ->{ type
} ne 'boolean' && $pwcallback ) {
1095 if ( $opts ->{ password
} || ! $pd ->{ optional
}) {
1096 $opts ->{ password
} = & $pwcallback ();
1101 $opts = PVE
:: Tools
:: decode_utf8_parameters
( $opts );
1103 foreach my $p ( keys %$opts ) {
1104 if ( my $pd = $schema ->{ properties
}->{ $p }) {
1105 if ( $pd ->{ type
} eq 'boolean' ) {
1106 if ( $opts ->{ $p } eq '' ) {
1108 } elsif ( $opts ->{ $p } =~ m/^(1|true|yes|on)$/i ) {
1110 } elsif ( $opts ->{ $p } =~ m/^(0|false|no|off)$/i ) {
1113 raise
( "unable to parse boolean option \n " , code
=> HTTP_BAD_REQUEST
);
1115 } elsif ( $pd ->{ format
}) {
1117 if ( $pd ->{ format
} =~ m/-list/ ) {
1118 # allow --vmid 100 --vmid 101 and --vmid 100,101
1119 # allow --dow mon --dow fri and --dow mon,fri
1120 $opts ->{ $p } = join ( "," , @{ $opts ->{ $p }});
1121 } elsif ( $pd ->{ format
} =~ m/-alist/ ) {
1122 # we encode array as \0 separated strings
1123 # Note: CGI.pm also use this encoding
1124 if ( scalar (@{ $opts ->{ $p }}) != 1 ) {
1125 $opts ->{ $p } = join ( "\0" , @{ $opts ->{ $p }});
1127 # st that split_list knows it is \0 terminated
1128 my $v = $opts ->{ $p }->[ 0 ];
1129 $opts ->{ $p } = " $v\0 " ;
1136 foreach my $p ( keys %$fixed_param ) {
1137 $opts ->{ $p } = $fixed_param ->{ $p };
1143 # A way to parse configuration data by giving a json schema
1145 my ( $schema, $filename, $raw ) = @_ ;
1147 # do fast check (avoid validate_schema($schema))
1148 die "got strange schema" if ! $schema ->{ type
} ||
1149 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1153 while ( $raw =~ /^\s*(.+?)\s*$/gm ) {
1156 next if $line =~ /^#/ ;
1158 if ( $line =~ m/^(\S+?):\s*(.*)$/ ) {
1161 if ( $schema ->{ properties
}->{ $key } &&
1162 $schema ->{ properties
}->{ $key }->{ type
} eq 'boolean' ) {
1164 $value = 1 if $value =~ m/^(1|on|yes|true)$/i ;
1165 $value = 0 if $value =~ m/^(0|off|no|false)$/i ;
1167 $cfg ->{ $key } = $value ;
1169 warn "ignore config line: $line\n "
1174 check_prop
( $cfg, $schema, '' , $errors );
1176 foreach my $k ( keys %$errors ) {
1177 warn "parse error in ' $filename ' - ' $k ': $errors ->{ $k } \n " ;
1184 # generate simple key/value file
1186 my ( $schema, $filename, $cfg ) = @_ ;
1188 # do fast check (avoid validate_schema($schema))
1189 die "got strange schema" if ! $schema ->{ type
} ||
1190 ! $schema ->{ properties
} || $schema ->{ type
} ne 'object' ;
1192 validate
( $cfg, $schema, "validation error in ' $filename ' \n " );
1196 foreach my $k ( keys %$cfg ) {
1197 $data .= " $k : $cfg ->{ $k } \n " ;