X-Git-Url: https://git.proxmox.com/?p=pve-common.git;a=blobdiff_plain;f=src%2FPVE%2FCLIHandler.pm;h=9a2f8418e21cd51d748e2fa08451181575af4c2b;hp=b32c2886e9fc9964da777680d21009790836cab6;hb=408976c6f711f82895b105733b914660384160df;hpb=891b798d5260042a747026b8d7bcab041296f443 diff --git a/src/PVE/CLIHandler.pm b/src/PVE/CLIHandler.pm index b32c288..9a2f841 100644 --- a/src/PVE/CLIHandler.pm +++ b/src/PVE/CLIHandler.pm @@ -8,6 +8,7 @@ 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); @@ -110,10 +111,51 @@ __PACKAGE__->register_method ({ }}); +sub print_simple_asciidoc_synopsys { + my ($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"; + + $synopsis .= $class->usage_str($name, $name, $arg_param, $uri_param, 'asciidoc', $pwcallback); + + return $synopsis; +} + +sub print_asciidoc_synopsys { + + die "not initialized" if !($cmddef && $exename && $cli_handler_class); + + my $pwcallback = $cli_handler_class->can('read_password'); + + my $synopsis = ""; + + $synopsis .= "*${exename}* ` [ARGS] [OPTIONS]`\n\n"; + + my $oldclass; + 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); + $synopsis .= "\n" if $oldclass && $oldclass ne $class; + + $synopsis .= "$str\n\n"; + $oldclass = $class; + } + + $synopsis .= "\n"; + + return $synopsis; +} + sub print_simple_pod_manpage { my ($podfn, $class, $name, $arg_param, $uri_param) = @_; - die "not initialized" if !($cmddef && $exename && $cli_handler_class); + die "not initialized" if !$cli_handler_class; + my $pwcallback = $cli_handler_class->can('read_password'); my $synopsis = " $name help\n\n"; @@ -336,7 +378,7 @@ sub generate_bash_completions { # this modifies global var, but I found no better way COMP_WORDBREAKS=\${COMP_WORDBREAKS//:} -complete -C '$exename bashcomplete' $exename +complete -o default -C '$exename bashcomplete' $exename __EOD__ } @@ -388,8 +430,29 @@ sub generate_pod_manpage { } } +sub generate_asciidoc_synopsys { + 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(); + } +} + my $handle_cmd = sub { - my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc) = @_; + my ($def, $cmdname, $cmd, $args, $pwcallback, $podfn, $preparefunc, $stringfilemap) = @_; $cmddef = $def; $exename = $cmdname; @@ -423,13 +486,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, $podfn, $preparefunc, $stringfilemap) = @_; my ($class, $name, $arg_param, $uri_param, $outsub) = @{$def}; die "no class specified" if !$class; @@ -456,7 +519,7 @@ my $handle_simple_cmd = sub { &$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; }; @@ -468,7 +531,7 @@ sub run_cli { die "password callback is no longer supported" if $pwcallback; - run_cli_handler($class, podfn => $podfn, preparefunc => $preparefunc); + run_cli_handler($class, podfn => $podfn, prepare => $preparefunc); } sub run_cli_handler { @@ -478,10 +541,19 @@ 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 + die "unknown parameter '$key'"; + } + my $podfn = $params{podfn}; - my $preparefunc = $params{preparefunc}; + my $preparefunc = $params{prepare}; + my $no_init = $params{no_init}; my $pwcallback = $class->can('read_password'); + my $stringfilemap = $class->can('string_param_file_mapping'); $exename = &$get_exe_name($class); @@ -490,10 +562,10 @@ sub run_cli_handler { if ($class !~ m/^PVE::Service::/) { die "please run as root\n" if $> != 0; - PVE::INotify::inotify_init(); + PVE::INotify::inotify_init() if !$no_init; my $rpcenv = PVE::RPCEnvironment->init('cli'); - $rpcenv->init_request(); + $rpcenv->init_request() if !$no_init; $rpcenv->set_language($ENV{LANG}); $rpcenv->set_user('root@pam'); } @@ -502,11 +574,11 @@ sub run_cli_handler { my $def = ${"${class}::cmddef"}; if (ref($def) eq 'ARRAY') { - &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $preparefunc); + &$handle_simple_cmd($def, \@ARGV, $pwcallback, $podfn, $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, $podfn, $preparefunc, $stringfilemap); } exit 0;