1 package PVE
::CLIHandler
;
8 use PVE
::Exception
qw(raise raise_param_exc);
12 use PVE
::CLIFormatter
;
14 use base
qw(PVE::RESTHandler);
16 # $cmddef defines which (sub)commands are available in a specific CLI class.
17 # A real command is always an array consisting of its class, name, array of
18 # position fixed (required) parameters and hash of predefined parameters when
19 # mapping a CLI command t o an API call. Optionally an output method can be
20 # passed at the end, e.g., for formatting or transformation purpose, and
21 # a schema of additional properties/arguments which are added to
22 # the method schema and gets passed to the formatter.
24 # [class, name, fixed_params, API_pre-set params, output_sub ]
26 # In case of so called 'simple commands', the $cmddef can be also just an
31 # command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
33 # this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
37 # that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
39 # dothat => { alias => 'do that' },
43 my $cli_handler_class;
45 my $standard_mappings = {
52 return $value if $value;
53 return PVE
::PTY
::get_confirmed_password
();
57 sub get_standard_mapping
{
58 my ($name, $base) = @_;
60 my $std = $standard_mappings->{$name};
61 die "no such standard mapping '$name'\n" if !$std;
63 my $res = $base || {};
65 foreach my $opt (keys %$std) {
66 next if defined($res->{$opt});
67 $res->{$opt} = $std->{$opt};
73 my $gen_param_mapping_func = sub {
74 my ($cli_handler_class) = @_;
76 my $param_mapping = $cli_handler_class->can('param_mapping');
78 if (!$param_mapping) {
79 my $read_password = $cli_handler_class->can('read_password');
80 my $string_param_mapping = $cli_handler_class->can('string_param_file_mapping');
82 return $string_param_mapping if !$read_password;
84 $param_mapping = sub {
87 my $password_map = get_standard_mapping
('pve-password', {
88 func
=> $read_password
90 my $map = $string_param_mapping ?
$string_param_mapping->($name) : [];
91 return [@$map, $password_map];
95 return $param_mapping;
98 my $assert_initialized = sub {
100 die "$caller[0]:$caller[2] - not initialized\n"
101 if !($cmddef && $exename && $cli_handler_class);
105 my ($reason, $cmd) = @_;
106 print_usage_short
(\
*STDERR
, $reason, $cmd);
110 my $expand_command_name = sub {
111 my ($def, $cmd) = @_;
113 return $cmd if exists $def->{$cmd}; # command is already complete
115 my $is_alias = sub { ref($_[0]) eq 'HASH' && exists($_[0]->{alias
}) };
116 my @expanded = grep { /^\Q$cmd\E/ && !$is_alias->($def->{$_}) } keys %$def;
118 return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
123 my $get_commands = sub {
124 my $def = shift // die "no command definition passed!";
125 return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias
})) } sort keys %$def ];
128 my $complete_command_names = sub { $get_commands->($cmddef) };
130 # traverses the command definition using the $argv array, resolving one level
132 # Returns the matching (sub) command and its definition, and argument array for
133 # this (sub) command and a hash where we marked which (sub) commands got
134 # expanded (e.g. st => status) while traversing
136 my ($argv, $is_alias) = @_;
138 my ($def, $cmd) = ($cmddef, $argv);
139 my $cmdstr = $exename;
141 if (ref($argv) eq 'ARRAY') {
142 my $expanded_last_arg;
143 my $last_arg_id = scalar(@$argv) - 1;
145 for my $i (0..$last_arg_id) {
146 $cmd = $expand_command_name->($def, $argv->[$i]);
148 # If the argument was expanded (or was already complete) and it
149 # is the final argument, tell our caller about it:
150 $expanded_last_arg = $cmd if $i == $last_arg_id;
152 # Otherwise continue with the unexpanded version of it.
157 last if !defined($def);
159 if (ref($def) eq 'ARRAY') {
160 # could expand to a real command, rest of $argv are its arguments
161 my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
162 return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
165 if (defined($def->{alias
})) {
166 die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
167 # replace aliased (sub)command with the expanded aliased command
168 splice @$argv, $i, 1, split(/ +/, $def->{alias
});
169 return resolve_cmd
($argv, 1);
172 # got either a special command (bashcomplete, verifyapi) or an unknown
173 # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
174 my $cmd_args = [ @$argv[1..$last_arg_id] ];
175 return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
177 return ($cmd, $def, undef, undef, $cmdstr);
180 sub generate_usage_str
{
181 my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
183 $assert_initialized->();
184 die 'format required' if !$format;
186 $sortfunc //= sub { sort keys %{$_[0]} };
190 my $param_cb = $gen_param_mapping_func->($cli_handler_class);
192 my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd
($cmd);
193 $abort->("unknown command '$cmdstr'") if !defined($def) && ref($cmd) eq 'ARRAY';
197 my ($indent, $separator, $def, $prefix) = @_;
200 if (ref($def) eq 'HASH') {
201 my $oldclass = undef;
202 foreach my $cmd (&$sortfunc($def)) {
204 if (ref($def->{$cmd}) eq 'ARRAY') {
205 my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @{$def->{$cmd}};
207 $str .= $separator if $oldclass && $oldclass ne $class;
209 $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
210 $fixed_param, $format, $param_cb, $formatter_properties);
213 } elsif (defined($def->{$cmd}->{alias
}) && ($format eq 'asciidoc')) {
215 $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
218 next if $def->{$cmd}->{alias
};
220 my $substr = $generate->($indent, '', $def->{$cmd}, "$prefix $cmd");
222 $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
229 my ($class, $name, $arg_param, $fixed_param, undef, $formatter_properties) = @$def;
230 $abort->("unknown command '$cmd'") if !$class;
233 $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format, $param_cb, $formatter_properties);
238 return $generate->($indent, $separator, $def, $cmdstr);
241 __PACKAGE__-
>register_method ({
245 description
=> "Get help about specified command.",
247 additionalProperties
=> 0,
249 'extra-args' => PVE
::JSONSchema
::get_standard_option
('extra-args', {
250 description
=> 'Shows help for a specific command',
251 completion
=> $complete_command_names,
254 description
=> "Verbose output format.",
260 returns
=> { type
=> 'null' },
265 $assert_initialized->();
267 my $cmd = $param->{'extra-args'};
269 my $verbose = defined($cmd) && $cmd;
270 $verbose = $param->{verbose
} if defined($param->{verbose
});
274 print_usage_verbose
();
276 print_usage_short
(\
*STDOUT
);
283 $str = generate_usage_str
('full', $cmd, '');
285 $str = generate_usage_str
('short', $cmd, ' ' x
7);
292 print "USAGE: $str\n";
299 sub print_simple_asciidoc_synopsis
{
300 $assert_initialized->();
302 my $synopsis = "*${exename}* `help`\n\n";
303 $synopsis .= generate_usage_str
('asciidoc');
308 sub print_asciidoc_synopsis
{
309 $assert_initialized->();
313 $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
315 $synopsis .= generate_usage_str
('asciidoc');
322 sub print_usage_verbose
{
323 $assert_initialized->();
325 print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
327 my $str = generate_usage_str
('full');
332 sub print_usage_short
{
333 my ($fd, $msg, $cmd) = @_;
335 $assert_initialized->();
337 print $fd "ERROR: $msg\n" if $msg;
338 print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
340 print {$fd} generate_usage_str
('short', $cmd, ' ' x
7, $cmd ?
'' : "\n", sub {
343 if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
344 # $a and $b are both real commands order them by their class
345 return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
346 } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
347 # real command and subcommand mixed, put sub commands first
348 return ref($h->{$b}) eq 'ARRAY' ?
-1 : 1;
350 # both are either from the same class or subcommands
357 my $print_bash_completion = sub {
358 my ($simple_cmd, $bash_command, $cur, $prev) = @_;
362 return if !(defined($cur) && defined($prev) && defined($bash_command));
363 return if !defined($ENV{COMP_LINE
});
364 return if !defined($ENV{COMP_POINT
});
366 my $cmdline = substr($ENV{COMP_LINE
}, 0, $ENV{COMP_POINT
});
367 print STDERR
"\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
369 my $args = PVE
::Tools
::split_args
($cmdline);
370 shift @$args; # no need for program name
371 my $print_result = sub {
373 print "$p\n" if $p =~ m/^\Q$cur\E/;
377 my ($cmd, $def) = ($simple_cmd, $cmddef);
379 ($cmd, $def, $args, my $expanded) = resolve_cmd
($args);
381 if (defined($expanded) && $prev ne $expanded) {
386 if (ref($def) eq 'HASH') {
387 &$print_result(@{$get_commands->($def)});
393 my $pos = scalar(@$args) - 1;
394 $pos += 1 if $cmdline =~ m/\s+$/;
395 print STDERR
"pos: $pos\n" if $debug;
400 my ($class, $name, $arg_param, $uri_param, undef, $formatter_properties) = @$def;
404 $arg_param = [ $arg_param ] if !ref($arg_param);
406 map { $skip_param->{$_} = 1; } @$arg_param;
407 map { $skip_param->{$_} = 1; } keys %$uri_param;
409 my $info = $class->map_method_by_name($name);
411 my $prop = { %{$info->{parameters
}->{properties
}} }; # copy
412 $prop = { %$prop, %$formatter_properties } if $formatter_properties;
414 my $print_parameter_completion = sub {
416 my $d = $prop->{$pname};
417 if ($d->{completion
}) {
418 my $vt = ref($d->{completion
});
420 my $res = $d->{completion
}->($cmd, $pname, $cur, $args);
421 &$print_result(@$res);
423 } elsif ($d->{type
} eq 'boolean') {
424 &$print_result('0', '1');
425 } elsif ($d->{enum
}) {
426 &$print_result(@{$d->{enum
}});
430 # positional arguments
431 if ($pos < scalar(@$arg_param)) {
432 my $pname = $arg_param->[$pos];
433 &$print_parameter_completion($pname);
437 my @option_list = ();
438 foreach my $key (keys %$prop) {
439 next if $skip_param->{$key};
440 push @option_list, "--$key";
444 &$print_result(@option_list);
448 if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
450 &$print_parameter_completion($pname);
454 &$print_result(@option_list);
460 # simply verify all registered methods
461 PVE
::RESTHandler
::validate_method_schemas
();
464 my $get_exe_name = sub {
474 sub generate_bash_completions
{
477 # generate bash completion config
479 $exename = &$get_exe_name($class);
482 # $exename bash completion
484 # see http://tiswww.case.edu/php/chet/bash/FAQ
485 # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
486 # this modifies global var, but I found no better way
487 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
489 complete -o default -C '$exename bashcomplete' $exename
493 sub generate_asciidoc_synopsys
{
495 $class->generate_asciidoc_synopsis();
498 sub generate_asciidoc_synopsis
{
501 $cli_handler_class = $class;
503 $exename = &$get_exe_name($class);
506 my $def = ${"${class}::cmddef"};
509 if (ref($def) eq 'ARRAY') {
510 print_simple_asciidoc_synopsis
();
512 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['cmd'] ];
514 print_asciidoc_synopsis
();
518 # overwrite this if you want to run/setup things early
519 sub setup_environment
{
522 # do nothing by default
525 my $handle_cmd = sub {
526 my ($args, $preparefunc, $param_cb) = @_;
528 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['extra-args'] ];
530 my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd
($args);
532 $abort->("no command specified") if !$cmd;
534 # call verifyapi before setup_environment(), don't execute any real code in
536 if ($cmd eq 'verifyapi') {
537 PVE
::RESTHandler
::validate_method_schemas
();
541 $cli_handler_class->setup_environment();
543 if ($cmd eq 'bashcomplete') {
544 &$print_bash_completion(undef, @$cmd_args);
548 # checked special commands, if def is still a hash we got an incomplete sub command
549 $abort->("incomplete command '$cmd_str'", $args) if ref($def) eq 'HASH';
551 &$preparefunc() if $preparefunc;
553 my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$def || []};
554 $abort->("unknown command '$cmd_str'") if !$class;
556 my ($res, $formatter_params) = $class->cli_handler(
557 $cmd_str, $name, $cmd_args, $arg_param, $uri_param, $param_cb, $formatter_properties);
559 if (defined $outsub) {
560 my $result_schema = $class->map_method_by_name($name)->{returns
};
561 $outsub->($res, $result_schema, $formatter_params);
565 my $handle_simple_cmd = sub {
566 my ($args, $preparefunc, $param_cb) = @_;
568 my ($class, $name, $arg_param, $uri_param, $outsub, $formatter_properties) = @{$cmddef};
569 die "no class specified" if !$class;
571 if (scalar(@$args) >= 1) {
572 if ($args->[0] eq 'help') {
573 my $str = "USAGE: $name help\n";
574 $str .= generate_usage_str
('long');
575 print STDERR
"$str\n\n";
577 } elsif ($args->[0] eq 'verifyapi') {
578 PVE
::RESTHandler
::validate_method_schemas
();
583 $cli_handler_class->setup_environment();
585 if (scalar(@$args) >= 1) {
586 if ($args->[0] eq 'bashcomplete') {
588 &$print_bash_completion($name, @$args);
593 &$preparefunc() if $preparefunc;
595 my ($res, $formatter_params) = $class->cli_handler(
596 $name, $name, \
@ARGV, $arg_param, $uri_param, $param_cb, $formatter_properties);
598 if (defined $outsub) {
599 my $result_schema = $class->map_method_by_name($name)->{returns
};
600 $outsub->($res, $result_schema, $formatter_params);
604 sub run_cli_handler
{
605 my ($class, %params) = @_;
607 $cli_handler_class = $class;
609 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
611 foreach my $key (keys %params) {
612 next if $key eq 'prepare';
613 next if $key eq 'no_init'; # not used anymore
614 next if $key eq 'no_rpcenv'; # not used anymore
615 die "unknown parameter '$key'";
618 my $preparefunc = $params{prepare
};
620 my $param_cb = $gen_param_mapping_func->($cli_handler_class);
622 $exename = &$get_exe_name($class);
624 my $logid = $ENV{PVE_LOG_ID
} || $exename;
628 $cmddef = ${"${class}::cmddef"};
630 if (ref($cmddef) eq 'ARRAY') {
631 $handle_simple_cmd->(\
@ARGV, $preparefunc, $param_cb);
633 $handle_cmd->(\
@ARGV, $preparefunc, $param_cb);