X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=73e8ee632fc9cd204d5db0a2532e1acfa3226d28;hp=9a2f8418e21cd51d748e2fa08451181575af4c2b;hb=3ef20687db9cda54dbb3a02ac3b911a87657efc0;hpb=408976c6f711f82895b105733b914660384160df diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index 9a2f841..73e8ee6 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -2,12 +2,10 @@ 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; use PVE::INotify; use base qw(PVE::RESTHandler); @@ -50,12 +48,12 @@ my $complete_command_names = sub { }; __PACKAGE__->register_method ({ - name => 'help', + name => 'help', path => 'help', method => 'GET', description => "Get help about specified command.", parameters => { - additionalProperties => 0, + additionalProperties => 0, properties => { cmd => { description => "Command name", @@ -71,7 +69,7 @@ __PACKAGE__->register_method ({ }, }, returns => { type => 'null' }, - + code => sub { my ($param) = @_; @@ -85,7 +83,7 @@ __PACKAGE__->register_method ({ if (!$cmd) { if ($verbose) { print_usage_verbose(); - } else { + } else { print_usage_short(\*STDOUT); } return undef; @@ -98,9 +96,11 @@ __PACKAGE__->register_method ({ raise_param_exc({ cmd => "no such command '$cmd'"}) if !$class; my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, - $verbose ? 'full' : 'short', $pwcallback); + $verbose ? 'full' : 'short', $pwcallback, + $stringfilemap); if ($verbose) { print "$str\n"; } else { @@ -111,25 +111,28 @@ __PACKAGE__->register_method ({ }}); -sub print_simple_asciidoc_synopsys { +sub print_simple_asciidoc_synopsis { my ($class, $name, $arg_param, $uri_param) = @_; die "not initialized" if !$cli_handler_class; my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); my $synopsis = "*${name}* `help`\n\n"; - $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param, 'asciidoc', $pwcallback); + $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param, + 'asciidoc', $pwcallback, $stringfilemap); return $synopsis; } -sub print_asciidoc_synopsys { +sub print_asciidoc_synopsis { die "not initialized" if !($cmddef && $exename && $cli_handler_class); my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); my $synopsis = ""; @@ -139,7 +142,8 @@ sub print_asciidoc_synopsys { 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, 'asciidoc', $pwcallback); + $uri_param, 'asciidoc', $pwcallback, + $stringfilemap); $synopsis .= "\n" if $oldclass && $oldclass ne $class; $synopsis .= "$str\n\n"; @@ -151,69 +155,19 @@ sub print_asciidoc_synopsys { return $synopsis; } -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 && $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"; - - my $style = 'full'; # or should we use '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, $style, $pwcallback); - $str =~ s/^USAGE: //; - - $synopsis .= "\n" if $oldclass && $oldclass ne $class; - $str =~ s/\n/\n /g; - $synopsis .= " $str\n\n"; - $oldclass = $class; - } - - $synopsis .= "\n"; - - my $parser = PVE::PodParser->new(); - $parser->{include}->{synopsis} = $synopsis; - $parser->parse_from_file($podfn); -} - sub print_usage_verbose { die "not initialized" if !($cmddef && $exename && $cli_handler_class); my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); 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', $pwcallback); + 'full', $pwcallback, $stringfilemap); print "$str\n\n"; } } @@ -228,6 +182,7 @@ sub print_usage_short { die "not initialized" if !($cmddef && $exename && $cli_handler_class); my $pwcallback = $cli_handler_class->can('read_password'); + my $stringfilemap = $cli_handler_class->can('string_param_file_mapping'); print $fd "ERROR: $msg\n" if $msg; print $fd "USAGE: $exename [ARGS] [OPTIONS]\n"; @@ -235,7 +190,7 @@ 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', $pwcallback); + my $str = $class->usage_str($name, "$exename $cmd", $arg_param, $uri_param, 'short', $pwcallback, $stringfilemap); print $fd "\n" if $oldclass && $oldclass ne $class; print $fd " $str"; $oldclass = $class; @@ -355,7 +310,7 @@ sub verify_api { my $get_exe_name = sub { my ($class) = @_; - + my $name = $class; $name =~ s/^.*:://; $name =~ s/_/-/g; @@ -382,94 +337,61 @@ complete -o default -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_asciidoc_synopsys { + my ($class) = @_; + $class->generate_asciidoc_synopsis(); +}; -sub generate_pod_manpage { - my ($class, $podfn) = @_; +sub generate_asciidoc_synopsis { + my ($class) = @_; $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); + print_simple_asciidoc_synopsis(@$def); } else { $cmddef = $def; $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; - print_pod_manpage($podfn); + print_asciidoc_synopsis(); } } -sub generate_asciidoc_synopsys { +# overwrite this if you want to run/setup things early +sub setup_environment { my ($class) = @_; - $cli_handler_class = $class; - - $exename = &$get_exe_name($class); - - no strict 'refs'; - my $def = ${"${class}::cmddef"}; - - if (ref($def) eq 'ARRAY') { - print_simple_asciidoc_synopsys(@$def); - } else { - $cmddef = $def; - - $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; - - print_asciidoc_synopsys(); - } + # do nothing by default } my $handle_cmd = sub { - my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_; + my ($def, $cmdname, $cmd, $args, $pwcallback, $preparefunc, $stringfilemap) = @_; $cmddef = $def; $exename = $cmdname; $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; - if (!$cmd) { + # call verifyapi before setup_environment(), because we do not want to + # execute any real code in this case + + if (!$cmd) { print_usage_short (\*STDERR, "no command specified"); exit (-1); } elsif ($cmd eq 'verifyapi') { 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') { + } + + $cli_handler_class->setup_environment(); + + if ($cmd eq 'bashcomplete') { &$print_bash_completion($cmddef, 0, @$args); return; } @@ -492,7 +414,7 @@ my $handle_cmd = sub { }; my $handle_simple_cmd = sub { - my ($def, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_; + my ($def, $args, $pwcallback, $preparefunc, $stringfilemap) = @_; my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def}; die "no class specified" if !$class; @@ -500,19 +422,21 @@ my $handle_simple_cmd = sub { 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', $pwcallback); + $str .= $class->usage_str($name, $name, $arg_param, $uri_param, 'long', $pwcallback, $stringfilemap); 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') { - $podfn = find_cli_class_source($name) if !defined($podfn); - print_simple_pod_manpage($podfn, @$def); + } + } + + $cli_handler_class->setup_environment(); + + if (scalar(@$args) >= 1) { + if ($args->[0] eq 'bashcomplete') { + shift @$args; + &$print_bash_completion({ $name => $def }, $name, @$args); return; } } @@ -528,10 +452,11 @@ sub run_cli { my ($class, $pwcallback, $podfn, $preparefunc) = @_; # Note: "depreciated function run_cli - use run_cli_handler instead"; - + # silently ignore $podfn , which is no longer supported. + die "password callback is no longer supported" if $pwcallback; - run_cli_handler($class, podfn => $podfn, prepare => $preparefunc); + run_cli_handler($class, prepare => $preparefunc); } sub run_cli_handler { @@ -542,15 +467,13 @@ sub run_cli_handler { $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 + next if $key eq 'no_init'; # not used anymore + next if $key eq 'no_rpcenv'; # not used anymore die "unknown parameter '$key'"; } - my $podfn = $params{podfn}; my $preparefunc = $params{prepare}; - my $no_init = $params{no_init}; my $pwcallback = $class->can('read_password'); my $stringfilemap = $class->can('string_param_file_mapping'); @@ -559,26 +482,15 @@ sub run_cli_handler { 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, $stringfilemap); + &$handle_simple_cmd($def, \@ARGV, $pwcallback, $preparefunc, $stringfilemap); } else { $cmddef = $def; my $cmd = shift @ARGV; - &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc, $stringfilemap); + &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $preparefunc, $stringfilemap); } exit 0;