X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=f973bdc1ccce6c2425665fa3e5bd2caeb5f82fd5;hp=2e7b14dc0e26479b05c498626da7203c77bba20d;hb=aeac55e13854fe8d7aeeef545c3f5d65edc34971;hpb=8e3e9929ac4e4bd7efcfd4d1b112b40adb43f48c diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index 2e7b14d..f973bdc 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,7 +2,9 @@ package PVE::CLIHandler; use strict; use warnings; +use Data::Dumper; +use PVE::SafeSyslog; use PVE::Exception qw(raise raise_param_exc); use PVE::RESTHandler; use PVE::PodParser; @@ -11,6 +13,7 @@ use base qw(PVE::RESTHandler); my $cmddef; my $exename; +my $cli_handler_class; my $expand_command_name = sub { my ($def, $cmd) = @_; @@ -32,6 +35,19 @@ my $expand_command_name = sub { return $cmd; }; +my $complete_command_names = sub { + my $res = []; + + return if ref($cmddef) ne 'HASH'; + + foreach my $cmd (keys %$cmddef) { + next if $cmd eq 'help'; + push @$res, $cmd; + } + + return $res; +}; + __PACKAGE__->register_method ({ name => 'help', path => 'help', @@ -44,6 +60,7 @@ __PACKAGE__->register_method ({ description => "Command name", type => 'string', optional => 1, + completion => $complete_command_names, }, verbose => { description => "Verbose output format.", @@ -57,7 +74,7 @@ __PACKAGE__->register_method ({ code => sub { my ($param) = @_; - die "not initialized" if !($cmddef && $exename); + die "not initialized" if !($cmddef && $exename && $cli_handler_class); my $cmd = $param->{cmd}; @@ -79,8 +96,10 @@ __PACKAGE__->register_method ({ raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class; + my $pwcallback = $cli_handler_class->can('read_password'); - my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, $verbose ? 'full' : 'short'); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, + $verbose ? 'full' : 'short', $pwcallback); if ($verbose) { print "$str\n"; } else { @@ -91,12 +110,32 @@ __PACKAGE__->register_method ({ }}); +sub print_simple_pod_manpage { + my ($podfn, $class, $name, $arg_param, $uri_param) = @_; + + die "not initialized" if !$cli_handler_class; + + my $pwcallback = $cli_handler_class->can('read_password'); + + my $synopsis = " $name help\n\n"; + my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback); + $str =~ s/^USAGE://; + $str =~ s/\n/\n /g; + $synopsis .= $str; + + my $parser = PVE::PodParser->new(); + $parser->{include}->{synopsis} = $synopsis; + $parser->parse_from_file($podfn); +} + sub print_pod_manpage { my ($podfn) = @_; - die "not initialized" if !($cmddef && $exename); + die "not initialized" if !($cmddef && $exename && $cli_handler_class); die "no pod file specified" if !$podfn; + my $pwcallback = $cli_handler_class->can('read_password'); + my $synopsis = ""; $synopsis .= " $exename [ARGS] [OPTIONS]\n\n"; @@ -105,8 +144,8 @@ sub print_pod_manpage { my $oldclass; foreach my $cmd (sorted_commands()) { my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}}; - my $str = $class->usage_str($name, "$exename $cmd", $arg_param, - $uri_param, $style); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, + $uri_param, $style, $pwcallback); $str =~ s/^USAGE: //; $synopsis .= "\n" if $oldclass && $oldclass ne $class; @@ -124,13 +163,16 @@ sub print_pod_manpage { sub print_usage_verbose { - die "not initialized" if !($cmddef && $exename); + die "not initialized" if !($cmddef && $exename && $cli_handler_class); + + my $pwcallback = $cli_handler_class->can('read_password'); print "USAGE: $exename [ARGS] [OPTIONS]\n\n"; foreach my $cmd (sort keys %$cmddef) { my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}}; - my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'full'); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, + 'full', $pwcallback); print "$str\n\n"; } } @@ -142,7 +184,9 @@ sub sorted_commands { sub print_usage_short { my ($fd, $msg) = @_; - die "not initialized" if !($cmddef && $exename); + die "not initialized" if !($cmddef && $exename && $cli_handler_class); + + my $pwcallback = $cli_handler_class->can('read_password'); print $fd "ERROR: $msg\n" if $msg; print $fd "USAGE: $exename [ARGS] [OPTIONS]\n"; @@ -150,14 +194,202 @@ sub print_usage_short { my $oldclass; foreach my $cmd (sorted_commands()) { my ($class, $name, $arg_param, $uri_param) = @{$cmddef->{$cmd}}; - my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short'); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback); print $fd "\n" if $oldclass && $oldclass ne $class; print $fd " $str"; $oldclass = $class; } } -sub handle_cmd { +my $print_bash_completion = sub { + my ($cmddef, $simple_cmd, $bash_command, $cur, $prev) = @_; + + my $debug = 0; + + return if !(defined($cur) && defined($prev) && defined($bash_command)); + return if !defined($ENV{COMP_LINE}); + return if !defined($ENV{COMP_POINT}); + + my $cmdline = substr($ENV{COMP_LINE}, 0, $ENV{COMP_POINT}); + print STDERR "\nCMDLINE: $ENV{COMP_LINE}\n" if $debug; + + my $args = PVE::Tools::split_args($cmdline); + my $pos = scalar(@$args) - 2; + $pos += 1 if $cmdline =~ m/\s+$/; + + print STDERR "CMDLINE:$pos:$cmdline\n" if $debug; + + return if $pos < 0; + + my $print_result = sub { + foreach my $p (@_) { + print "$p\n" if $p =~ m/^$cur/; + } + }; + + my $cmd; + if ($simple_cmd) { + $cmd = $simple_cmd; + } else { + if ($pos == 0) { + &$print_result(keys %$cmddef); + return; + } + $cmd = $args->[1]; + } + + my $def = $cmddef->{$cmd}; + return if !$def; + + print STDERR "CMDLINE1:$pos:$cmdline\n" if $debug; + + my $skip_param = {}; + + my ($class, $name, $arg_param, $uri_param) = @$def; + $arg_param //= []; + $uri_param //= {}; + + $arg_param = [ $arg_param ] if !ref($arg_param); + + map { $skip_param->{$_} = 1; } @$arg_param; + map { $skip_param->{$_} = 1; } keys %$uri_param; + + my $fpcount = scalar(@$arg_param); + + my $info = $class->map_method_by_name($name); + + my $schema = $info->{parameters}; + my $prop = $schema->{properties}; + + my $print_parameter_completion = sub { + my ($pname) = @_; + my $d = $prop->{$pname}; + if ($d->{completion}) { + my $vt = ref($d->{completion}); + if ($vt eq 'CODE') { + my $res = $d->{completion}->($cmd, $pname, $cur, $args); + &$print_result(@$res); + } + } elsif ($d->{type} eq 'boolean') { + &$print_result('0', '1'); + } elsif ($d->{enum}) { + &$print_result(@{$d->{enum}}); + } + }; + + # positional arguments + $pos += 1 if $simple_cmd; + if ($fpcount && $pos <= $fpcount) { + my $pname = $arg_param->[$pos -1]; + &$print_parameter_completion($pname); + return; + } + + my @option_list = (); + foreach my $key (keys %$prop) { + next if $skip_param->{$key}; + push @option_list, "--$key"; + } + + if ($cur =~ m/^-/) { + &$print_result(@option_list); + return; + } + + if ($prev =~ m/^--?(.+)$/ && $prop->{$1}) { + my $pname = $1; + &$print_parameter_completion($pname); + return; + } + + &$print_result(@option_list); +}; + +sub verify_api { + my ($class) = @_; + + # simply verify all registered methods + PVE::RESTHandler::validate_method_schemas(); +} + +my $get_exe_name = sub { + my ($class) = @_; + + my $name = $class; + $name =~ s/^.*:://; + $name =~ s/_/-/g; + + return $name; +}; + +sub generate_bash_completions { + my ($class) = @_; + + # generate bash completion config + + $exename = &$get_exe_name($class); + + print <<__EOD__; +# $exename bash completion + +# see http://tiswww.case.edu/php/chet/bash/FAQ +# and __ltrim_colon_completions() in /usr/share/bash-completion/bash_completion +# this modifies global var, but I found no better way +COMP_WORDBREAKS=\${COMP_WORDBREAKS//:} + +complete -C '$exename bashcomplete' $exename +__EOD__ +} + +sub find_cli_class_source { + my ($name) = @_; + + my $filename; + + $name =~ s/-/_/g; + + my $cpath = "PVE/CLI/${name}.pm"; + my $spath = "PVE/Service/${name}.pm"; + foreach my $p (@INC) { + foreach my $s (($cpath, $spath)) { + my $testfn = "$p/$s"; + if (-f $testfn) { + $filename = $testfn; + last; + } + } + last if defined($filename); + } + + return $filename; +} + +sub generate_pod_manpage { + my ($class, $podfn) = @_; + + $cli_handler_class = $class; + + $exename = &$get_exe_name($class); + + $podfn = find_cli_class_source($exename) if !defined($podfn); + + die "unable to find source for class '$class'" if !$podfn; + + no strict 'refs'; + my $def = ${"${class}::cmddef"}; + + if (ref($def) eq 'ARRAY') { + print_simple_pod_manpage($podfn, @$def); + } else { + $cmddef = $def; + + $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; + + print_pod_manpage($podfn); + } +} + +my $handle_cmd = sub { my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_; $cmddef = $def; @@ -172,8 +404,12 @@ sub handle_cmd { PVE::RESTHandler::validate_method_schemas(); return; } elsif ($cmd eq 'printmanpod') { + $podfn = find_cli_class_source($exename) if !defined($podfn); print_pod_manpage($podfn); return; + } elsif ($cmd eq 'bashcomplete') { + &$print_bash_completion($cmddef, 0, @$args); + return; } &$preparefunc() if $preparefunc; @@ -191,40 +427,98 @@ sub handle_cmd { my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback); &$outsub($res) if $outsub; -} +}; -sub handle_simple_cmd { - my ($def, $args, $pwcallback, $podfn) = @_; +my $handle_simple_cmd = sub { + my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_; my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def}; die "no class specified" if !$class; - if (scalar(@$args) == 1) { + if (scalar(@$args) >= 1) { if ($args->[0] eq 'help') { my $str = "USAGE: $name help\n"; - $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long'); + $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback); print STDERR "$str\n\n"; return; + } elsif ($args->[0] eq 'bashcomplete') { + shift @$args; + &$print_bash_completion({ $name => $def }, $name, @$args); + return; } elsif ($args->[0] eq 'verifyapi') { PVE::RESTHandler::validate_method_schemas(); return; } elsif ($args->[0] eq 'printmanpod') { - my $synopsis = " $name help\n\n"; - my $str = $class->usage_str($name, $name, $arg_param, $uri_param, 'long'); - $str =~ s/^USAGE://; - $str =~ s/\n/\n /g; - $synopsis .= $str; - - my $parser = PVE::PodParser->new(); - $parser->{include}->{synopsis} = $synopsis; - $parser->parse_from_file($podfn); + $podfn = find_cli_class_source($name) if !defined($podfn); + print_simple_pod_manpage($podfn, @$def); return; } } + &$preparefunc() if $preparefunc; + my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback); &$outsub($res) if $outsub; +}; + +sub run_cli { + my ($class, $pwcallback, $podfn, $preparefunc) = @_; + + # Note: "depreciated function run_cli - use run_cli_handler instead"; + + die "password callback is no longer supported" if $pwcallback; + + run_cli_handler($class, podfn => $podfn, prepare => $preparefunc); +} + +sub run_cli_handler { + my ($class, %params) = @_; + + $cli_handler_class = $class; + + $ENV{'PATH'} = '/sbin:/bin:/usr/sbin:/usr/bin'; + + foreach my $key (keys %params) { + next if $key eq 'podfn'; + next if $key eq 'prepare'; + next if $key eq 'no_init'; # used by lxc hooks + die "unknown parameter '$key'"; + } + + my $podfn = $params{podfn}; + my $preparefunc = $params{prepare}; + my $no_init = $params{no_init}; + + my $pwcallback = $class->can('read_password'); + + $exename = &$get_exe_name($class); + + initlog($exename); + + if ($class !~ m/^PVE::Service::/) { + die "please run as root\n" if $> != 0; + + PVE::INotify::inotify_init() if !$no_init; + + my $rpcenv = PVE::RPCEnvironment->init('cli'); + $rpcenv->init_request() if !$no_init; + $rpcenv->set_language($ENV{LANG}); + $rpcenv->set_user('root@pam'); + } + + no strict 'refs'; + my $def = ${"${class}::cmddef"}; + + if (ref($def) eq 'ARRAY') { + &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc); + } else { + $cmddef = $def; + my $cmd = shift @ARGV; + &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc); + } + + exit 0; } 1;