X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=e2a81a0a8c0866051940d15382619676d93e1e27;hp=c2d34387ac87c4a9331d229f6064cbe1e5625498;hb=0a5a1eeec20f17d2a7fa3c8b2782df1391ff8555;hpb=881eb755318100c4587a3cb48cc5aa41f05f1a6d diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index c2d3438..e2a81a0 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -7,7 +7,6 @@ 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); @@ -98,9 +97,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 +112,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 +143,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 +156,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 +183,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 +191,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; @@ -405,33 +361,13 @@ sub find_cli_class_source { 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); - } -} - sub generate_asciidoc_synopsys { my ($class) = @_; + $class->generate_asciidoc_synopsis(); +}; + +sub generate_asciidoc_synopsis { + my ($class) = @_; $cli_handler_class = $class; @@ -441,18 +377,18 @@ sub generate_asciidoc_synopsys { my $def = ${"${class}::cmddef"}; if (ref($def) eq 'ARRAY') { - print_simple_asciidoc_synopsys(@$def); + print_simple_asciidoc_synopsis(@$def); } else { $cmddef = $def; $cmddef->{help} = [ __PACKAGE__, 'help', ['cmd'] ]; - print_asciidoc_synopsys(); + print_asciidoc_synopsis(); } } my $handle_cmd = sub { - my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_; + my ($def, $cmdname, $cmd, $args, $pwcallback, $preparefunc, $stringfilemap) = @_; $cmddef = $def; $exename = $cmdname; @@ -465,10 +401,6 @@ my $handle_cmd = sub { } 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') { &$print_bash_completion($cmddef, 0, @$args); return; @@ -486,13 +418,13 @@ my $handle_cmd = sub { } my $prefix = "$exename $cmd"; - my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback); + my $res = $class->cli_handler($prefix, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap); &$outsub($res) if $outsub; }; my $handle_simple_cmd = sub { - my ($def, $args, $pwcallback, $podfn, $preparefunc) = @_; + my ($def, $args, $pwcallback, $preparefunc, $stringfilemap) = @_; my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def}; die "no class specified" if !$class; @@ -500,7 +432,7 @@ 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') { @@ -510,16 +442,12 @@ my $handle_simple_cmd = sub { } 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); - return; } } &$preparefunc() if $preparefunc; - my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback); + my $res = $class->cli_handler($name, $name, \@ARGV, $arg_param, $uri_param, $pwcallback, $stringfilemap); &$outsub($res) if $outsub; }; @@ -528,10 +456,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,17 +471,18 @@ 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_rpcenv'; die "unknown parameter '$key'"; } - my $podfn = $params{podfn}; my $preparefunc = $params{prepare}; my $no_init = $params{no_init}; + my $no_rpcenv = $params{no_rpcenv}; my $pwcallback = $class->can('read_password'); + my $stringfilemap = $class->can('string_param_file_mapping'); $exename = &$get_exe_name($class); @@ -563,21 +493,23 @@ sub run_cli_handler { PVE::INotify::inotify_init() if !$no_init; + if (!$no_rpcenv) { my $rpcenv = PVE::RPCEnvironment->init('cli'); - $rpcenv->init_request() if !$no_init; - $rpcenv->set_language($ENV{LANG}); - $rpcenv->set_user('root@pam'); + $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); + &$handle_simple_cmd($def, \@ARGV, $pwcallback, $preparefunc, $stringfilemap); } else { $cmddef = $def; my $cmd = shift @ARGV; - &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $podfn, $preparefunc); + &$handle_cmd($cmddef, $exename, $cmd, \@ARGV, $pwcallback, $preparefunc, $stringfilemap); } exit 0;