]>
Commit | Line | Data |
---|---|---|
e143e9d8 DM |
1 | package PVE::RESTHandler; |
2 | ||
3 | use strict; | |
4 | no strict 'refs'; # our autoload requires this | |
e143e9d8 DM |
5 | use warnings; |
6 | use PVE::SafeSyslog; | |
7 | use PVE::Exception qw(raise raise_param_exc); | |
8 | use PVE::JSONSchema; | |
dfc6cff8 | 9 | use PVE::Tools; |
e143e9d8 DM |
10 | use HTTP::Status qw(:constants :is status_message); |
11 | use Text::Wrap; | |
4be9b5f7 | 12 | use Clone qw(clone); |
e143e9d8 DM |
13 | |
14 | my $method_registry = {}; | |
15 | my $method_by_name = {}; | |
c1089794 | 16 | my $method_path_lookup = {}; |
e143e9d8 DM |
17 | |
18 | our $AUTOLOAD; # it's a package global | |
19 | ||
20 | sub api_clone_schema { | |
21 | my ($schema) = @_; | |
22 | ||
23 | my $res = {}; | |
24 | my $ref = ref($schema); | |
25 | die "not a HASH reference" if !($ref && $ref eq 'HASH'); | |
26 | ||
27 | foreach my $k (keys %$schema) { | |
28 | my $d = $schema->{$k}; | |
29 | if ($k ne 'properties') { | |
4be9b5f7 | 30 | $res->{$k} = ref($d) ? clone($d) : $d; |
e143e9d8 DM |
31 | next; |
32 | } | |
33 | # convert indexed parameters like -net\d+ to -net[n] | |
34 | foreach my $p (keys %$d) { | |
35 | my $pd = $d->{$p}; | |
36 | if ($p =~ m/^([a-z]+)(\d+)$/) { | |
b546f33e | 37 | my ($name, $idx) = ($1, $2); |
b54ad320 | 38 | if ($idx == 0 && defined($d->{"${name}1"})) { |
b546f33e DM |
39 | $p = "${name}[n]"; |
40 | } elsif (defined($d->{"${name}0"})) { | |
2c2a5fd3 | 41 | next; # only handle once for -xx0, but only if -xx0 exists |
e143e9d8 DM |
42 | } |
43 | } | |
534d4270 DM |
44 | my $tmp = ref($pd) ? clone($pd) : $pd; |
45 | # NOTE: add typetext property for more complex types, to | |
46 | # make the web api viewer code simpler | |
47 | if (!(defined($tmp->{enum}) || defined($tmp->{pattern}))) { | |
48 | my $typetext = PVE::JSONSchema::schema_get_type_text($tmp); | |
49 | if ($tmp->{type} && ($tmp->{type} ne $typetext)) { | |
50 | $tmp->{typetext} = $typetext; | |
51 | } | |
52 | } | |
53 | $res->{$k}->{$p} = $tmp; | |
e143e9d8 DM |
54 | } |
55 | } | |
56 | ||
57 | return $res; | |
58 | } | |
59 | ||
60 | sub api_dump_full { | |
1e5ecf7b | 61 | my ($tree, $index, $class, $prefix, $raw_dump) = @_; |
e143e9d8 DM |
62 | |
63 | $prefix = '' if !$prefix; | |
64 | ||
65 | my $ma = $method_registry->{$class}; | |
66 | ||
67 | foreach my $info (@$ma) { | |
68 | ||
69 | my $path = "$prefix/$info->{path}"; | |
70 | $path =~ s/\/+$//; | |
71 | ||
72 | if ($info->{subclass}) { | |
1e5ecf7b | 73 | api_dump_full($tree, $index, $info->{subclass}, $path, $raw_dump); |
e143e9d8 DM |
74 | } else { |
75 | next if !$path; | |
76 | ||
77 | # check if method is unique | |
78 | my $realpath = $path; | |
79 | $realpath =~ s/\{[^\}]+\}/\{\}/g; | |
80 | my $fullpath = "$info->{method} $realpath"; | |
81 | die "duplicate path '$realpath'" if $index->{$fullpath}; | |
82 | $index->{$fullpath} = $info; | |
83 | ||
84 | # insert into tree | |
85 | my $treedir = $tree; | |
86 | my $res; | |
87 | my $sp = ''; | |
88 | foreach my $dir (split('/', $path)) { | |
89 | next if !$dir; | |
90 | $sp .= "/$dir"; | |
91 | $res = (grep { $_->{text} eq $dir } @$treedir)[0]; | |
92 | if ($res) { | |
93 | $res->{children} = [] if !$res->{children}; | |
94 | $treedir = $res->{children}; | |
95 | } else { | |
96 | $res = { | |
97 | path => $sp, | |
98 | text => $dir, | |
99 | children => [], | |
100 | }; | |
101 | push @$treedir, $res; | |
102 | $treedir = $res->{children}; | |
103 | } | |
104 | } | |
105 | ||
106 | if ($res) { | |
107 | my $data = {}; | |
108 | foreach my $k (keys %$info) { | |
109 | next if $k eq 'code' || $k eq "match_name" || $k eq "match_re" || | |
110 | $k eq "path"; | |
111 | ||
112 | my $d = $info->{$k}; | |
e143e9d8 | 113 | |
1e5ecf7b DM |
114 | if ($raw_dump) { |
115 | $data->{$k} = $d; | |
116 | } else { | |
117 | if ($k eq 'parameters') { | |
118 | $data->{$k} = api_clone_schema($d); | |
119 | } else { | |
120 | $data->{$k} = ref($d) ? clone($d) : $d; | |
121 | } | |
e143e9d8 DM |
122 | } |
123 | } | |
124 | $res->{info}->{$info->{method}} = $data; | |
125 | }; | |
126 | } | |
127 | } | |
128 | }; | |
129 | ||
130 | sub api_dump_cleanup_tree { | |
131 | my ($tree) = @_; | |
132 | ||
133 | foreach my $rec (@$tree) { | |
134 | delete $rec->{children} if $rec->{children} && !scalar(@{$rec->{children}}); | |
135 | if ($rec->{children}) { | |
136 | $rec->{leaf} = 0; | |
137 | api_dump_cleanup_tree($rec->{children}); | |
138 | } else { | |
139 | $rec->{leaf} = 1; | |
140 | } | |
141 | } | |
142 | ||
143 | } | |
144 | ||
903ea3ff DM |
145 | # api_dump_remove_refs: prepare API tree for use with to_json($tree) |
146 | sub api_dump_remove_refs { | |
147 | my ($tree) = @_; | |
148 | ||
149 | my $class = ref($tree); | |
150 | return $tree if !$class; | |
151 | ||
152 | if ($class eq 'ARRAY') { | |
153 | my $res = []; | |
154 | foreach my $el (@$tree) { | |
155 | push @$res, api_dump_remove_refs($el); | |
156 | } | |
157 | return $res; | |
158 | } elsif ($class eq 'HASH') { | |
159 | my $res = {}; | |
160 | foreach my $k (keys %$tree) { | |
161 | if (my $itemclass = ref($tree->{$k})) { | |
162 | if ($itemclass eq 'CODE') { | |
163 | next if $k eq 'completion'; | |
164 | } | |
165 | $res->{$k} = api_dump_remove_refs($tree->{$k}); | |
166 | } else { | |
167 | $res->{$k} = $tree->{$k}; | |
168 | } | |
169 | } | |
170 | return $res; | |
171 | } elsif ($class eq 'Regexp') { | |
172 | return "$tree"; # return string representation | |
173 | } else { | |
174 | die "unknown class '$class'\n"; | |
175 | } | |
176 | } | |
177 | ||
e143e9d8 | 178 | sub api_dump { |
1e5ecf7b | 179 | my ($class, $prefix, $raw_dump) = @_; |
e143e9d8 DM |
180 | |
181 | my $tree = []; | |
182 | ||
183 | my $index = {}; | |
1e5ecf7b | 184 | api_dump_full($tree, $index, $class, $prefix, $raw_dump); |
e143e9d8 DM |
185 | api_dump_cleanup_tree($tree); |
186 | return $tree; | |
187 | }; | |
188 | ||
189 | sub validate_method_schemas { | |
190 | ||
191 | foreach my $class (keys %$method_registry) { | |
192 | my $ma = $method_registry->{$class}; | |
193 | ||
194 | foreach my $info (@$ma) { | |
195 | PVE::JSONSchema::validate_method_info($info); | |
196 | } | |
197 | } | |
198 | } | |
199 | ||
200 | sub register_method { | |
201 | my ($self, $info) = @_; | |
202 | ||
203 | my $match_re = []; | |
204 | my $match_name = []; | |
205 | ||
c1089794 DM |
206 | my $errprefix; |
207 | ||
208 | my $method; | |
209 | if ($info->{subclass}) { | |
210 | $errprefix = "register subclass $info->{subclass} at ${self}/$info->{path} -"; | |
211 | $method = 'SUBCLASS'; | |
212 | } else { | |
213 | $errprefix = "register method ${self}/$info->{path} -"; | |
214 | $info->{method} = 'GET' if !$info->{method}; | |
215 | $method = $info->{method}; | |
216 | } | |
217 | ||
218 | $method_path_lookup->{$self} = {} if !defined($method_path_lookup->{$self}); | |
219 | my $path_lookup = $method_path_lookup->{$self}; | |
220 | ||
221 | die "$errprefix no path" if !defined($info->{path}); | |
222 | ||
e143e9d8 | 223 | foreach my $comp (split(/\/+/, $info->{path})) { |
c1089794 DM |
224 | die "$errprefix path compoment has zero length\n" if $comp eq ''; |
225 | my ($name, $regex); | |
e143e9d8 | 226 | if ($comp =~ m/^\{(\w+)(:(.*))?\}$/) { |
c1089794 DM |
227 | $name = $1; |
228 | $regex = $3 ? $3 : '\S+'; | |
229 | push @$match_re, $regex; | |
230 | push @$match_name, $name; | |
e143e9d8 | 231 | } else { |
c1089794 DM |
232 | $name = $comp; |
233 | push @$match_re, $name; | |
234 | push @$match_name, undef; | |
235 | } | |
236 | ||
237 | if ($regex) { | |
238 | $path_lookup->{regex} = {} if !defined($path_lookup->{regex}); | |
239 | ||
240 | my $old_name = $path_lookup->{regex}->{match_name}; | |
241 | die "$errprefix found changed regex match name\n" | |
242 | if defined($old_name) && ($old_name ne $name); | |
243 | my $old_re = $path_lookup->{regex}->{match_re}; | |
244 | die "$errprefix found changed regex\n" | |
245 | if defined($old_re) && ($old_re ne $regex); | |
246 | $path_lookup->{regex}->{match_name} = $name; | |
247 | $path_lookup->{regex}->{match_re} = $regex; | |
248 | ||
249 | die "$errprefix path match error - regex and fixed items\n" | |
250 | if defined($path_lookup->{folders}); | |
251 | ||
252 | $path_lookup = $path_lookup->{regex}; | |
253 | ||
254 | } else { | |
255 | $path_lookup->{folders}->{$name} = {} if !defined($path_lookup->{folders}->{$name}); | |
256 | ||
257 | die "$errprefix path match error - regex and fixed items\n" | |
258 | if defined($path_lookup->{regex}); | |
259 | ||
260 | $path_lookup = $path_lookup->{folders}->{$name}; | |
e143e9d8 DM |
261 | } |
262 | } | |
263 | ||
c1089794 DM |
264 | die "$errprefix duplicate method definition\n" |
265 | if defined($path_lookup->{$method}); | |
266 | ||
1dad1ca5 DM |
267 | if ($method eq 'SUBCLASS') { |
268 | foreach my $m (qw(GET PUT POST DELETE)) { | |
269 | die "$errprefix duplicate method definition SUBCLASS and $m\n" if $path_lookup->{$m}; | |
270 | } | |
271 | } | |
c1089794 DM |
272 | $path_lookup->{$method} = $info; |
273 | ||
e143e9d8 DM |
274 | $info->{match_re} = $match_re; |
275 | $info->{match_name} = $match_name; | |
276 | ||
277 | $method_by_name->{$self} = {} if !defined($method_by_name->{$self}); | |
278 | ||
279 | if ($info->{name}) { | |
c1089794 | 280 | die "$errprefix method name already defined\n" |
e143e9d8 DM |
281 | if defined($method_by_name->{$self}->{$info->{name}}); |
282 | ||
283 | $method_by_name->{$self}->{$info->{name}} = $info; | |
284 | } | |
285 | ||
286 | push @{$method_registry->{$self}}, $info; | |
287 | } | |
288 | ||
f1fb34a0 DM |
289 | sub DESTROY {}; # avoid problems with autoload |
290 | ||
e143e9d8 DM |
291 | sub AUTOLOAD { |
292 | my ($this) = @_; | |
293 | ||
294 | # also see "man perldiag" | |
295 | ||
296 | my $sub = $AUTOLOAD; | |
297 | (my $method = $sub) =~ s/.*:://; | |
298 | ||
e143e9d8 DM |
299 | my $info = $this->map_method_by_name($method); |
300 | ||
301 | *{$sub} = sub { | |
302 | my $self = shift; | |
303 | return $self->handle($info, @_); | |
304 | }; | |
305 | goto &$AUTOLOAD; | |
306 | } | |
307 | ||
308 | sub method_attributes { | |
309 | my ($self) = @_; | |
310 | ||
311 | return $method_registry->{$self}; | |
312 | } | |
313 | ||
314 | sub map_method_by_name { | |
315 | my ($self, $name) = @_; | |
316 | ||
317 | my $info = $method_by_name->{$self}->{$name}; | |
318 | die "no such method '${self}::$name'\n" if !$info; | |
319 | ||
320 | return $info; | |
321 | } | |
322 | ||
c1089794 | 323 | sub map_path_to_methods { |
39313ced | 324 | my ($class, $stack, $uri_param, $pathmatchref) = @_; |
e143e9d8 | 325 | |
c1089794 | 326 | my $path_lookup = $method_path_lookup->{$class}; |
e143e9d8 | 327 | |
39313ced DM |
328 | # Note: $pathmatchref can be used to obtain path including |
329 | # uri patterns like '/cluster/firewall/groups/{group}'. | |
330 | # Used by pvesh to display help | |
331 | if (defined($pathmatchref)) { | |
332 | $$pathmatchref = '' if !$$pathmatchref; | |
333 | } | |
334 | ||
844a246d | 335 | while (defined(my $comp = shift @$stack)) { |
c1089794 DM |
336 | return undef if !$path_lookup; # not registerd? |
337 | if ($path_lookup->{regex}) { | |
338 | my $name = $path_lookup->{regex}->{match_name}; | |
339 | my $regex = $path_lookup->{regex}->{match_re}; | |
e143e9d8 | 340 | |
c1089794 DM |
341 | return undef if $comp !~ m/^($regex)$/; |
342 | $uri_param->{$name} = $1; | |
343 | $path_lookup = $path_lookup->{regex}; | |
39313ced | 344 | $$pathmatchref .= '/{' . $name . '}' if defined($pathmatchref); |
c1089794 DM |
345 | } elsif ($path_lookup->{folders}) { |
346 | $path_lookup = $path_lookup->{folders}->{$comp}; | |
39313ced | 347 | $$pathmatchref .= '/' . $comp if defined($pathmatchref); |
e143e9d8 | 348 | } else { |
c1089794 | 349 | die "internal error"; |
e143e9d8 | 350 | } |
c1089794 DM |
351 | |
352 | return undef if !$path_lookup; | |
e143e9d8 | 353 | |
c1089794 DM |
354 | if (my $info = $path_lookup->{SUBCLASS}) { |
355 | $class = $info->{subclass}; | |
e143e9d8 | 356 | |
c1089794 | 357 | my $fd = $info->{fragmentDelimiter}; |
e143e9d8 | 358 | |
c1089794 DM |
359 | if (defined($fd)) { |
360 | # we only support the empty string '' (match whole URI) | |
361 | die "unsupported fragmentDelimiter '$fd'" | |
362 | if $fd ne ''; | |
e143e9d8 | 363 | |
c1089794 DM |
364 | $stack = [ join ('/', @$stack) ] if scalar(@$stack) > 1; |
365 | } | |
366 | $path_lookup = $method_path_lookup->{$class}; | |
e143e9d8 | 367 | } |
c1089794 | 368 | } |
e143e9d8 | 369 | |
c1089794 | 370 | return undef if !$path_lookup; |
e143e9d8 | 371 | |
c1089794 DM |
372 | return ($class, $path_lookup); |
373 | } | |
e143e9d8 | 374 | |
c1089794 | 375 | sub find_handler { |
39313ced | 376 | my ($class, $method, $path, $uri_param, $pathmatchref) = @_; |
e143e9d8 | 377 | |
c1089794 | 378 | my $stack = [ grep { length($_) > 0 } split('\/+' , $path)]; # skip empty fragments |
e143e9d8 | 379 | |
c1089794 DM |
380 | my ($handler_class, $path_info); |
381 | eval { | |
39313ced | 382 | ($handler_class, $path_info) = $class->map_path_to_methods($stack, $uri_param, $pathmatchref); |
c1089794 DM |
383 | }; |
384 | my $err = $@; | |
385 | syslog('err', $err) if $err; | |
e143e9d8 | 386 | |
c1089794 | 387 | return undef if !($handler_class && $path_info); |
e143e9d8 | 388 | |
c1089794 | 389 | my $method_info = $path_info->{$method}; |
e143e9d8 | 390 | |
c1089794 | 391 | return undef if !$method_info; |
e143e9d8 | 392 | |
c1089794 | 393 | return ($handler_class, $method_info); |
e143e9d8 DM |
394 | } |
395 | ||
396 | sub handle { | |
397 | my ($self, $info, $param) = @_; | |
398 | ||
399 | my $func = $info->{code}; | |
400 | ||
401 | if (!($info->{name} && $func)) { | |
402 | raise("Method lookup failed ('$info->{name}')\n", | |
403 | code => HTTP_INTERNAL_SERVER_ERROR); | |
404 | } | |
405 | ||
406 | if (my $schema = $info->{parameters}) { | |
407 | # warn "validate ". Dumper($param}) . "\n" . Dumper($schema); | |
408 | PVE::JSONSchema::validate($param, $schema); | |
409 | # untaint data (already validated) | |
5851be88 | 410 | my $extra = delete $param->{'extra-args'}; |
e143e9d8 DM |
411 | while (my ($key, $val) = each %$param) { |
412 | ($param->{$key}) = $val =~ /^(.*)$/s; | |
413 | } | |
5851be88 | 414 | $param->{'extra-args'} = [map { /^(.*)$/ } @$extra] if $extra; |
e143e9d8 DM |
415 | } |
416 | ||
417 | my $result = &$func($param); | |
418 | ||
419 | # todo: this is only to be safe - disable? | |
420 | if (my $schema = $info->{returns}) { | |
9030a7d7 | 421 | PVE::JSONSchema::validate($result, $schema, "Result verification failed\n"); |
e143e9d8 DM |
422 | } |
423 | ||
424 | return $result; | |
425 | } | |
426 | ||
8fa050cd | 427 | # format option, display type and description |
921f91d1 DM |
428 | # $name: option name |
429 | # $display_name: for example "-$name" of "<$name>", pass undef to use "$name:" | |
8fa050cd | 430 | # $phash: json schema property hash |
b0e5e9fa | 431 | # $format: 'asciidoc', 'short', 'long' or 'full' |
abc1afd8 | 432 | # $style: 'config', 'config-sub', 'arg' or 'fixed' |
dfc6cff8 | 433 | # $mapdef: parameter mapping ({ desc => XXX, func => sub {...} }) |
8fa050cd | 434 | my $get_property_description = sub { |
dfc6cff8 | 435 | my ($name, $style, $phash, $format, $hidepw, $mapdef) = @_; |
8fa050cd DM |
436 | |
437 | my $res = ''; | |
438 | ||
439 | $format = 'asciidoc' if !defined($format); | |
440 | ||
441 | my $descr = $phash->{description} || "no description available"; | |
442 | ||
32f8e0c7 DM |
443 | if ($phash->{verbose_description} && |
444 | ($style eq 'config' || $style eq 'config-sub')) { | |
445 | $descr = $phash->{verbose_description}; | |
446 | } | |
447 | ||
8fa050cd DM |
448 | chomp $descr; |
449 | ||
77096a6f | 450 | my $type_text = PVE::JSONSchema::schema_get_type_text($phash, $style); |
8fa050cd | 451 | |
921f91d1 | 452 | if ($hidepw && $name eq 'password') { |
77096a6f | 453 | $type_text = ''; |
8fa050cd DM |
454 | } |
455 | ||
dfc6cff8 DM |
456 | if ($mapdef && $phash->{type} eq 'string') { |
457 | $type_text = $mapdef->{desc}; | |
4845032a FG |
458 | } |
459 | ||
8fa050cd DM |
460 | if ($format eq 'asciidoc') { |
461 | ||
df79b428 | 462 | if ($style eq 'config') { |
921f91d1 | 463 | $res .= "`$name`: "; |
32f8e0c7 DM |
464 | } elsif ($style eq 'config-sub') { |
465 | $res .= "`$name`="; | |
df79b428 | 466 | } elsif ($style eq 'arg') { |
a4f181a3 | 467 | $res .= "`--$name` "; |
df79b428 | 468 | } elsif ($style eq 'fixed') { |
abc1afd8 | 469 | $res .= "`<$name>`: "; |
df79b428 DM |
470 | } else { |
471 | die "unknown style '$style'"; | |
8fa050cd DM |
472 | } |
473 | ||
77096a6f | 474 | $res .= "`$type_text` " if $type_text; |
8fa050cd DM |
475 | |
476 | if (defined(my $dv = $phash->{default})) { | |
25d9bda9 | 477 | $res .= "('default =' `$dv`)"; |
8fa050cd | 478 | } |
a736ac99 | 479 | |
32f8e0c7 DM |
480 | if ($style eq 'config-sub') { |
481 | $res .= ";;\n\n"; | |
482 | } else { | |
483 | $res .= "::\n\n"; | |
484 | } | |
485 | ||
486 | my $wdescr = $descr; | |
a736ac99 DM |
487 | chomp $wdescr; |
488 | $wdescr =~ s/^$/+/mg; | |
489 | ||
490 | $res .= $wdescr . "\n"; | |
8fa050cd DM |
491 | |
492 | if (my $req = $phash->{requires}) { | |
493 | my $tmp .= ref($req) ? join(', ', @$req) : $req; | |
494 | $res .= "+\nNOTE: Requires option(s): `$tmp`\n"; | |
495 | } | |
496 | $res .= "\n"; | |
497 | ||
b0e5e9fa | 498 | } elsif ($format eq 'short' || $format eq 'long' || $format eq 'full') { |
8fa050cd DM |
499 | |
500 | my $defaulttxt = ''; | |
501 | if (defined(my $dv = $phash->{default})) { | |
502 | $defaulttxt = " (default=$dv)"; | |
503 | } | |
504 | ||
df79b428 DM |
505 | my $display_name; |
506 | if ($style eq 'config') { | |
507 | $display_name = "$name:"; | |
508 | } elsif ($style eq 'arg') { | |
509 | $display_name = "-$name"; | |
510 | } elsif ($style eq 'fixed') { | |
511 | $display_name = "<$name>"; | |
512 | } else { | |
513 | die "unknown style '$style'"; | |
514 | } | |
8fa050cd | 515 | |
77096a6f | 516 | my $tmp = sprintf " %-10s %s$defaulttxt\n", $display_name, "$type_text"; |
8fa050cd DM |
517 | my $indend = " "; |
518 | ||
519 | $res .= Text::Wrap::wrap('', $indend, ($tmp)); | |
520 | $res .= "\n", | |
521 | $res .= Text::Wrap::wrap($indend, $indend, ($descr)) . "\n\n"; | |
522 | ||
523 | if (my $req = $phash->{requires}) { | |
524 | my $tmp = "Requires option(s): "; | |
525 | $tmp .= ref($req) ? join(', ', @$req) : $req; | |
526 | $res .= Text::Wrap::wrap($indend, $indend, ($tmp)). "\n\n"; | |
527 | } | |
528 | ||
529 | } else { | |
530 | die "unknown format '$format'"; | |
531 | } | |
532 | ||
533 | return $res; | |
534 | }; | |
535 | ||
dfc6cff8 DM |
536 | # translate parameter mapping definition |
537 | # $mapping_array is a array which can contain: | |
538 | # strings ... in that case we assume it is a parameter name, and | |
539 | # we want to load that parameter from a file | |
540 | # [ param_name, func, desc] ... allows you to specify a arbitrary | |
541 | # mapping func for any param | |
542 | # | |
543 | # Returns: a hash indexed by parameter_name, | |
544 | # i.e. { param_name => { func => .., desc => ... } } | |
545 | my $compute_param_mapping_hash = sub { | |
546 | my ($mapping_array) = @_; | |
547 | ||
548 | my $res = {}; | |
549 | ||
550 | return $res if !defined($mapping_array); | |
551 | ||
552 | foreach my $item (@$mapping_array) { | |
c7171ff2 | 553 | my ($name, $func, $desc, $interactive); |
dfc6cff8 | 554 | if (ref($item) eq 'ARRAY') { |
c7171ff2 | 555 | ($name, $func, $desc, $interactive) = @$item; |
a1c7edda DC |
556 | } elsif (ref($item) eq 'HASH') { |
557 | # just use the hash | |
558 | $res->{$item->{name}} = $item; | |
559 | next; | |
dfc6cff8 DM |
560 | } else { |
561 | $name = $item; | |
562 | $func = sub { return PVE::Tools::file_get_contents($_[0]) }; | |
563 | } | |
564 | $desc //= '<filepath>'; | |
c7171ff2 | 565 | $res->{$name} = { desc => $desc, func => $func, interactive => $interactive }; |
dfc6cff8 DM |
566 | } |
567 | ||
568 | return $res; | |
569 | }; | |
570 | ||
e143e9d8 DM |
571 | # generate usage information for command line tools |
572 | # | |
573 | # $name ... the name of the method | |
574 | # $prefix ... usually something like "$exename $cmd" ('pvesm add') | |
1d21344c DM |
575 | # $arg_param ... list of parameters we want to get as ordered arguments |
576 | # on the command line (or single parameter name for lists) | |
e143e9d8 DM |
577 | # $fixed_param ... do not generate and info about those parameters |
578 | # $format: | |
b0e5e9fa DM |
579 | # 'long' ... default (text, list all options) |
580 | # 'short' ... command line only (text, one line) | |
581 | # 'full' ... text, include description | |
fe3f1fde | 582 | # 'asciidoc' ... generate asciidoc for man pages (like 'full') |
e143e9d8 | 583 | # $hidepw ... hide password option (use this if you provide a read passwork callback) |
b01af861 | 584 | # $param_mapping_func ... mapping for string parameters to file path parameters |
e143e9d8 | 585 | sub usage_str { |
b01af861 | 586 | my ($self, $name, $prefix, $arg_param, $fixed_param, $format, $hidepw, $param_mapping_func) = @_; |
e143e9d8 DM |
587 | |
588 | $format = 'long' if !$format; | |
589 | ||
590 | my $info = $self->map_method_by_name($name); | |
591 | my $schema = $info->{parameters}; | |
592 | my $prop = $schema->{properties}; | |
593 | ||
594 | my $out = ''; | |
595 | ||
596 | my $arg_hash = {}; | |
597 | ||
598 | my $args = ''; | |
1d21344c DM |
599 | |
600 | $arg_param = [ $arg_param ] if $arg_param && !ref($arg_param); | |
601 | ||
e143e9d8 DM |
602 | foreach my $p (@$arg_param) { |
603 | next if !$prop->{$p}; # just to be sure | |
1d21344c | 604 | my $pd = $prop->{$p}; |
e143e9d8 DM |
605 | |
606 | $arg_hash->{$p} = 1; | |
607 | $args .= " " if $args; | |
1d21344c | 608 | if ($pd->{format} && $pd->{format} =~ m/-list/) { |
7f0f0610 | 609 | $args .= "{<$p>}"; |
1d21344c DM |
610 | } else { |
611 | $args .= $pd->{optional} ? "[<$p>]" : "<$p>"; | |
612 | } | |
e143e9d8 DM |
613 | } |
614 | ||
e143e9d8 DM |
615 | my $argdescr = ''; |
616 | foreach my $k (@$arg_param) { | |
617 | next if defined($fixed_param->{$k}); # just to be sure | |
618 | next if !$prop->{$k}; # just to be sure | |
305068a7 | 619 | $argdescr .= &$get_property_description($k, 'fixed', $prop->{$k}, $format, 0); |
e143e9d8 DM |
620 | } |
621 | ||
622 | my $idx_param = {}; # -vlan\d+ -scsi\d+ | |
623 | ||
624 | my $opts = ''; | |
625 | foreach my $k (sort keys %$prop) { | |
626 | next if $arg_hash->{$k}; | |
627 | next if defined($fixed_param->{$k}); | |
628 | ||
77096a6f | 629 | my $type_text = $prop->{$k}->{type} || 'string'; |
e143e9d8 DM |
630 | |
631 | next if $hidepw && ($k eq 'password') && !$prop->{$k}->{optional}; | |
632 | ||
633 | my $base = $k; | |
634 | if ($k =~ m/^([a-z]+)(\d+)$/) { | |
b546f33e | 635 | my ($name, $idx) = ($1, $2); |
e143e9d8 | 636 | next if $idx_param->{$name}; |
b54ad320 | 637 | if ($idx == 0 && defined($prop->{"${name}1"})) { |
f922b8a8 FG |
638 | $idx_param->{$name} = 1; |
639 | $base = "${name}[n]"; | |
640 | } | |
e143e9d8 DM |
641 | } |
642 | ||
b01af861 DM |
643 | my $param_mapping_hash = $compute_param_mapping_hash->(&$param_mapping_func($name)) |
644 | if $param_mapping_func; | |
dfc6cff8 | 645 | |
305068a7 | 646 | $opts .= &$get_property_description($base, 'arg', $prop->{$k}, $format, |
dfc6cff8 | 647 | $hidepw, $param_mapping_hash->{$k}); |
e143e9d8 DM |
648 | |
649 | if (!$prop->{$k}->{optional}) { | |
650 | $args .= " " if $args; | |
a4f181a3 | 651 | $args .= "--$base <$type_text>" |
e143e9d8 DM |
652 | } |
653 | } | |
654 | ||
fe3f1fde DM |
655 | if ($format eq 'asciidoc') { |
656 | $out .= "*${prefix}*"; | |
657 | $out .= " `$args`" if $args; | |
658 | $out .= $opts ? " `[OPTIONS]`\n" : "\n"; | |
659 | } else { | |
660 | $out .= "USAGE: " if $format ne 'short'; | |
661 | $out .= "$prefix $args"; | |
662 | $out .= $opts ? " [OPTIONS]\n" : "\n"; | |
663 | } | |
e143e9d8 DM |
664 | |
665 | return $out if $format eq 'short'; | |
666 | ||
fe3f1fde DM |
667 | if ($info->{description}) { |
668 | if ($format eq 'asciidoc') { | |
669 | my $desc = Text::Wrap::wrap('', '', ($info->{description})); | |
670 | $out .= "\n$desc\n\n"; | |
671 | } elsif ($format eq 'full') { | |
672 | my $desc = Text::Wrap::wrap(' ', ' ', ($info->{description})); | |
673 | $out .= "\n$desc\n\n"; | |
674 | } | |
e143e9d8 DM |
675 | } |
676 | ||
677 | $out .= $argdescr if $argdescr; | |
678 | ||
679 | $out .= $opts if $opts; | |
680 | ||
681 | return $out; | |
682 | } | |
683 | ||
8fa050cd DM |
684 | # generate docs from JSON schema properties |
685 | sub dump_properties { | |
df79b428 | 686 | my ($prop, $format, $style, $filterFn) = @_; |
8fa050cd DM |
687 | |
688 | my $raw = ''; | |
689 | ||
df79b428 DM |
690 | $style //= 'config'; |
691 | ||
8fa050cd DM |
692 | my $idx_param = {}; # -vlan\d+ -scsi\d+ |
693 | ||
694 | foreach my $k (sort keys %$prop) { | |
695 | my $phash = $prop->{$k}; | |
696 | ||
697 | next if defined($filterFn) && &$filterFn($k, $phash); | |
32f8e0c7 | 698 | next if $phash->{alias}; |
8fa050cd DM |
699 | |
700 | my $base = $k; | |
701 | if ($k =~ m/^([a-z]+)(\d+)$/) { | |
b546f33e | 702 | my ($name, $idx) = ($1, $2); |
8fa050cd | 703 | next if $idx_param->{$name}; |
b54ad320 | 704 | if ($idx == 0 && defined($prop->{"${name}1"})) { |
f922b8a8 FG |
705 | $idx_param->{$name} = 1; |
706 | $base = "${name}[n]"; | |
707 | } | |
8fa050cd DM |
708 | } |
709 | ||
df79b428 | 710 | $raw .= &$get_property_description($base, $style, $phash, $format, 0); |
32f8e0c7 DM |
711 | |
712 | next if $style ne 'config'; | |
713 | ||
714 | my $prop_fmt = $phash->{format}; | |
715 | next if !$prop_fmt; | |
716 | ||
717 | if (ref($prop_fmt) ne 'HASH') { | |
718 | $prop_fmt = PVE::JSONSchema::get_format($prop_fmt); | |
719 | } | |
720 | ||
721 | next if !(ref($prop_fmt) && (ref($prop_fmt) eq 'HASH')); | |
722 | ||
723 | $raw .= dump_properties($prop_fmt, $format, 'config-sub') | |
724 | ||
8fa050cd | 725 | } |
b0e5e9fa | 726 | |
8fa050cd DM |
727 | return $raw; |
728 | } | |
729 | ||
408976c6 | 730 | my $replace_file_names_with_contents = sub { |
dfc6cff8 | 731 | my ($param, $param_mapping_hash) = @_; |
408976c6 | 732 | |
dfc6cff8 | 733 | while (my ($k, $d) = each %$param_mapping_hash) { |
c7171ff2 | 734 | next if $d->{interactive}; # handled by the JSONSchema's get_options code |
dfc6cff8 DM |
735 | $param->{$k} = $d->{func}->($param->{$k}) |
736 | if defined($param->{$k}); | |
408976c6 FG |
737 | } |
738 | ||
739 | return $param; | |
740 | }; | |
741 | ||
e143e9d8 | 742 | sub cli_handler { |
8d3eb3ce | 743 | my ($self, $prefix, $name, $args, $arg_param, $fixed_param, $read_password_func, $param_mapping_func) = @_; |
e143e9d8 DM |
744 | |
745 | my $info = $self->map_method_by_name($name); | |
746 | ||
e143e9d8 DM |
747 | my $res; |
748 | eval { | |
c7171ff2 WB |
749 | my $param_mapping_hash = $compute_param_mapping_hash->($param_mapping_func->($name)) if $param_mapping_func; |
750 | my $param = PVE::JSONSchema::get_options($info->{parameters}, $args, $arg_param, $fixed_param, $read_password_func, $param_mapping_hash); | |
dfc6cff8 | 751 | |
c7171ff2 | 752 | if (defined($param_mapping_hash)) { |
dfc6cff8 DM |
753 | &$replace_file_names_with_contents($param, $param_mapping_hash); |
754 | } | |
755 | ||
e143e9d8 DM |
756 | $res = $self->handle($info, $param); |
757 | }; | |
758 | if (my $err = $@) { | |
759 | my $ec = ref($err); | |
760 | ||
761 | die $err if !$ec || $ec ne "PVE::Exception" || !$err->is_param_exc(); | |
762 | ||
8d3eb3ce | 763 | $err->{usage} = $self->usage_str($name, $prefix, $arg_param, $fixed_param, 'short', $read_password_func, $param_mapping_func); |
e143e9d8 DM |
764 | |
765 | die $err; | |
766 | } | |
767 | ||
768 | return $res; | |
769 | } | |
770 | ||
771 | # utility methods | |
772 | # note: this modifies the original hash by adding the id property | |
773 | sub hash_to_array { | |
774 | my ($hash, $idprop) = @_; | |
775 | ||
776 | my $res = []; | |
777 | return $res if !$hash; | |
778 | ||
779 | foreach my $k (keys %$hash) { | |
780 | $hash->{$k}->{$idprop} = $k; | |
781 | push @$res, $hash->{$k}; | |
782 | } | |
783 | ||
784 | return $res; | |
785 | } | |
786 | ||
787 | 1; |