]>
Commit | Line | Data |
---|---|---|
1 | package PVE::CLIHandler; | |
2 | ||
3 | use strict; | |
4 | use warnings; | |
5 | ||
6 | use JSON; | |
7 | use Scalar::Util qw(weaken); | |
8 | ||
9 | use PVE::SafeSyslog; | |
10 | use PVE::Exception qw(raise raise_param_exc); | |
11 | use PVE::JSONSchema; | |
12 | use PVE::RESTHandler; | |
13 | use PVE::PTY; | |
14 | use PVE::INotify; | |
15 | use PVE::CLIFormatter; | |
16 | ||
17 | use base qw(PVE::RESTHandler); | |
18 | ||
19 | # $cmddef defines which (sub)commands are available in a specific CLI class. | |
20 | # A real command is always an array consisting of its class, name, array of | |
21 | # position fixed (required) parameters and hash of predefined parameters when | |
22 | # mapping a CLI command t o an API call. Optionally an output method can be | |
23 | # passed at the end, e.g., for formatting or transformation purpose, and | |
24 | # a schema of additional properties/arguments which are added to | |
25 | # the method schema and gets passed to the formatter. | |
26 | # | |
27 | # [class, name, fixed_params, API_pre-set params, output_sub ] | |
28 | # | |
29 | # In case of so called 'simple commands', the $cmddef can be also just an | |
30 | # array. | |
31 | # | |
32 | # Examples: | |
33 | # $cmddef = { | |
34 | # command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ], | |
35 | # do => { | |
36 | # this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub { | |
37 | # my ($res) = @_; | |
38 | # print "$res\n"; | |
39 | # }], | |
40 | # that => [ 'PVE::API2::OtherClass', 'subroutine' [] ], | |
41 | # }, | |
42 | # dothat => { alias => 'do that' }, | |
43 | # } | |
44 | my $cmddef; | |
45 | my $exename; | |
46 | my $cli_handler_class; | |
47 | ||
48 | my $standard_mappings = { | |
49 | 'pve-password' => { | |
50 | name => 'password', | |
51 | desc => '<password>', | |
52 | interactive => 1, | |
53 | func => sub { | |
54 | my ($value) = @_; | |
55 | return $value if $value; | |
56 | return PVE::PTY::get_confirmed_password(); | |
57 | }, | |
58 | }, | |
59 | }; | |
60 | sub get_standard_mapping { | |
61 | my ($name, $base) = @_; | |
62 | ||
63 | my $std = $standard_mappings->{$name}; | |
64 | die "no such standard mapping '$name'\n" if !$std; | |
65 | ||
66 | my $res = $base || {}; | |
67 | ||
68 | foreach my $opt (keys %$std) { | |
69 | next if defined($res->{$opt}); | |
70 | $res->{$opt} = $std->{$opt}; | |
71 | } | |
72 | ||
73 | return $res; | |
74 | } | |
75 | ||
76 | my $gen_param_mapping_func = sub { | |
77 | my ($cli_handler_class) = @_; | |
78 | ||
79 | my $param_mapping = $cli_handler_class->can('param_mapping'); | |
80 | ||
81 | if (!$param_mapping) { | |
82 | my $read_password = $cli_handler_class->can('read_password'); | |
83 | my $string_param_mapping = $cli_handler_class->can('string_param_file_mapping'); | |
84 | ||
85 | return $string_param_mapping if !$read_password; | |
86 | ||
87 | $param_mapping = sub { | |
88 | my ($name) = @_; | |
89 | ||
90 | my $password_map = get_standard_mapping('pve-password', { | |
91 | func => $read_password | |
92 | }); | |
93 | my $map = $string_param_mapping ? $string_param_mapping->($name) : []; | |
94 | return [@$map, $password_map]; | |
95 | }; | |
96 | } | |
97 | ||
98 | return $param_mapping; | |
99 | }; | |
100 | ||
101 | my $assert_initialized = sub { | |
102 | my @caller = caller; | |
103 | die "$caller[0]:$caller[2] - not initialized\n" | |
104 | if !($cmddef && $exename && $cli_handler_class); | |
105 | }; | |
106 | ||
107 | my $abort = sub { | |
108 | my ($reason, $cmd) = @_; | |
109 | print_usage_short (\*STDERR, $reason, $cmd); | |
110 | exit (-1); | |
111 | }; | |
112 | ||
113 | my $expand_command_name = sub { | |
114 | my ($def, $cmd, $enforce_exact) = @_; | |
115 | ||
116 | return $cmd if exists $def->{$cmd}; # command is already complete | |
117 | ||
118 | my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias}) }; | |
119 | my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def; | |
120 | ||
121 | return @expanded if !$enforce_exact; | |
122 | ||
123 | return $expanded[0] if scalar(@expanded) == 1; # enforce exact match | |
124 | ||
125 | return undef; | |
126 | }; | |
127 | ||
128 | my $get_commands = sub { | |
129 | my $def = shift // die "no command definition passed!"; | |
130 | return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias})) } sort keys %$def ]; | |
131 | }; | |
132 | ||
133 | my $complete_command_names = sub { $get_commands->($cmddef) }; | |
134 | ||
135 | # traverses the command definition using the $argv array, resolving one level | |
136 | # of aliases. | |
137 | # Returns the matching (sub) command and its definition, and argument array for | |
138 | # this (sub) command and a hash where we marked which (sub) commands got | |
139 | # expanded (e.g. st => status) while traversing | |
140 | sub resolve_cmd { | |
141 | my ($argv, $is_alias) = @_; | |
142 | ||
143 | my ($def, $cmd) = ($cmddef, $argv); | |
144 | my $cmdstr = $exename; | |
145 | ||
146 | if (ref($argv) eq 'ARRAY') { | |
147 | my $expanded_last_arg; | |
148 | my $last_arg_id = scalar(@$argv) - 1; | |
149 | ||
150 | for my $i (0..$last_arg_id) { | |
151 | $cmd = $expand_command_name->($def, $argv->[$i], 1); | |
152 | if (defined($cmd)) { | |
153 | # If the argument was expanded (or was already complete) and it | |
154 | # is the final argument, tell our caller about it: | |
155 | $expanded_last_arg = $cmd if $i == $last_arg_id; | |
156 | } else { | |
157 | # Otherwise continue with the unexpanded version of it. | |
158 | $cmd = $argv->[$i]; | |
159 | } | |
160 | $cmdstr .= " $cmd"; | |
161 | if (!defined($def->{$cmd})) { | |
162 | # $cmd still could be a valid prefix for bash_completion | |
163 | # in that case keep $def as it is, else set it to undef | |
164 | $def = undef if !$expand_command_name->($def, $cmd); | |
165 | last; | |
166 | } | |
167 | $def = $def->{$cmd}; | |
168 | ||
169 | if (ref($def) eq 'ARRAY') { | |
170 | # could expand to a real command, rest of $argv are its arguments | |
171 | my $cmd_args = [ @$argv[$i+1..$last_arg_id] ]; | |
172 | return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr); | |
173 | } | |
174 | ||
175 | if (defined($def->{alias})) { | |
176 | die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles | |
177 | # replace aliased (sub)command with the expanded aliased command | |
178 | splice @$argv, $i, 1, split(/ +/, $def->{alias}); | |
179 | return resolve_cmd($argv, 1); | |
180 | } | |
181 | } | |
182 | # got either a special command (bashcomplete, verifyapi) or an unknown | |
183 | # cmd, just return first entry as cmd and the rest of $argv as cmd_arg | |
184 | my $cmd_args = [ @$argv[1..$last_arg_id] ]; | |
185 | return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr); | |
186 | } | |
187 | return ($cmd, $def, undef, undef, $cmdstr); | |
188 | } | |
189 | ||
190 | sub generate_usage_str { | |
191 | my ($format, $cmd, $indent, $separator, $sortfunc) = @_; | |
192 | ||
193 | $assert_initialized->(); | |
194 | die 'format required' if !$format; | |
195 | ||
196 | $sortfunc //= sub { sort keys %{$_[0]} }; | |
197 | $separator //= ''; | |
198 | $indent //= ''; | |
199 | ||
200 | my $param_cb = $gen_param_mapping_func->($cli_handler_class); | |
201 | ||
202 | my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd($cmd); | |
203 | ||
204 | my $generate_weak; | |
205 | $generate_weak = sub { | |
206 | my ($indent, $separator, $def, $prefix) = @_; | |
207 | ||
208 | my $str = ''; | |
209 | if (ref($def) eq 'HASH') { | |
210 | my $oldclass = undef; | |
211 | foreach my $cmd (&$sortfunc($def)) { | |
212 | ||
213 | if (ref($def->{$cmd}) eq 'ARRAY') { | |
214 | my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}}; | |
215 | ||
216 | $str .= $separator if $oldclass && $oldclass ne $class; | |
217 | $str .= $indent; | |
218 | $str .= $class->usage_str($name, "$prefix $cmd", $arg_param, | |
219 | $fixed_param, $format, $param_cb, $formatter_properties); | |
220 | $oldclass = $class; | |
221 | ||
222 | } elsif (defined($def->{$cmd}->{alias}) && ($format eq 'asciidoc')) { | |
223 | ||
224 | $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n"; | |
225 | ||
226 | } else { | |
227 | next if $def->{$cmd}->{alias}; | |
228 | ||
229 | my $substr = $generate_weak->($indent, '', $def->{$cmd}, "$prefix $cmd"); | |
230 | if ($substr) { | |
231 | $substr .= $separator if $substr !~ /\Q$separator\E{2}/; | |
232 | $str .= $substr; | |
233 | } | |
234 | } | |
235 | ||
236 | } | |
237 | } else { | |
238 | $abort->("unknown command '$cmd->[0]'") if !$def; | |
239 | my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def; | |
240 | ||
241 | $str .= $indent; | |
242 | $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties); | |
243 | } | |
244 | return $str; | |
245 | }; | |
246 | my $generate = $generate_weak; | |
247 | weaken($generate_weak); | |
248 | ||
249 | return $generate->($indent, $separator, $def, $cmdstr); | |
250 | } | |
251 | ||
252 | __PACKAGE__->register_method ({ | |
253 | name => 'help', | |
254 | path => 'help', | |
255 | method => 'GET', | |
256 | description => "Get help about specified command.", | |
257 | parameters => { | |
258 | additionalProperties => 0, | |
259 | properties => { | |
260 | 'extra-args' => PVE::JSONSchema::get_standard_option('extra-args', { | |
261 | description => 'Shows help for a specific command', | |
262 | completion => $complete_command_names, | |
263 | }), | |
264 | verbose => { | |
265 | description => "Verbose output format.", | |
266 | type => 'boolean', | |
267 | optional => 1, | |
268 | }, | |
269 | }, | |
270 | }, | |
271 | returns => { type => 'null' }, | |
272 | ||
273 | code => sub { | |
274 | my ($param) = @_; | |
275 | ||
276 | $assert_initialized->(); | |
277 | ||
278 | my $cmd = $param->{'extra-args'}; | |
279 | ||
280 | my $verbose = defined($cmd) && $cmd; | |
281 | $verbose = $param->{verbose} if defined($param->{verbose}); | |
282 | ||
283 | if (!$cmd) { | |
284 | if ($verbose) { | |
285 | print_usage_verbose(); | |
286 | } else { | |
287 | print_usage_short(\*STDOUT); | |
288 | } | |
289 | return undef; | |
290 | } | |
291 | ||
292 | my $str; | |
293 | if ($verbose) { | |
294 | $str = generate_usage_str('full', $cmd, ''); | |
295 | } else { | |
296 | $str = generate_usage_str('short', $cmd, ' ' x 7); | |
297 | } | |
298 | $str =~ s/^\s+//; | |
299 | ||
300 | if ($verbose) { | |
301 | print "$str\n"; | |
302 | } else { | |
303 | print "USAGE: $str\n"; | |
304 | } | |
305 | ||
306 | return undef; | |
307 | ||
308 | }}); | |
309 | ||
310 | sub print_simple_asciidoc_synopsis { | |
311 | $assert_initialized->(); | |
312 | ||
313 | my $synopsis = "*${exename}* `help`\n\n"; | |
314 | $synopsis .= generate_usage_str('asciidoc'); | |
315 | ||
316 | return $synopsis; | |
317 | } | |
318 | ||
319 | sub print_asciidoc_synopsis { | |
320 | $assert_initialized->(); | |
321 | ||
322 | my $synopsis = ""; | |
323 | ||
324 | $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n"; | |
325 | ||
326 | $synopsis .= generate_usage_str('asciidoc'); | |
327 | ||
328 | $synopsis .= "\n"; | |
329 | ||
330 | return $synopsis; | |
331 | } | |
332 | ||
333 | sub print_usage_verbose { | |
334 | $assert_initialized->(); | |
335 | ||
336 | print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n"; | |
337 | ||
338 | my $str = generate_usage_str('full'); | |
339 | ||
340 | print "$str\n"; | |
341 | } | |
342 | ||
343 | sub print_usage_short { | |
344 | my ($fd, $msg, $cmd) = @_; | |
345 | ||
346 | $assert_initialized->(); | |
347 | ||
348 | print $fd "ERROR: $msg\n" if $msg; | |
349 | print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n"; | |
350 | ||
351 | print {$fd} generate_usage_str('short', $cmd, ' ' x 7, $cmd ? '' : "\n", sub { | |
352 | my ($h) = @_; | |
353 | return sort { | |
354 | if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') { | |
355 | # $a and $b are both real commands order them by their class | |
356 | return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b; | |
357 | } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') { | |
358 | # real command and subcommand mixed, put sub commands first | |
359 | return ref($h->{$b}) eq 'ARRAY' ? -1 : 1; | |
360 | } else { | |
361 | # both are either from the same class or subcommands | |
362 | return $a cmp $b; | |
363 | } | |
364 | } keys %$h; | |
365 | }); | |
366 | } | |
367 | ||
368 | my $print_bash_completion = sub { | |
369 | my ($simple_cmd, $bash_command, $cur, $prev) = @_; | |
370 | ||
371 | my $debug = 0; | |
372 | ||
373 | return if !(defined($cur) && defined($prev) && defined($bash_command)); | |
374 | return if !defined($ENV{COMP_LINE}); | |
375 | return if !defined($ENV{COMP_POINT}); | |
376 | ||
377 | my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT}); | |
378 | print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug; | |
379 | ||
380 | my $args = PVE::Tools::split_args($cmdline); | |
381 | shift @$args; # no need for program name | |
382 | my $print_result = sub { | |
383 | foreach my $p (@_) { | |
384 | print "$p\n" if $p =~ m/^\Q$cur\E/; | |
385 | } | |
386 | }; | |
387 | ||
388 | my ($cmd, $def) = ($simple_cmd, $cmddef); | |
389 | if (!$simple_cmd) { | |
390 | ($cmd, $def, $args, my $expanded) = resolve_cmd($args); | |
391 | ||
392 | if (defined($expanded) && $prev ne $expanded) { | |
393 | print "$expanded\n"; | |
394 | return; | |
395 | } | |
396 | ||
397 | if (ref($def) eq 'HASH') { | |
398 | &$print_result(@{$get_commands->($def)}); | |
399 | return; | |
400 | } | |
401 | } | |
402 | return if !$def; | |
403 | ||
404 | my $pos = scalar(@$args) - 1; | |
405 | $pos += 1 if $cmdline =~ m/\s+$/; | |
406 | print STDERR "pos: $pos\n" if $debug; | |
407 | return if $pos < 0; | |
408 | ||
409 | my $skip_param = {}; | |
410 | ||
411 | my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def; | |
412 | $arg_param //= []; | |
413 | $uri_param //= {}; | |
414 | ||
415 | $arg_param = [ $arg_param ] if !ref($arg_param); | |
416 | ||
417 | map { $skip_param->{$_} = 1; } @$arg_param; | |
418 | map { $skip_param->{$_} = 1; } keys %$uri_param; | |
419 | ||
420 | my $info = $class->map_method_by_name($name); | |
421 | ||
422 | my $prop = { %{$info->{parameters}->{properties}} }; # copy | |
423 | $prop = { %$prop, %$formatter_properties } if $formatter_properties; | |
424 | ||
425 | my $print_parameter_completion = sub { | |
426 | my ($pname) = @_; | |
427 | my $d = $prop->{$pname}; | |
428 | if ($d->{completion}) { | |
429 | my $vt = ref($d->{completion}); | |
430 | if ($vt eq 'CODE') { | |
431 | my $res = $d->{completion}->($cmd, $pname, $cur, $args); | |
432 | &$print_result(@$res); | |
433 | } | |
434 | } elsif ($d->{type} eq 'boolean') { | |
435 | &$print_result('0', '1'); | |
436 | } elsif ($d->{enum}) { | |
437 | &$print_result(@{$d->{enum}}); | |
438 | } | |
439 | }; | |
440 | ||
441 | # positional arguments | |
442 | if ($pos < scalar(@$arg_param)) { | |
443 | my $pname = $arg_param->[$pos]; | |
444 | &$print_parameter_completion($pname); | |
445 | return; | |
446 | } | |
447 | ||
448 | my @option_list = (); | |
449 | foreach my $key (keys %$prop) { | |
450 | next if $skip_param->{$key}; | |
451 | push @option_list, "--$key"; | |
452 | } | |
453 | ||
454 | if ($cur =~ m/^-/) { | |
455 | &$print_result(@option_list); | |
456 | return; | |
457 | } | |
458 | ||
459 | if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) { | |
460 | my $pname = $1; | |
461 | &$print_parameter_completion($pname); | |
462 | return; | |
463 | } | |
464 | ||
465 | &$print_result(@option_list); | |
466 | }; | |
467 | ||
468 | sub verify_api { | |
469 | my ($class) = @_; | |
470 | ||
471 | # simply verify all registered methods | |
472 | PVE::RESTHandler::validate_method_schemas(); | |
473 | } | |
474 | ||
475 | my $get_exe_name = sub { | |
476 | my ($class) = @_; | |
477 | ||
478 | my $name = $class; | |
479 | $name =~ s/^.*:://; | |
480 | $name =~ s/_/-/g; | |
481 | ||
482 | return $name; | |
483 | }; | |
484 | ||
485 | sub generate_bash_completions { | |
486 | my ($class) = @_; | |
487 | ||
488 | # generate bash completion config | |
489 | ||
490 | $exename = &$get_exe_name($class); | |
491 | ||
492 | print <<__EOD__; | |
493 | # $exename bash completion | |
494 | ||
495 | # see http://tiswww.case.edu/php/chet/bash/FAQ | |
496 | # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion | |
497 | # this modifies global var, but I found no better way | |
498 | COMP_WORDBREAKS=\${COMP_WORDBREAKS//:} | |
499 | ||
500 | complete -o default -C '$exename bashcomplete' $exename | |
501 | __EOD__ | |
502 | } | |
503 | ||
504 | sub generate_zsh_completions { | |
505 | my ($class) = @_; | |
506 | ||
507 | # generate zsh completion config | |
508 | ||
509 | $exename = &$get_exe_name($class); | |
510 | ||
511 | print <<__EOD__; | |
512 | #compdef _$exename $exename | |
513 | ||
514 | function _$exename() { | |
515 | local cwords line point cmd curr prev | |
516 | cwords=\${#words[@]} | |
517 | line=\$words | |
518 | point=\${#line} | |
519 | cmd=\${words[1]} | |
520 | curr=\${words[cwords]} | |
521 | prev=\${words[cwords-1]} | |
522 | compadd -- \$(COMP_CWORD="\$cwords" COMP_LINE="\$line" COMP_POINT="\$point" \\ | |
523 | $exename bashcomplete "\$cmd" "\$curr" "\$prev") | |
524 | } | |
525 | __EOD__ | |
526 | } | |
527 | ||
528 | sub generate_asciidoc_synopsys { | |
529 | my ($class) = @_; | |
530 | $class->generate_asciidoc_synopsis(); | |
531 | }; | |
532 | ||
533 | sub generate_asciidoc_synopsis { | |
534 | my ($class) = @_; | |
535 | ||
536 | $cli_handler_class = $class; | |
537 | ||
538 | $exename = &$get_exe_name($class); | |
539 | ||
540 | no strict 'refs'; | |
541 | my $def = ${"${class}::cmddef"}; | |
542 | $cmddef = $def; | |
543 | ||
544 | if (ref($def) eq 'ARRAY') { | |
545 | print_simple_asciidoc_synopsis(); | |
546 | } else { | |
547 | $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; | |
548 | ||
549 | print_asciidoc_synopsis(); | |
550 | } | |
551 | } | |
552 | ||
553 | # overwrite this if you want to run/setup things early | |
554 | sub setup_environment { | |
555 | my ($class) = @_; | |
556 | ||
557 | # do nothing by default | |
558 | } | |
559 | ||
560 | my $handle_cmd = sub { | |
561 | my ($args, $preparefunc, $param_cb) = @_; | |
562 | ||
563 | $cmddef->{help} = [ __PACKAGE__, 'help', ['extra-args'] ]; | |
564 | ||
565 | my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd($args); | |
566 | ||
567 | $abort->("no command specified") if !$cmd; | |
568 | ||
569 | # call verifyapi before setup_environment(), don't execute any real code in | |
570 | # this case | |
571 | if ($cmd eq 'verifyapi') { | |
572 | PVE::RESTHandler::validate_method_schemas(); | |
573 | return; | |
574 | } | |
575 | ||
576 | $cli_handler_class->setup_environment(); | |
577 | ||
578 | if ($cmd eq 'bashcomplete') { | |
579 | &$print_bash_completion(undef, @$cmd_args); | |
580 | return; | |
581 | } | |
582 | ||
583 | # checked special commands, if def is still a hash we got an incomplete sub command | |
584 | $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH'; | |
585 | ||
586 | &$preparefunc() if $preparefunc; | |
587 | ||
588 | my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []}; | |
589 | $abort->("unknown command '$cmd_str'") if !$class; | |
590 | ||
591 | my ($res, $formatter_params) = $class->cli_handler( | |
592 | $cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties); | |
593 | ||
594 | if (defined $outsub) { | |
595 | my $result_schema = $class->map_method_by_name($name)->{returns}; | |
596 | $outsub->($res, $result_schema, $formatter_params); | |
597 | } | |
598 | }; | |
599 | ||
600 | my $handle_simple_cmd = sub { | |
601 | my ($args, $preparefunc, $param_cb) = @_; | |
602 | ||
603 | my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef}; | |
604 | die "no class specified" if !$class; | |
605 | ||
606 | if (scalar(@$args) >= 1) { | |
607 | if ($args->[0] eq 'help') { | |
608 | my $str = "USAGE: $name help\n"; | |
609 | $str .= generate_usage_str('long'); | |
610 | print STDERR "$str\n\n"; | |
611 | return; | |
612 | } elsif ($args->[0] eq 'verifyapi') { | |
613 | PVE::RESTHandler::validate_method_schemas(); | |
614 | return; | |
615 | } | |
616 | } | |
617 | ||
618 | $cli_handler_class->setup_environment(); | |
619 | ||
620 | if (scalar(@$args) >= 1) { | |
621 | if ($args->[0] eq 'bashcomplete') { | |
622 | shift @$args; | |
623 | &$print_bash_completion($name, @$args); | |
624 | return; | |
625 | } | |
626 | } | |
627 | ||
628 | &$preparefunc() if $preparefunc; | |
629 | ||
630 | my ($res, $formatter_params) = $class->cli_handler( | |
631 | $name, $name, \@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties); | |
632 | ||
633 | if (defined $outsub) { | |
634 | my $result_schema = $class->map_method_by_name($name)->{returns}; | |
635 | $outsub->($res, $result_schema, $formatter_params); | |
636 | } | |
637 | }; | |
638 | ||
639 | sub run_cli_handler { | |
640 | my ($class, %params) = @_; | |
641 | ||
642 | $cli_handler_class = $class; | |
643 | ||
644 | $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin'; | |
645 | ||
646 | foreach my $key (keys %params) { | |
647 | next if $key eq 'prepare'; | |
648 | next if $key eq 'no_init'; # not used anymore | |
649 | next if $key eq 'no_rpcenv'; # not used anymore | |
650 | die "unknown parameter '$key'"; | |
651 | } | |
652 | ||
653 | my $preparefunc = $params{prepare}; | |
654 | ||
655 | my $param_cb = $gen_param_mapping_func->($cli_handler_class); | |
656 | ||
657 | $exename = &$get_exe_name($class); | |
658 | ||
659 | my $logid = $ENV{PVE_LOG_ID} || $exename; | |
660 | initlog($logid); | |
661 | ||
662 | no strict 'refs'; | |
663 | $cmddef = ${"${class}::cmddef"}; | |
664 | ||
665 | if (ref($cmddef) eq 'ARRAY') { | |
666 | $handle_simple_cmd->(\@ARGV, $preparefunc, $param_cb); | |
667 | } else { | |
668 | $handle_cmd->(\@ARGV, $preparefunc, $param_cb); | |
669 | } | |
670 | ||
671 | exit 0; | |
672 | } | |
673 | ||
674 | 1; |