1 package PVE
::CLIHandler
;
7 use Scalar
::Util
qw(weaken);
10 use PVE
::Exception
qw(raise raise_param_exc);
15 use PVE
::CLIFormatter
;
17 use base
qw(PVE::RESTHandler);
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.
27 # [class, name, fixed_params, API_pre-set params, output_sub ]
29 # In case of so called 'simple commands', the $cmddef can be also just an
34 # command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
36 # this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
40 # that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
42 # dothat => { alias => 'do that' },
46 my $cli_handler_class;
48 my $standard_mappings = {
55 return $value if $value;
56 return PVE
::PTY
::get_confirmed_password
();
60 sub get_standard_mapping
{
61 my ($name, $base) = @_;
63 my $std = $standard_mappings->{$name};
64 die "no such standard mapping '$name'\n" if !$std;
66 my $res = $base || {};
68 foreach my $opt (keys %$std) {
69 next if defined($res->{$opt});
70 $res->{$opt} = $std->{$opt};
76 my $gen_param_mapping_func = sub {
77 my ($cli_handler_class) = @_;
79 my $param_mapping = $cli_handler_class->can('param_mapping');
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');
85 return $string_param_mapping if !$read_password;
87 $param_mapping = sub {
90 my $password_map = get_standard_mapping
('pve-password', {
91 func
=> $read_password
93 my $map = $string_param_mapping ?
$string_param_mapping->($name) : [];
94 return [@$map, $password_map];
98 return $param_mapping;
101 my $assert_initialized = sub {
103 die "$caller[0]:$caller[2] - not initialized\n"
104 if !($cmddef && $exename && $cli_handler_class);
108 my ($reason, $cmd) = @_;
109 print_usage_short
(\
*STDERR
, $reason, $cmd);
113 my $expand_command_name = sub {
114 my ($def, $cmd, $enforce_exact) = @_;
116 return $cmd if exists $def->{$cmd}; # command is already complete
118 my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias
}) };
119 my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
121 return @expanded if !$enforce_exact;
123 return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
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 ];
133 my $complete_command_names = sub { $get_commands->($cmddef) };
135 # traverses the command definition using the $argv array, resolving one level
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
141 my ($argv, $is_alias) = @_;
143 my ($def, $cmd) = ($cmddef, $argv);
144 my $cmdstr = $exename;
146 if (ref($argv) eq 'ARRAY') {
147 my $expanded_last_arg;
148 my $last_arg_id = scalar(@$argv) - 1;
150 for my $i (0..$last_arg_id) {
151 $cmd = $expand_command_name->($def, $argv->[$i], 1);
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;
157 # Otherwise continue with the unexpanded version of it.
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);
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);
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);
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);
187 return ($cmd, $def, undef, undef, $cmdstr);
190 sub generate_usage_str
{
191 my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
193 $assert_initialized->();
194 die 'format required' if !$format;
196 $sortfunc //= sub { sort keys %{$_[0]} };
200 my $param_cb = $gen_param_mapping_func->($cli_handler_class);
202 my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd
($cmd);
205 $generate_weak = sub {
206 my ($indent, $separator, $def, $prefix) = @_;
209 if (ref($def) eq 'HASH') {
210 my $oldclass = undef;
211 foreach my $cmd ($sortfunc->($def)) {
213 if (ref($def->{$cmd}) eq 'ARRAY') {
214 my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}};
216 $str .= $separator if $oldclass && $oldclass ne $class;
218 $str .= $class->usage_str(
219 $name, "$prefix $cmd", $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
223 } elsif (defined($def->{$cmd}->{alias
}) && ($format eq 'asciidoc')) {
225 $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
228 next if $def->{$cmd}->{alias
};
230 my $substr = $generate_weak->($indent, '', $def->{$cmd}, "$prefix $cmd");
232 $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
239 $abort->("unknown command '$cmd->[0]'") if !$def;
240 my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def;
243 $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
247 my $generate = $generate_weak;
248 weaken
($generate_weak);
250 return $generate->($indent, $separator, $def, $cmdstr);
253 __PACKAGE__-
>register_method ({
257 description
=> "Get help about specified command.",
259 additionalProperties
=> 0,
261 'extra-args' => PVE
::JSONSchema
::get_standard_option
('extra-args', {
262 description
=> 'Shows help for a specific command',
263 completion
=> $complete_command_names,
266 description
=> "Verbose output format.",
272 returns
=> { type
=> 'null' },
277 $assert_initialized->();
279 my $cmd = $param->{'extra-args'};
281 my $verbose = defined($cmd) && $cmd;
282 $verbose = $param->{verbose
} if defined($param->{verbose
});
286 print_usage_verbose
();
288 print_usage_short
(\
*STDOUT
);
295 $str = generate_usage_str
('full', $cmd, '');
297 $str = generate_usage_str
('short', $cmd, ' ' x
7);
304 print "USAGE: $str\n";
311 sub print_simple_asciidoc_synopsis
{
312 $assert_initialized->();
314 my $synopsis = "*${exename}* `help`\n\n";
315 $synopsis .= generate_usage_str
('asciidoc');
320 sub print_asciidoc_synopsis
{
321 $assert_initialized->();
325 $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
327 $synopsis .= generate_usage_str
('asciidoc');
334 sub print_usage_verbose
{
335 $assert_initialized->();
337 print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
339 my $str = generate_usage_str
('full');
344 sub print_usage_short
{
345 my ($fd, $msg, $cmd) = @_;
347 $assert_initialized->();
349 print $fd "ERROR: $msg\n" if $msg;
350 print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
352 print {$fd} generate_usage_str
('short', $cmd, ' ' x
7, $cmd ?
'' : "\n", sub {
354 my @sorted_commands = sort {
355 if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
356 # $a and $b are both real commands order them by their class
357 return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
358 } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
359 # real command and subcommand mixed, put sub commands first
360 return ref($h->{$b}) eq 'ARRAY' ?
-1 : 1;
362 # both are either from the same class or subcommands
366 return @sorted_commands;
370 my $print_bash_completion = sub {
371 my ($simple_cmd, $bash_command, $cur, $prev) = @_;
375 return if !(defined($cur) && defined($prev) && defined($bash_command));
376 return if !defined($ENV{COMP_LINE
});
377 return if !defined($ENV{COMP_POINT
});
379 my $cmdline = substr($ENV{COMP_LINE
}, 0, $ENV{COMP_POINT
});
380 print STDERR
"\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
382 my $args = PVE
::Tools
::split_args
($cmdline);
383 shift @$args; # no need for program name
384 my $print_result = sub {
386 print "$p\n" if $p =~ m/^\Q$cur\E/;
390 my ($cmd, $def) = ($simple_cmd, $cmddef);
392 ($cmd, $def, $args, my $expanded) = resolve_cmd
($args);
394 if (defined($expanded) && $prev ne $expanded) {
399 if (ref($def) eq 'HASH') {
400 &$print_result(@{$get_commands->($def)});
406 my $pos = scalar(@$args) - 1;
407 $pos += 1 if $cmdline =~ m/\s+$/;
408 print STDERR
"pos: $pos\n" if $debug;
413 my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def;
417 $arg_param = [ $arg_param ] if !ref($arg_param);
419 map { $skip_param->{$_} = 1; } @$arg_param;
420 map { $skip_param->{$_} = 1; } keys %$uri_param;
422 my $info = $class->map_method_by_name($name);
424 my $prop = { %{$info->{parameters
}->{properties
}} }; # copy
425 $prop = { %$prop, %$formatter_properties } if $formatter_properties;
427 my $print_parameter_completion = sub {
429 my $d = $prop->{$pname};
430 if ($d->{completion
}) {
431 my $vt = ref($d->{completion
});
433 my $res = $d->{completion
}->($cmd, $pname, $cur, $args);
434 &$print_result(@$res);
436 } elsif ($d->{type
} eq 'boolean') {
437 &$print_result('0', '1');
438 } elsif ($d->{enum
}) {
439 &$print_result(@{$d->{enum
}});
443 # positional arguments
444 if ($pos < scalar(@$arg_param)) {
445 my $pname = $arg_param->[$pos];
446 &$print_parameter_completion($pname);
450 my @option_list = ();
451 foreach my $key (keys %$prop) {
452 next if $skip_param->{$key};
453 push @option_list, "--$key";
457 &$print_result(@option_list);
461 if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
463 &$print_parameter_completion($pname);
467 &$print_result(@option_list);
473 # simply verify all registered methods
474 PVE
::RESTHandler
::validate_method_schemas
();
477 my $get_exe_name = sub {
487 sub generate_bash_completions
{
490 # generate bash completion config
492 $exename = &$get_exe_name($class);
495 # $exename bash completion
497 # see http://tiswww.case.edu/php/chet/bash/FAQ
498 # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
499 # this modifies global var, but I found no better way
500 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
502 complete -o default -C '$exename bashcomplete' $exename
506 sub generate_zsh_completions
{
509 # generate zsh completion config
511 $exename = &$get_exe_name($class);
514 #compdef _$exename $exename
516 function _$exename() {
517 local cwords line point cmd curr prev
522 curr=\${words[cwords]}
523 prev=\${words[cwords-1]}
524 compadd -- \$(COMP_CWORD="\$cwords" COMP_LINE="\$line" COMP_POINT="\$point" \\
525 $exename bashcomplete "\$cmd" "\$curr" "\$prev")
530 sub generate_asciidoc_synopsys
{
532 $class->generate_asciidoc_synopsis();
535 sub generate_asciidoc_synopsis
{
538 $cli_handler_class = $class;
540 $exename = &$get_exe_name($class);
543 no strict
'refs'; ## no critic (ProhibitNoStrict)
544 $cmddef = ${"${class}::cmddef"};
547 if (ref($cmddef) eq 'ARRAY') {
548 print_simple_asciidoc_synopsis
();
550 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['cmd'] ];
552 print_asciidoc_synopsis
();
556 # overwrite this if you want to run/setup things early
557 sub setup_environment
{
560 # do nothing by default
563 my $handle_cmd = sub {
564 my ($args, $preparefunc, $param_cb) = @_;
566 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['extra-args'] ];
568 my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd
($args);
570 $abort->("no command specified") if !$cmd;
572 # call verifyapi before setup_environment(), don't execute any real code in
574 if ($cmd eq 'verifyapi') {
575 PVE
::RESTHandler
::validate_method_schemas
();
579 $cli_handler_class->setup_environment();
581 if ($cmd eq 'bashcomplete') {
582 &$print_bash_completion(undef, @$cmd_args);
586 # checked special commands, if def is still a hash we got an incomplete sub command
587 $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
589 &$preparefunc() if $preparefunc;
591 my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []};
592 $abort->("unknown command '$cmd_str'") if !$class;
594 my ($res, $formatter_params) = $class->cli_handler(
595 $cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties);
597 if (defined $outsub) {
598 my $result_schema = $class->map_method_by_name($name)->{returns
};
599 $outsub->($res, $result_schema, $formatter_params);
603 my $handle_simple_cmd = sub {
604 my ($args, $preparefunc, $param_cb) = @_;
606 my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef};
607 die "no class specified" if !$class;
609 if (scalar(@$args) >= 1) {
610 if ($args->[0] eq 'help') {
611 my $str = "USAGE: $name help\n";
612 $str .= generate_usage_str
('long');
613 print STDERR
"$str\n\n";
615 } elsif ($args->[0] eq 'verifyapi') {
616 PVE
::RESTHandler
::validate_method_schemas
();
621 $cli_handler_class->setup_environment();
623 if (scalar(@$args) >= 1) {
624 if ($args->[0] eq 'bashcomplete') {
626 &$print_bash_completion($name, @$args);
631 &$preparefunc() if $preparefunc;
633 my ($res, $formatter_params) = $class->cli_handler(
634 $name, $name, \
@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties);
636 if (defined $outsub) {
637 my $result_schema = $class->map_method_by_name($name)->{returns
};
638 $outsub->($res, $result_schema, $formatter_params);
642 sub run_cli_handler
{
643 my ($class, %params) = @_;
645 $cli_handler_class = $class;
647 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
649 foreach my $key (keys %params) {
650 next if $key eq 'prepare';
651 next if $key eq 'no_init'; # not used anymore
652 next if $key eq 'no_rpcenv'; # not used anymore
653 die "unknown parameter '$key'";
656 my $preparefunc = $params{prepare
};
658 my $param_cb = $gen_param_mapping_func->($cli_handler_class);
660 $exename = &$get_exe_name($class);
662 my $logid = $ENV{PVE_LOG_ID
} || $exename;
666 no strict
'refs'; ## no critic (ProhibitNoStrict)
667 $cmddef = ${"${class}::cmddef"};
670 if (ref($cmddef) eq 'ARRAY') {
671 $handle_simple_cmd->(\
@ARGV, $preparefunc, $param_cb);
673 $handle_cmd->(\
@ARGV, $preparefunc, $param_cb);