1 package PVE
::CLIHandler
;
8 use PVE
::Exception
qw(raise raise_param_exc);
12 use base
qw(PVE::RESTHandler);
16 my $cli_handler_class;
18 my $expand_command_name = sub {
23 for my $k (keys(%$def)) {
26 $expanded = undef; # more than one match
33 $cmd = $expanded if $expanded;
38 my $complete_command_names = sub {
41 return if ref($cmddef) ne 'HASH';
43 foreach my $cmd (keys %$cmddef) {
44 next if $cmd eq 'help';
51 __PACKAGE__-
>register_method ({
55 description
=> "Get help about specified command.",
57 additionalProperties
=> 0,
60 description
=> "Command name",
63 completion
=> $complete_command_names,
66 description
=> "Verbose output format.",
72 returns
=> { type
=> 'null' },
77 die "not initialized" if !($cmddef && $exename && $cli_handler_class);
79 my $cmd = $param->{cmd
};
81 my $verbose = defined($cmd) && $cmd;
82 $verbose = $param->{verbose
} if defined($param->{verbose
});
86 print_usage_verbose
();
88 print_usage_short
(\
*STDOUT
);
93 $cmd = &$expand_command_name($cmddef, $cmd);
95 my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd} || []};
97 raise_param_exc
({ cmd
=> "no such command '$cmd'"}) if !$class;
99 my $pwcallback = $cli_handler_class->can('read_password');
100 my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
102 my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
103 $verbose ?
'full' : 'short', $pwcallback,
108 print "USAGE: $str\n";
115 sub print_simple_asciidoc_synopsis
{
116 my ($class, $name, $arg_param, $uri_param) = @_;
118 die "not initialized" if !$cli_handler_class;
120 my $pwcallback = $cli_handler_class->can('read_password');
121 my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
123 my $synopsis = "*${name}* `help`\n\n";
125 $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param,
126 'asciidoc', $pwcallback, $stringfilemap);
131 sub print_asciidoc_synopsis
{
133 die "not initialized" if !($cmddef && $exename && $cli_handler_class);
135 my $pwcallback = $cli_handler_class->can('read_password');
136 my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
140 $synopsis .= "*${exename}* `<COMMAND> [ARGS] [OPTIONS]`\n\n";
143 foreach my $cmd (sort keys %$cmddef) {
144 my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
145 my $str = $class->usage_str($name, "$exename $cmd", $arg_param,
146 $uri_param, 'asciidoc', $pwcallback,
148 $synopsis .= "\n" if $oldclass && $oldclass ne $class;
150 $synopsis .= "$str\n\n";
159 sub print_usage_verbose
{
161 die "not initialized" if !($cmddef && $exename && $cli_handler_class);
163 my $pwcallback = $cli_handler_class->can('read_password');
164 my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
166 print "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n\n";
168 foreach my $cmd (sort keys %$cmddef) {
169 my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
170 my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param,
171 'full', $pwcallback, $stringfilemap);
176 sub sorted_commands
{
177 return sort { ($cmddef->{$a}->[0] cmp $cmddef->{$b}->[0]) || ($a cmp $b)} keys %$cmddef;
180 sub print_usage_short
{
183 die "not initialized" if !($cmddef && $exename && $cli_handler_class);
185 my $pwcallback = $cli_handler_class->can('read_password');
186 my $stringfilemap = $cli_handler_class->can('string_param_file_mapping');
188 print $fd "ERROR: $msg\n" if $msg;
189 print $fd "USAGE: $exename <COMMAND> [ARGS] [OPTIONS]\n";
192 foreach my $cmd (sorted_commands
()) {
193 my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}};
194 my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback, $stringfilemap);
195 print $fd "\n" if $oldclass && $oldclass ne $class;
201 my $print_bash_completion = sub {
202 my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_;
206 return if !(defined($cur) && defined($prev) && defined($bash_command));
207 return if !defined($ENV{COMP_LINE
});
208 return if !defined($ENV{COMP_POINT
});
210 my $cmdline = substr($ENV{COMP_LINE
}, 0, $ENV{COMP_POINT
});
211 print STDERR
"\nCMDLINE: $ENV{COMP_LINE}\n" if $debug;
213 my $args = PVE
::Tools
::split_args
($cmdline);
214 my $pos = scalar(@$args) - 2;
215 $pos += 1 if $cmdline =~ m/\s+$/;
217 print STDERR
"CMDLINE:$pos:$cmdline\n" if $debug;
221 my $print_result = sub {
223 print "$p\n" if $p =~ m/^$cur/;
232 &$print_result(keys %$cmddef);
238 my $def = $cmddef->{$cmd};
241 print STDERR
"CMDLINE1:$pos:$cmdline\n" if $debug;
245 my ($class, $name, $arg_param, $uri_param) = @$def;
249 $arg_param = [ $arg_param ] if !ref($arg_param);
251 map { $skip_param->{$_} = 1; } @$arg_param;
252 map { $skip_param->{$_} = 1; } keys %$uri_param;
254 my $fpcount = scalar(@$arg_param);
256 my $info = $class->map_method_by_name($name);
258 my $schema = $info->{parameters
};
259 my $prop = $schema->{properties
};
261 my $print_parameter_completion = sub {
263 my $d = $prop->{$pname};
264 if ($d->{completion
}) {
265 my $vt = ref($d->{completion
});
267 my $res = $d->{completion
}->($cmd, $pname, $cur, $args);
268 &$print_result(@$res);
270 } elsif ($d->{type
} eq 'boolean') {
271 &$print_result('0', '1');
272 } elsif ($d->{enum
}) {
273 &$print_result(@{$d->{enum
}});
277 # positional arguments
278 $pos += 1 if $simple_cmd;
279 if ($fpcount && $pos <= $fpcount) {
280 my $pname = $arg_param->[$pos -1];
281 &$print_parameter_completion($pname);
285 my @option_list = ();
286 foreach my $key (keys %$prop) {
287 next if $skip_param->{$key};
288 push @option_list, "--$key";
292 &$print_result(@option_list);
296 if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) {
298 &$print_parameter_completion($pname);
302 &$print_result(@option_list);
308 # simply verify all registered methods
309 PVE
::RESTHandler
::validate_method_schemas
();
312 my $get_exe_name = sub {
322 sub generate_bash_completions
{
325 # generate bash completion config
327 $exename = &$get_exe_name($class);
330 # $exename bash completion
332 # see http://tiswww.case.edu/php/chet/bash/FAQ
333 # and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion
334 # this modifies global var, but I found no better way
335 COMP_WORDBREAKS=\${COMP_WORDBREAKS//:}
337 complete -o default -C '$exename bashcomplete' $exename
341 sub find_cli_class_source
{
348 my $cpath = "PVE/CLI/${name}.pm";
349 my $spath = "PVE/Service/${name}.pm";
350 foreach my $p (@INC) {
351 foreach my $s (($cpath, $spath)) {
352 my $testfn = "$p/$s";
358 last if defined($filename);
364 sub generate_asciidoc_synopsys
{
366 $class->generate_asciidoc_synopsis();
369 sub generate_asciidoc_synopsis
{
372 $cli_handler_class = $class;
374 $exename = &$get_exe_name($class);
377 my $def = ${"${class}::cmddef"};
379 if (ref($def) eq 'ARRAY') {
380 print_simple_asciidoc_synopsis
(@$def);
384 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['cmd'] ];
386 print_asciidoc_synopsis
();
390 # overwrite this if you want to run/setup things early
391 sub setup_environment
{
394 # do nothing by default
397 my $handle_cmd = sub {
398 my ($def, $cmdname, $cmd, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
403 $cmddef->{help
} = [ __PACKAGE__
, 'help', ['cmd'] ];
405 # call verifyapi before setup_environment(), because we do not want to
406 # execute any real code in this case
409 print_usage_short
(\
*STDERR
, "no command specified");
411 } elsif ($cmd eq 'verifyapi') {
412 PVE
::RESTHandler
::validate_method_schemas
();
416 $cli_handler_class->setup_environment();
418 if ($cmd eq 'bashcomplete') {
419 &$print_bash_completion($cmddef, 0, @$args);
423 &$preparefunc() if $preparefunc;
425 $cmd = &$expand_command_name($cmddef, $cmd);
427 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$cmddef->{$cmd} || []};
430 print_usage_short
(\
*STDERR
, "unknown command '$cmd'");
434 my $prefix = "$exename $cmd";
435 my $res = $class->cli_handler($prefix, $name, \
@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
437 &$outsub($res) if $outsub;
440 my $handle_simple_cmd = sub {
441 my ($def, $args, $pwcallback, $preparefunc, $stringfilemap) = @_;
443 my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def};
444 die "no class specified" if !$class;
446 if (scalar(@$args) >= 1) {
447 if ($args->[0] eq 'help') {
448 my $str = "USAGE: $name help\n";
449 $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap);
450 print STDERR
"$str\n\n";
452 } elsif ($args->[0] eq 'verifyapi') {
453 PVE
::RESTHandler
::validate_method_schemas
();
458 $cli_handler_class->setup_environment();
460 if (scalar(@$args) >= 1) {
461 if ($args->[0] eq 'bashcomplete') {
463 &$print_bash_completion({ $name => $def }, $name, @$args);
468 &$preparefunc() if $preparefunc;
470 my $res = $class->cli_handler($name, $name, \
@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap);
472 &$outsub($res) if $outsub;
476 my ($class, $pwcallback, $podfn, $preparefunc) = @_;
478 # Note: "depreciated function run_cli - use run_cli_handler instead";
479 # silently ignore $podfn , which is no longer supported.
481 die "password callback is no longer supported" if $pwcallback;
483 run_cli_handler
($class, prepare
=> $preparefunc);
486 sub run_cli_handler
{
487 my ($class, %params) = @_;
489 $cli_handler_class = $class;
491 $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin';
493 foreach my $key (keys %params) {
494 next if $key eq 'prepare';
495 next if $key eq 'no_init'; # not used anymore
496 next if $key eq 'no_rpcenv'; # not used anymore
497 die "unknown parameter '$key'";
500 my $preparefunc = $params{prepare
};
502 my $pwcallback = $class->can('read_password');
503 my $stringfilemap = $class->can('string_param_file_mapping');
505 $exename = &$get_exe_name($class);
510 my $def = ${"${class}::cmddef"};
512 if (ref($def) eq 'ARRAY') {
513 &$handle_simple_cmd($def, \
@ARGV, $pwcallback, $preparefunc, $stringfilemap);
516 my $cmd = shift @ARGV;
517 &$handle_cmd($cmddef, $exename, $cmd, \
@ARGV, $pwcallback, $preparefunc, $stringfilemap);