1 package PVE
::CLIHandler
;
7 use PVE
::Exception
qw(raise raise_param_exc);
10 use base
qw(PVE::RESTHandler);
12 # $cmddef defines which (sub)commands are available in a specific CLI class.
13 # A real command is always an array consisting of its class, name, array of
14 # position fixed (required) parameters and hash of predefined parameters when
15 # mapping a CLI command t o an API call. Optionally an output method can be
16 # passed at the end, e.g., for formatting or transformation purpose.
18 # [class, name, fixed_params, API_pre-set params, output_sub ]
20 # In case of so called 'simple commands', the $cmddef can be also just an
25 # command => [ 'PVE::API2::Class', 'command', [ 'arg1', 'arg2' ], { node => $nodename } ],
27 # this => [ 'PVE::API2::OtherClass', 'method', [ 'arg1' ], undef, sub {
31 # that => [ 'PVE::API2::OtherClass', 'subroutine' [] ],
33 # dothat => { alias => 'do that' },
37 my $cli_handler_class;
39 my $assert_initialized = sub {
41 die "$caller[0]:$caller[2] - not initialized\n"
42 if !($cmddef && $exename && $cli_handler_class);
46 my ($reason, $cmd) = @_;
47 print_usage_short
(\
*STDERR
, $reason, $cmd);
51 my $expand_command_name = sub {
54 return $cmd if exists $def->{$cmd}; # command is already complete
56 my @expanded = grep { /^\Q$cmd\E/ } keys %$def;
57 return $expanded[0] if scalar(@expanded) == 1; # enforce exact match
62 my $get_commands = sub {
63 my $def = shift // die "no command definition passed!";
64 return [ grep { !(ref($def->{$_}) eq 'HASH' && defined($def->{$_}->{alias
})) } sort keys %$def ];
67 my $complete_command_names = sub { $get_commands->($cmddef) };
69 # traverses the command definition using the $argv array, resolving one level
71 # Returns the matching (sub) command and its definition, and argument array for
72 # this (sub) command and a hash where we marked which (sub) commands got
73 # expanded (e.g. st => status) while traversing
75 my ($argv, $is_alias) = @_;
77 my ($def, $cmd) = ($cmddef, $argv);
78 my $cmdstr = $exename;
80 if (ref($argv) eq 'ARRAY') {
81 my $expanded_last_arg;
82 my $last_arg_id = scalar(@$argv) - 1;
84 for my $i (0..$last_arg_id) {
85 $cmd = $expand_command_name->($def, $argv->[$i]);
87 # If the argument was expanded (or was already complete) and it
88 # is the final argument, tell our caller about it:
89 $expanded_last_arg = $cmd if $i == $last_arg_id;
91 # Otherwise continue with the unexpanded version of it.
95 last if !defined($def->{$cmd});
98 if (ref($def) eq 'ARRAY') {
99 # could expand to a real command, rest of $argv are its arguments
100 my $cmd_args = [ @$argv[$i+1..$last_arg_id] ];
101 return ($cmd, $def, $cmd_args, $expanded_last_arg, $cmdstr);
104 if (defined($def->{alias
})) {
105 die "alias loop detected for '$cmd'" if $is_alias; # avoids cycles
106 # replace aliased (sub)command with the expanded aliased command
107 splice @$argv, $i, 1, split(/ +/, $def->{alias
});
108 return resolve_cmd
($argv, 1);
111 # got either a special command (bashcomplete, verifyapi) or an unknown
112 # cmd, just return first entry as cmd and the rest of $argv as cmd_arg
113 my $cmd_args = [ @$argv[1..$last_arg_id] ];
114 return ($argv->[0], $def, $cmd_args, $expanded_last_arg, $cmdstr);
116 return ($cmd, $def, undef, undef, $cmdstr);
119 sub generate_usage_str
{
120 my ($format, $cmd, $indent, $separator, $sortfunc) = @_;
122 $assert_initialized->();
123 die 'format required' if !$format;
125 $sortfunc //= sub { sort keys %{$_[0]} };
129 my $read_password_func = $cli_handler_class->can('read_password');
130 my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
131 $cli_handler_class->can('string_param_file_mapping');
133 my ($subcmd, $def, undef, undef, $cmdstr) = resolve_cmd
($cmd);
137 my ($indent, $separator, $def, $prefix) = @_;
140 if (ref($def) eq 'HASH') {
141 my $oldclass = undef;
142 foreach my $cmd (&$sortfunc($def)) {
144 if (ref($def->{$cmd}) eq 'ARRAY') {
145 my ($class, $name, $arg_param, $fixed_param) = @{$def->{$cmd}};
147 $str .= $separator if $oldclass && $oldclass ne $class;
149 $str .= $class->usage_str($name, "$prefix $cmd", $arg_param,
150 $fixed_param, $format,
151 $read_password_func, $param_mapping_func);
154 } elsif (defined($def->{$cmd}->{alias
}) && ($format eq 'asciidoc')) {
156 $str .= "*$prefix $cmd*\n\nAn alias for '$exename $def->{$cmd}->{alias}'.\n\n";
159 next if $def->{$cmd}->{alias
};
161 my $substr = $generate->($indent, $separator, $def->{$cmd}, "$prefix $cmd");
163 $substr .= $separator if $substr !~ /\Q$separator\E{2}/;
170 my ($class, $name, $arg_param, $fixed_param) = @$def;
171 $abort->("unknown command '$cmd'") if !$class;
174 $str .= $class->usage_str($name, $prefix, $arg_param, $fixed_param, $format,
175 $read_password_func, $param_mapping_func);
180 return $generate->($indent, $separator, $def, $cmdstr);
183 __PACKAGE__-
>register_method ({
187 description
=> "Get help about specified command.",
189 additionalProperties
=> 0,
191 'extra-args' => PVE
::JSONSchema
::get_standard_option
('extra-args', {
192 description
=> 'Shows help for a specific command',
193 completion
=> $complete_command_names,
196 description
=> "Verbose output format.",
202 returns
=> { type
=> 'null' },
207 $assert_initialized->();
209 my $cmd = $param->{'extra-args'};
211 my $verbose = defined($cmd) && $cmd;
212 $verbose = $param->{verbose
} if defined($param->{verbose
});
216 print_usage_verbose
();
218 print_usage_short
(\
*STDOUT
);
225 $str = generate_usage_str
('full', $cmd, '');
227 $str = generate_usage_str
('short', $cmd, ' ' x
7);
234 print "USAGE: $str\n";
241 sub print_simple_asciidoc_synopsis
{
242 $assert_initialized->();
244 my $synopsis = "*${exename}* `help`\n\n";
245 $synopsis .= generate_usage_str
('asciidoc');
250 sub print_asciidoc_synopsis
{
251 $assert_initialized->();
255 $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
257 $synopsis .= generate_usage_str
('asciidoc');
264 sub print_usage_verbose
{
265 $assert_initialized->();
267 print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
269 my $str = generate_usage_str
('full');
274 sub print_usage_short
{
275 my ($fd, $msg, $cmd) = @_;
277 $assert_initialized->();
279 print $fd "ERROR: $msg\n" if $msg;
280 print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
282 print {$fd} generate_usage_str
('short', $cmd, ' ' x
7, "\n", sub {
285 if (ref($h->{$a}) eq 'ARRAY' && ref($h->{$b}) eq 'ARRAY') {
286 # $a and $b are both real commands order them by their class
287 return $h->{$a}->[0] cmp $h->{$b}->[0] || $a cmp $b;
288 } elsif (ref($h->{$a}) eq 'ARRAY' xor ref($h->{$b}) eq 'ARRAY') {
289 # real command and subcommand mixed, put sub commands first
290 return ref($h->{$b}) eq 'ARRAY' ?
-1 : 1;
292 # both are either from the same class or subcommands
299 my $print_bash_completion = sub {
300 my ($simple_cmd, $bash_command, $cur, $prev) = @_;
304 return if !(defined($cur) && defined($prev) && defined($bash_command));
305 return if !defined($ENV{COMP_LINE
});
306 return if !defined($ENV{COMP_POINT
});
308 my $cmdline = substr($ENV{COMP_LINE
}, 0, $ENV{COMP_POINT
});
309 print STDERR
"\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
311 my $args = PVE
::Tools
::split_args
($cmdline);
312 shift @$args; # no need for program name
313 my $print_result = sub {
315 print "$p\n" if $p =~ m/^$cur/;
319 my ($cmd, $def) = ($simple_cmd, $cmddef);
321 ($cmd, $def, $args, my $expanded) = resolve_cmd
($args);
323 if (defined($expanded) && $prev ne $expanded) {
328 if (ref($def) eq 'HASH') {
329 &$print_result(@{$get_commands->($def)});
335 my $pos = scalar(@$args) - 1;
336 $pos += 1 if $cmdline =~ m/\s+$/;
337 print STDERR
"pos: $pos\n" if $debug;
342 my ($class, $name, $arg_param, $uri_param) = @$def;
346 $arg_param = [ $arg_param ] if !ref($arg_param);
348 map { $skip_param->{$_} = 1; } @$arg_param;
349 map { $skip_param->{$_} = 1; } keys %$uri_param;
351 my $info = $class->map_method_by_name($name);
353 my $prop = $info->{parameters
}->{properties
};
355 my $print_parameter_completion = sub {
357 my $d = $prop->{$pname};
358 if ($d->{completion
}) {
359 my $vt = ref($d->{completion
});
361 my $res = $d->{completion
}->($cmd, $pname, $cur, $args);
362 &$print_result(@$res);
364 } elsif ($d->{type
} eq 'boolean') {
365 &$print_result('0', '1');
366 } elsif ($d->{enum
}) {
367 &$print_result(@{$d->{enum
}});
371 # positional arguments
372 if ($pos < scalar(@$arg_param)) {
373 my $pname = $arg_param->[$pos];
374 &$print_parameter_completion($pname);
378 my @option_list = ();
379 foreach my $key (keys %$prop) {
380 next if $skip_param->{$key};
381 push @option_list, "--$key";
385 &$print_result(@option_list);
389 if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
391 &$print_parameter_completion($pname);
395 &$print_result(@option_list);
401 # simply verify all registered methods
402 PVE
::RESTHandler
::validate_method_schemas
();
405 my $get_exe_name = sub {
415 sub generate_bash_completions
{
418 # generate bash completion config
420 $exename = &$get_exe_name($class);
423 # $exename bash completion
425 # see http://tiswww.case.edu/php/chet/bash/FAQ
426 # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
427 # this modifies global var, but I found no better way
428 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
430 complete -o default -C '$exename bashcomplete' $exename
434 sub generate_asciidoc_synopsys
{
436 $class->generate_asciidoc_synopsis();
439 sub generate_asciidoc_synopsis
{
442 $cli_handler_class = $class;
444 $exename = &$get_exe_name($class);
447 my $def = ${"${class}::cmddef"};
450 if (ref($def) eq 'ARRAY') {
451 print_simple_asciidoc_synopsis
();
453 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['cmd'] ];
455 print_asciidoc_synopsis
();
459 # overwrite this if you want to run/setup things early
460 sub setup_environment
{
463 # do nothing by default
466 my $handle_cmd = sub {
467 my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
469 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['extra-args'] ];
471 my ($cmd, $def, $cmd_args, undef, $cmd_str) = resolve_cmd
($args);
473 $abort->("no command specified") if !$cmd;
475 # call verifyapi before setup_environment(), don't execute any real code in
477 if ($cmd eq 'verifyapi') {
478 PVE
::RESTHandler
::validate_method_schemas
();
482 $cli_handler_class->setup_environment();
484 if ($cmd eq 'bashcomplete') {
485 &$print_bash_completion(undef, @$cmd_args);
489 # checked special commands, if def is still a hash we got an incomplete sub command
490 $abort->("incomplete command '$cmd_str'") if ref($def) eq 'HASH';
492 &$preparefunc() if $preparefunc;
494 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def || []};
495 $abort->("unknown command '$cmd_str'") if !$class;
497 my $res = $class->cli_handler($cmd_str, $name, $cmd_args, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
499 &$outsub($res) if $outsub;
502 my $handle_simple_cmd = sub {
503 my ($args, $read_password_func, $preparefunc, $param_mapping_func) = @_;
505 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef};
506 die "no class specified" if !$class;
508 if (scalar(@$args) >= 1) {
509 if ($args->[0] eq 'help') {
510 my $str = "USAGE: $name help\n";
511 $str .= generate_usage_str
('long');
512 print STDERR
"$str\n\n";
514 } elsif ($args->[0] eq 'verifyapi') {
515 PVE
::RESTHandler
::validate_method_schemas
();
520 $cli_handler_class->setup_environment();
522 if (scalar(@$args) >= 1) {
523 if ($args->[0] eq 'bashcomplete') {
525 &$print_bash_completion($name, @$args);
530 &$preparefunc() if $preparefunc;
532 my $res = $class->cli_handler($name, $name, \
@ARGV, $arg_param, $uri_param, $read_password_func, $param_mapping_func);
534 &$outsub($res) if $outsub;
537 sub run_cli_handler
{
538 my ($class, %params) = @_;
540 $cli_handler_class = $class;
542 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
544 foreach my $key (keys %params) {
545 next if $key eq 'prepare';
546 next if $key eq 'no_init'; # not used anymore
547 next if $key eq 'no_rpcenv'; # not used anymore
548 die "unknown parameter '$key'";
551 my $preparefunc = $params{prepare
};
553 my $read_password_func = $class->can('read_password');
554 my $param_mapping_func = $cli_handler_class->can('param_mapping') ||
555 $class->can('string_param_file_mapping');
557 $exename = &$get_exe_name($class);
562 $cmddef = ${"${class}::cmddef"};
564 if (ref($cmddef) eq 'ARRAY') {
565 &$handle_simple_cmd(\
@ARGV, $read_password_func, $preparefunc, $param_mapping_func);
567 &$handle_cmd(\
@ARGV, $read_password_func, $preparefunc, $param_mapping_func);